Job Statistics

This task can be found in the Plug-in Bar, under the OL Connect tasks group.

The Job Statistics task retrieve statistics for print jobs created through OL Connect Server. The data returned includes the number of documents, sheets, and pages used, as well as the media types applied. This feature is valuable for accounting purposes and helps you track costs for better budget management in a printing environment.

The output is a file in either JSON or XML format.

Input

This plugin doesn't require any specific job file. The task takes a single Job Set ID, either from a task property, which can contain a variable, or from the Metadata.

Tasks that can output a Job Set ID to the Metadata are the Create Job, Retrieve Items, and All In One tasks.

Processing

For each document in the Job Set ID, the task extracts all of the relevant job details.

Output

The task outputs the report either in JSON or XML format.

Task properties

General Tab

  • Job Set group: All the information regarding the Job Set.

    • Job Set ID: Enter a single Job Set ID. Or, right-click the field to open the contextual menu that allows you to select variables, data and lookup functions (see Data selections).

      • Use Metadata: Check this option to use the Job Set ID in Metadata that is the output of the All In One, Create Job, or Retrieve Items task.

        Note: Metadata is only retained if this box is selected. When the Job Set ID comes from the metadata, it is likely that the metadata was created by the OL Connect plugin and can be reused later.

    • Scope: Enter the scope of the job statistics to gather. The selections are: 

      1. Documents: returns only a list of documents contained in the Job Set.

      2. Documents and Sets: returns a list of document sets contained in the Job Set.

      3. Document Sets: returns a list of document sets (including all of the documents) contained in the Job Set.

  • Output: Select the desired type of output file.

    • JSON: Outputs the job statistics report in a JSON file.

    • XML: Outputs the job statistics report in an XML formatted text file.

OL Connect Proxy Tab

This tab is common to most OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect preferences.

Note: Defaults are not used unless the configuration is sent to the Workflow service.

  • OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides.

  • Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340

  • User name: Enter the user name expected by the OL Connect Server.

  • Password: Enter the password expected by the OL Connect Server for the above user name.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.