The following table describes request_order_force XML parameters:
Parameter |
Description |
---|---|
user_token |
Defines the serial identification number supplied to the user during registration. String. |
control_m |
Defines the data center name. Mandatory for both jobs and Folders.String. |
(Control‑M for z/OS only) Defines the name of the library in which the folder is located. String |
|
Defines the name of the folder. Mandatory for both jobs and folders. String. |
|
folder_info |
Defines a sequence of folder_info. See the folder_info_type XML parameters |
force_it |
Indicates whether the job is ordered or forced. Mandatory for both jobs and Folders.
|
job_id |
Defines the occurrence number of the job within the folder. String. Optional Used to identify a specific job, in case there are multiple occurrences of the same job name in the folder. If the value of the job_id parameter is blank, 0, or 1, the first occurrence of the job is used. |
Defines the name of the job (mandatory). Must be left empty for folders. String. |
|
max_returned_nodes |
Enables you to limit the number of returned entities. Optional. NOTE: Should not exceed the value of the EMAPIActiveJobsLoadLimit system parameter. |
order_date |
Enables you to order the job with a specific date. Mandatory for both jobs and folders. Valid values:
|
unique_flow |
Determines if a flow in a folder is ordered uniquely. This is only if you are ordering a single folder created in version 8.0.00 and later. A unique suffix is added to every condition name. Not applicable to sub-folders. Valid values:
|
Defines a sequence of variable XML parameters:
|
|
wait_for_order_date |
Indicates whether the job submission should wait for a specified order date (order_date), or be submitted as soon as the execution criteria for the job is satisfied. Valid values:
|
with_hold |
Enables you to hold all jobs immediately after they are ordered. |
For an example of a request, see Order XML parameters examples.
Parent Topic |