Job directives control the running of jobs. The job queue is sorted by priority first and then by date submitted. Jobs in higher-priority queues execute before jobs with lower priority, even if jobs with lower priority are submitted first.
Job directives can be provided through the Transformation Services, FME Server REST API, and FME Server Console.
Job directives are also available through Schedules and the FME Workspace Subscriber.
tm_priority (deprecated)
An integer representing the request's priority level. Lower values mean a higher priority. Priority values must be greater than or equal to zero.
If priority is not set, the default is 100. The default range is 1 to 200, but there is no restriction other than being greater than zero. The highest priority is 1. A priority less than or equal to zero defaults to 100.
Note: tm_priority is shown for backward compatibility only. Use job queue priority instead. If tm_priority is specified, FME Server creates a job queue dynamically in which to run the job. The job queue is named <queue>-P<queue priority>, where <queue> is tm_tag (below) and <queue priority> is derived from tm_priority. The FME Engines that run the job are those associated with tm_tag. For example, if tm_priority is 11 and tm_tag is Default, the job runs in queue Default-P1 by FME Engines associated with the Default queue. If tm_priority is 81 and tm_tag is Test, the jobs runs in queue Test-P5 by FME Engines associated with queue Test.
tm_rtc
Runs a job until it is explicitly canceled. The job continuously restarts, regardless of whether the job completed successfully, failed, or the server crashed or was shut down. Valid values are true or false.
tm_tag
The job queue in which to run the job. The specified queue overrides the queue of the repository to which the workspace belongs. If not specified, the job is placed in the job queue of the repository.
tm_ttc
The time, in seconds, a job will remain in the running state. This directive is used to ensure that a job does not hang and block an FME Engine indefinitely.
tm_ttl
The "time to live" in the job queue in seconds. This is used in cases where jobs are time-sensitive and can become invalid or stale while waiting in the job queue. If a job is queued longer than "time to live", it is removed from the queue instead of redirecting to an engine.
Note: This directive is enforced only during periods when FME Engines are free, which comprises the time between completion of a job and the start of the next queued job.
Examples
Transformation Services Example
Specify job directives as query string arguments in a URL.
This example specifies a higher job priority than the default value of 100 (in this case, 50):
http://localhost/fmejobsubmitter/Samples/austinDownload.fmw&tm_priority=50
REST API Example
You can specify job directives in the body of these FME Server REST API V3 endpoints:
/transformations/submit/< repository >/< workspace >
/transformations/transact/< repository >/< workspace >
For example:
"TMDirectives": {
"rtc": false,
"description": "This is my description",
"tag": "linux",
"priority": 5
},
Alternatively, in the /transformations/transactdata/< repository >/< workspace > endpoint, specify job directives as individual URL arguments.
See Also
Tags maximum time for job, job timeout, job time limit, hanging job, stop job, priority, rtc, tag, ttc, ttl