Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The Daily Plan is used to manage start times for Orders orders that are executed by the Workflows workflows available with the connected Controllers. 
  • The Daily Plan runs existing JS7 - Schedules and generates Orders orders for the resulting days and start times. This applies to Schedules schedules that specify a single start time for an Order order and to Schedules schedules that specify cyclic starts. For each start time in a cycle an individual Order order is created. Planned Orders orders are available for any modification of start times and variables. In a subsequent step such Orders orders are submitted to their respective Controllers. 
  • This functionality is available for automation with the JS7 - Daily Plan Service. In addition, JOC Cockpit offers a user interface to manage the Daily Plan, to create Orders orders and to submit Orders orders to Controllers.

Schedules

Orders are created from Schedules schedules that indicate the Workflow workflow and variables to be used as well as the run-time specification, i.e. the rules for which days and start times Orders orders should be created. Schedules are available from the Configuration View view:


Use with the Daily Plan Service:

  • The checkbox "Plan Order automatically" checkbox specifies that the Schedule schedule will be applied when running the Daily Plan Service. Orders created by this service are added with a PLANNED state.
  • The checkbox "Submit Order to Controller when planned" checkbox specifies that any PLANNED Orders orders - from the current Daily Plan run or from previous runs - will be submitted to a Controller and will result in a PENDING order state.  Submission Submission of an Order order to a Controller means that the order will be submitted to any Controllers which the Workflow workflow has been deployed to.

Daily Plan View

The Daily Plan view is available from JOC Cockpit's main menu like this:


Explanation:

  • Calendar Panel: The calendar panel allows navigation to a specific date to display the Daily Plan.
    • The panel shows the list of Submissionssubmissions, i.e. the points in time when Orders orders have been created for the selected date.
  • Detail Panel: The detail panel displays the Orders orders available for a selected date.
    • Filters are available to limit the list of Orders orders to the given order state. In addition, late Orders can be filtered to find Orders that have over-run their start time.
    • Groupings are available to display Orders orders per Schedule, per Workflow or per Order.
    • The Planned Start time is calculated from the Schedule. The Expected End time is calculated from all previous runs of the same workflow. Consider that the JS7 - Cleanup Service can be configured to limit the number of history entries to the given number of days and therefore impacts the calculation of average execution periods.

Depending on the run-time specification of a Scheduleschedule, an Order order is created for one-off execution or for cyclic execution. Cyclic Orders orders include that an individual Order order is created for each interval in the given period , e.g. for a cycle starting a Workflow workflow every 5 minutes between 10am and 11am, this would will be 12 Ordersorders. The Daily Plan View view - as with every other view except for the History - displays Cyclic Orders cyclic orders as a single Order order with the cycle icon icon . When modifying the start time or variables of a Cyclic Order cyclic order then this change is applied to any Orders orders included with the Cyclic Ordercyclic order. The History View view displays Cyclic Orders cyclic orders individually to enable access to the order state and log for each Order order included with the cycle.

Create Daily Plan

The functionality for creating a Daily Plan is provided by the calendar panel of the Daily Plan View view. It allows the creation of Orders orders and optionally the submission of Orders orders to Controllers.


Explanation:

  • The Daily Plan can be created for any released Schedules schedules and it can be limited to a selection of Schedulesschedules.
  • If a Daily Plan has already been created for the same date then existing Orders orders can be considered or can be overwritten.
  • Creating a Daily Plan includes two steps:
    • Plan Orders
      • The planning step includes creating Orders orders from Schedules schedules and making them available with the PLANNED state. Such Orders orders are visible with the Daily Plan View view for a given date.
    • Submit Orders
      • The Submission submission step includes forwarding Orders orders to any Controllers which the underlying Workflow workflow has been deployed to.
  • Users can decide if they want Orders orders to be submitted to a Controller immediately. If Orders orders are not be submitted immediately then this can be done later on from the Daily Plan View view. Note that the Daily Plan Service will automatically submit planned Orders orders for a number of days ahead within the scope of its configuration.

...

Submissions are a means of avoiding conflicts with the Daily Plan Service that will not consider Daily Plan dates for which Submissions submissions are available. Submissions are automatically added when Orders orders are submitted to a Controller. This includes that the Daily Plan Service will not run for a given Daily Plan date if it finds a submission from a previous Daily Plan Service run or from users creating the Daily Plan for the given date.

