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, as described in ctmdeffolder. A sub-folder can be empty or contain jobs and 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 $ (dollar sign) can be enclosed in ' ' (apostrophes or " " (quotation marks). A variable that does contain a $ must be enclosed in ' '. A variable containing a $ cannot be resolved if it is enclosed in " ".

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 * (asterisk) 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 is not specified.

Creating a Sub-folder

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 on the Agent by navigating to where Control-M/Agent is installed.

  2. Run the following command:

    ctmdefsubfolder -FOLDER <Sub-folder_Name>

    The following list of additional parameters appears, as described in ctmdefsubfolder Parameters:

    Copy 
    ctmdefsubfolder -FOLDER          <Name>
      [ -SUBAPPLICATION <Sub_application Name> ]
      [ -APPLICATION    <Aplication Name> ]
      [ -MAXWAIT        <Days> ]
      [ -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         <Drectory 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 ]]
    Copy 
          [ -DOREMOTEFORCEJOB <Folder_Name> <Job_Name> <ODATE>|ODAT <Control-M/Server_Name. [ <Library> ] [ -UNIQUE_FLOW Y|N ] ]
          [ -ORDERVARIABLE <Variable_Name> <Expression> ]
    Copy 
          [ -DOMAIL     <Destination> <cc> <urgency R|U|V> <Subject> <Message> ]
          [ -DOREMEDY   <Summary> <Description> <Urgency L|M|H|U|C> ]
    [ -RBC              <Rule-Based-Calendar_Name|NONE|"*">    ]
    Copy 
    [ -IS_REFERENCING   Y|N ]
    [ -REFERENCED_PATH  <Referenced Name> ]

You can also use the following -input_file parameter to run the utility:

ctmdefsubfolder -input_file <fullPathFileName>

ctmdefsubfolder Parameters

The following table lists the ctmdefsubfolder utility parameters.

Parameter

Description

-DEBUG

Defines the level of debug messages.

Valid Values: 0–5

Default: 0—no debug messages.

-QUIET

Determines that no informational messages appear when the command executes.

-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_REFERENCING

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 that the sub-folder references, as follows:

<Folder_Name>/<Job_Name>