Creating a Sub-folder

This procedure describes how to create a sub-folder in a Workspace A working area in the Planning domain where you define and edit new jobs and SMART folders.. Sub-folders and jobs inherit the parameters that you define at the SMART folder level. You can also create a sub-folder with the ctmdefsubfolder utility.

Begin

1. From the Center Pane Toolbar, click Add Job and from the drop-down list, drag and drop a Folder into the Workspace.

   The Create New Folder pane appears.

2. From the Folder Type drop-down list, select SMART folder and click Create.
   A SMART folder appears in the Workspace.

3. From the Add Job drop-down list, drag and drop another folder into the SMART folder you just created.
   A sub-folder appears inside the SMART folder you just created.

4. From the General tab in the right pane, define one or more of the following properties:

   • General: Defines the sub-folder general parameters, as described in Sub-folder General Parameters.

   • Scheduling: Defines the sub-folder scheduling parameters, as described in Sub-folder Scheduling Attributes.

   • Prerequisites: Defines the prerequisites The part of the job definition that controls the flow of your jobs, such as an event that controls flow sequence or a resource that controls load balancing. that must be met before the sub-folder executes, as described in Prerequisites.

   • Actions: Defines the actions that Control-M performs after the sub-folder executes, as described in Actions.

Sub-folder General Parameters

The following table describes the sub-folder general parameters in the General tab in the right pane.

Parameter	Description
Folder Type	Defines the folder type as a sub-folder.
Folder Name	Defines the name of the folder. Rules: Characters: 1–64 Case Sensitive: Yes Invalid Characters: Blank spaces, ', $, /, *, ?, and ". Job names must be unique in each sub-folder. You cannot define a job name with the name as the sub-folder. To use ( or ) (parentheses), precede each parenthesis with a /, for example: /( or /). To rename a sub-folder, note the following: You must load all jobs in the sub-folder to the Workspace. You cannot rename a partially-loaded folder. You must manually update all dependent prerequisites and actions with the new sub-folder name. For instance, the sub-folder might be run by an If-Action of another folder or by a job in a different folder. Alternatively, the sub-folder name might be part of an event name. To revert to the original sub-folder name, you must unload the folder from the Workspace. Any other changes you make to the sub-folder or jobs inside the sub-folder are also reverted.
Description	Defines a free-text description of the sub-folder. Rules: Characters: 1–4,000 Case Sensitive: Yes
Reference	Defines the sub-folder as a reference sub-folder, as described in Reference Sub-folder. You cannot reference a sub-folder that contains jobs.
Reference Path	Defines the full pathname for the SMART folder or job that is referenced, as follows: <Folder_Name>/<Job_Name> If you reference SMART folder Folder_A, the full pathname is Folder_A. If you reference job Job_B, which resides in Folder_A, the full pathname is Folder_A/Job_B. Rules: Number of Nested Reference Sub-folders: 1–9 Characters: 1–1,024 The reference path cannot include wildcards. If a Site Standard is applied to a SMART folder that contains a reference sub-folder, the Site Standard is validated on the sub-folder but not on the referenced entities.
Server	Defines the name of the Server that processes the sub-folder.
Run As	Defines the username with the authorization to execute jobs in the sub-folder. Rules: Characters: 1–30 Case Sensitive: Yes Invalid Characters: Blank spaces and ' (apostrophes).
Parent Folder	Defines the name of the folder where the sub-folder is nested.
Application	Defines a descriptive name for related job groups. The jobs in these groups do not have to run at the same time. Rules: Case Sensitive: Yes Invalid Characters: Blank spaces and '.
Sub-application	Defines a logical name for the Sub-application. Rules: Characters: 1–64 Case Sensitive: Yes Invalid Characters: Blank spaces and '. Application: Finance Sub-application: Payroll
Variables	Determines variable types, names, and values, as described in Variables. Rules: Characters: 1–40 Value: 1–4,000 Invalid Characters: Latin-1 special characters, uppercase and lowercase. Control-M recognizes fields that you define with %% as variables A memory location with a name and value that you can reference in your job processing definitions, which Control-M resolves for the current job execution..
Created By	Defines the Control-M user who created the sub-folder. Rules: Characters: 1–64 Case Sensitive: Yes Invalid Characters: Blank spaces and ' (apostrophes).
Documentation	Defines the location of the folder documentation.
Type	Determines whether the documentation for the sub-folder is in a file or URL, as follows: URL: Saves the documentation in the URL that you define in the URL field. The format of the URL address must start with one of the following prefixes: http:// https:// ftp:// file:// File: Saves the documentation to a file that you define in the Doc Path and Doc File fields. Doc Path Rules: Characters: 1–255 Case Sensitive: Yes Doc File Rules: Characters: 1–64 Case Sensitive: Yes Invalid Characters: Blank spaces.
Priority	Determines the order that Control-M processes jobs. A higher priority forces Control-M to reserve resources from the Resource Pool A type of quantifiable resource, which represents the total amount of resources from a physical or logical device that a job can access. to ensure that the job is submitted as soon as possible.

