UOA:OMQCHGTD

From Remain Software
(Redirected from UOA:OMQCHGTD)
Jump to navigation Jump to search

Type Code Detail API (OMQCHGTD) - Help

Type Code Detail API (OMQCHGTD)

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 the create command detail. You can use this command to add, change, or delete the create command detail.

Action code

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

*ADD
Use this action code to add a new create command detail definitions.
*CHANGE
Use this action code to change the contents or certain attributes of the create command detail definitions.
*DELETE
Use this action code to delete the create command detail definitions.

Type code

Specify the type code. See the description of the type code for more information. The possible values are:

Command type

These command-type groups create the object commands. The possible values are:

'1' or *PRE
This command type must be used for the pre-commands.
'2' or *COMPILE
This command type must be used for the create command.
'3' or *POST
This command type must be used for the Post commands.
*ALL
Use this value to delete all command types only if you are in delete mode and if you are in add or change mode, this value is not allowed.
Note:                   
When the compile type is *COMPILE, the entered sequence value is ignored and automatically set to *ONLY (1), because only one compilation command is allowed.
When the command type is *ALL for a delete operation, the entered sequence value is ignored and automatically set to *ALL.

Command sequence number

Specify the command sequence number.

*NEXT
Use this value to allocate the next command sequence 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.
*ONLY
You can use this value with the command type *COMPILE.
*ALL
Use this value to delete all command sequence numbers if you are in delete mode and if you are in add or change mode, this value is not allowed.

Command new sequence number

Specify the command new sequence number. The possible values are:

*SAME
Use this value to indicate that the command sequence number does not change.
*NEXT
Use this value to modify the command sequence number to a new value. It will increase by 10 or round off to the nearest multiple of 10.

Behaviour 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 '*NOTERROR';

The result of the last command executed will determine the end result of the compilation, normal or abnormal, regardless if any of the previous commands failed.

If any of the pre, compile, or post commands fails, then this will be remembered for the rest of the commands. The error flag will remain '*ERROR' during the remainder of the execution.

Command String

The Command String 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 those used in action definitions.

*SAME
Use this value to indicate that the command string does not change if you are in change mode. It is not allowed in add mode.