Site Standards

Site Standards is a tool that uses rules to control the job definition by enforcing restrictions on specific job parameters and is applicable to the folder, sub-folder, and jobs within the folder. Site Standards are applied at the folder level, as described in Folder General Attributes.

  • Enforce a rule that all folder names in your billing department use the billing prefix BIL.

  • Enforce a non-mandatory field, such as the Description field to be mandatory.

  • Enforce users to use a resource from the Resource Pool in the job definition.

A Site Standard Policy is a rule that you can apply to Site Standards in the following ways:

  • You can use a Site Standard Policy to apply the rules that are defined in a specific Site Standard to multiple folders in an environment. This eliminates the need to redefine Site Standards for multiple folders.

  • You can also use a Site Standard Policy to apply multiple, non-conflicting Site Standards to one folder. Instead of creating one large Site Standard with numerous rules, you can create multiple Site Standards, with fewer rules, and apply all or some of them to a single folder.

There are three Site Standards that enforce a rule that all folder names created by department managers must use a department-specific prefix:

  • The Billing Department must use the prefix BIL when new folders are created.

  • The Savings Department must use the prefix SAV when new folders are created.

  • The Loans Department must use the prefix LNS when new folders are created.

Another Site Standard is created to enforce a rule that all folders created by anyone in the organization must use the suffix BNK1. You can now create a Site Standard Policy to apply this Site Standard to any folder that uses one of the above three Site Standards. This eliminates the need to change any of the first three Site Standards to enforce the rule created by the fourth Site Standard.

For more information, see Creating a Site Standard Policy.

In Site Standards you can define the event format, as described in Defining the Event Format. The format is automatically created when events are applied to a job flow, as described in Events.

Site Standard rules define restrictions on specific job parameters, as described in Adding a Rule to a Site Standard. You can use business parametersClosedA Site Standard parameter that carries a specific meaning to your organization, which you add to a Site Standard Rule and then require the user to define in job definitions, and internal rules in your restriction definition, as follows:

  • Your Site Standard might have many rules that apply to your organization, some specific and some general. You can create one Site Standard for the general rules that apply to your organization and another Site Standard for each application that requires specific rules. This enables you to apply the general rules (globally) using a policy for the entire organization and each application assigns their specific Site Standards to the specific folders.

  • You can gradually introduce and enforce a new rule using two levels of Site Standards. You can set the severity of the validation messages issued by a Policy to warning for some applications and set the severity to error for other applications. This enables the application that has not been enforced to adjust the folder to apply to the standard.

Creating a Site Standard

This procedure describes how to create a Site Standard, which enables you to define rules and apply these to job parameters.

Begin

  1. From the Tools drop-down menu, select Site Standards.

    The Site Standards home page appears.

  2. From the Site Standards toolbar, click + Add Site Standard.

    The Create New Site Standard pane appears.

  3. Do the following:

      1. In the Name field, type a name for the Site Standard.

      2. In the Description field, provide a description of the Site Standard.

  4. Click Create.

    An empty Site Standard appears.

  5. From the Site Standards tool bar, select from one or more of the following to create restriction rules:

  6. From the Site Standard tool bar, click Save.

  7. The Site Standard is created and appears on the Site Standard list.

Adding a Rule to a Site Standard

This procedure describes how to add a Site Standard RuleClosedA rule in a Site Standard that determines how users must define jobs, which enables you to define restrictions and apply them to all job types or specific job types.

  • Set the default value of a job attribute, such as cyclic by selecting Any.

  • In an Administrative role, prevent users from selecting job attributes, such as Retroactive order by setting the restriction to Always not selected.

  • Define a rule to enforce the Keep Active parameter in a cyclic job to greater than 5.

