CHILD

Lists dependent jobs with IN conditions that are created by the job whose order ID is specified in this command.

ctmpsm -CHILD <order_ID> [<tasktype>]

order_ID

Identifies the parent job.

tasktype

• B: Batch job
• D: Detached
• C: Command
• U: Dummy
• X: External job

IMPORT_CAL

Imports a calendar from the Control‑M/EM.

ctmpsm -IMPORT_CAL <ECS exported file name> [overwrite]

<ECS exported file Name> is the full path name of the calendars file to be imported from Control-M/EM.

NOTE: The file must be imported from Control‑M/EM in XML mode only.

If overwrite is specified, when the specified calendar to be imported from Control‑M/EM already exists in the Control-M/Server database, the import action will overwrite it. Default: overwrite is not specified.

NOTE: There is a line of output for every calendar handled by the import_cal option.

EXAMPLE: After a successful import of a calendar, the following message is displayed:

Calendar <x>, for year <y>, has been imported.

EXAMPLE: Assume calendar <x>, that is being imported, already exists in the Control-M/Server database, and that the overwrite option has not been specified. The following message is displayed:

Calendar <x>, for year <y>, that already exists, has not been imported.

LISTCAL

Lists available calendars. The list can be restricted by calendar name and year.

ctmpsm -LISTCAL [<calendar name>][<calendar year>]

<calendar name>

Restricts the list to calendars with the specified name or prefix (indicated by * at the end).

<calendar year>

Restricts the list to calendars for the specified year.

LISTALL

Lists jobs in the Active Jobs database. The list can be filtered by time, application, and member name. The list can be sorted by order ID or job name.

