Connection Rule Detail API (OMQCHGCD) - Help

Connection Rule Detail API (OMQCHGCD)

This Application Program Interface command allows you to manipulate the TD/OMS database. This can be done from a command line or from within your programs.

The command enables you to add detail definitions to a connection rule, remove detail definitions from a connection rule, copy a connection rule detail definition from a connection rule, copy a connection rule detail definition, or change connection rule detail definitions.

Action code

Specify the action to be performed. The possible values are:

*ADD: Use this action code to add the connection rule detail.

*CHANGE: Use this action code to change the connection rule detail.

*COPY: Use this action code to copy the connection rule detail.

*DELETE: Use this action code to remove the connection rule detail.

Application code or *ALL

Specify the application code. See the description of the application code for more information.

*ALL: Instead of selecting an Application you can use the special value *ALL when you wish to define connection rules that will be applied in all Applications.

Connection Rule Code

The connection rule code is used as a unique identifier for the connection rule.

Related object regex

This field contains the regular expression that is used in the evaluation of the primary object. If the object code matches the regular expression, the evaluation of the primary object continues. For more information about regular expressions, please refer to the Regular Expressions Concepts. The concepts also contain some examples of regular expressions that might be used in the context of OMS.

*SAME: Use this value to indicate that the primary object regex does not change. In *ADD mode, this value is not allowed.

Object type

The object type specifies the type of object. Program objects are of the type *PGM, file objects are of the type *FILE, etc. Refer to the IBM OS/400 reference guide for more information.

*SAME: Use this value to indicate that the object type does not change. In *ADD mode, it copies the value from the object type of the primary object: if the primary object was a *PGM, then the related object must also be a *PGM.

*ALL: The object type is not specified. Any object type will match.

Object attribute

The object attribute contains the extended attribute for an object. This can be used to further identify the object along with the object code, the object type, and the library of the object. For example, object attribute RPG indicates a *PGM object created from an RPG source. The object attribute does not have to be entered for existing objects. OMS can find any attribute of any object. However, if you create your objects, or the object is a temporary object then the object attribute must be entered manually.

*SAME: Use this value to indicate that the object attribute does not change. In *ADD mode, it copies the value from the object attribute of the primary object: if the primary object is a PF, then the related object matches if it has also the attribute PF.

*ALL: The object attribute is not specified. Any object attribute will match. For object types that do not have associated object attributes, you have to enter the value *ALL.

Related new object regex

Specify the related new object regex.

*SAME: Use this value to indicate that the primary object regex does not change.

Target related object regex

Specify the target related object regex.

*SAME: Use this value to indicate that the primary object regex does not change.

New object type

Specify the new object type.

*SAME: Use this value to indicate that the object type does not change.

*ALL: The object type is not specified. Any object type will match.

Target object type

Specify the target object type.

*SAME: Use this value to indicate that the object type does not change.

*ALL: The object type is not specified. Any object type will match.

New object attribute

Specify the new object attribute.

*SAME: Use this value to indicate that the object attribute does not change.

*ALL: The object attribute is not specified. Any object attribute will match. For object types that do not have associated object attributes, you have to enter the value *ALL.

Target object attribute

Specify the target object attribute.

*SAME: Use this value to indicate that the object attribute does not change.

*ALL: The object attribute is not specified. Any object attribute will match. For object types that do not have associated object attributes, you have to enter the value *ALL.

Object contains mask

Specifies if the regular expression contains one of the special characters. These special characters are the percent sign and the ampersand sign.

If percent signs are used, each percent sign in the first part of the expression will be mapped to the corresponding percent sign in the second part of the expression. The first part and the second part should both be entered in the field 'Related object regex'. The parts should be separated by the character '|' (the pipe symbol).

 First part: PGM%%%%                                         
 Second part: DS%%%D                                         
 Results in: If the current primary object is PGM001R, then the related object should have the object code DS001D. 
                                                           
 First part: %%R%%%X                                         
 Second part: %%DS%%%X    
 Results in: If the current primary object is OMR002X, then the related object should have the object code OMDS002X.