Begin

  1. From a Site Standard, click + Rule.

    The Create New Rule pane appears.

  2. From the Rule Prerequisites tab, select a job type from the Job Type drop down list.

    If you create a rule for an attribute on a specific job type, such as a dummy or OS job, and you define a global rule on the same attribute, the global rule is ignored and the rule defined on the specific job type is applied.

  3. Click Add a Rule Condition If you want the rule to apply only when a condition is met, as follows:

    • Condition field: Determines the name of the job parameter.

    • Operator: Determines the operator type.

    • Condition value: Determines the value of the job parameter.

    • In a Site Standard rule, you can add one or more conditions to a rule prerequisite or a job attribute. However, all conditions that are defined need to be met for the Site Standard rule to apply. If you want the Site Standard to apply after any one of the conditions are met, you need to create a separate Site Standard rule for each condition.

    • You can define a default value for a conditional rule on a job attribute, which is applied automatically to the folder/job attribute in the Planning domain.

  4. From the Job Attributes tab, select a job parameter to apply this rule.

  5. Click Add an Attribute Condition If you want the rule to apply only when a condition is met, as follows:

    • Condition field: Determines the name of the job parameter.

    • Operator: Determines the operator type.

    • Condition value: Determines the value of the job parameter.

      • You can only add an attribute condition to a list attribute, such as a variable. You must apply a restriction type to a list attribute, as follows:

        • Regular: Define to include a restriction type on a job parameter, where the restriction defined in the rule format applies to all jobs in the folder.

        • Attributes must be defined: Define to include a restriction type on a job parameter, where the restriction defined in the rule format must apply at least once in a job.

      • If you define an attribute in a Site Standard that creates a dependency on another attribute, an alert appears when you save the Site Standard. This dependency might result in a different definition value when you create a job in the Planning domain.

  6. From the Rule Format tab, define the restrictions according to the selected field type.

  7. Select Include, Exclude, and Characters to define which restrictions to apply to a job attribute, as follows:

    • To define an include or exclude rule using values, from the drop-down list, select Values and do one of the following:

      • Type a value and description.

      • Click Upload to upload a CSV file containing values and descriptions. The CSV file must be in the following format:

        <VALUE>,<DESCRIPTION>

    • To define an include or exclude rule using patterns, from the drop-down list, select Patterns and Element Type, and select one or more of the following:

      • Internal Rule: Defines the use of an internal rule as a pattern part.

      • Fixed Text: Defines the format value using fixed text, such as BIL.

      • Business Parameter: Defines the use of additional business parameters as a pattern part.

      • Free Text: Defines the format value using free text.

    • To define character restrictions, click Characters and define the field values, as follows:

      • Length Range: Defines a minimum and/or maximum length of characters in a parameter.

      • Allowed Characters: Determines the character restriction types, as follows:

        • Alphanumeric: Defines the letters, numbers and specific characters.

        • Any: Defines excluded characters.

    • Default value: Set as default value

    • Required: To enforce the use of a value field, select Required and turn the toggle on.

  8. Click OK.

  9. From the Site Standard tool bar, click Save.

    The Site Standard rule is created.

Adding an Internal Rule to a Site Standard

This procedure describes how to add an internal rule to a Site Standard, and define which restrictions apply to this rule. Internal rules use values, patterns, and character limitations to define restrictions, which you can reuse in multiple internal rules. You can define whether to include or exclude a list of values or patterns, and define character restrictions.

Begin

  1. From the Site Standards tool, select a Site Standard.

  2. From the Site Standard tool bar, select Internal Rules.

    The Internal Rules pane appears.

  3. Click Rules .

  4. In the Name field, type a name for the internal rule.

  5. Select Include, Exclude, or Characters to define which restrictions apply to this rule, as follows:

    • To define an include or exclude rule using values, from the drop-down list, select Values and do one of the following:

      • Type a value and description.

      • Click Upload to upload a CSV file containing values and descriptions. The CSV file must be in the following format:

        <VALUE>,<DESCRIPTION>

    • To define an include or exclude rule using patterns, from the drop-down list, select Patterns and Element Type, and select one or more of the following:

      • Internal Rule: Defines the use of an internal rule as a pattern part.

      • Fixed Text: Defines the format value using fixed text, such as BIL.

      • Free Text: Defines the format value using free text.

    • To define character restrictions, click Characters and define the field values, as follows:

      • Length Range: Defines the minimum and/or maximum length of characters in a parameter.

      • Allowed Characters: Determines the character restriction types, as follows:

        • Alphanumeric: Defines the letters, numbers and specific characters.

        • Any: Defines excluded characters.

  6. Click OK and then Close.

  7. From the Site Standard tool bar, click Save.

    The internal rule is created.

Adding a Business Parameter to a Site Standard

This procedure describes how to add a business parameter to a Site Standard, and define which restrictions to apply. Values defined in a business parameter at the folder level are applicable to all jobs within the folder and cannot be changed.

Begin

  1. From the Site Standards tool, select a Site Standard.

  2. From the Site Standard tool bar, select Business Parameters.

    The Business Parameters pane appears.

  3. Click business parameters .

  4. In the Name field, type a name for the business parameter.

  5. To enforce the mandatory use of the value fields, turn the toggle on to Make this a required field.

  6. Select Include, Exclude, or Characters to define which restrictions apply, as follows:

    • To define an include or exclude rule using values, from the drop-down list, select Values and do one of the following:

      • Type a value and description.

      • Click Upload to upload a CSV file containing values and descriptions. The CSV file must be in the following format:

        <VALUE>,<DESCRIPTION>

    • To define an include or exclude rule using patterns, from the drop-down list, select Patterns and Element Type, and select one or more of the following:

      • Internal Rule: Defines the use of an internal rule as a pattern part .

      • Business Parameter: Defines the use of additional business parameters as a pattern part.

      • Fixed Text: Defines the format value using fixed text, such as BIL.

      • Free Text: Defines the format value using free text.

    • To define character restrictions, click Characters and define the field values, as follows:

      • Length Range: Defines the minimum and/or maximum length of characters in a parameter.

      • Allowed Characters: Determines the character restriction types, as follows:

        • Alphanumeric: Defines the letters, numbers and specific characters.

        • Any: Defines excluded characters.

  7. Click OK and then Close.

  8. From the Site Standard tool bar, click Save.

    The Business Parameter rule is created.

