Introduction To Journals
Journals is a feature in orchestrator which helps in tracking the entire lifecycle of a file.
While a workflow/work-order monitors end-end execution of the steps given for multiple files, Journals helps in tracking it down to a file level.
Although Journals has been historically supported as a plugin, from release 2.3 orchestrator provides journaling as a step level configuration.
If you would like to know more about configuring journaling as a plugin, the plugins help file has the necessary information to setup Journaling. Link to Journal Plugin -> Journal Plugin
This article is focused more towards setting up journaling as part of the work-step.
Journal tab can be found list of options available on a work-steps right click. The parameters found while configuring Journals are
1. Journal On? - This parameter decides if you are setting the journaling.
2. New File? - When you start the journaling on a file this option has to be checked to map it as a new file. On the consecutive steps the file name can be mapped to the existing file to change the progress of the same file.
3. Journal Book - (available only for new file)This provides a way to classify the Journals. (Example - If you want to look at files transcoded by Vantage and Carbon Coder separately, you can create two journal books for the respective and map the journals into the corresponding Journal Book. ) Journal Books can be configured under the Workflows tab -> Journal Configuration page.
4. File - Choose from the list of drop-down the file to be journaled. (If you want to enter the value manually or using ruby code choose the "Value or Composite Mapping" option and enter the value). The options available here would be the inputs/outputs/attributes of the step being set.
5. New Package - Check this option if its a new package.
6. Package - Package is used to further classify the journals into useful category. (Example: if you want to view the files under /tmp/server1 and /tmp/server2 separately map the package to these directory paths and the 'View by Package' option in Journal view helps you achieve this)
7. File Path - Map this field to the path of the file being journaled.
8. File Status - This field helps in tracking the status of the file. (Example: Assuming that only if a file completes the anti-virus check and a validation check would its processing be done, then this Status tab can help in setting the file status to inprogress while the anti-virus scan is going on. )
9. Event - Event is a text field that can be used to manually store the event or the current status of the file. (Example: "File inprogress for Anti-Virus", "File transferred to Server 1" )
Below is the screenshot of the Journal box.
Journals can be viewed under the Work-Orders screen from the main dashboards. On the Work-Orders page there is a sub-tab called File Journals that leads to journals.
Journals also provisions the same options as work-orders to view by files or packages along with filtering options to narrow down the results.
Attaching a sample workflow showing Journals for reference. This workflow monitors /tmp folder locally for *.txt files and adds them as journals. Please refer to this to get a general idea on Journaling.
Please reach out to the orchestrator team if you have more questions about Journaling.
1. In 2.3 JournalsBooks are not exported with the Workflows. So it has to be created manually before importing the workflows. In 2.4 this issue is fixed.
2. In 2.3 Journal Configuration is found under 'Engine' tab. In 2.4 this is moved to 'Workflows' tab.
3. Old Journals (Plugin based Journals) are mapped to a default journalBook called Miscellaneous Journals.
4. Any Journal Book can be made primary in the Journal Configuration so that on the display page they get displayed first.