Job Report

The Job Report task creates a job report with details for one or more jobs that belong to the same job set. The output is either in JSON or a configurable text format.

The report can be used as input for job sheets and for closed-loop inserter systems (e.g. Automated Insertion Management System - AIMS).

Note: For this plugin to work, the following lines:

Copy 
java.io.FileWriter
java.nio.charset.Charset
sun.nio.cs.UTF_8

need to be added to the file:
C:\Program Files\Objectif Lune\OL Connect\Plugins\com.objectiflune.weaver.engine_<version>\runtime\lib\scripting\allowed

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, the task extracts either all (for JSON output) or a selection (for text output) of the job details.

In addition, if the output is set to be a JSON file, the task will extract:

  • Per document: any document level tags defined in the job creation preset.

  • The media type(s) and the number of sheets per media type.

Output

The task outputs the report either in JSON format or text format. In either case, the plugin writes the output for each document on a single line in the output file.

The JSON file contains all possible details for each document in the job, and an overview of how many sheets use each of the print media types in the job (e.g. Plain, Stationery, or 'unspecified' if the media type wasn't specified in the template). The structure is as follows:

Copy 
{"documents": [
{ «document-1» },
{ «document-n» }
],
"media":{"types":{"Media-type-1":50,"Media-type-n":50}}}

The text file contains the job details as configured in the task properties, for each document in the job. Print media type information and any document level tags defined in the job creation preset are not included in the text file.

Task properties

General Tab

  • Job Set ID: Enter a single Job Set ID. Or, right-click the field to open the contextual menu that allows 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.

  • Output: Select the desired type of output file.

    • JSON: Outputs the job report in a JSON file. The file contains all the details that the task can provide on each document, and an overview of how many sheets use each of the print media types in the job. For the structure of the JSON, see Output.

    • Text: Outputs the job report in a text file; see Output. You can either import a text output definition (click the Import definition button) or configure it:

      • Line separator: Enter a line separator. The default line separator is \n (newline character).

      • Field separator: Enter a field separator. The default field separator is \t (tab character).

      • Output header row: Check this option to include a header row in the text file. The name that appears in the header row can be set per job detail.

      • Source: Select which job details to include in the file:

        Job Detail Description
        JobSourceName The Job Set ID
        JobCountSegments The number of segments in the job
        JobCountSets The number of document sets in the job
        JobCountDocuments The number of documents in the job
        JobCountSheets The number of sheets in the job
        SegmentSequenceJob The sequence number of this segment in the job
        SegmentCountSets The number of document sets in the segment
        SegmentCountDocuments The number of documents in the segment
        SegmentCountSheets The number of sheets in the segment
        SetSequenceJob The sequence number of this document set in the job
        SetSequenceSegment The sequence number of this document set in the segment
        SetCountDocuments The number of documents in the document set
        SetCountSheets The number of sheets in the document set
        documentSequenceJob The sequence number of this document in the job
        documentSequenceSegment The sequence number of this document in the segment
        documentSequenceSet The sequence number of this document in the document set
        documentCountSheets The number of sheets in the document

        Click the Standard fields button to include all possible job details.

        You can use the Add item and Delete item buttons at the bottom to add or remove job details, and change the order with the Move up and Move down buttons.

        Per job detail you can make the following settings:

        • Name: The name to display in a header row.

        • Width: The number of characters. Set this to 0 to ensure that the result column takes up the space needed for the data. With any other width, the data is cut off if the specified width is shorter than the data, and if the width is larger than the data, the padding character is placed in the available space between the data and the specified width.

          Note: The prefix and suffix do not count towards the width.

        • Pad: Select whether to use padding. If the data is shorter than the specified width, padding fills the available space to the left or right of the data with a padding character of your choice.

        • Pad Char: The character to use for the padding.

        • Prefix: One or more characters to use as prefix.

        • Suffix: One or more characters to use as suffix.

    Tip: Click the Standard fields button and then the Export definition button to get an example of a text output definition file.

    Note: Print media type information and any document level tags defined in the job creation preset are not included in the text file.

OL Connect Proxy Tab

This tab is common to all 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.