ctmpsm -LISTALL [<ODAT|TIME|APPLICATION|FILENAME|ALL|ALLFIELDS_ALLFIELDS_FULL]
[-SORT {ORDERID|JOBNAME>]

In addition to the order ID and the job name, one of the following fields must also be included in the LISTALL output:

• ODAT: Order date.
• TIME: Time execution started and ended.
• APPLICATION: Application to which the job belongs.
• FILENAME: File name for the job.
• ALL: – Includes ODAT, FROMTIME and UNTIL fields.
• ALLFIELDS: Includes ODAT, FILENAME, and APPLICATION fields.
• ALLFIELDS_FULL: Includes ODAT,FILENAME, APPLICATION fields and full size for the JOBNAME column.
• –SORT: Indicates the order in which the jobs should be listed. Valid values: ORDERID and JOBNAME.

Note for other job statuses:

The following additional job statuses are visible only when using the LISTALL option:

• WAIT_ODAT   The Job’s Odate is later than the Control-M/Server working date for the relevant timezone. The job is waiting for the relevant day (Odate) to begin.
• POST_ODAT  The job’s Odate is earlier than the Control-M/Server working date for the relevant timezone. The job will be deleted during the next run of the New Day procedure.

These job statuses are used in the Control‑M/Server Active Jobs database. However, in Control‑M/EM, jobs with these statuses will appear with Wait Condition status. In non-interactive mode, WAIT_Condition and WAIT_CONFIRM are both displayed as Wait Con.

LISTJOB

Lists jobs that are cyclic, as well as jobs in the Active Jobs database with a specified status. Jobs can be filtered by status: OK, NOTOK, executing, waiting for the end of a time interval, waiting for confirmation.

ctmpsm -LISTJOB
<OK|NOTOK|EXECUTING|CYCLIC| WAITTIME|WAITCONFIRM}
[-SORT {ORDERID|JOBNAME>]

• OK: Jobs with a completion Ended OK status.
• NOTOK: Jobs with a completion Ended NOTOK status.
• EXECUTING: Jobs that are currently executing.
• CYCLIC: Jobs that are cyclic.
• WAITTIME: Jobs waiting to begin executing based on the time specified in their Time From parameter.
• WAITCONFIRM: Jobs waiting for confirmation.
• –SORT: Indicates the order in which the jobs should be listed. Valid values: ORDERID and JOBNAME.

LISTSUB_APPLICATION

Lists jobs in the specified Sub Application that are associated with a Specified Application.

ctmpsm -LISTSUB_APPLICATION <application> <sub application>> [<scheduling date>]

Wildcard characters can be used as part of the specified application or sub-application names, as follows:

• * represents any number of characters.
• ? represents any single character.

LISTAJFFLD

Lists jobs in the Active Jobs database that were ordered from the specified SMART Folder.

ctmpsm -LISTAJFFLD <folder name>

Wildcard characters can be used as part of the specified application or sub-application names, as follows:

• * represents any number of characters.
• ? represents any single character.

FOLDER

Lists SMART Folders and jobs defined in the Control‑M/Server database, and allows you to add or delete SMART Folders.

ctmpsm -FOLDER

<LISTFOLDER <folder name>|-UPDATE <row number> <udaily name>|

-ADD <folder name> <udaily name>|-DUDAILY <row number>|

-REMOVE <folder name>|-LISTJOBS <row number> [FULL]

-LISTFOLDER

Lists all instances of SMART Folders that match the specified name or mask. For example, if a SMART Folder is ordered by two different user dailies, that folder will appear twice in the output of this option.

Wildcards can be used as part of the folder name for this option.

• * Represents any number of characters.
• ? Represents any single character.

-UPDATE

Updates the User Daily name for a specific SMART Folder.

-ADD

Adds a User Daily to an existing folder. The Folder name and Order method name must be specified when this option is used.

-UDAILY_NAME

Removes an instance of a SMART Folder from the Control‑M/Server database.

If the specified instance is the only instance of the folder (that is, that folder is ordered by only one order method), the SMART Folder and all its associated jobs are deleted.

If the specified instance is not the only instance of the folder, then only the specified instance is removed from the Control‑M/Server database.

-REMOVE

Deletes a specific SMART Folder and its associated jobs.

-LISTJOBS

Lists jobs in a SMART Folder.

LISTOUTPUT

List the OUTPUTs for an order ID. The list can be restricted by runcount number.

ctmpsm -LISTOUTPUT <orderID> [OUTPUTNUMBER {<number>|ALL}]

These parameters are described below.

To define a viewer to which the display of the OUTPUT of a job is redirected, specify the CTMPSM_VIEWER parameter in the ~<controlm_owner>/ctm_server/data/config.dat file. For more information about the CTMPSM_VIEWER parameter, see System configuration.

order_ID: Identifies the job whose OUTPUTs are listed.

number: Restricts the list to the OUTPUT whose runcount is specified. If ALL is specified, the output will contain only a list of all OUTPUTs related to the specified order ID.

LISTDETAILS

Lists the details of the job associated with the specified order ID.

LISTDETAILS <orderID>

LISTFULLDETAILS

Lists the parameters of a specified job in the Active Jobs database. In addition to the data provided by LISTDETAILS (above), LISTFULLDETAILS provides data about In conditions, Out conditions, and Variable values. (LISTFULLDETAILS was added for use with the "Zoom and Save" option in WebAccess.)

ctmpsm -LISTFULLDETAILS <orderID>

UPDATEAJF

Performs a specified command or updates conditions for a job in the Active Jobs database that is associated with a specified order ID.

ctmpsm -UPDATEAJF <orderID> <command>

command is one of the following:

• HOLD _ Set the status of a job to HELD.
• FREE _ Free a previously held job.
• DELETE _ Mark a job for deletion.

  NOTE: Jobs with Executing or Submitted status cannot be deleted.

• UNDELETE _ Undelete a job marked for deletion.
• RERUN _ Rerun a job.
• CONFIRM _ Confirm submission of a job.
• SET TO OK _ Set the status a job to be OK.

  NOTE: SET TO OK can only be applied to inactive jobs (that is, jobs that are not running).

• STATISTICS – Display a job’s statistics.
• CONDADDIN <cond> <date> <AND|OR> _ Add the specified IN condition with the specified date reference. You can include one or more additional IN conditions by using the AND or OR conjunctional parameter.
• CONDADDOUT <cond> <date> <+|-> _ Add the specified OUT condition with the specified date reference. Use + to indicate that the condition must be present. Use - to indicate that the condition must not be present.
• CONDDELIN <cond> _ Delete the specified IN condition.
• CONDDELOUT <cond> _ Delete the specified OUT condition.

  NOTE: Conditions specified using this mode apply only to the specified instance of the job in the Active Jobs database. Subsequent orders of that job are not affected.

UPDATESUBAPPLICATION

Applies a specified command to jobs in the specified Sub Application that are associated with the specified Application.

ctmpsm -UPDATESUB_APPLICATION <application> <sub application> <command>

<command> is one of the following:

• HOLD _ Set the status of a job to HELD.
• FREE _ Free previously held jobs.
• DELETE _ Mark the jobs for deletion.
• UNDELETE _ Undelete the jobs marked for deletion.
• CONFIRM _ Confirm submission of the jobs.

UPDATEFOLDER

Applies a specified command to jobs in the Active Jobs database that were ordered from the specified folder.

ctmpsm -UPDATEFOLDER <folder> <command>

<command> is one of the following:

• HOLD _ Set the status of a job to HELD.
• FREE _ Free previously held jobs.
• DELETE _ Mark the jobs for deletion.
• UNDELETE _ Undelete the jobs marked for deletion.
• RERUN _ Rerun the jobs.
• CONFIRM _ Confirm submission of the jobs.

XML

Lists jobs in the Active Jobs database in XML format. The job output formats can be changed according to the specified parameter, such as order date, time, application, or member name can be added to the output.

ctmpsm -XML [{ODAT|TIME|APPLICATION|MEMNAME|ALL|ALLFIELDS}]
[-SORT <ORDERID|JOBNAME>]

To list jobs in the Active Jobs database in XML format, specify ctmpsm -XML plus at least one of the following fields:

• ODAT: Order date.
• TIME: Time execution started and ended.
• APPLICATION: Application to which the job belongs.
• FILENAME: File name for the job.
• ALL: Includes ODAT and TIME fields.
• ALLFIELDS: Includes ODAT, FILENAME, and APPLICATION fields.

In addition, you can specify the following:

–SORT indicates the order in which the jobs should be listed.
Valid values: ORDERID and JOBNAME.

EXAMPLE: To change the output format in the Active Jobs database according to the file name of the job, specify the following:

ctmpsm -XML FILENAME

EXAMPLE: To sort the list in Example 1 above according to job name, specify the following:

ctmpsm -XML FILENAME -SORT JOBNAME