UOA:OMQCHGRS

From Remain Software
Jump to navigation Jump to search

Change Rules (OMQCHGRS)

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.

This command enables you to perform all allowed actions on the rules. You can use this command to add, update, and delete rules.

Action code

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

*ADD
Use this action code to add new rules.
*CHANGE
Use this action code to change existing rules.
*DELETE
Use this action code to delete rules.

Selection target

Specify the target to work with different types of rules. The possible values are:

*COMPILE
Use this value to work with compile rules.
*LOCATION
Use this value to work with location rules.
*ACTION
Use this value to work with action rules.
*GRPDETAIL
Use this value to work with group detail rules.
*GROUP
Use this value to work with group rules.

Type code

Specify the type code. See the description of the type code for information.

Action or Action group number

Specify the action or action group number. This field should be interpreted as an action key number or as an action group key number. The way it should be interpreted is determined by the selection target, a field that always accompanies the action key number.

Action group detail sequence

Specify the action group detail sequence. See the description of the action group detail sequence for information.

Processing step code

The processing step code is a two-character abbreviation of a processing step. Processing steps are defined at certain stages of the object transfer process. Currently, the possible values are:

SP=Start of processing
This step is executed right at the beginning of an object transfer. The step can also be executed at the start of the distribution, when the distribution library has already been created. To achieve this, the field When to activate should have the value 1=Pre-distribution.
SL=Start of library list
This step is executed when the processing of a library list is started, i.e., when objects are about to be created for that library list.
SO=Start of object
This step is executed when the processing of an individual object is started.
CO=Creation of object
This step is executed when an object is about to be created in the target environment. When one or more actions are executed for an object in this processing step, then the standard OMS creation processing will be skipped. It is very important to realize this!
EO=End of object
This step is executed when the processing of an individual object has just finished, i.e., the object has been created and all standard OMS processing (for instance data conversion, attribute conversion, and authority conversion) has been executed.
EL=End of library list
This step is executed when the processing of a library list has just finished, i.e., when all objects for that library list have been created. Note that at this point the fall-back library has not yet been deleted.
SD=Start of distribution
This step is executed when the distribution of objects is being prepared. Note that at this point, the distribution library has not yet been created. If you want to access the temporary distribution library, use processing step SP on pre-distribution.
ED=End of distribution
This step is executed when the distribution of objects has completely finished, i.e., when all objects have already been sent to the remote systems and the distribution library has already been deleted.
EP=End of processing
This step is executed when the object transfer is about to be ended. The step can also be executed at the end of the distribution, when the objects to be distributed have been collected in the distribution library. To achieve this, the field When to activate should have the value 1=Pre-distribution.
*N=Special Action Selection
This step is not executed during object transfer but is used to associate some special commands to a selection. This is used, for instance, in the Type Maintenance function where selections can be made for compiles and impact analyzer functions.

Processing steps only have relevance in the context of object transfers. If you are statically applying an action selection, then the processing step specified in the action selection has no meaning.

Action selection key number

Specify the action selection key number. See the description of the action selection key number for information.

Rules

Specify the field name, selection, value, values, and address.

Element 1
Field name
Use this element to pass the values for the action.
*WHERE
Use this field to pass the values for action where to activate. See the description of the action where to activate for information.
*WHEN
Use this field to pass the values for action when to activate. See the description of the action when to activate for information.
*SUPRESS
Use this field to pass the values for suppress subsequent. See the description of suppress subsequent for information.
*OBJECT
Use this field to pass the names of the object code for which rules must be selected. See the description of the object code for information.
*OBJTYPE
Use this field to pass the name of the object types for which rules must be selected. See the description of the object type for information.
*OBJATTR
Use this field to pass the name of the object attribute for which rules must be selected. See the description of the object attribute for information.
*OBJLIB
Use this field to pass the name of the object library for which rules must be selected. See the description of the object library for information.
*OBJDETAIL
Use this field to pass the name of the object detail for which rules must be selected. See the description of the object detail for information.
*MBRATTR
Use this field to pass the name of the member attribute for which rules must be selected. See the description of the member attribute for information.
*OBJCLASS
Use this field to pass the object class for which rules must be selected. See the description of the object class for information.
*LABEL
Use this field to pass the label name for which rules must be selected. See the description of the label for information.
*OBJVRS
Use this field to pass the object version for which rules must be selected. See the description of the object version for information.
*APPC
Use this field to pass the name of the application code for which rules must be selected. See the description of the application code for information.
*ENV
Use this field to pass the name of the environment code for which rules must be selected. See the description of the environment code for information.
*TASK
Use this field to pass the name of the fix code for which rules must be selected. See the description of the fix number for information.
*SOLUTIONTYPE
Use this field to pass the solution type for which rules must be selected. See the description of the solution type for information.
*DIRECTION
Use this field to indicate the direction of processing for which rules must be selected. See the description of the direction for information.
*DISABLEIND
Use this field to temporarily disable an action group detail. See the description of the disable indicator for information.
Element 2
Selection
This is used in conjunction with the field.
*IS
The value '*IS' indicates that the condition is true if the run-time value is equal to the value of the field.
*ISNOT
The value '*ISNOT' indicates that the condition is true if the run-time value is not equal to the value of the field.
Element 3
Value
This is used to pass the values for a particular field.
*ALL
It will include everything for that field.
*LOCAL
The rules will only be evaluated when objects are created locally.
*PRE
The rule will only be evaluated when objects are collected for distribution in the temporary distribution library. The rule is not evaluated when objects are created locally.
*NEVER
The rule is disabled.
*ALWAYS
Use this value if the direction of processing is not important. The rule will be fulfilled regardless of the processing direction.
*HORIZON
Use this value if the rule applies only when objects are transferred horizontally within the same environment.
*UP
Use this value if the action selection should be applied only when objects are transferred from a lower to a higher environment, i.e., in the direction of ascending environment sequence numbers.
*DOWN
Use this value if the action selection should be applied only when objects are transferred from a higher to a lower environment, i.e., in the direction of descending environment sequence numbers.
*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.
*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.
*TERM
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.
*YES
Suppress subsequent with *YES indicates that subsequent executions of the action should be suppressed or ignored after the first execution.
*NO
Suppress subsequent with *NO indicates that subsequent executions of the action should not be suppressed or ignored after the first execution.
*ENABLE
The action group detail selection is enabled, i.e., the action group detail selection will be evaluated, and the action group detail will be executed.
*DISABLE
The action group detail selection is disabled, i.e., the action group detail selection will not be evaluated, and the action group detail will not be executed.
*LIST
A *LIST detail value is the multiple sublevel specification of a simple selection item. Within the main function, the field representing that selection item allows the input of the special value *LIST.
ELEMENT 3
One of the list values
It is used to pass the list values for the list. A maximum of 50 values are allowed to pass.
ELEMENT 4
Address
Use this to pass the address for a particular rule.
*CALC
Use this value to indicate the default for the address which is blank.
*ALL
Use this to create an *ALL record. If such a record is created, then the rule will be activated on all addresses.