Job Definitions view

A job definition allows you to specify the type of job (see Job Types) along with the parameters for the job, schedule of the job, and various other settings. The following are some of the key elements of a job definition:

Scheduling Details: Job instances may be scheduled on-demand, daily, monthly, or at a fixed interval (specified in minutes). On-demand jobs may either be scheduled manually by a user or API, or they may be initiated by another job, event notification, or alert.
Job Parameters: The five free form parameters for a job definition are utilized differently by each job type. Generally, these parameters will specify options or settings that the job type will need to configure and run its business logic. For more information, see Job Types for the type of job being defined.
Template File: For jobs which create a template definition a template file can be specified. For example, an API job type uses the template file as the format for the API calls. The API job type supports string substitution based on the job’s parameters to modify the template file before sending the API for each entity selected.
Input File: The input file can be used by jobs to identify key information for the processing of the job. The input file in the case of a job instance initiated from an Event Notification (EN) will be the EN file. For a job instance initiated from an Alert, the input file will be the Alert XML file, if the Alert is configured to generate an XML file. For a job instance initiated by a previous job instance, the input file will be the output file from the previous job instance.
Output File: Many jobs will include results in an output format (usually the output of an API). Since multiple entities may be processed by a single job instance, multiple output files may be created by a single job instance. The output file from a job instance may be used by later job instances as an Input File.
Alert Watch Group: Alert watch groups may be specified so that appropriate parties are notified by email upon successful or failed completion of a job instance.
Job Entity Selection Criteria: Each job may be associated with one or more Entity Selection Criteria (ESC). The use of the ESCs may vary from job type to job type. For a re-rate job type, the ESCs would be used to identify what shipments, loads, trips, and/or bookings should be re-rated. For a TransVoyant Ocean Tracking job type, the ESCs would select the bookings to be tracked. For an API job type, the selection criteria would query for entities to which the action should be applied. For more information, see Job Types for the type of job being defined.

In this section