Page History

...

This article describes how the Join Job can be used in a "Y" pattern , - the How to Execute Jobs in a Job Chain in Parallel article describes it use in a Split and Join pattern.

...

• See the How To Synchronize Job Execution Across Job Chains article for information about synchronizing Jobs in different Job Chains and for joining up parallel executing child Job Chain segments in JobScheduler versions 1.11.3 and older.

...

• Download the example y_join.zip
• Extract the archive to a folder ./config/live of your JobScheduler Master installation.
• The archive will extract the files to a folder y_join. 
• The y_join folder can be renamed if required, the solution does not require the use of specific folder or Job names.

...

Example Description

The Join Job has basically a counting function. This makes it significantly faster than the Sync Job which checks the IDs of the jobs being processed.

...

• The required_orders parameter is read immediately by the join Join Job, which will then wait until the number of Orders specified in the parameter (here it is 12) have been processed.
  
  • Note that the Join Job only counts orders that have the state of the join Job as their end state (here join).
• The main_order moves to the generate_orders Job, which generates a total of 10 Child Orders.
  
  • This number is specified in a second parameter for the main_order - generate_orders.
  • 5 of these child orders start processing at node 150 and end at the Join Job and 5 will start at node 160 and . All the Child Orders will end at the Join Job.
    • It is not important whether or not Child Orders take the same branch of the Job Chain as the main_order.
  • All these Child Orders will be counted towards the required_orders parameter.
  • Child Orders are given an Id based on the Parent Order ID plus a string.
    • The first generated Child Order in the example will be given the ID main_order_0.
• The main_order itself then moves to the wait Job where it waits for a time specified in the Order's wait_time parameter (here 35 seconds).
  
  • The sole purpose of this delay is to demonstrate that the main_order can reach the Join Job after the other Orders.
  • This delay is not necessary for the functioning of the Join Job and the example will work with the wait_time parameter set to its minimum value of 1 (0 will cause an error).
• When the main_order reaches the Join Job it will be counted towards the number of Orders specified in the required_orders parameter, making a total of 11 after all the generated Child Orders have been completed.
  • Note that the main_order is the only Order that will be counted that does not have to have the state of the Join Job as its end state.
• The main_order will now be suspended at the Join Job (without the Job being processed) until:
  • a further Order that has the state of the Join Job as its end state is completed. 

The main_order_add-order Order can now be used to increase the the total number of Orders counted by the join Join Job by 1.

• In the current example, running the main_order_add-order Order once will cause the number of Orders counted to reach the value set in the required_orders parameter (12).
  • The join Job will now process the main_order which will then proceed along the Job Chain - in this example to the Job C with the state 200.
• The ID of this Order has to follow the convention used for other Child Orders - that is, the ID of the parent Order plus a string.
  
  • Note that this string may not contain an underscore character ("_").

Note that Child Orders such as the generated Orders or the manually configured the main_order_add-order Order in this example will only be recognized as such when they are started after the Parent Order has been started.

The Job Chain, Jobs and Orders

...

<?xml version="1.0" encoding="ISO-8859-1"?>
<job_chain  title="Y Join">
    <job_chain_node  state="100" job="generate_orders" next_state="wait" error_state="error"/>
    <job_chain_node  state="150" job="job_a" next_state="join" error_state="error" delay="10"/>
    <job_chain_node  state="wait" job="wait" next_state="join" error_state="error"/>
    <job_chain_node  state="join" job="join" next_state="200" error_state="error"/>
    <job_chain_node  state="200" job="job_b" next_state="success" error_state="error"/>
    <job_chain_node  state="success"/>
    <job_chain_node  state="error"/>
</job_chain>

The generate_orders job Job contains the following script:

...