OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-15
Building a Root Object
Building a Root Object
Building a root object is the main task of outbound processing. The client translates
proprietary information into XAPIA attributes. Using object management procedure
calls, the client creates objects and fills them with these attributes. The objects are
assembled to form a fully defined root object of the desired class: message, probe,
report, or P1-encoded object.
Any of the object management procedures can be used when building a root object.
During this process, you must follow four basic rules:
1. You must create a root object before creating any of its subobjects.
2. Within the first level of any object, no two attribute positions can be occupied by the
same attribute type.
3. A root object is not considered fully formed (transferrable) until all the subobjects
created for it have been inserted and filled with all required attributes.
4. No two objects contained within an object can have the same object identifier. If
you want to use a specific instance of an object as a subobject more than once within
Figure 5-2. GPI Program Flow: Outbound Processing
502CDT .CDD
GPI Procedure
Outbound Processing
Build root object
Transfer out root object
Close a session
Open a session
Program Flow
Note: GPI_STATUS_ may
be used anytime after
successful GPI_INITIALIZE_
GPI_OM_CREATE_
GPI_OM_INSERT_
GPI_OM_WRITE_
Composing:
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
Inspecting:
GPI_OM_READ_
GPI_OM_COPY_
Copying:
GPI_OM_DELETE_
GPI_OM_REMOVE_
Decomposing:
Initialize workspace
GPI_INITIALIZE_
GPI_OPEN_
GPI_MT_TRANSFER_OUT_
GPI_CLOSE_