Versions Compared

Key

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

...

  • The StickySubagent Instruction is the dynamic version of the JS7 - Fork-Join Instruction. Use of the ForkList Instruction with a JS7 - Agent Cluster can be used to execute a number of jobs with the same Subagent of a JS7 - Agent Cluster. Use of Agent Clusters is subject to the terms for clustering with the JS7 - License.
  • Technically it implements the Fork/Join operation, however, it allows a number of child orders and branches to be created dynamically in order to execute the same sequence of jobs on a number of Subagents: users can run the same jobs in parallel on a number of servers or containers operating Subagents. Use cases include for example to execute similar backup jobs on a larger number of servers.
  • The ForkList Instruction expects a Subagent Cluster to be assigned that can include any number of Subagents running on the same or different server nodes that execute the same jobs.
  • The ForkList Instruction is designed as a single branch when configuring the workflow with the Configuration View of the JOC Cockpit user interface. Depending on the number of Subagents provided with the assigned Subagent Cluster the Controller will dynamically create branches for each Subagent.
  • While child orders are running, the parent order waits for its child orders to be completed, i.e. to arrive at the Join Instruction. The parent order therefore is assigned the WAITING state, see JS7 - Order State Transitions.
  • the block instruction checks the first available Subagent of a Subagent Cluster. This Subagent will be used for subsequent jobs within the block instruction.
    • The underlying use case is the situation when jobs in a workflow create temporary files that should be picked up by successor jobs. If successor jobs were executed with a different Subagent on a different server then they might not find files created by predecessor jobs.
    • If the Subagent used for the first job of the StickyAgent Instructions becomes unavailable for subsequent jobs then the order will be put to the BLOCKED state.
    • Jobs within a StickyAgent Instruction block can be assigned the predetermined Subagent or can be assigned Standalone Agents and Subagent Clusters unrelated to the StickyAgent Instruction
    A variant of this instruction is available with the JS7 - ForkList-Join Instruction for variable sets
    • .

Display feature availability
StartingFromRelease2.5.0

Workflow Instruction:

...

StickyAgent

Static Assignment of Subagent Cluster

Download example (upload .json): pdfAgentClusterForkListpdfAgentClusterStickySubagent.workflow.json

Using a Subagent

...

Selection to assign the Subagent Cluster to the

...

StickySubagent Instruction

The workflow editor is used to add a ForkList StickySubagent Instruction as shown:

  • The ForkList StickySubagent Instruction is assigned a Subagent Cluster.
  • The ForkList StickySubagent Instruction includes a number of jobs that should be executed in parallel on all Subagents on the same Subagent of the given Subagent Cluster.

Image RemovedImage Added


Explanation:

  • The ForkList StickySubagent Instruction is assigned the Subagent Cluster active-active-all-agents from the AgentCluster001 cluster.
  • The jobs inside the ForkList StickySubagent Instruction are executed in parallel on all Subagents included with on the same Subagent that is a member of the active-active-all-agents Subagent Cluster.
    • Users are free to exempt individual jobs from being executed on Subagents of the cluster this Subagents and instead to be executed for example on Standalone Agents. 

...

Individual jobs inside the ForkList StickySubagent Instruction are assigned Subagents like this:

  • The Subagent Expression radio button is selected and the same AgentCluster001 cluster as for the ForkList StickySubagent Instruction is selected.
  • The Subagent Cluster ID Expression is specified: the $js7ForkListSubagentId variable is automatically available at run-time and holds the identification of the respective Subagent for execution of the job.

Image Removed

Explanation:

...


Image Added

Dynamic Assignment of Subagent Cluster

...

  • The Subagent Cluster indicating the Subagents on which to execute jobs in parallel is dynamically specified from a workflow variable.
  • The ForkList StickySubagent Instruction is combined with a JS7 - Fork-Join Instruction that allows parallel execution of jobs with each Subagent.

...

  • The countries list variable specifies an array of elements holding the countryCode and countryName variables.
  • The subagent_cluster workflow variable is assigned a default value indicating the active-active-all-agents Subagent Cluster.
    • The default value can be overwritten by an order that specifies this variable.

Using a Subagent Expression to assign the Subagent Cluster to the

...

StickySubagent Instruction

The workflow editor is used to add a ForkList StickySubagent Instruction as shown:

  • The ForkList StickySubagent Instruction is assigned a Subagent Expression.
    • This includes to select an Agent Cluster.
    • This includes to specify an expression, for this example the workflow variable $subagent_cluster, that carries the name of the Subagent Cluster.
  • The ForkList StickySubagent Instruction includes a number of jobs that should be executed in parallel on all Subagents on the same Subagent of the given Subagent Cluster.

...