request_order_force XML parameters

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.

folder_library

(Control‑M for z/OS only) Defines the name of the library in which the folder is located. String

folder_name

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.

  • no: Orders job/folder
  • yes: Forces job/folder

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.

job_name

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:

  • Numerical date ( yyyymmdd format)
  • ODAT

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.

See Conditions management.

Valid values:

  • Yes
  • No

variable_assignments

Defines a sequence of variable XML parameters:

  • Name: Name of the variable (mandatory if the variable_assignment element is specified. String. Name sequence.
  • Value: Value of the variable expression. String.

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:

  • yes: Wait for order_date
  • no Do not wait for order_date (default)

    NOTE: Relevant for Control‑M versions 6.2.01 or later.

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

Order