If the ampersand sign is used, the ampersand sign will be replaced by the object code of the current primary object.

 Related object regex: &DOC                                      
                                                               
 Results in: If the current primary object is PGM001, then the related object should have the object code PGM001DOC.  
                                                               
 Related object regex: FUNC&DOC                                  
                                                               
 Results in: If the current primary object is PGM001, then the related object should have the object code FUNCPGM001DOC.

Relation scope

Specifies the scope of the connection processing. The possible values are:

*SAME: Use this value to indicate that the relation scope does not change.

*ALL: The related component does not have any relation with the primary component. The component can be any existing component in the object database. Use this value to connect objects for which TD/OMS can not implicitly determine a relationship and store that in its database, such as functional design documents that describe programs.

*RELATED: The component to find must be related to the primary object and it refers to a used-by or a using relation.

   PROGRAM1 CALLS PROGRAM2 CALLS PROGRAM3          
   PROGRAM1 >     PROGRAM2 >     PROGRAM3          
   USING          component      USED-BY

*USING: The component to find must be related to the primary object and it refers to a using relation.

   PROGRAM1 CALLS PROGRAM2 CALLS PROGRAM3          
   PROGRAM1 >     PROGRAM2 >     PROGRAM3          
   USING          component      USED-BY

*USEDBY: The component to find must be related to the primary object and it refers to a used-by relation.

   PROGRAM1 CALLS PROGRAM2 CALLS PROGRAM3    
   PROGRAM1 >     PROGRAM2 >     PROGRAM3    
   USING          component      USED-BY

Environment scope

Specifies the scope of the connection processing. The possible values are:

*SAME: Use this value to indicate that the environment scope does not change.

*ALL: All connection rules are evaluated again. If your current rule definition is within a specific application, all rules of that application will be loaded and evaluated. If your current definition is a *ALL rule, rule selection will be all rules in the currently active application and the *ALL rules that do not occur in the application set. Please be very careful when you plan to use this value. Changes in the connection rule can dramatically change the behavior of the connection function.

*CURRENT: Only components in the environment where the primary object currently resides will be connected.

Continue with rule

Specifies the connection rule to continue with. The possible values are:

*SAME: Use this value to indicate that the connection rule to continue does not change.

*NONE: No further processing will be done.

*connection-rule-code: Enter a valid connection rule code. If your current rule definition is within a specific application, you can only add a connection rule to that application. If you change an *ALL rule definition, you can add any *ALL or application-specific rule. Only this rule will be evaluated.

Connection Rule code: The Connection Rule code contains a unique code for a set of connection rules. The related objects defined in the connection rule details also will be retrieved, when the object defined in the connection rule header is moved to the connection list.

Solution type

The solution type controls the way OMS handles a solution object and the possible values are:

'1' or *CHANGE: This solution type indicates that this is a solution for which changes are to be made. This is generally referred to as a normal maintenance action; Either bugs are solved or functionality is added or removed. The version number is incremented if this solution completes the cycle.

'3' or *COMPILE: This solution type indicates that this is a solution for which no changes are made. This solution type can be used to recompile solutions in the target library.

'9' or *TERMINATE: Solutions with type *TERMINATE are objects that have reached the end of their lives. They are either superseded by new objects or the functionality of the object is no longer needed. All occurrences of the object are removed from the application, environment by environment if this object is transferred through the maintenance cycle.

*SAME: Use this value to indicate that the solution type does not change.

Disable connection rule

This field can be used to (temporarily) disable an item definition or rule for example a Connection rule or an AI definition If the item or rule will never be used again, then it can be deleted altogether. The possible values are:

0=Enabled: The item selection is enabled, i.e. the item will be evaluated, and the item will be executed when all selection criteria have been fulfilled.

1=Disabled: The item is disabled, i.e. the item will not be evaluated, and the item will never be executed.

*SAME: Use this value to indicate that the disable connection rule does not change.

Note: Keep in mind that if the action code is *CHANGE, *COPY, or *DELETE and you pass incorrect related object regex or object type or object attribute you will get the error message "Detail record does not exist" 5 times. The message is the same for all 5 fields however each message belongs to a particular field.

UOA:OMQCHGCD

Contents

Connection Rule Detail API (OMQCHGCD) - Help