Running a report

1. From LMC, click the System tab.

2. From the System section, select Reports.

3. In the Available Reports list, select a report.

4. Specify the reporting period, and then select an output format.

   Note: Each report has a default output format. For more information on custom reports, contact the designer of your custom report.

5. Save the report or send it in an e-mail.

   • To save the report, do the following:

     1. Select Save To, and then click beside the field.

     2. Using a UNC path for a shared folder, type a destination folder path.

     3. Type your credentials.

     4. Click OK.

   • To send the report in an e-mail, do the following:

     1. Select Email To, and then click beside the field.

     2. If necessary, edit the e-mail, and then click OK.

6. If other query parameters are available for the selected report, then click Additional Parameters to specify values for those parameters. For more information, see Adding special LDD parameters.

   Note: Additional Parameters can be defined only when including a report with a workflow solution during development. For more information, see the Lexmark Document Distributor SDK Guide.

7. Click Run Report.

   The report is shown in a new window.

   Notes:

   • Only summary reports are supported. If a custom report does not have a summary section, then the finished report is blank.
   • To view reports, enable pop-ups for LMC in your web browser.
   • Adobe Reader® is required to view PDF reports.

Scheduling a report

1. From LMC, click the System tab.

2. From the System section, select Schedule.

3. Click Add > Report.

4. If necessary, type a description for the task, and then click Next.

5. In the Available Reports list, select a report.

6. Specify the reporting period, and then select an output format.

   Note: Each report has a default output format. For more information on custom reports, contact the designer of your custom report.

7. Save the report or send it in an e-mail.

   • To save the report, do the following:

     1. Select Save To, and then click beside the field.

     2. Using a UNC path for a shared folder, type a destination folder path.

     3. Type your credentials.

     4. Click OK.

   • To send the report in an e-mail, do the following:

     1. Select Email To, and then click beside the field.

     2. If necessary, edit the e-mail, and then click OK.

8. If other query parameters are available for the selected report, then click Additional Parameters to specify values for those parameters. For more information, see Adding special LDD parameters.

   Note: Additional Parameters can be defined only when including a report with a workflow solution during development. For more information, see the Lexmark Document Distributor SDK Guide.

9. Click Next.

10. Configure the date, time, and frequency for the task.

11. Click Finish.

Understanding built-in reports

Built-in reports show commonly used data and are designed for PDF output, except for those reports that specify CSV in the report title.

• Jobs Report - CSV—Shows the jobs list in CSV format.

• Log Report - CSV—Shows all log entries in CSV format.

• Log Report - Failed Jobs—Shows log entries for failed jobs.

• Printer Report—Shows printer usage data, such as printer success rates, printer model usage, printer usage per profile, and most active users per printer.

• Report by Time—Shows daily and hourly data, such as job totals, job success rates, printer usage, user usage, server usage, and job durations.

• Server Report—Shows server usage data, such as job success rates, hourly job rates, job duration, and server distribution. A summary for all servers and details for individual servers are available.

• Software Client Report—Shows software client usage data, such as software client success rates, software client usage per profile, and most active users per software client.

• Solution Report—Shows solution usage data, such as solution success rates, most used solutions, and how solutions are accessed.

• Task Summary Report—Shows task data, such as task attempts, task success rates, and task times. A summary and details for all tasks are available.

• Tops Report—Shows the most active of the following elements:

  • Users

  • Printers

  • Printer models

  • Profiles

  • User for each profile

  • Servers

  • User for each printer

  • Software client for each profile

  • User for each software client

  • Tasks

  • Printer for each profile

  • Scheduled scripts

• User Report—Shows user data, such as user job success rates, most active users, and job duration.

Adding a report

1. From LMC, click the System tab.

2. From the System section, click Reports.

3. Upload the report files. Do the following:

   1. Click Upload Report Files, and then browse to one of the following files:

      • .jasper compiled report file

      • .jpg or .png graphics included in the report

      • .jrxml report source files (optional)

      Note: To prevent overwriting existing files, clear Overwrite if file already exists.

   2. Click Upload.

      Selected files are copied to the \Lexmark\Solutions\apps\wf-ldss\WEB-INF\reports\ folder where the system is installed on each server.

4. In the Available Reports list, click or Add.

5. Type a descriptive report name.

6. Select the report file name for the compiled report that you uploaded.

7. Select the default output format.

   Note: Each report has a default output format. For more information on custom reports, contact the designer of your custom report.

