Versions Compared

Key

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

...

JS7 - Workflows implement jobs and dependencies for workload automation. Orders are triggers that cause the execution of workflows.

  • The Configuration View offers provides a graphical design view from the JS7 - Workflow Editor.
  • The Workflows View offers provides a tactical execution view that can be used to monitor the processing of orders with workflows in near real-time and to perform interventions if required.
  • The Dashboard View offers provides a summary of current order states that and navigation to the Orders Overview, which allows bulk operations, for . For details see JS7 - Orders - Bulk Operations.

Orders can be cancelled and can , be suspended to prevent execution of instructions such as jobs and they can be resumed.

Status Operations on Orders

Status Operations operations are available individually per workflow order and are available as bulk operations when users select a number of workflows orders are selected in the Workflows view.

The following sample workflow is available that which implements a number of jobs and passes variables between jobs:

Anchor
cancel
cancel
Cancel Order

Orders in a PENDING, SCHEDULED, IN PROGRESS, RUNNING, SUSPENDED, PROMPTING, WAITING, BLOCKED and FAILED state offer to cancel operation of the order, states can be cancelled: for details see the JS7 - Order State Transitions article:

  • Cancel: The This operation allows the order to complete the current instruction, for example, executing a job, and after completion of the instruction the order leaves will leave the workflow with a failed history outcome.
  • Cancel/Kill Taskforce: The operation kills processing of forcibly terminates the current instruction, for example a running task for a job, and makes the order leave the workflow.


Explanation:

  • When Cancelling an order is cancelled this is performed from as an asynchronous operation that which includes the JOC Cockpit, Controller and Agent.
    • In a first step the order is displayed from with a green/red bullet  icon icon indicating that indicates that the order still is running and that the cancel operation to cancel the order is in progress.
      • Should If the Controller or Agent not cannot be accessible accessed then the display of the order remains will remain unchanged.
      • Consider Note that "inaccessible" can mean that the network connection is has been lost and that the Agent in fact is up and running. In this situation the order will continue processing with to be processed by the Agent until the order cancel operation to cancel the order is successfully transmitted to the Agent.

Anchor
suspend
suspend
Suspend Order

Orders in a PENDING, SCHEDULED, IN PROGRESS, RUNNING, PROMPTING, WAITING, BLOCKED state offer the operation to suspend the order states can be suspended:

  • Suspend:  The This operation allows the order to complete the current instruction, for example, executing a job, and after completion of the instruction the order is put to the SUSPENDED state.
  • Suspend/Kill Taskforce:  The operation kills processing of The operation forcibly terminates the current instruction, for example, a running task, and puts the order in the SUSPENDED state.


Explanation:

  • When Suspending an order is suspended this is performed from as an asynchronous operation that which includes the JOC Cockpit, Controller and Agent.
    • In a first step the order is displayed from with a green/orange bullet icon, indicating that indicates that the order still is running and that the suspend operation to suspend the order is in progress.
      • Should If the Controller or Agent not cannot be accessible then the display of the order remains will remain unchanged.
      • Consider Note that "inaccessible" can mean that the network connection is has been lost and that the Agent in fact is up and running. In this situation the order will continue processing with to be processed by the Agent until the suspend operation to suspend the order is successfully transmitted to the Agent.
    • In a second step the order is will be displayed from with an orange bullet icon that indicates indicating that the order is has been suspended.

Anchor
resume
resume
Resume Order

FAILED and SUSPENDED orders can be resumed from the Workflows view like thisas follows:

  • Resume: The order is can be resumed from its current position in the workflow. Resume Parameterized:
  • The order is resumed similar to the Resume operation. In addition this operation allows to modify order variables.

Image Removed

  • can be resumed from a  previous or later position in the workflow that matches the same instruction level. 
  • Order variables that are dynamically created and updated in a workflow can be modified.
  • Consider that for failed orders the History status remains In Progress as long as the order did not complete the workflow.

Image Added

Resuming an Order from a specific Job or Instruction

If the Resume operation is used for an order, then a If the operation to resume an order is used then the tabular view of the workflow is will be displayed:

  • Users can click the Submit button to resume the order from its current position.
  • Users can resume the order from a different position before or after the current position: clicking the order with the mouse and moving the order to the desired position makes the order resume from this position.
    • This operation is offered for top level instructions available for instructions located at the same level in a workflow.
    • This operation is denied for nested instructions, for example resuming :
      • For example, an order can be resumed from a position inside
      or JS7 - Lock Instruction is not allowed.
    • This operation is offered inside nested instructions, for example if an order in a branch of a Fork/Join Instruction is suspended it can be freely resumed inside its branch.

Image Removed

If the Resume Parameterized operation is used then in addition to the tabular view of the workflow

  • The order can be resumed from any position in the workflow as explained above.
  • In addition the list of order variables is displayed.
    • Users can modify values of order variables.
    • Users can use the Add Variable link to specify a variable that is not available from the order but has been declared with a default value from the workflow.

