UOA:OMQCHGAC

From Remain Software
Jump to navigation Jump to search
Translate this page

Change Actions API (OMQCHGAC)

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 perform all allowed actions on actions, action groups, and action group details.

Action Code

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

*ADD
Use this action code to add the actions.
*CHANGE
Use this action code to change the actions.
*DELETE
Use this action code to delete the actions.

Type

Specify the type to work with different types of actions. The possible values are:

*ACTIONS
Use this value to work with actions.
*GROUPS
Use this value to work with action groups.
*GRPDETAILS
Use this value to work with action group details.

Action Key Number

Specify the action key number.

Action Key Type

Specify the action key type.

*ACTIONS
Use this value to work with actions.
*GROUPS
Use this value to work with action groups.
*GRPDETAILS
Use this value to work with action group details.
*SAME
Use this value to indicate that the action key type does not change if you are in change mode.

Action Group Key Number

Specify the action group key number.

Description

This serves a dual purpose based on the value specified in type. If GROUP or GRPDETAIL is specified in TYPE, it acts as a group description. Conversely, if ACTION is specified, it functions as an action description.

See the description of the action description for more information. See the description of the action group description for more information.

*SAME
Use this value to indicate that the description does not change if you are in change mode.

New Description

The new description is used to provide an updated description when the action code is *CHANGE.

*SAME
Use this value to indicate that the description does not change if you are in change mode.

Action Group Detail Number

Specify the action group detail number.

*NEXT
Use this value to allocate the action group detail number. It will increment by 10 or round off to the nearest multiple of 10 if you are in add mode. However, if you are in change or delete mode, this value is not allowed.

New Action Group Detail Number

Specify the new action group detail number when updating the action group detail.

*SAME
Use this value to indicate that the action group detail number does not change if you are in change mode.

Action or Action Group Number

Specify the action or action group number. The usage of this field depends on the action key type. If "ACTION" is specified for the action key type, this field is used to specify the action key number. If "GROUP" is specified for the action key type, this field is used to specify the action group key number.

*SAME
Use this value to indicate that the action or action group number does not change if you are in change mode.

Action Command

The Action command can be used to enter a command string that can be executed by TD/OMS. The attributes of the command string can be substituted. The substitution variables used are the same as used in action definitions.

*SAME
Use this value to indicate that the action command does not change if you are in change mode.

Action Cluster

Specify the action cluster.

See the description of the action cluster for more information.

*SAME
Use this value to indicate that the action cluster does not change if you are in change mode.

Single Action Detail

The single action detail field controls the behavior of an action group. The possible values are:

0=No
This value indicates that all action group details within the action group should be executed.
1=Yes
This value indicates that the execution of the action group should be terminated as soon as an action group detail has been executed. The value '1' might be compared to the LEAVE statement in RPG.
*SAME
Use this value to indicate that the single action detail does not change if you are in change mode. If you are in add mode it contains the default value, the default value for the single action detail is '*NO'.

Behavior on Error

This field indicates in what circumstances a create command detail should be executed. The possible values are:

0=Always (*ALWAYS)
This value indicates that the create command detail should always be executed, whether or not there have been errors during the execution of previous create command details.
1=Not if error (*NOTERROR)
This value indicates that the create command detail will not be executed if there have been errors during the execution of previous create command details.
2=If error (*ERROR)
This value indicates that the create command detail will only be executed if there have been errors during the execution of previous create command details.
*SAME
Use this value to indicate that the behavior on error does not change if you are in change mode. If you are in add mode it contains the default value, the default value for the behavior on error is '*ALWAYS'.

Critical Action Group Detail

This field is used to indicate if error processing will be started if an error occurs during the execution of the action group detail. The possible values are:

0=No
This value indicates that an error in this action group detail will not start error processing. That is to say, subsequent action group details will not know about the error. This value is used if the result of the action group detail has no influence on the subsequent action group details.
1=Yes
This value indicates that an error in this action group detail will start error processing. That is to say, if an error occurs during the execution of the action group detail, then subsequent action group details will only be executed if their value for the field Behavior on error is 0=Always or 2=If error. The subset is saved.

This field is used in close conjunction with the field Behavior on error.

*SAME
Use this value to indicate that the critical action group detail does not change if you are in change mode. If you are in add mode it contains the default value, the default value for the critical action group detail is '*NO'.

Propagate Error

This field is used to indicate whether or not an error in this action group detail will be propagated to a higher level. The possible values are:

0=No
This value indicates that an error in this action group detail will not be propagated to a higher level.
1=Yes
This value indicates that an error in this action group detail will be propagated to a higher level.

Example: If an action group is executed as part of another action group, then an error in the lower level action group may or may not be propagated to the higher level. If the error is not propagated, then the action group on the higher level will not be informed about the fact that an error has occurred on the lower level.

*SAME
Use this value to indicate that the propagate error does not change if you are in change mode. If you are in add mode it contains the default value, the default value for the propagate error is '*YES'.