Introduction
- The History View displays the history of workflow and job executions and it enables access to log files.
- The JS7 History works asynchronously:
- Events about JS7 - Order State Transitions can occur with the Agent and with the Controller.
- Such events are subscribed to by the JS7 - History Service background task that receives events.
- Events include state transitions and log output by jobs that are added to the JS7 - Database.
Order History
The History View by default displays entries from the Orders sub-view. The order history includes any output of jobs in a workflow that the order passed. Instead of checking individual log files of jobs a single view and log are available to display any output in the lifetime of an order.
Order History View
This view displays orders sorted by descending date of state change.
Explanations:
- The view displays the execution history about start time, end time etc. of the order and of individual jobs in the workflow.
- Order variables are displayed that the order was started with.
- Filtering is enabled for order states and periods.
- The view can be limited to display history entries for the currently connected Controller only or for any connected Controllers.
- When clicking the order id then the order log view will open.
- When clicking an individual job then the task log view will open.
Order Log View
This view displays any log output created in an order's lifetime. Clicking on the order id will bring up the low view window:
Advanced Search
To search for history entries in longer periods, by workflow, order state etc. the Advanced Search offers to filter results by the selected criteria.
Task History
The task history is available from the respective sub-view of the History View.
Task History View
This view displays task history entries that include the output of individual jobs. History entries by default are displayed in descending order of completion.
Consider that task history entries are displayed for any workflows executed in parallel.
Task Log View
The task log includes any output created by a job in the workflow for a given order.
Advanced Search
The Advanced Search offers to search for tasks in past periods.
File Transfer History
tbd
File Transfer History View
This view displays details about past file transfesr.
Advanced Search
The Advanced Search offers to search for file transfers in past periods.
Explanations:
- tbd
Deployment History
The Deployment History is available from the Deployment sub-view of the History View. This view displays objects that have been deployed to the connected Controllers.
Explanations:
- This view supports filters for frequently used date ranges. For longer periods the Advanced Search can be used.
- The deployment status per object is displayed either being deployed or not deployed.
Advanced Search
The Advanced Search offers to search for deployments in past periods.
Daily Plan History
The Daily Plan History includes the history of orders that have been submitted for the respective Daily Plan date. Order submissions can occur manually from the JS7 - Daily Plan View and automatically from the JS7 - Daily Plan Service
Daily Plan History View
This view displays submissions of order for Daily Plan dates. Should problems be detected, e.g. about Schedules being active for Workflows that have not been deployed then this view will display the respective elements.
Explanations:
- This view supports filters for frequently used date ranges. For longer periods the Advanced Search can be used.
- Per order the submission status is displayed being either submitted or not submitted.
Advanced Search
The Advanced Search offers to search for order submissions in past periods.
Operational Topics
Controller Interaction
The JS7 - History Service receives information from connected Controllers and adds it to the database.
- Performance
- Performance of the History Service depends on the following factors:
- Database performance is essential for the History Service to provide data in time.
- If a large number of tasks are starting and completing in short intervals then the workload of the History Service will increase. This can cause delays for order and task history entries becoming visible with the History View. No history entries will be lost, however, it could take minutes for history entries to become available if e.g. 500 tasks are starting and completing per second.
- Reasonable performance can be expected for approx. two tasks completing per second which includes visibility of history entries with the History View in 3s.
- Performance of the History Service depends on the following factors:
- Resilience
- In case of outage of the Primary Controller instance the History Service will automatically switch to the Secondary Controller instance to retrieve history items. Fail-over typically takes place within 10s.
- In case of outage of the History Service the Controller will store events with its journal until the History Service is up again and will acknowledge receipt of events. Only then events are released from a Controller's journal. Consider that the Controller journal can grow in case of longer outages of the History Service if a larger number of jobs and/or jobs with abundant log output are handled by the Controller. Therefore a Controller should be assigned sufficient storage to hold its journal for the maximum expected duration of an outage of JOC Cockpit.
- The History Service will resume after an outage and will continue to receive events from a Controller and write them to the database.
Cleanup Service Interaction
The JS7 - Cleanup Service is operated to purge history data from the above views. Therefore the Cleanup Service limits the lifetime of history entries.
By default the Cleanup Service will purge history entries older than 90 days. The Cleanup Service can be configured for an arbitrary retention period of history entries.
Cluster Operation
The History Service is operated with a JOC Cockpit active-passive cluster:
- Only one instance of JOC Cockpit and of the History Service is active at a given point in time.
- The history information provided from the active History Service instance is available to any passive JOC Cockpit instances.
- The History Service will fail-over to the next active JOC Cockpit instance in case of outage of the current JOC Cockpit instance.