UOA:OMQCHGAI
Application Interface API (OMQCHGAI) - Help
Application Interface API (OMQCHGAI)
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 application interface. You can use this command to add, change or delete the application interface definition.
Action code
Specify the action to be performed. The possible values are:
- *ADD
- Use this action code to add an application interface definition.
- *CHANGE
- Use this action code to change the attributes of an existing application interface definition.
- *DELETE
- Use this action code to delete the application interface definition.
Import application
Specify the import application. See the description of the import application for more information.
Import environment
Specify the import environment. See the description of the import environment for more information.
Interface sequence number
Specify the interface sequence number. See the description of the interface sequence number for more information.
- *NEXT
- Use this value to allocate the next 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.
Export application
Specify the export application. See the description of the export application for more information.
Export environment
Specify the export environment. See the description of the export environment for more information.
Export library
Specify the export library. See the description of the export library for more information.
Export route
Specify the export route. See the description of the export route for more information.
Conversion Type
The conversion type in the function Application Interface Maintenance is used to indicate if physical files can be imported with or without their data. The possible values are:
- 0=No copy data (*NOCOPYDATA)
- Use "0" (*NOCOPYDATA) if you do not allow copying of data from any data files from the export application into the import application.
- 1=Copy data allowed (*COPYDATA)
- Use "1" (*COPYDATA) if you allow copying of data from any data files from the export application to the import application.
- *SAME
- Use this value to indicate that the conversion type does not change if you are in change mode. In add mode, it contains the default value, the default value for the conversion type is '*NOCOPYDATA'.
New import environment
Specify the new import environment. The possible values are:
- *SAME.
- Use this value to indicate that the import environment does not change.
New interface sequence number
Specify the New interface sequence number. The possible values are:
- *SAME.
- Use this value to indicate that the sequence number does not change.
- *NEXT.
- Use this value to modify the sequence number to a new value. It will increase by 10 or round off to the nearest multiple of 10.
Crossing AI type
The Crossing Application Interface type defines the way of creation the secondary entities Crossing Fix and Crossing Solution. These entities contain controlling data for the continuation of various maintenance processes when parallel version workflows are configured by use of Application Interface Definitions. Examples of maintenance processes involved are Solution Maintenance and Fix/Object Transfer. The possible values are:
- A=automatic (*AUTOMATIC)
- The object version maintenance in the parallel defined version workflow (import application) is automatic started by creating Crossing Fix and Crossing Solution and is directly continued by duplicating Fix and Solution from the initial Application into the related Application.
- M=manual (*MANUAL)
- The object version maintenance in the parallel defined version workflow (import application) is started by creating Crossing Fix and Crossing Solution, but will only be continued after manual evaluation and confirmation of the entities that control the crossing procedure.
- blank=no crossing (*NOCROSSING)
- The Application Interface is not defined for the purpose of maintaining different versions of an Object by use of Crossing procedures for Fix and Solution between parallel workflows.
- *SAME
- Use this value to indicate that the crossing type does not change if you are in change mode. In add mode, it contains the default value, the default value for the crossing type is '*NOCROSSING'.
Disable item definition or 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 (*NO)
- 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 (*YES)
- 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 indicator does not change if you are in change mode. In add mode it contains the default value, the default value for the disable indicator is '*NO'.