Reference Sub-folder

A reference sub-folder is an empty sub-folder that points to another SMART folder or job and enables you to run one or more of these entities when you run the reference sub-folder. This eliminates the need to replicate and manage defined SMART folders and jobs.

Entities that are defined in referenced SMART folders or jobs are added to reference sub-folders as follows:

• Variables

  • Variables that do not exist in the reference sub-folder are added.

  • Variables in the reference sub-folder are resolved instead of identically named variables in the referenced SMART folder.

• If-Actions

  • Referenced SMART folder If-Actions execute before reference sub-folder If-Actions.

  • If-Actions that are defined in a referenced job are not added to the reference sub-folder, and remain in the job.

• Lock Resources

  • Lock Resources that do not exist in the reference sub-folder are added.

  • Lock Resources in the reference sub-folder are used instead of identically named Lock Resources in the referenced SMART folder.

  • Lock Resources that are defined in a referenced job are not added to the reference sub-folder.

• Notifications

  • Notifications that are defined in a referenced SMART folder are added to the reference sub-folder.

  • Notifications that are defined in a referenced job are not added to the reference sub-folder.

• The defined values of the documentation fields (Type, Doc Path, Doc File), and Priority, Description, Application, and Sub-application in a referenced SMART folder or job are added into the reference sub-folder during the run process. If no values are defined in the reference sub-folder, Control-M uses the values defined in the referenced SMART folder and job.

During the run process the schedule and event definitions of the referenced SMART folder or jobs are ignored and the reference sub-folder definitions are used.

Creating a Reference Sub-folder

This procedure describes how to create a reference a sub-folder, which enables you to replicate and run (reference) a SMART folder or job from a different folder, without the need to manually replicate and manage it.

Begin

1. Create a new sub-folder where you want to run a SMART folder or job that is defined in a different folder in your Workspace, as described in Creating a Sub-folder.

2. In the job definitions of the new sub-folder, select the Reference checkbox.

   The Reference Path field appears.

3. In the Reference Path field, type the full pathname of the SMART folder or job to reference, as follows:

   <SMART_Folder_Name>/<Job_Name>

   The following appears inside the reference sub-folder:

   Referenced <Folder or Job>:

   <SMART_Folder_Name or Job_Name>

   The My Boutique store contains a clothing and shoes department. Two reference sub-folders, Clothing_Department and Shoes_Department, are created to bill customers with the Invoice job defined in the Billing SMART Folder, as appears in the following image:

   

   The following appears in the Viewpoint when the jobs execute:

   

4. (Optional) To display defined referenced job attributes in the reference sub-folder in the Viewpoint in the Monitoring domain, do the following:

   1. Add one or more referenced job attribute variables to the reference sub-folder, as described in Adding Variables and Referenced Job Attribute Variables.

   2. In one or more job attribute fields in the definitions pane of the referenced job or jobs, type REF__ (REF and two _) where you want the job attribute to appear, as follows:
      

      • REF__ <Referenced Attribute>: The referenced job attribute variable value appears before the job attribute in the reference sub-folder in the Monitoring domain.

      • <Referenced Attribute> REF__: The referenced job attribute variable value appears after the job attribute in the reference sub-folder in the Monitoring domain.

      • REF__: Only the referenced job attribute variable value appears in the reference sub-folder in the Monitoring domain.

   3. If the referenced job attribute is the job name, you must revise the Reference Path in the reference sub-folders to match the new job name, for example—Billing/REF__ Invoice.

   Job-name referenced job attribute variables (%%REF_NAME) are added to the Clothing_Department and Shoes_Department reference sub-folders, and assigned the respective values Clothing and Shoes. The referenced job name is changed from Invoice to REF__ Invoice, as appears in the following image:

   

   The following appears in the Viewpoint when the jobs execute:

   

Referenced Job Attribute Variables

Referenced Job Attribute	Variable Name	Variable Value Description
Job Name	REF_NAME	Defines the names of the referenced jobs that contain REF__ in their Job Name fields, as described in Job General Attributes.
Description	REF_DESCRIPTION	Defines the descriptions of the referenced jobs that contain REF__ in their Description fields, as described in Job General Attributes .
Run As	REF_RUN_AS	Defines the Run as User in the referenced jobs that contain REF__ in their Run As fields.
Application	REF_APPLICATION	Defines the Application name in the referenced jobs that contain REF__ in their Application fields, as described in Job General Attributes.
Sub-application	REF_SUB_APPL	Defines the Sub-application name in the referenced jobs that contain REF__ in their Sub-application fields, as described in Job General Attributes.
Host/Host Group	REF_HOST_GROUP	Defines the name of the Hosts or Host Groups in the referenced jobs that contain REF__ in their Sub-application fields, as described in Job General Attributes. You cannot use this variable if a Site Standard rule forces Control-M to validate the Host/Host Group attribute according to topology.