Working with Journals

Creating and Configuring Journals

To edit the journal configuration, open a workflow and right-click the step where you want to configure the journal, then click Journal. When the Journal Configuration dialog opens, edit the fields and click Done when finished.
Field Value
Journal on? This option must be selected to see the full journal UI options, including the status bar.
New file? Select this option to create a new journal file. If not selected, the log will link to a corresponding file that was previously created.
Journal book From the dropdown list, select the journal book to associate with this journal.
File From the dropdown, select the input or output to associate with this journal.
New package? Check this option to create a new package.
Package From the dropdown, select an option. This value will be the package name.
File path From the dropdown, select the value to associate with this package.
File status From the dropdown, select the status of the file being tracked by this journal.
Event Enter a note to indicate the significance of the step being tracked (for example, "file validated").
Journal Milestone Enter the milestone value for the step associated with this journal. See below for more details about setting milestones.
Users with workflows created in older versions of Orchestrator may also have the File Journal Log Entry enabled in their workflows. This is an alternate method to set the same configuration parameters. See the help file for further information (right-click the plugin and click Help).

Setting Milestones in Journals to Track Percentage Complete of a Workflow

A milestone (set in Journal Milestone parameter of the configuration) is a numeric value from 0 to 100 that defines the the weight (relative percentage of importance) of a step in a workflow, from the perspective of the journal. This value is displayed as a percentage of the process that has completed on a file being tracked by a journal.

The weights are added in an incremental manner, ending with 100. So, for example, if the first step has a weight of 10% (milestone = 10), and the second step has a weight of 40, the milestone of the second step = 50 (weight 10 + weight 40).

Viewing Journals Status

Click Work Orders > Journals to open the Journals page. On this page, select a journal book from the dropdown at the top of the page to display the journal entries associated with that journal book. The Journal Filter pane allows you to View by Files or View by Package, and to set filtering criteria for viewing current journals.

The right pane of the page displays a list of journals as determined by the selections in the Journal Filter Pane, including progress bars for journal status.

Clicking the file name displayed in right pane provides more detailed information about the journal entry, as in the following example:

Deleting Journals

There are two methods for deleting journals: