Page History

...

The required job properties are available with the Job Properties tab of the Workflow Editor.

• Name: A job name is required. No spaces are allowed and a number of characters are not allowed. 
• Label: A label assigns a name to the workflow node that is assigned the job.
  • A job can be re-used in a workflow, however, the job label must be unique.
• Agent: Assignment to an Agent is required.
• Return Code: The meaning of the job's return code has to be specified. 
  • Return Codes
    • For shell jobs the OS exit code determines the return code. By default an exit code 0 signals success, any other exit codes signal failure.
    • For JVM jobs the return code is specified by the job implementation.
  • Values
    • Return Codes are integer values within the range from 0 to 9999.
    • A number of return codes can be specified separated by a comma. 
  • On Success / On Error
    • Either successful return codes can be specified or return codes signaling failure.
    • If a job terminates with a return code that is not indicated with the successful return codes or that is stated with return codes signaling failure then the job is considered to have failed. For further details see the section below on Error Handling.
    • A JS7 - Notification is created for failed jobs.
  • On Warning
    • For return codes that signal warnings the job execution is considered successful and no error handling applies.
    • A JS7 - Notification is created for jobs with warnings.
• Executable Type: Allows the job implementation to be selected as a shell job or a JVM job.
  • For shell jobs the Job Property Editor displays the Script subtab and Environment Variables sub-tab.
  • For JVM jobs the Job Property Editor displays the Java subtab.
• Script SubtabSub-tab
  
  • This tab holds the input field for the job script. 
    
    
    
    
  • The right upper corner of this tab offers a pencil icon to invoke the script editor if more than a few commands are to be added to the job script:
    
    
    
    
  • The script editor offers resizing, syntax highlighting, capabilities for search & replace, undo & redo etc. Closing the script editor with the Submit button will add the script content to the script subtabsub-tab.

• Java SubtabSub-tab
  
  • For jobs assigned the JVM job class the Java subtab sub-tab is displayed to enter the name of the Java class used for this job.
  • The JS7 release includes JS7 - Job Templates that can be specified by their Java class name.

...

• Title: A title that will be displayed in the relevant views can be added to a job.Compatibility: For users of JobScheduler branch 1.x a compatibility mode is available.
• For use of environment variables compatibility enables:
  • the automatic creation of environment variables for shell jobs from any available order variables and job arguments.
  • the use of the SCHEDULER_PARAM_ prefix for any environment variable created.
• For use of job arguments the compatibility mode offers a corresponding tab.
For Shell Jobs: Environment Variables SubtabSub-tab
• Environment variables for job scripts have to be specified by a mapping:
  
  
  
  
• The mapping includes specification of a name for the environment variable that has to comply with OS requirements. Names are automatically converted to uppercase. The GUI provides a list of order variable names for the mapping to environment variables.
• The value of an environment variable is an expression that can be specified:
  • as a reference to a variable using the $variableName syntax
    • consider that leading or trailing spaces are not allowed for references.
  • as a string which is a sequence of characters
    • enclosed with single quotes to allow literal use of any characters, including the $ character. The only character not allowed for a string is a single quote.
    • enclosed with double quotes to allow mixed use of characters and variables. A $ character is considered as a prefix for a variable.
• The advantage of the above mapping is the fact that:
  • you publish only the environment variables that are required by a job instead of creating an arbitrary number of environment variables from any order variables and job arguments,
  • you limit the risk of overwriting existing shell environment variables, e.g. passing an order variable with the name "PATH" would then overwrite a shell environment variable of the same name.

...

• Job options include the following configuration items:
Image Removed
Image Added


• Task LimitParallelism: Should more than one order pass the workflow at any given  time or should parallel child orders execute the same job, then this setting determines the maximum number of tasks that are available for the job. This limits parallelism of tasks to the specified number. If more than the specified number of tasks is requested then orders have to wait until a task becomes free.
• Timeout / Grace Timeout: Specifies the maximum duration that a job should run.
  • If the timeout is exceeded then the Agent will send a SIGTERM signal to a shell job. This corresponds to executing the kill -15 command in Unix environments. The purpose of the SIGTERM signal is to let the job know that it should terminate and to leave it up to the job implementation to perform some cleanup tasks such as disconnecting from a database or removing temporary files.
  • After sending the SIGTERM signal the Agent will wait for the duration of the Grace Timeout to allow the task to complete. If the Grace Timeout is exceeded then the Agent will send a SIGKILL signal that will kill the task. This corresponds to executing the kill -9 command in Unix environments.
• Compatibility: For users of JobScheduler branch 1.x a compatibility mode is available.
  • For use of environment variables compatibility enables:
    • the automatic creation of environment variables for shell jobs from any available order variables and job arguments.
    • the use of the SCHEDULER_PARAM_ prefix for any environment variable created.
  • For use of job arguments the compatibility mode offers a corresponding tab.
• Criticality: This option allows a level to be selected that can be used for monitoring purposes to prioritize alerts depending on a job's criticality.
• Log Level: The log level can be used by JVM jobs to adjust their log level. This option is not applicable for shell jobs.

...