8. Select the data source that the report is designed to access. Commonly used databases include the following:

   • MONITOR—Used by reports that access the jobs list and the log

   • SOLUTIONINFO—Used by some solutions to store custom data

9. Click Save.

Editing report settings

1. From LMC, click the System tab.

2. From the System section, click Reports.

3. In the Available Reports list, select a report, and then click or Edit.

4. Edit the report settings. Do one or more of the following:

   • Type a descriptive report name.

   • Select the report file name for the compiled report that you uploaded.

   • Select the default output format.

     Note: Each report has a default output format. For more information on custom reports, contact the designer of your custom report.

   • Select the data source that the report is designed to access. Commonly used databases include the following:

     • MONITOR—Used by reports that access the jobs list and the log

     • SOLUTIONINFO—Used by some solutions to store custom data

5. Click Save.

Removing a report

1. From LMC, click the System tab.

2. From the System section, click Reports.

3. In the Available Reports list, select a report.

4. Click or Delete > Yes.

Notes:

• Scheduled report tasks that are associated with the deleted report are automatically deleted.
• Scheduled script tasks that use the deleted report are not detected and must be deleted manually.

After removing a report from the Available Reports list, you can optionally delete associated files from the \Lexmark\Solutions\apps\wf-ldss\WEB-INF\reports\ folder on each server where LDD is installed.

Configuring default report options

1. From LMC, click the System tab.

2. From the System section, click Reports.

3. In the Available Reports list, select a report.

4. Configure one or more of the following report options:

   • Reporting period

   • Output format

   • Folder destination

   • E-mail destination

   • Other parameters

   Note: Clicking Refresh Defaults while configuring a report returns settings to defaults.

5. Click Run Report.

Adding special LDD parameters

To use special LDD parameters in other parts of a report, add the following parameters to the report design:

• start_date—Retrieves the start date for report data, as specified in a script or by the administrator when the report is run

• end_date—Retrieves the end date for report data, as specified in a script or by the administrator when the report is run

• SUBREPORT_DIR—Retrieves the reports at the \Lexmark\Solutions\apps\wf-ldss\WEB-INF\reports\ folder on each server where LDD is installed

Querying the database

Information for built-in reports and many custom reports are retrieved from the MONITOR database, which contains information about tasks. Custom reports may also retrieve information from the SOLUTIONINFO database, where some solutions store custom data.

The credentials for Firebird databases are the following:

• User name—framework

• Password—rivet

The TASK_LOG table in the MONITOR database contains the following fields:

• ID—A unique ID number that is assigned to each entry in the log.

• LOG_TIME—The time when an entry is added to the log.

• STATUS—The status reported by the solution that added the log entry.

• PERCENT_COMPLETE—The progress reported by the solution that added the log entry.

• TASK_MESSAGE—The log message reported by the solution.

• TASK_ID—The unique ID number that is assigned to a task. Each entry recorded from the same task has the same TASK_ID.

The TASK_INFO table in the MONITOR database contains the following fields:

• TASK_ID—The unique ID number that is assigned to each task.

• HOST_NAME—The host name of the server where the job is run.

• TASK_NAME

• SOLUTION_NAME—The name of the solution where the task is run.

• STATUS—The status that is reported when the job is completed or abandoned.

• START_TIME—The time when the job is received.

• END_TIME—The time when the job is completed or abandoned.

• PERCENT_COMPLETE—The progress reported by the job when it is completed or abandoned.

• USER_ID—The user who submitted the job (if applicable).

• PRINTER—The IP address of the printer or software client that submitted the job (if applicable).

• ADDRESS—The unique ID number of the printer that processed the job.

• SCHEDULE_ID—The unique ID number of the scheduled task that ran (if applicable).

• PARENT_ID—The unique ID number of the previous task that started the listed task (if applicable).

• THREAD_NAME—The name of the thread that is used by the task.

• CLIENT_NAME—The host name of the printer or software client that submitted the job (if applicable).

• PRINTER_MODEL—The printer model number reported by the printer that submitted the job (if applicable).

• JOB_TYPE—The device class for which the task runs a profile (if applicable).

• HAS_SCANNER—The Boolean value (0 or 1) for identifying whether the printer that submitted the job has a scanner.

Understanding included subreports

Some subreports are included with the installation, and may be useful in developing custom reports.

When using a subreport in a custom report, pass the following to any of the subreports by using the Parameters property of the subreport element:

• start_date

• end_date

• SUBREPORT_DIR

The different subreports are the following: