Site Standards

Site Standards is a tool that uses rules to control the job definition by enforcing restrictions on specific job parameters. Site StandardsClosedA set of rules that are relevant to your organization and applied on the folder level, and that determines how users must define folders and jobs are applied at folder level, as described in Folder General Attributes, and are applicable to the folder, sub-folder, and jobs within the folder.

  • 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.

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:

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.

  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 condition 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.

  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.

  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.