ctmdefsubfolder

The ctmdefsubfolder utility creates a definition for a new Sub Folder. Sub Folders are used for jobs whose processing can be treated as a single unit. A Sub Folder can only be defined within a SMART folder, see ctmdeffolder. A Sub Folder can be empty, or it can contain jobs and also other Sub Folders.

For more information about parameters of Sub Folders, see Sub-folder General Parameters.

When using variables in ctmdefsubfolder parameters, a variable that does not contain a $ sign can be enclosed in single (‘ ’) or double (" ") quotation marks. A variable that does contain a $ sign must be enclosed in single quotation marks. A variable containing a $ sign cannot be resolved if it is enclosed in double quotation marks.

The RBC option associates Rule-Based Calendars to be used by the Sub Folder and it may appear more than once. Specified Rule-Based Calendars must be defined by the direct parent folder. The '*' means that the Sub Folder inherits all the Rule-Based Calendars from the direct parent folder. When a Sub Folder is defined without a Rule-based calendar, the Sub Folder inherits the Rule-based calendars of the direct parent. To define a Sub Folder without any Rule-based calendar associations, use the NONE option. If a Rule-based calendar is defined 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.

The Created by field will be set automatically with the default logged in account name if it's not specified.

Creating a Sub Folder Using the ctmdefsubfolder Utility

This procedure describes how to run the ctmdefsubfolder utility, which enables you to create a definition for a new Sub Folder.

Begin

1. Do one of the following:

   • UNIX: Log in to a Control-M/Server account.

   • Windows: Open a command prompt window where Control-M/Server is installed.

     You can also run this utility in Control-M Agent by navigating to where Control-M/Agent is installed.

2. Type the following command:

   ctmdefsubapplication

   -FOLDER <name>

   -SUBAPPLICATION <sub_application name>

   -APPLICATION <applic name>

   [ -ADJUST_COND Y|N|B ]

   [ -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 ]

   [ -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> ]

   [ -SHOUT OK|NOTOK|LATESUB|LATETIME|EXECTIME

   <destination> <urgency R|U|V> <message> [<time>| <#mmm>] ]

   [ -ON <OK|NOTOK|FAILCOUNT <equal operator EQ|=> <number>|

   <varname> <operator EQ|NE|GT|GE|LT|LE|IR|NR|LK|NL|IX|NX|SW|EW|CO|NC|MP|NP> <value> ]

   [ -DOOK ]

   [ -DONOTOK ]

   [ -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 [ -UNIQUE_FLOW Y|N ]]

   [ -DOMAIL <destination> <cc> <urgency R|U|V> <subject> <message> ]

   [ -DOREMEDY <summary> <description> <urgency L|M|H|U|C> ]

   [ -RBC <rule_based_calendar_name|NONE|"*"> ]

For the Control-M parameter name, see Parameter name cross references.

ctmdefsubfolder Parameters

The following table lists the ctmdefsubfolder utility parameters:

Parameter	Description
-DEBUG	Defines the level of debug messages. Valid values: 0 to 5 Default: 0—no debug messages
-QUIET	Indicates that no information messages are displayed during execution of the command.
-input_file	Name and full path of a file containing parameters for the utility. In this file, each parameter and its values, if any, are on a separate line with the same syntax they would have on the command line. Enables you to: prepare and save files of utility parameters that can be reused. specify utility input longer than the number of characters allowed in the command line. -input_file ~<controlmOwner>/ctm_server/data/ctmdefsubtab_parms.txt
IS_REFERENCE	Indicates if the sub-folder is a reference folder. Valid Values: Y: Yes N: No Default: N
REFERENCED_PATH	Defines the full referenced path name (folder/jobname) that the sub folder references.