Event Format

The EventClosedAn entity that creates a sequence relationship between jobs by enabling the successor job to execute after the predecessor job has executed format is automatically created when events are applied to a job flow, as described in Events. You can manually edit the event format in a Site Standard. The event format, by default is set as [Source Job Attribute: Job Name]-TO-[Target Job Attribute: Job Name].

You can define the format in the following field types:

  • Source Job Attribute: Defines the name of the source job attribute, which adds the event, such as the name of a job or folder.

  • Fixed Text: Defines the fixed text value that connects the source and target job attributes.

  • Target Job Attribute: Defines the name of the target job attribute, which waits for the event, such as the name of a job or folder.

Defining the Event Format

This procedure describes how to define the event format of a Site Standard.

Begin

  1. From the Site Standards tool, select a Site Standard.

  2. From the Site Standard, click Event Format.

    The Edit Event Format pane appears on the right.

  3. In the Event Format table, do one or more of the following:

    • To add a fixed text field, click Event format.

    • To change the source or target job attribute value, do the following:

      • From the Type drop-down list, select an attribute.

      • From the Value drop-down list, select an attribute value.

    • To change the fixed text value, click the Value field, and enter a value.

  4. Click OK .

  5. From the Site Standard tool bar, click Save.

    The event format is updated.

Creating a Site Standard Policy

This procedure describes how to create a Site Standard Policy and apply the policy to a specific folder or group of folders.

You can use a Site Standard Policy to apply the rules that are defined in a specific Site Standard to multiple folders in an environment. This eliminates the need to redefine Site Standards for multiple folders. You can also use a Site Standard Policy to apply multiple, non-conflicting Site Standards to one folders. Instead of creating one large Site Standard with numerous rules, you can create multiple Site Standards, with fewer rules, and apply all or some of them to a single folder.

Begin

  1. From the Tools drop-down menu, select Site Standards.

    The Site Standards home page appears.

  2. From the Site Standards toolbar, click Policies.

    The Policies pane appears.

  3. Select Add Policy.

    The Add a Site Standard Policy tab appears.

  4. Define the Policy Details and Policy Filters, as described in Policy Details and Filter Attributes.

  5. Click Add.

    The Site Standard Policy appears.

Policy Details and Filter Attributes

The following table describes the policy and filter attributes of a Site Standard Policy:

Attributes

Descriptions

Policy Details

Policy name

Defines a unique Site Standard Policy name.

Description

Defines a description of the Site Standard Policy.

Rules: 1- 512 characters

Site Standard

Determines the name of the Site Standard that is applied to the relevant folders.

If the Site Standard selected has business parameters, you can define values for these parameters.

Validation Message Severity

Determines the message severity for all the messages issued by the Site Standard associated with the policy, as follows:

  • Default: Severity is defined according to the configuration set by the Administrator.

  • Error: Issues that must be fixed

  • Warning: Issues that may be ignored

Policy status

Determines the status of the Site Standard Policy, as follows:

  • Active

  • Not Active

Policy Filters

Servers

Filters the folders by Control-M/Server name to apply the policy.

You can use * as a wildcard in the filter fields.

Folders

Filters the folders by name or pattern to apply the policy.

You can use * as a wildcard in the filter fields.

Restoring Site Standards after Downgrade

This procedure describes how to restore Site Standards that you created before you upgraded to a new version of Control-M.

Begin

  1. Do one of the following:

    • Windows: Run the following command from a command prompt: util.exe –U <dbo user> -P <dbo password> -import -replace -type wcm -file "<installation location>\install\def_items_table_backup.dat"

    • UNIX: Run the following command: em util –U <dbo user> -P <dbo password> -import -replace -type wcm -file <installation_account_home_directory>/ctm_em/install/def_items_table_backup.dat"

  2. Site Standards that you create in an upgraded version of Control-M no longer exist after you downgrade.

    If you applied a Site Standard that no longer exists to a folder, do the following:

    1. Check-out the folder that contains the Site Standard.

    2. From the General tab of the folder in the right pane, replace the Site Standard with one of the restored Site Standards.

    3. Check-in the folder