UOA:OMQCHGCR

From Remain Software
Jump to navigation Jump to search

Connection Rule API (OMQCHGCR) - Help

Connection Rule (OMQCHGCR)

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 an entry to the database, remove an entry from the database, copy a set of connection rules or change the connection rule definition. Also, you can add or copy a connection rule to another application or define a connection rule under the special key value *ALL which means the connection rule will be selected and applied in all applications.

Action code

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

*ADD
Use this action code to add the connection rule.
*CHANGE
Use this action code to change the connection rule.
*COPY
Use this action code to copy the connection rule.
*DELETE
Use this action code to remove the connection rule.

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.

To Application Code

Specify the target application code. You can use this field only with action code *COPY. You can copy the connection rule to the same or different application.

*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.

To Connection Rule Code

Specify the target connection rule code. You can use this field only with action code *COPY. You can copy the definition of an existing connection rule to a new connection rule.

Connection rule description

The connection rule description can be used to indicate the function of the connection rule. A blank value is not allowed.

*SAME
Use this value to indicate that the description does not change. In *ADD mode, this value is not allowed.

Primary 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, this value is not allowed.

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 own 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, this value is not allowed.

Connection rule type

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

*SAME
Use this value to indicate that the connection rule type does not change. If you are in add mode it contains the default value. The default value for the connection rule type is '*ENABLED'.
*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.
*DISABLED
The item is disabled, i.e. the item will not be evaluated, and the item will never be executed.
*CONTINUATION
It means it will only be executed when it is defined as a "continue with rule" in detail of another Connection rule.