Page History

Scope

• Use Case:
  • Consider the situation where:
    
    • A job chain is to start at a certain point in time and after an arbitrary number of other job chains jobs have been completed successfully.
    • The predecessor job chains run in an arbitrary sequence at arbitrary points in time.
• Example:
  • Job chain Z runs after 2 other job chains A and B have completed.

Solution

• Download: final_chain_job_history.zip
• Extract the archive to a folder in your JobScheduler installation named ./config/live/issues.
• The archive will extract the files to a sub-folder final_chain_job_history. 
• Note that you can store the sample files in any folder you like: however, you will then have to adjust the job parameters accordingly.

Pattern

order_A [shape="ellipse",label="Order A\n start time: Friday 08:00 ",fillcolor="violet"]
order_B [shape="ellipse",label="Order B\n start time: Friday 07:00 ",fillcolor="violet"]
order_Z [shape="ellipse",label="Order Z\n start time: Friday 15:00 ",fillcolor="violet"]
 
job_chain_A [label="Job Chain A\nhas no relevant dependencies",fillcolor="orange"]
job_A [label="Job do_something_job_chain_A",fillcolor="lightskyblue"]

job_chain_B [label="Job Chain B\nhas no relevant dependencies",fillcolor="orange"]
job_B [label="Job do_something_job_chain_B",fillcolor="lightskyblue"]
 
job_chain_Z [label="Job Chain Z\ndepends on the execution of\nJob Chain A and Job Chain B",fillcolor="orange"]

job_check_predecessor [label="Job check_predecessor",fillcolor="lightskyblue"]

job_next_job [label="Next Job", fillcolor="lightskyblue"]
check_predecessor_successful [shape=diamond,label="execution successful\nfor jobs in Job Chain A and Job Chain B?",fillcolor="white"]
order_setback [label="Set back Order",fillcolor="white"]

order_A -> job_chain_A -> job_A
order_B -> job_chain_B -> job_B
order_Z -> job_chain_Z
job_chain_Z -> job_check_predecessor
job_check_predecessor -> job_chain_A
job_check_predecessor -> job_chain_B
job_check_predecessor -> check_predecessor_successful
check_predecessor_successful -> job_next_job [label=" yes "]
check_predecessor_successful -> order_setback [label=" no "]
order_setback -> job_check_predecessor

Implementation

Components

• The solution contains three job chains:
  • job_chain_A and job_chain_B represent the predecessor job chains that have no relevant dependencies with job_chain_Z.
  • job_chain_Z is the final job chain that checks if job_chain_A and job_chain_B have already been executed successfully.
• The solution implements a job check_predecessor_job_chain_Z that has been added at the start of job_chain_Z.
  • This job is parameterized with a number of parameters that start with the prefix "check_predecessor" and use an arbitrary suffix that is required in order to create unique parameter names. The value of each parameter is the final job of the respective job chain that is checked for successful execution:makes use of a parameter check_jobs that is assigned a semicolon separated list of job names.
    • Job names can be specified with an absolute path (starting from the live folder) or with a path relative to the directory of this job.
    • Example:
      • check_predecessor_A = issues/final_chain/jobs = job_do_something_job_chain_Acheck_predecessor_B = issues/final_chain/;job_do_something_job_chain_B
    • Should the sample files not have been extracted to the ./config/live/issues/final_chain folder then please adjust the parameter value to point to the relevant directory.
  • This job implements a spooler_process() function that reads the parameters parameter and checks the job history for successful execution of the jobs specified by the parametersparameter.
  • Should all checks for previous successful execution provide a positive result then the current order will be moved to the next job chain node. Otherwise the current order is set back and will be repeated regularly according to the setback configuration for this job.

Usage

• Positive Check
  • Add an order to job_chain_A using JOC's Add Order context menu.
    • The order should pass through the job chain without errors.
  • Add an order to job_chain_B using JOC's Add Order context menu.
    • The order should also pass through the job chain without errors.
  • Add an order to job_chain_BZ using JOC's Add Order context menu.
    • The order should pass through the job chain without errors as all pre-conditions are met.
• Negative Check
  • Modify the job do_something_job_chain_A to include an error, e.g. by adding the command exit 1 as the final line in the job script.
  • Add an order to job_chain_A:
    
    • The order should proceed with an error.
  • Add an order to job_chain_Z
    • The order should proceed with an error that is visible in the order log. This error will state that the predecessor job did not complete successfully.
    • The order will be set back and be repeated according to the setback intervals that have been specified for the job check_predecessor_job_chain_Z.
  • Removing the modification to job do_something_job_chain_A and adding an order to job_chain_A that then runs successfully should result in a successful run of job_chain_Z - either by a new order added to job_chain_Z or by the next execution of the previous order that has been set back.

...

See also

• How to check the job history for previous job runs
• How to add a condition to check previous job chains before the execution of the current job chain