...

Introduction

• The History View displays the history of workflow and job executions and it enables access to log filesincludes a number of sub-views to display the:
  • JS7 - Order History for the execution of orders passing workflows and jobs,
  • JS7 - Task History for the execution of tasks and their log output,
  • JS7 - File Transfer History for details about transfers performed with the YADE Add-on,
  • JS7 - Deployment History with information about objects such as workflows deployed to a Controller,
  • JS7 - Daily Plan History for details about submission of orders for a particular Daily Plan date.
• 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 of jobs that are added to the JS7 - Database and are available with the History View.
• The History View offers to export history items to files in Excel format.

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.

Image Removed

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:

Image Removed

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.

Image Removed

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.

Image Removed

Task Log View

The task log includes any output created by a job in the workflow for a given order.

Image Removed

Advanced Search

The Advanced Search offers to search for tasks in past periods.

Image Removed

File Transfer History

tbd

File Transfer History View

This view displays details about past file transfesr.

Image Removed

Advanced Search

The Advanced Search offers to search for file transfers in past periods.

Image Removed

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.

Deployment History View

Image Removed

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.

Image Removed

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.

Image Removed

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.

Image Removed

Operational Topics

Controller Interaction

The JS7 - History Service receives information from connected Controllers and adds it to the database.

• History Service works independently from user interaction and displays added or updated history items on-the-fly for all users connected to an active JOC Cockpit instance.
• All sub-views of the History View allow history items to be exported as files in Excel® format.

Controller Interaction

The JS7 - History Service is a background service that receives events from connected Controllers and adds information about order state transitions and log output to the database.

• The History Service automatically subscribes to events from any active Controller instance connected with JOC Cockpit.
• The service acknowledges receipt and processing of events to the originating Controller. The Controller will then release events and will drop them from its journal.
• With a number of JOC Cockpit instances being in place only one JOC Cockpit instance can acquire the active role of running the History Service and related services. Any additional JOC Cockpit instances share the history information from the database but will not receive near real-time events about added or updated history entries.

Performance

The asynchronous nature of events is designed for resilience, at the same time performance cannot be predicted individually for each history item. As a rule of thumb history items are available in near real-time within 2-3s.

• Performance PerformancePerformance of the History Service depends on the following factors:
  • Database performance is essential for the History Service to provide persist data in good time.
  • If a large larger 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 if 100 tasks are starting and completing per second.
• Reasonable performance can be expected for approx. two 30 tasks completing per second which includes visibility of history entries items with the History View in 2-3s.

Resilience

 The History Service supports a number of outage scenarios:

• 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 will events are be released from a the Controller's journal. Consider Note that the Controller journal can grow in case of during longer outages of the History Service if a larger number of jobs and/or jobs with abundant log output are of jobs have to be 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, see JS7 - Sizing.
• The History Service will resume operation after an outage and will continue to receive events from a Controller and to write them events to the database.

Cleanup Service Interaction

The JS7 - Cleanup Service is operated to purge older history data items from the above views. Therefore the Cleanup Service limits the lifetime of history entriesitems.

By default the Cleanup Service will purge history entries items older than 90 days. The Cleanup Service can be configured for an arbitrary individual retention period periods of history entriesitems, see JS7 - History Service.

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 active and passive JOC Cockpit instances. The active JOC Cockpit instance only will receive near real-time events and will update the GUI automatically, any passive JOC Cockpit instances will display the updated history if the user navigates to the respective History View.
• The History Service will fail-over to the next active JOC Cockpit instance in case of outage of the current JOC Cockpit instance.

Further Resources