Versions Compared

Key

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

Table of Contents

Introduction

...

The JS7 - Daily Plan holds the orders that are scheduled for future execution. Typically orders are added to the Daily Plan for the near future, for example for one week. The orders are submitted to Controllers and Agents and will be executed independently from JOC Cockpit

  • 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 the 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 to Controllersorders to Controllers.

JS7 - Daily Plan Projections are different from the Daily Plan:

  • Projections calculate order execution for longer future periods. By default a period of 6 months is used. However, this can be prolonged to years.
  • Projections do not hold orders but calculate future start times of orders based on the schedules used in the Daily Plan.

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:

Image Modified


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 of an Order order to a Controller includes that for means that the order will be submitted to any Controllers to and Agents which the respective Workflow workflow has been deployed an Order is submittedto.

Daily Plan View

Image Removed

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

Image Added


ExplanationExplanations:

  • Calendar Panel: The calendar panel offers allows navigation to navigate 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.
  • Tags Panel:
  • Detail Panel: The detail panel displays Orders the orders available for the 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 exceeded have over-run their start time.
    • Groupings are available to display Orders orders per Schedule or per Workflow, 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 Schedule schedule, an Order order is created for one-time off execution or for cyclic execution. Cyclic Orders orders include that an individual order is created for each interval in the given period for each interval an individual Order is created, e.g. , for example for a cycle to start 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

. User should consider use of cyclic workflows instead of cyclic orders, see JS7 - Cycle Instruction.

Creating the Daily Plan

Users have a choice to automatically create the Daily Plan (default) or to manually plan for specific dates.

Creating the Daily Plan Automatically

By default the Daily Plan is created automatically. The JS7 - Daily Plan Service is running once per day and will plan orders and submit orders for the next few days.

  • The Daily Plan Service does not add or submit orders for the current day.
  • The start time of the Daily Plan Service and the period for which orders are planned and submitted is specified by tJS7 - Settings.
  • The Daily Plan Service will not add orders to days for which the Daily Plan has been manually created.

Creating the Daily Plan Manually

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

Image Removed

the submission of orders to Controllers.

Image Added


Explanation:

  • Users can choose to create orders from all released schedules or from selected schedules.
  • If orders exist in the Daily Plan for the current day then they can be overwritten, otherwise the existing orders remain in place.
  • Orders can be immediately submitted to related Controllers.
  • Users can specify to create orders from any schedules or from schedules that specify the flag for automated planning only.


Image Added


ExplanationExplanations:

  • 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 previously 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 to create Orders from Schedules and to make creating orders from schedules and making them available with the PLANNED state. Such Orders orders are visible with the Daily Plan View view for the a given date.
    • Submit Orders
      • The Submission submission step includes to forward Orders forwarding orders to any Controllers to and Agents which the underlying Workflow workflow has been deployed to.
  • Users can decide if they want Orders orders to be immediately submitted to a Controller immediately. Should Orders If orders are not be submitted immediately then this can be done later on from the Daily Plan View view. Consider Note that the Daily Plan Service will automatically submit planned Orders orders for a number of days ahead within the scope of its configuration.

...

Deleting Submissions

Submissions are a means to avoid 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 are submitted to a Controllerorders are added, updated or removed. 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 manually 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 partially are in part available as bulk operations. Availability The availability of operations depends on the state of selected Ordersorders.

...

Submitting, Cancelling and Removing Orders

  • The operation 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 considers takes account of the removal of Orders orders and will not re-create the respective Ordersremoved orders.
  • The operation to cancel Orders orders can be performed for any order state except for the PLANNED state and the FINISHED orders in the SUBMITTED state.

...

Suspending and Resuming Orders

  • The runRun-time operations are not performed in the Daily Plan view, but in the Orders Overview available from the JS7 - Dashboard. Such operations include:
    • to suspend Orders can be performed orders for the order states INPROGRESS, RUNNING and WAITING.
    • to resume Orders can be performed for Orders with orders in a SUSPENDED state.

...

