Default language.

Space announcement This documentation space provides the same content as before, but the organization of the content has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.
Space announcement To view the latest version of the product documentation, select the version from the Product version menu above the navigation pane.

AR – Approval Rules

The following figure shows the approval rules that are used to determine a list of approver names in set processing. This places a restriction on the execution of the set until the approvers have authorized it. See Set-Processing for details.

Approval Rules

M.R               REFERENCE DATA MAINTENANCE (PROD)                UPDATE MODE
Command  ===>                                                 Scroll ===> CSR  
                                                                              
List Commands: A Add, L Locate Entry, B Browse Mode                            
Line Commands: S Select, D Delete, C Clone, I Import, E Export                 
               V View, M Modify, A Activate                                    
                                                                              
  Code N/A      N/A      N/A      Vers Version Description  Actv Loaded RefrReq
   AR  ________ ________ ________ ____ ____________________   _     _      _   
__ AR                             0000 INSTALL VERSION        Y     Y          
******************************* Bottom of data ********************************

Approval Rules Definition Screen

The following figure is a list of Approval Rules. It is the first screen displayed after entering option AR and selecting a version.

Approval Rules Definition Screen

M.AR                   APPROVAL RULES TABLE (4)                    UPDATE MODE
Command ===>                                                  Scroll ===> 0006
                                                                     More -->
List Commands: A Add Entry, L Locate Entry, B Browse Mode                     
Line Commands: S Select, D Delete                                             
                                                                             
    Appl Group Appl     SubAppl  Stream   Lvl  Type     Chg Appr Group Crit Reqd
    __________ ________ ________ ________ ____ ________ ___ __________ ____ ____
_              TST1     TST1     BASIC    HOLD DDL      S   DBA             N   
_              TST1     TST1     BASIC    HOLD *        S   QA              Y   
_              TST1     TST1     BASIC    HOLD *        S   AUDIT           N   
------------------------------- Bottom of List ---------------------------------

Detail Screen

The following figure shows the details displayed when a specific Approval Rule is selected from the Approval Rule List screen.

Detail Screen

M.AR               MODIFY APPROVAL RULE DETAIL (PROD)                          
Command ===>                                                                   
                                                                              
Enter required details:                                                        
                                                                              
Appl Group   (KEY) ==>                                                        
Appl         (KEY) ==> TST1                                                   
SubAppl      (KEY) ==> TST1                                                   
Stream       (KEY) ==> BASIC                                                  
Level        (KEY) ==> HOLD                                                   
Type         (KEY) ==> *                                                      
Change Type  (KEY) ==> S                                                      
Approver     (KEY) ==> QA                                                     
Criteria     (KEY) ==>             (Site defined values)                      
                                                                              
Approval Required  ==> Y                                                      
Quorum             ==> 1                                                      
Usage              ==>     I Impacts only  S SQL only  A All                  
                          leave blank for standard approval rule              
                                                                              
Press ENTER to complete the change or END to terminate                         
Note: You can add a new entry by overtyping the Keys with new unique values    


Field Descriptions

The following table describes each field for an Approval Rule definition:

Field Descriptions

Field Name

Description

Appl Group

The Application Group covered by this approval rule.

Appl

The Application covered by this approval rule.

Valid values:

  • * – An asterisk indicates all applications.
  • An existing ApplicationID.

SubAppl

The subapplication covered by this approval rule.
Valid values:

  • * - An asterisk indicates all subapplications
  • An existing subapplication

Stream

The Stream covered by the rule.

Valid values:

  • * – An asterisk indicates all Streams.
  • An existing Stream code.

Level

The level to be protected. For a promote operation, the target level is used.

Valid values:

  • * – An asterisk indicates all levels.
  • An existing level.

Type

The component type to be protected.

Valid values:

  • * – An asterisk indicates all component types.
  • An existing component type.

Change Type

The change type of the set.

Valid values:

  • * – An asterisk indicates all change types.
  • S – Standard.
  • E – Emergency.
  • I – Incidental.
  • User-defined change type – as defined in M.CH.

Approver

The approver name. See Set-Processing for details of the approval process.

Valid values:

  • A value that is defined in M.AN (Approver Names). This name maps to a resource in the external security product.

Criteria

This field is available for customized site-specific values.

Approval Required

Indicates whether approval is required before the set can be executed. If approvals are required, the approver has a restrictive role over the change. If approvals are not required, the approver has more of an auditing role over the change.

Valid values:

  • Y – Approvals are required before the set can be executed.
  • N – Approvals are not required before the set can be executed.

Quorum

Indicates that multiple UserIDs must grant approval for this approver name.

Valid values:

  • A number from 1-9.

Usage

The Usage flag can have the following valid values:

  • blank – Regular Rule.
  • I – Impact Approvals Only. This rule is to enable approvals of Sets that have components in them affecting this Application. Approvals will not be required if the component is from the same Application Owning Group, nor when a version of the component already exists in the level being promoted to. This is based upon both Static and Dynamic relationships found in the Component Reference.
  • S – SQL Rule. This rule is to enable approvals of Sets that have components with the SQL Flag set to “Y”.
  • A – All Rules. This rule is for all of the above.

How Approval Rules Work

When a Set is Locked, Code Pipeline uses the entries defined here to determine what approvals are required for the Set. Code Pipeline looks at each Task in the Set, and if there is a matching Approval Rule, the Approval is added to the Set.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*