This procedure describes how to run the ctmdefine utility, which enables you to add a job processing definition to a Folder, a SMART Folder, and a Sub Folder in the Control‑M/Server database.
To add a job using the ctmdefine utility:
NOTE: You can also run this utility in Control-M Agent by navigating to where Control-M/Agent is installed.
ctmdefine
-FOLDER <name>
-JOBNAME <name>
-TASKTYPE <JOB|EXTERNAL|DETACHED|COMMAND|DUMMY>
-SUB_APPLICATION <sub_application name>
-APPLICATION <applic name>
[ -CMDLINE <string> ]
[ -EMBEDDED_SCRIPT <file name> ]
[ -MAXRERUN <value> ]
[ -CRITICAL Y|N ]
[ -END_FOLDER Y|N ]
[ -CYCLIC Y|N ]
[ -CYCLIC_TYPE INTERVAL|INTERVAL_SEQUENCE|SPECIFIC_TIMES ]
[ -INTERVAL <45d(days) | 1080h(hours) | 64800m (minutes)> ]
[ -SPECIFIC_TIMES <specific times string (HHMM,HHMM)> ]
[ -INTERVAL_SEQUENCE <interval sequence string e.g(+1H,+2M)> ]
[ -TOLERANCE <maximum delay allowed (minutes)> ]
[ -INTERVALFROM START | END | TARGET ]
[ -OVERRIDE_PATH <alternative directory> ]
[ -RELATIONSHIP AND|OR ]
[ -MAXWAIT <days> ]
[ -HOSTGRP <name> ]
[ -FILE_PATH <path> ]
[ -FILE_NAME <filename> ]
[ -MULTIAGENT Y|N ]
[ -ADJUST_COND Y|N ]
[ -RUN_AS <username> ]
[ -CREATED BY <username> ]
[ -DEBUG <debug level 0-5> ]
[ -QUIET ]
[ -TIMEZONE <xxx> ]
[ -TIMEFROM <earliest submission time> ]
[ -TIMEUNTIL <latest submission time> | '>' ]
[ -PRIORITY <job priority> ]
[ -CONFIRM Y|N ]
[ -TASKCLASS DISTRIBUTION_|DECOLLATION
[ -APPLTYPE <agent_application> ]
[ -APPLVER <application version> ]
[ -CMVER <CM version> ]
[ -APPLFORM <application form> ]
[ -DESCRIPTION <string> ]
[ -DOCMEM <filename> ]
[ -DOCLIB <directory name> ]
[ -INCOND <condition> <dateref>|ODAT AND|OR ]
[ -OUTCOND <condition> <dateref>|ODAT ADD|DEL ]
[ -VARIABLE <variable name as %%local, %%\global, %%\\smart or %%\\pool\variable> <expression> ]
[ -QUANTITATIVE <name> <quantity> ]
[ -OUTPUT RELEASE|DELETE|COPY|MOVE [<parameter>]]
[ -CONTROL <name> E|S ]
[ -SHOUT OK|NOTOK|RERUN|LATESUB|LATETIME|EXECTIME <destination> <urgency R|U|V> <message> [<time>] ]
[ -ON <statement> <code>
[ -DOOK ]
[ -DONOTOK ]
[ -DORERUN ]
[ -DOOUTPUT RELEASE|DELETE|COPY|MOVE [<parameter>] ] ]
[ -DOSTOPCYCLIC ]
[ -DOSHOUT <destination> <urgency R|U|V> <message> ]
[ -DOCOND <condname> <dateref>|ODAT ADD|DEL ]
[ -DOVARIABLE <variable name as %%local, %%\global, %%\\smart or %%\\pool\variable> <expression> ]
[ -DOFORCEJOB <foldername> <jobname> <odate>|ODAT ]
[ -DOREMOTEFORCEJOB <foldername> <jobname> <odate>|ODAT ]
[ -ORDERVARIABLE <variable name as %%local, %%\global, %%\\smart or %%\\pool\variable> <expression> ]
[ -DOMAIL <destination> <cc> <urgency R|U|V> <subject> <message> [<attach output>] ]
[ -DOREMEDY <summary> <description> <urgency L|M|H|U|C> ]
[ -CAPTURE INTO <variable name as %%local,%%global,%%\\smart or %%\\pool\variable>
SEARCH <Search string>
[ SKIPROWS <Number rows>]
[ SKIPWORDS <Number words> [DELIMITER <Character delimiter> TAKE <Number words|0 until end>]|SKIPCHARS <Number characters> [TAKE <Number chars|0 until end>]]]
[ -DAYS <daystr> ]
[ -WEEKDAYS <weekdaystr> ]
[ -MONTH ALL|JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC Y|N ]
[ -DATE <MMDD> ]
[ -DATEFROM <YYYYMMDD> ]
[ -DATEUNTIL <YYYYMMDD> ]
[ -DAYSCAL <calendar> ]
[ -WEEKCAL <calendar> ]
[ -CAL_ANDOR AND|OR ]
[ -SHIFT [</>/@][+/-]nn ]
[ -CONFCAL <calendar> ]
[ -RETRO Y|N ]
[ -RBC <rule_based_calendar> ]
If you define a new Rule-based calendar with the ! character at the beginning of the Rule-based calendar name, the Rule-based calendar is excluded. If this feature is disabled, an error message is displayed that you cannot define a Rule-based calendar with the ! character. For more information, see DefaultCTMExcludeRBC in Control-M/EM general parameters.
For the Control-M parameter name, see Parameter name cross references. For more details on the ctmdefine parameters, see ctmdefine parameters.
Parent Topic |