Running a report

1. Click the System tab.

2. Select Reports from the System list.

3. Select a report from the Available Reports list.

4. Specify the reporting period.

5. Select an output format from the Output Format drop-down menu.

   Note: Each report has a default selection for the output format, which may be the format that the report was specifically designed to use. For more information about a custom report, contact the designer of your custom report.

6. Save the report to a file or send it in an e-mail message:

   To save the report to a file:

   1. Select the Save To check box.

   2. Click beside the Save To field.

   3. Type a destination folder path using either a local drive letter or a UNC path for a network share.

   4. If the folder is located on a network share that requires authentication, then type the network share user name and password.

   5. Click OK.

   To send the report in an e-mail message:

   1. Select the Email To check box .

   2. Click beside the Email To field.

   3. Edit the fields of the e-mail message as necessary, and then click OK.

7. If additional query parameters are available for the selected report, then click Additional Parameters to specify values for those parameters. If no additional parameters are available, then the button is disabled.

   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.

8. Click Run Report.

   The report is displayed in a new window and may be saved to a file or sent in an e-mail message.

   Notes:

   • Only summary reports are supported. Even if a custom report has a detail section defined, the section is not displayed. If a custom report does not have a summary section, then the finished report is blank.
   • Pop-ups must be allowed for LMC in your Web browser to view reports.
   • Adobe Reader is required to view PDF reports.

Scheduling a report

1. Click the System tab.

2. Select Schedule from the System list.

3. Click Add > Report.

   Note: Some solutions may include a script that runs a report with a predetermined configuration which can be scheduled like any other script. Additionally, reports that run through a script can be run separately for each server in the system. For more information, contact the developer of your solution.

4. Type a description for the task, and then click Next.

5. Select and configure the scheduled report:

   1. Select a report from the Available Reports list.

   2. Select a reporting period.

   3. Select an output format from the Output Format drop-down menu.

      Note: Each report has a default selection for Output Format, which may be the format that the report was specifically designed to use. For more information about a custom report, contact the designer of your custom report.

   4. Save the report to a file or send it in an e-mail message:

      To save the report to a file:

      1. Select the Save To check box.

      2. Click beside the Save To field.

      3. Type a destination folder path using either a local drive letter or a UNC path for a network share.

      4. If the folder is located on a network share that requires authentication, then type the network share user name and password.

      5. Click OK.

      To send the report in an e-mail message:

      1. Select the Save To check box..

      2. Click beside the Email To field.

   5. If additional query parameters are available for the selected report, then click Additional Parameters to specify values for those parameters. If no additional parameters are available, then the button is disabled.

6. Click Next.

7. Enter a start date and a start time.

8. Configure the frequency of the scheduled event, and then click Finish.

Using built-in reports

Built-in reports are available to display commonly used data. All built-in reports are designed for PDF output, except for those that specify CSV in the report title.

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

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

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

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

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

• Server Report—This displays data related to server usage, such as job success rates, hourly job rates, job duration, and server distribution. Both a summary for all servers and details for individual servers are available.

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

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

• Task Summary Report—This displays data related to tasks, such as task attempts, task success rates, and task times. Both a summary and details are available.

• Tops Report—This displays 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—This displays data related to users, such as user job success rates, most active users, and job duration.

Adding a report

1. Click the System tab.

2. Click Reports in the System list.

3. Upload the report files:

   1. Click Upload Report Files > Browse.

   2. Select a .jasper compiled report file, as well as any of the following:

      • .jasper compiled report files used as subreports

      • .jpg or .png graphics included in the report

      • .jrxml report source files (optional)

   3. Click Open.

   4. Existing files are overwritten by default. If you do not want to overwrite existing files, then clear the Overwrite if file already exists check box.

   5. Click Upload.

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

4. Below the Available Reports list, click Add.

5. Type a descriptive report name.

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

7. Select the database the report was designed to access from the Datasource drop-down menu. Commonly used databases include:

   • MONITOR—This is used by reports that access the jobs list and the log.

   • SOLUTIONINFO—This is used by some solutions to store custom data.

   For more information about a custom report, contact the designer of your custom report.

8. Select the default output format.

   Note: Each report has a default selection for output format, which may be the format that the report was specifically designed to use. For more information about a custom report, contact the designer of your custom report.

9. Click Save.

Editing report settings

1. Click the System tab.

2. Click Reports in the System list.

3. Select a report from the Available Reports list, and then click Edit.

4. Edit the report settings as necessary:

   • Type a descriptive report name.

   • Select the Jasper report file name for a compiled report that has been uploaded to the system.

   • Select the data source.

   • Select the default output format.

     Note: Each report has a default selection for output format, which may be the format the report was specifically designed to use. For more information about a custom report, contact the designer of your custom report.

5. Click Save.

Removing a report

To remove a report, select a report from the Available Reports list, and then click Delete.

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

Configuring default report options

You can configure default report options, such as default e-mail or file destination and default reporting period.

Select the Reports service from the Services tab.

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

Using special LDD parameters

You can add the following parameters to the report design in order to use the specified information in other parts of the report:

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

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

• SUBREPORT_DIR—This retrieves the reports folder, located at \Lexmark\Solutions\apps\wf-ldss\WEB-INF\reports\ where LDD is installed on each server, from the LDD installation in order to locate subreport files.

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 as follows:

• User name—framework

• Password—rivet

Information that appears in the log is available from the TASK_LOG table in the MONITOR database. It contains the following fields:

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

• LOG_TIME—The time when an entry was 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 assigned to a task. Each entry recorded from the same task has the same TASK_ID.

Information from the Jobs list is available from the TASK_INFO table in the MONITOR database. It contains the following fields:

• TASK_ID—The unique ID number assigned to the task.

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

• TASK_NAME—The name of the task.

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

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

• START_TIME—The time when the job was received.

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

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

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

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

• ADDRESS—The unique ID number of a printer.

• SCHEDULE_ID—The ID for the scheduled task that ran (if applicable).

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

• THREAD_NAME—The name of the thread 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.

Using included subreports

Some subreports included may be useful in developing other custom reports. Since these files are included with the installation, they do not have to be uploaded before adding a form that includes any of them.

When using a subreport in a custom report, you must pass the start_date, end_date, and SUBREPORT_DIR to the subreport using the Parameters property of the subreport element.