...

      • branch. Similarly the order can be resumed from the end of the branch. However, an order cannot be resumed from a different branch or outside of the Fork-Join Instruction.
      • For example, an order can be resumed from other positions inside a JS7 - Lock Instruction. However, it cannot be resumed outside of the Lock Instruction.

Image Added


Dragging & dropping an order with the mouse to different position in the workflow looks like this:

Image Added

Resuming an Order and modifying Workflow Variables

The above example shows a workflow variable that can be modified:

  • Variables are displayed with values that are historically specific before starting the failed job.
  • Variables with modifiable values can be selected from a checkbox:
    • If a variable is selected then its current value will be used when resuming from the selected position in the workflow.
      • Consider that this will overwrite the historic value of the variable for the targeted workflow position.
      • Users are free to modify the values of variables.
    • If a variable is not selected then it will use the historic value associated with the position in the workflow from which the order will be continued.
  • Variables with constant values cannot be modified. This includes order variables that are added when planning the order and this includes variables that are declared with a workflow. Other variables that are created dynamically during workflow execution can be modified.

Resuming an Order and specifying the Cycle End Time

If an order is suspended or failed in a JS7 - Cycle Instruction then users can modify the cycle end time:

  • A period shorter than configured with the Cycle Instruction can be specified.
    • Periods are specified by relative dates, for example 1h (1 hour), 10m (10 minutes), 01:30:00 (1 hour, 30 minutes).
    • Specifying a value 0 for the period will cause the order to continue from the resumed position in the workflow, to execute subsequent jobs and to leave the cycle next time it meets the Cycle Instruction.
  • A period that is specified longer than configured with the Cycle Instruction will be ignored


Image Added

Anchor
let_run
let_run
Let Run Order

Orders in a PENDING, SCHEDULED or WAITING state for a JS7 - Cycle Instruction or JS7 - Retry Instruction can be forced to run immediately from the Workflows view as follows:

  • Orders will be running from their current position in the workflow.
  • Orders in the WAITING state ignore the wait time for a next cycle or a next retry and will run immediately.
  • Orders in the PENDING or SCHEDULED state will start immediately.

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
keyJS-2111

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

Let Run Order from Workflows View

The functionality is available from the Workflows view like this:

Image Added

Let Run Order from Daily Plan View

When used with the JS7 - Daily Plan view the operation brings the following behavior:

  • The order remains assigned its original Daily Plan date though it is executed at an earlier date/time. This means that the order will not consider Notices from JS7 - Notice Boards of an earlier Daily Plan date but Notices of its original Daily Plan date if the “let run” operation causes the order to start before begin of the assigned Daily Plan.
  • Users who wish to modify an order's assignment to the Daily Plan and to Notices matching the order's effective start date can use the operation "Modify start time" with option "Now" from the Daily Plan view.
  • The "let run" operation is available for non-cyclic orders in the submitted state. For bulk operations users have to apply the One-time order

Display feature availability
StartingFromRelease2.7.1

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-1779


Image Added

Anchor
transfer
transfer
Transfer Orders

The operation is available with the Workflows view and can be applied in a situation when users find more than one version of the same workflow:

  • When modifying and deploying workflows then a new version of the workflow is created.
  • Orders that did not yet start and that hold the PENDING or SCHEDULED state can make use of the new workflow version.
  • Orders that have started and that hold any other state will remain with the previous workflow version. The reason being that changes to the workflow can disrupt orders that have been added to a previous version of the workflow. For example, if certain jobs or instructions have been added before the order's current position in the workflow, then this will break execution of an exiting order.

The operation to transfer orders is available for previous workflow versions and includes to transfer all orders to the latest version of the workflow.

Image Added


Explanation:

  • The previous version of the workflow holds 2 orders in the SCHEDULED and in the SUSPENDED state. This version of the workflow will not accept new orders but will continue to run orders previously assigned.
  • The latest version of the workflow currently is not assigned any orders.

The previous version of the workflow offers the "Transfer Orders to latest Version" action menu item like this:

Image Added


As a result of the transfer operation users find all orders assigned the latest workflow version. The previous workflow version disappears as it is no longer needed with all orders being transferred.

Image Added


Transfer is possible within limits of the order state:

  • If orders are in the PENDING, SCHEDULED, FAILED, SUSPENDED, PROMPTING state then this will work.
  • If orders are in the IN PROGRESS, RUNNING or BLOCKED state then this cannot work.  
  • If orders are in the WAITING state then it depends on what orders are waiting for:

Bulk Operations

The Workflows view displays a maximum of three orders with for each workflow. The overall number of orders available for the workflow is displayed with by the grey order indicator:


When clicking the order indicator, a popup window is displayed with the list of orders like thiswill be displayed as follows:


Explanation:

  • When clicking Clicking the Order ID of an individual order then will cause the order log is to be displayed.
  • When selecting Selecting one or more orders then depending on the order state bulk operations to will allow the cancel, to suspend and to resume or resume bulk operations to be carried out for the selected orders are displayed, according to the order state.
  • When an order is resumed from a bulk operation then:
    • the position to resume from which the order from cannot be selectedwill be resumed will always be the current position,
    • the order variables cannot be modified.

...