Page History

...

Users can define their own job templates for use with workflows.

• Job templates can be applied to allow existing jobs to be re-use existing jobs used in a number of workflows.
• Job templates can be used to update any workflows that which include jobs that have been derived from a given job template.

...

Anchor
adding_job_templates adding_job_templates

Adding Job Templates

Find the The following examples for example Job Templates are available:

• Example for download (upload .json): pdtTemplateShellJob_001.jobtemplate.json
• Example for download (upload .json): pdtTemplateShellJob_002.jobtemplate.json

Job Templates are available from in the Configuration->Inventory view. They are offered from to be found in object folders with of the same name that which are available in any user folder:

...

Properties to a Job Template correspond to the properties of a job in a workflow,  see see the JS7 - Job Instruction
 article.

Explanation:

• The above example is used to create a Shell Job. Any All of the properties available for Shell Jobs can be added, see JS7 - Job Instruction.
• The Update Jobs button allows to update any jobs referencing the Job Template from the released version of the template.
• This window offers the same sub-views for Script, Argument, Environment Variables and Notification as for any job.
• Job Templates are not deployed to a Controller or Agent. Instead, they are released to allow use with workflows.

...

• Any number of arguments can be added.
• Each argument is specified by its Name, Data Type and optionally its Value.
  • Consider Note that argument names are case-sensitive.
  • The data type can be one of String, Number or Boolean.
  • Values have to correspond to their data type, for example a value true or false matches the Boolean data type.
  • Empty values are allowed, consider to use in accordance with the Required checkbox.
• Arguments can be specified to be Required. When creating a job from a Job Template the user then has to specify a value for a required argument.

...

Anchor
updating_job_templates updating_job_templates

Updating Job Templates

Find the The following examples for example workflows using use two jobs that which reference two distinct Job Templates:

...

• Users can modify any attributes of a Job Template.
• After the Job Template is released, related jobs can be updated from the Job Template.

...

When modifying properties of a Job Template users have the option to propagate changes to jobs that have been derived from the given Job Template. This operation is available:

• from the Job Template that offers the Update Jobs button.
  • The operation is used to update any workflows that include jobs derived from the current Job Template and to select specific workflows for updateupdating.
    
    
• from any user folder including the top level folder that offer the which offers the Update Jobs from Templates action menu in the tree panel to Update Jobs from Templates.
  • The operation updates any all jobs included with any workflows located in folders recursively from any referenced Job Templates.
    
    
    
    
• from the Workflow's action menu in the tree panel that offers to Update Jobs from Templates.
  • The operation updates any jobs in the workflow from any referenced Job Templates.
    
    
    
    
• from the Job that offers an action menu in the JS7 - Workflow Editor. to Update from Job Template.
  • The operation updates the current job in the workflow. Should the same job occur a number of times in the workflow then all occurrences will reflect the update.
    
    
    
    

When clicking the Update Jobs button from a Job Template and when using one of the related action menu items at folder level then a popup window with a list of workflows is displayed that which include jobs making use of Job Templates.

• The popup window:
  • allows to filter filtering for draft workflows and deployed workflows.
  • allows to specify if specifying whether job properties related to to JS7 - NotificationNotifications and JS7 - Admission Times for Jobs should be updated.
  • displays a blue bullet for deployed workflows and an orange bullet for draft workflows that include affected jobs.
  • displays the status:
    • synchronized for workflows that which hold jobs that are in sync with the Job Template, i.e. use the same properties and values.
    • not synchronized for workflows that which include jobs that are not in sync with the Job Template.
• Users can select individual workflows or all workflows recursively to be updated.
  • The update step includes to add adding or to modify modifying a job's properties from the Job Template.
  • Consider Note that updating workflows from a Job Template will create a draft of the given workflow and requires later deployment of the workflow.
    
    

Report of updated Jobs

When performing Performing the operation to update jobs operation in a number of workflows this will results in a report that is available from a popup window like this:.

• The report displays the workflows and jobs that have been updated.
• The jobs per workflow that have been changed or skipped.
• The tooltip icon provides additional information why a job was not updated. For example, for example if the job is was not derived from the Job Template for which the update operation is has been performed.
  
  

Job Properties subject to Update from Job Templates

When updating jobs in workflows from a changed Job Template then:

• the following properties will not be updated:
  • Job Properties
    • Job Name
    • Label
    • Agent
  • Job Options
    
    • Skip Job if no admission for Order's date
• the following properties will be updated:
  • Job Properties
    • Job Template: Reference to the Job Template that which includes the name and hash of the Job Template in usebeing used
    • Title
    • Documentation: Reference to the JS7 - User Documentation
    • Job Resources: References to JS7 - Job Resources
    • Return Codes: On Success, On Failure
    • Return Codes: On Warning
    • Job Class: Shell Job or JITL JVM Job
    • Script/Class Name: Content of a Shell job script or Java class of a JVM job.
  • Job Options
    • Parallelism
    • Timeout
    • Grace Timeout
    • Warn on shorter execution period
    • Warn on longer execution period
    • Criticality
    • Fail on output to stderr / Warn on output to stderr
    • Admission Times: users can choose to overwrite existing properties when updating the job.
  • Notification
    • Mail related properties for job notifications: users can choose to overwrite existing properties when updating the job.
  • Parameterization
    • Arguments:
      • For Shell Jobs arguments are added to the job's Node Arguments
      • For JITL Jobs arguments are added to the job's Arguments
      • The update of Arguments is performed in a way that
        • in case they are added to the Job Template then they will be added to the job,
        • in case they are removed from the Job Template then they will be removed from the job,
        • in case of changes to arguments in the Job Template the changes will not be applied when updating jobs.
    • Environment Variables
      • Names and values of Environment Variables are updated from the Job Template;
        • this includes to add Environment Variables that have been added to the Job Template,
        • this includes to remove Environment Variables that have been removed from the Job Template.

...

Job Templates can be removed using the Remove action menu item that is available from in the tree panel:

• for individual Job Templates,
• for Job Templates at any folder level.

If a Job Template is removed then the jobs holding a reference to the Job Template will continue to work.

• Users can drop the reference to the Job Template at any later point in time.
• Dropping a reference does not modify the job's properties.
• Optionally the job can be updated later on from an existing Job Template using the Wizard button.

Searching Job Templates

The Search button in the JOC Cockpit's Configuration->Inventory view is available to invoke allows searching for Job Templates:

...