Letting Run Orders

  • The operation forces an order to start now. This does not modify the orders' assignment to a Daily Plan date.
    • For example, if the Daily Plan starts at 11:30 each day and an order scheduled for 11:45 is forced to start at 10:45 then this will not change the order's assignment to today's Daily Plan, though technically the order is running in the period of yesterday's Daily Plan.
    • The implication is relevant when using JS7 - Notice Boards as Notices are considered for the Daily Plan date assigned an order.
  • The operation is available from one-time orders' action menu for orders in the SUBMITTED state.

Display feature availability
StartingFromRelease2.7.0

Jira
serverSOS JIRA
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1763

Modifying Order Start Times and Order

...

Parameterization

Both operations to modify Order order start times and to modify Order Variables include to drop existing Orders and to re-create the order parameterization 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.

...

Modifying Start Times

Image Removed

The operation offers to specify This operation allows specification of a new date and time for the execution of the Orderorder. The Order order will be added to the Daily Plan for the new date and time.

Invoke the operation from an order's action menu like this:

Image Added


Invoke the operation for a number of selected orders like this date respectively.

Modify Variables

:

Image Added


The operation brings forward a popup window to specify the modified start time of an order.

Modifying start time of a one-time order

The operation offers the following options:

  • Now: The order will be started immediately.
  • Specific Date: The order will be moved to a later Daily Plan date.
  • Relative to Current Time: The order will be moved to a point in time that is specified by a relative period (days, hours, minutes etc.) to the user's current time.
  • Relative to Start Time: The order will be moved to a point in time that is specified by a relative period (days, hours, minutes etc.) to the order's current start time.

All operations offered will consider the Daily Plan date of the updated start time. For example, if the Daily Plan starts at 11:30 each day and an order scheduled for 11:45 is forced to start at 10:45 then this will move the order to yesterday's Daily Plan. The implication is relevant when using JS7 - Notice Boards as Notices are considered for the Daily Plan date assigned an order.

Image Added

Modifying the start time of a cyclic order

Modifying a cyclic orders includes to modify the begin, end and repeat time of the given order.


Image Added


Related Changes:

Display feature availability
StartingFromRelease2.5.8

Display feature availability
StartingFromRelease2.6.5

Modifying Parameterization

This operation allows to modify an order's parameterization including its start position and end positions in a workflow and any variables assigned.

Users can invoke the operation from an order's action menu like this:

Image AddedImage Removed


JS7 - Order Variables can be declared per Workflow. When modifying variables then values have to be indicated for required variables. In addition, optional variables can be added or removed.

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

Image Added

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


ExplanationsExplanation:

  • This view offers to select Submissions allows selection of submissions for a range of Daily Plan dates. 
    • Consider 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 respective date in question.
  • Each Submission submission includes the Orders orders that are affected by the underlying operation.
  • As for Note that as with any history view consider that , 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. 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.

Applying modified Workflows or Schedules to the Daily Plan

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

  • This offers to apply 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 should if workflow modifications are to be applied earlier than Orders exist to orders already existing in the Daily Plan.

When deploying a modified workflow, schedule or calendar then users have a choice to update the Daily Plan:

Image Added


Explanation:

  • Now: Any orders for the given workflow starting from the current point in time will be updated to make use of the newly deployed version of the workflow. This option is active by default.
  • Start Date: Orders in the Daily Plan will be updated starting from the date specified by the user.
  • No: The Daily Plan will not be updated. Existing orders in the Daily Plan remain assigned the previous workflow version. The JS7 - Daily Plan Service will consider the new workflow version for newly created orders only.

As an alternative users can use the Advanced Filter This use case suggests that the user makes use of the Advanced Search in the Daily Plan View to identify Orders associated with orders assigned the modified workflow for a given date range and

  • to cancel

...

  • resulting orders which means to revoke them from the given Controller and Agents. Such orders will transition to the planned state.
  • to re-submit 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
    • orders automatically.
    Then no
    • No further action is required from the user as the Daily Plan Service will re-submit orders in the planned state.
    • or
    the user does not want
    • to
    make use of the automation capabilities and manually creates Orders for each date.If the modified workflow has to be applied to the current day then it is required to manually re-create Orders
    • manually submit planned orders for each date.