However, users are free to delete Submissions submissions with the Daily Plan View view. Deleting a Submission submission does not remove Ordersorders, it just hides the fact that for the given date a previous planning has been performed. If no Submission submission is available for a given date then the Daily Plan Service will consider existing Orders orders for this date and will create additional Orders orders if required by the underlying Schedulesschedules. Practically speaking: if a user drops e.g. 3 Orders for example 3 orders out of 10 for a given date and deletes the Submission submission then the Daily Plan Service will re-create the supplemental 3 Ordersorders.

Operations on Orders

The Daily Plan View view offers a number of operations on Orders orders that are in part available as bulk operations. The availability of operations depends on the state of selected Ordersorders.

Operations to Submit, to Cancel and to Remove Orders

  • The operations to submit and to remove Orders orders from the Daily Plan can be performed for Orders for orders in a PLANNED state. 
    • Removal from the Daily Plan includes that such Orders orders do not exist any longer. The Daily Plan Service takes account of the removal of Orders orders and will not re-create removed Ordersorders.
  • The operation to cancel Orders orders can be performed for any order state except for the PLANNED and FINISHED states.

...

  • The run-time operations:
    • to suspend Orders orders can be performed for the order states INPROGRESS, RUNNING and WAITING.
    • to resume Orders orders can be performed for Orders orders with a SUSPENDED state.

Operations to Modify Order Start Times and Order

...

Parameterization

Both operations to modify order start times and to modify order variables parameterizations include dropping existing orders and re-creating them with a new Order ID. The operations are available from an order's action menu and from bulk operations offered when selecting a number of orders.

...

The operation brings forward a popup window to specify the modified start time start position, end positions and variables like this:

Daily Plan Submission History View

The Daily Plan holds the history of Submissionssubmissions, i.e. the information about when Orders orders have been submitted to Controllers and the successful/failed result of this operation.

The history of Submissions submissions is available from the History -> Daily Plan menuSubmissions menu.

Image Modified


Explanation:

  • This view allows selection of Submissions submissions for a range of Daily Plan dates. 
    • Note that the Submission submission date is the point in time when an Order order has been submitted. The Daily Plan date is the point in time that the Order order is scheduled for.
    • Filtering is available for the Submission submission status being successful or failed.
  • For each Daily Plan date a number of Submissions submissions can be available if the Daily Plan has been re-created for the date in question.
  • Each Submission submission includes the Orders orders that are affected by the underlying operation.
  • Note that as with any history view, the information displayed can be focused on the currently selected Controller or can include information from any connected Controllers.

...

The Daily Plan Service is an unattended background service that plans and submits Orders orders as indicated with Schedulesschedules.

Find details from the JS7 - Daily Plan Service article.

...

In this scenario the user does not want to interact with the Daily Plan. Instead, all order management is automatically performed by the Daily Plan Service.

Schedules specify that Orders orders should be planned and should be submitted automatically. 

  • Each day the Daily Plan Service creates and submits Orders orders for the given days ahead.
  • Such Orders orders become visible with the Daily Plan View with a PLANNED state and with a PENDING state respectively.

...

  • The user will manually create the Daily Plan from the view.
  • The user will submit Orders orders either immediately when creating the Daily Plan or later on.
  • At the same time the Daily Plan Service should not create or plan any Ordersorders. To this purpose the Daily Plan Service setting settings should be modified to plan and to submit 0 no days ahead.

It remains the user's responsibility to create and to submit Orders orders in good time and for all requested Schedules.

Note: When manually creating the Daily Plan for a given date then the Daily Plan Service will skip this date in order to prevent interference.

Apply modified Workflows to the Daily Plan

If a workflow is modified and deployed to a Controller then this will create a new version of the workflow. The modified workflow is not applied to existing Orders orders that have been created for a previous version of the workflow.

  • This allows changes to workflows to be applied for new Orders orders only, giving the user full control about the date starting from which a modified workflow should be applied.
  • This forces the user to drop Orders orders from the Daily Plan if workflow modifications are to be applied to Orders orders already existing in the Daily Plan.

This use case suggests that the user makes use of the Advanced SearchFilter in the Daily Plan View to identify Orders orders associated with the modified workflow for a given date range and to cancel the resulting Ordersorders.

To re-create Orders orders for the given workflow there are two options:

  • either the underlying Schedules are configured to allow the Daily Plan Service to plan and to submit Orders automatically. orders automatically. If the users makes use of the Delete Daily Plan (available from a button with this name) then any orders and submissions are removed from the given Daily Plan date. Then no further action is required from the user as the Daily Plan Service will re-create orders from the underlying schedules.
  • or the user does not want to make use of the automation capabilities and manually creates Orders orders for each date using the Create Daily Plan operation (available from a button with this name).
  • If the modified workflow has to be applied to the current day then it is necessary for Orders orders to be re-created manually.

...