OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual Abstract This manual describes the Gateway Programmatic Interface (GPI) to the Compaq OSI/MHS subsystem. The manual is provided as a reference tool for TAL and C programmers using the GPI library procedures. Product Version OSI/MHS GPI D42 Supported Releases This manual supports G06 and D41 releases and all subsequent releases until otherwise indicated in a new edition.
Document History Part Number Product Version Published 099931 OSI/MHS GPI D20 September 1993 104440 OSI/MHS GPI D21 May 1994 132297 OSI/MHS GPI D41 February 1997 424823-001 OSI/MHS GPI D42 December 1999 427564-001 OSI/MHS GPI D42 March 2001 522223-001 OSI/MHS GPI D42 November 2001 Ordering Information For manual ordering information: domestic U.S. customers, call 1-800-243-6886; international customers, contact your local sales representative.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual Glossary Index Figures Tables What’s New in This Manual xxv Manual Information xxv New and Changed Information xxv About This Manual xxvii Who Should Read This Manual? What’s in This Manual? xxvii xxvii What Related Publications Are Available? xxviii Your Comments Invited xxxii Notation Conventions xxxii Abbreviations xxxv 1. Introduction to the GPI GPI Overview 1-1 X.
2. Information Architecture and Data Structures (continued) Contents 2. Information Architecture and Data Structures (continued) Types 2-3 Syntax and Values 2-4 Data Structures 2-5 Attribute Descriptor Structure Bit-String Structure Descriptor Lists 2-6 2-6 2-7 String Buffers 2-9 String Segments 2-10 3.
3. Object Classes and Attribute Types (continued) Contents 3.
3. Object Classes and Attribute Types (continued) Contents 3.
4. Procedure Calls Contents 4.
A. DDL Definitions (continued) Contents A.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
B. Return Codes (continued) Contents B.
Figures (continued) Contents Figures (continued) Figure 2-1. Example of Attribute Descriptor 2-3 Figure 2-2. Attribute Descriptor Structure 2-6 Figure 2-3. Bit-String Structure 2-7 Figure 2-4. Descriptor List of GPI_OM_EXAMINE_ 2-8 Figure 2-5. Descriptor List for Multivalued Attribute Figure 2-6. Example of String Buffer 2-10 Figure 2-7. Example of Retrieving String Segments 2-11 Figure 4-1. Sample GPI Procedure Call Description 4-4 Figure 4-2.
Tables (continued) Contents Tables (continued) Table 3-6. MH-C-BILATERAL-INFORMATION Attributes—General Characteristics 3-9 Table 3-7. MH-C-BILATERAL-INFORMATION Attributes—Additional Characteristics 3-9 Table 3-8. MH-C-DELIVERY-ENVELOPE Attributes—General Characteristics (page 1 of 2) 3-11 Table 3-9. MH-C-DELIVERY-ENVELOPE Attributes—Additional Characteristics (page 1 of 2) 3-12 Table 3-10. MH-C-EITS Attributes—General Characteristics Table 3-11.
Tables (continued) Contents Tables (continued) Table 3-28. MH-C-MESSAGE-RD Attributes—Additional Characteristics (page 1 of 2) 3-45 Table 3-29. MH-C-MTS-IDENTIFIER Attributes—General Characteristics 3-48 Table 3-30. MH-C-MTS-IDENTIFIER Attributes—Additional Characteristics 3-49 Table 3-31. MH-C-OR-NAME Attributes—General Characteristics (page 1 of 2) 3-50 Table 3-32. MH-C-OR-NAME Attributes—Additional Characteristics (page 1 of 3) 3-51 Table 3-33.
Tables (continued) Contents Tables (continued) Table 3-50. IM-C-ACP127-NOTIFICATION Attributes—General Characteristics 3-90 Table 3-51. IM-C-ACP127-NOTIFICATION-RSP Attributes—General Characteristics 3-92 Table 3-52. IM-C-ACP127-NOTIFICATION-RSP Attributes—Additional Characteristics 3-92 Table 3-53. IM-C-ADATP3-BODY-PART Attributes—General Characteristics 3-94 Table 3-54. IM-C-ADDRESS-LIST-DESIGNATOR Attributes—General Characteristics 3-95 Table 3-55.
Tables (continued) Contents Tables (continued) Table 3-68. IM-C-IPM-IDENTIFIER Attributes—General Characteristics Table 3-69. IM-C-IPM-IDENTIFIER Attributes—Additional Characteristics Table 3-70. IM-C-ISO-6937-TEXT-BODY-PART Attributes—General Characteristics 3-116 Table 3-71. IM-C-ISO-6937-TEXT-BODY-PART Attributes—Additional Characteristics 3-116 Table 3-72. IM-C-MESSAGE-BODY-PART Attributes—General Characteristics 3-117 Table 3-73.
Tables (continued) Contents Tables (continued) Table 3-88. IM-C-RECIPIENT-SPECIFIER Attributes—General Characteristics 3-131 Table 3-89. IM-C-RECIPIENT-SPECIFIER Attributes—Additional Characteristics 3-131 Table 3-90. IM-C-TELETEX-BODY-PART Attributes—General Characteristics 3-133 Table 3-91. IM-C-TELETEX-BODY-PART Attributes—Additional Characteristics 3-133 Table 3-92. IM-C-UNIDENTIFIED-BODY-PART Attributes—General Characteristics 3-135 Table 3-93.
Tables (continued) Contents Tables (continued) Table 3-108. EDI-C-EDI-NOTIF-REQUESTS Attributes—Additional Characteristics 3-150 Table 3-109. EDI-C-EDIM Attributes—General Characteristics 3-152 Table 3-110. EDI-C-EDIM Attributes—Additional Characteristics 3-152 Table 3-111. EDI-C-EDIM-BODYPART Attributes—General Characteristics 3-153 Table 3-112. EDI-C-EDIM-BODYPART Attributes—Additional Characteristics 3-153 Table 3-113. EDI-C-EDIM-EX-DF-BODYPART Attributes—General Characteristics 3-155 Table 3-114.
Tables (continued) Contents Tables (continued) Table 3-128. EDI-C-INTER-SENDER-RECIP Attributes—Additional Characteristics 3-164 Table 3-129. EDI-C-NEGATIVE-NOTIF Attributes—General Characteristics 3-165 Table 3-130. EDI-C-NEGATIVE-NOTIF Attributes—Additional Characteristics 3-165 Table 3-131. EDI-C-NN-PDAU-REASON-CODE Attributes—General Characteristics 3-167 Table 3-132. EDI-C-NN-PDAU-REASON-CODE Attributes—Additional Characteristics 3-167 Table 3-133.
Tables (continued) Contents Tables (continued) Table 4-1. GPI Environment Management Procedures 4-2 Table 4-2. GPI Object Management Procedures Table 4-3. GPI Message Transfer Procedures 4-3 Table 4-4. Writing String Segments 4-44 Table B-1. Return Code Values for Object Management (page 1 of 2) Table B-2. Return Code Values for Message Handling B-8 Table B-3. Request Types Table B-4. Error Class Values (page 1 of 2) Table B-5.
Contents OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 xxiv
What’s New in This Manual Manual Information OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual Abstract This manual describes the Gateway Programmatic Interface (GPI) to the Compaq OSI/MHS subsystem. The manual is provided as a reference tool for TAL and C programmers using the GPI library procedures. Product Version OSI/MHS GPI D42 Supported Releases This manual supports G06 and D41 releases and all subsequent releases until otherwise indicated in a new edition.
What’s New in This Manual • • ° ° ° ° ° ° ° ° ° ° ° New and Changed Information IM-C-ACP127-NOTIFICATION-RSP on page 3-92 IM-C-ADATP3-BODY-PART on page 3-94 IM-C-ADDRESS-LIST-DESIGNATOR on page 3-95 IM-C-CORRECTIONS-BODY-PART on page 3-98 IM-C-DISTRIBUTION-CODES on page 3-99 IM-C-FORWARDED-ENC-BODY-PART on page 3-103 IM-C-MESSAGE-TYPE on page 3-118 IM-C-MM-MESSAGE-BODY-PART on page 3-120 IM-C-OTHER-RECIP-DESIGNATOR on page 3-126 IIM-C-PILOT-INFORMATION on page 3-127 MH-C-SECURITY-LABEL on page 3-85 Se
About This Manual This manual describes the Compaq OSI/MHS Gateway Programmatic Interface (GPI), which is the Compaq implementation of the X.400 Gateway Application Program Interface (X.400 API). The GPI provides a programmatic interface to the Compaq Open Systems Interconnection/Message Handling System (OSI/MHS) at the message transfer agent (MTA) boundary.
About This Manual • What Related Publications Are Available? Appendix E, Event Messages, lists the event messages generated by the GPI. What Related Publications Are Available? The most closely related manual, the OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide, provides important background information about X.400 gateways and Compaq OSI/MHS. It presents a detailed overview of how the GPI operates and how to write client application programs using the GPI procedures.
Programming Manuals About This Manual • • Transaction Application Language (TAL) Reference Manual C/C++ Programmer’s Guide Figure i shows the related Compaq publications. Figure i. Related Publications X.400 Gateway API Specification EDI API Specification OSI Object Management API Specification X.400 API Specification TAL Reference Manual C/C++ Programmer's Guide For information For information on on the Compaq API standards CCITT Recommendation X.435 CCITT Blue Book, Recommendations X.400X.
About This Manual Other OSI/MHS Manuals Other OSI/MHS Manuals The following manuals provide information about Compaq OSI/MHS: • • • • • • • • OSI/MHS Orientation Guide describes common tasks involved in building message handling systems with Compaq products. It also helps you to find related information in other Compaq manuals and educational offerings.
Other OSI/MHS Manuals About This Manual shows the manual set for OSI/MHS and the type of information contained in each manual. Figure ii.
About This Manual Your Comments Invited Your Comments Invited After using this manual, please take a moment to send us your comments. You can do this by returning a Reader Comment Card or by sending an Internet mail message. A Reader Comment Card is located at the back of printed manuals and as a separate file on the User Documentation disc. You can either fax or mail the card to us. The fax number and mailing address are provided on the card.
About This Manual General Syntax Notation { } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list may be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF } | Vertical Line.
Notation for Messages About This Manual !i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data to the called procedure); the !o notation follows an output parameter (one that returns data to the calling program). For example: CALL CHECKRESIZESEGMENT ( segment-id , error ) ; !i !o !i,o. In procedure calls, the !i,o notation follows an input/output parameter (one that both passes data to the called procedure and returns data to the calling program).
Notation for Management Programming Interfaces About This Manual { } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list might be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LBU { X | Y } POWER FAIL process-name State changed from old-objstate to objstate { Operator Request.
About This Manual API. Application program interface APIA. Application Program Interface Association ASN.1. Abstract Syntax Notation One AU. Access unit BER. Basic encoding rules CCITT. International Telegraph and Telephone Consultative Committee DDL. Data Definition Language (Compaq term) DSM. Distributed Systems Management (Compaq term) EDI. electronic data interchange EDIM. EDI message EDIMG. EDI messaging EDIMS. EDI messaging system EDIN. EDI notification EDI-MS. EDI message store EDI-UA.
About This Manual Abbreviations IPN. Interpersonal notification ISO. International Organization for Standards MD. Management domain MH. Message handling MHS. Message handling system MOTIS. Message-Oriented Text Interchange System MPDU. Message protocol data unit MR. Message relay MRP. Message relay process MS. Message store MTA. Message transfer agent MTS. Message transfer system NBPS. Nonbasic parameters OM. Object management O/R. Originator/recipient OSI. Open Systems Interconnection OSI/MHS.
About This Manual Hypertext Links SC. Store cleaner SCF. Subsystem Control Facility (Compaq term) SCP. Subsystem Control Point (Compaq term) SPI. Subsystem Programmatic Interface (Compaq term) TAL. Transaction Application Language (Compaq term) TMF. Transaction Management Facility (Compaq term) UA. User agent UTC. Universal Coordinated Time XAPIA. X.400 Application Program Interface Association Hypertext Links Blue underline is used to indicate a hypertext link within text.
1 Introduction to the GPI This section provides an overview of the Gateway Programmatic Interface (GPI) and defines some general concepts and terms used in this manual. The GPI is an implementation of the X.400 Gateway Application Program Interface as specified by the X.400 Application Program Interface Association (XAPIA) and the X/Open Company Limited. This interface enables a client application program to access the X.
Introduction to the GPI X.400 Messages X.400 Messages The three types of X.400 messages that the GPI service translates and transfers in from and out to an MTA are messages, probes, and reports: • • • A message conveys information from an originator to one or more recipients. A user who sends a communication is an originator. A user who receives a communication is a recipient. A message consists of an envelope and content.
Introduction to the GPI Gateway Interface Programs Gateway Interface Programs A typical client program processes inbound and outbound information. The GPI procedures enable you to perform the following functions: • • • • • Initialize the GPI environment in which your client application program is to operate. Open and close sessions between your program and the GPI service. Create messages, probes, and reports and transfer them out to an OSI/MHS MTA by way of the GPI service’s output queue.
Introduction to the GPI Object Management The GPI assigns a session identifier that you specify when creating or transferring a communication. The GPI uses the session identifier to associate the communication with the session performing the operation. The GPI_OPEN_ procedure returns information about the local environment, including the name of the management domain (MD) of the local MTA and the country of the MD. For a detailed description, see MH-C-ENVIRONMENT on page 3-19.
Introduction to the GPI Message Transfer Message Transfer The GPI message transfer procedures allow you to transfer X.400 communications in from and out to the X.400 network. You process inbound communications by using three procedures: • • • To determine whether a communication is awaiting transfer from the input queue, you use the GPI_MT_WAIT_ procedure. If a communication is available, you call the GPI_MT_START_TRANSFER_IN_ procedure to reserve it.
Introduction to the GPI Military Messaging Support Military Messaging Support The Gateway Programmatic Interface supports Military Messaging through use of the P772 protocol. Users can access both ACP 127 and civilian military message handling networks. The following classes of object directly support military messaging: 1. IM-C-ACP127-DATA-BODY-PART on page 3-89 2. IM-C-ACP127-NOTIFICATION on page 3-90 3. IM-C-ACP127-NOTIFICATION-RSP on page 3-92 4. IM-C-ADATP3-BODY-PART on page 3-94 5.
Introduction to the GPI Conformance of the GPI to X.400 API Specifications Conformance of the GPI to X.400 API Specifications The CCITT has ratified two series of standards for X.400 message handling, one in 1984 and the other in 1988. Two versions of the X.400 API have been specified, one for use with the X.400 (1984) standard and one for use with both the X.400 (1984) and X.400 (1988) standards. • • The first version, the X.400 Gateway API, was specified by the X.400 APIA for use with the X.
Introduction to the GPI Conformance of the GPI to X.
2 Information Architecture and Data Structures The GPI information architecture defines the structure of X.400 communications that a client application creates, interprets, and transfers to or from the GPI service. The basic components of this architecture are attributes and objects. Attributes and Objects An attribute is a fundamental item of information. An object consists of a set of attributes.
Information Architecture and Data Structures Class Hierarchy objects of that class.
Types Information Architecture and Data Structures • The syntax is represented by the DDL constant OM-S-BOOLEAN, which is a 16-bit integer value of 1. • The value is represented by the DDL constant OM-TRUE, which is a 32-bit integer value of 1. The DDL structure for a descriptor defines a 64-bit field for the value, so the last 32-bit field is undefined in this case. For descriptions of more descriptors, see Data Structures on page 2-5.
Information Architecture and Data Structures Syntax and Values DDL constant names for all attribute types are given in Section 3, Object Classes and Attribute Types. Syntax and Values Each syntax is represented by an integer. A syntax has a DDL constant name with the prefix OM-S-. The GPI defines and recognizes the following syntaxes: Boolean, enumeration, integer, object, and eleven types of strings. The syntax determines the value as follows: OM-S-BOOLEAN Value is true or false.
Information Architecture and Data Structures Data Structures OM-S-OBJECT-IDENTIFIER-STRING Value is one of the ordered sequences of octets within the encoding of a value of an ASN.1 object-identifier type, accompanied by its length in octets. The alternate spelling, OM-S-OBJECT-ID-STRING, is valid. OM-S-OCTET-STRING Value is an ordered sequence of zero or more octets, accompanied by its length in octets.
Attribute Descriptor Structure Information Architecture and Data Structures Attribute Descriptor Structure Figure 2-2 illustrates the data structure of descriptors for each type of syntax. The OM-S-xxx-STRING structure applies to all of the syntaxes for strings. (In the actual DDL name, the type of string replaces xxx: for example, OM-S-BIT-STRING.) A string value is a 32-bit length field and a 32-bit address of the string data.
Descriptor Lists Information Architecture and Data Structures Figure 2-3. Bit-String Structure String Element (Octets) Attribute Descriptor Attribute Type Attribute IM-T-IMAGES Type Attribute Syntax Attribute OM-S-BIT-STRING Syntax Attribute Value StringAttribute Length Value = 8 Octets o Pointer to String Element 00000101 All bits used. Indicates 5 unused bits in last octet. All bits used. All bits used. All bits used. All bits used. All bits used. Unused Bits: 01234567 VST203.
Descriptor Lists Information Architecture and Data Structures Figure 2-4.
String Buffers Information Architecture and Data Structures Figure 2-5.
String Segments Information Architecture and Data Structures Figure 2-6. Example of String Buffer Descriptor List GPI_OM_EXAMINE_ String Buffer String Value Descriptor OM-S-xxx-STRING Length, Elements o o ••• Descriptor OM-S-xxx-STRING (too long) ••• String Value Descriptor OM-S-xxx-STRING Length, Elements oo VST 206.
String Segments Information Architecture and Data Structures Figure 2-7 shows an example of reading segments of a string value at attribute position 5, beginning at value position 0. The maximum number of octets read at one time is 32,767. The string offset is incremented by 32,767 at each call. Figure 2-7.
Information Architecture and Data Structures String Segments OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 2- 12
3 Object Classes and Attribute Types This section provides the DDL names for object classes and attribute types. These DDL names are used to generate source code definitions for use by client application and GIP processes.
Object Classes and Attribute Types • • • Object Class Descriptions Attributes that have additional characteristics to consider. The DDL names of the attributes are listed and the following information is provided when applicable: Initial Value The value to which the attribute is set if you request that the object be initialized when created. Enumerated Values Is a set of distinct values for the attribute represented by their DDL names.
Object Management Classes Object Classes and Attribute Types Object Management Classes This subsection describes objects and attributes of the object management package. The single supported class in the object management package is OM-C-EXTERNAL. For an overview of how each class relates to the other classes, refer to Appendix D, Class Hierarchies. OM-C-EXTERNAL This class of object appears in the definition of the IM-T-EXTERNAL-DATA, IM-T-EXTERNAL-PARAMETERS, and MH-T-CONTENT attributes.
Object Classes and Attribute Types OM-C-EXTERNAL OM-T-ASN1-ENCODING The data value encoded in Basic Encoding Rules. This attribute may be present only if the data type is an ASN.1 type. OM-T-DATA-VALUE-DESCRIPTOR A description of the data value; an object descriptor. OM-T-DIRECT-REFERENCE A direct reference to the data type; an object identifier. OM-T-INDIRECT-REFERENCE An indirect reference to the data type; an integer. OM-T-OCTET-ALIGNED-ENCODING A representation of the data value as an octet string.
Message Handling Classes Object Classes and Attribute Types longer than the specification of the max-string-len parameter of GPI_INITIALIZE_. Thus, you can use only the procedure calls GPI_OM_READ_ and GPI_OMWRITE_ to read and write the values of strings that have the syntax OM-SONFILE-STRING. Message Handling Classes This subsection describes objects and attributes of the message handling package. For an overview of how each class relates to other classes, see Appendix D, Class Hierarchies.
Object Classes and Attribute Types MH-C-ALGORITHM Meanings of Attributes The attribute types specify the following information: MH-T-ALGORITHM-DATUM Contains any data that might be required to use the algorithm. MH-T-ALGORITHM-ID Identifies the algorithm generically. The values for this identifier can be agreed on by the sender and recipient, or they can refer to an international standard or other register of algorithms.
MH-C-ALGORITHM-AND-RESULT Object Classes and Attribute Types MH-C-ALGORITHM-AND-RESULT This class of object identifies a mathematical (usually cryptographic) algorithm and the result obtained from using this algorithm to decrypt a particular message. Table 3-4 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-4.
Object Classes and Attribute Types MH-C-ALGORITHM-AND-RESULT When this attributes has the syntax OM-S-ONFILE-STRING, the GPI library stores the value in a file, and the value retains the characteristics of its primary syntax. For outbound messages, the client program should specify OM-S-ONFILE-STRING as the syntax of an attribute when the memory storage space might be insufficient to accommodate the value of the attribute.
MH-C-BILATERAL-INFORMATION Object Classes and Attribute Types MH-C-BILATERAL-INFORMATION This class of object consists of binary data that follows the BER. The data type of the encoded value is defined by the source domain, the administration management domain (ADMD) or private management domain (PRMD) that supplies the data. The ADMDs or PRMDs for which the data is intended are presumed to know the syntax and semantics of the data.
Object Classes and Attribute Types MH-C-BILATERAL-INFORMATION Meanings of Attributes The attribute types specify the following information: MH-T-ADMD-NAME Is the name of the source domain (ADMD) or the ADMD to which the source domain is attached (PRMD). The values of this attribute are defined by the country specified in the MH-T-COUNTRY-NAME attribute. MH-T-COUNTRY-NAME Is the name of the country of the ADMD. The values for this attribute are numbers X.
MH-C-DELIVERY-ENVELOPE Object Classes and Attribute Types only the procedure calls GPI_OM_READ_ and GPI_OM-WRITE_ to read and write the values of strings that have the syntax OM-S-ONFILE-STRING. MH-C-DELIVERY-ENVELOPE This class of object contains information that the MTS provides a specific recipient, in addition to the content of a message. Table 3-8 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-8.
MH-C-DELIVERY-ENVELOPE Object Classes and Attribute Types Table 3-8.
MH-C-DELIVERY-ENVELOPE Object Classes and Attribute Types Table 3-9. MH-C-DELIVERY-ENVELOPE Attributes—Additional Characteristics (page 2 of 2) Attribute Type MH-T-PRIORITY MH-T-SUBMISSIONTIME Value Characteristics Enumerated Values: MH-DM-ANY MH-DM-MTS MH-DM-PDS MH-DM-TELEX MH-DM-TELETEX MH-DM-G3-FAX MH-DM-G4-FAX MH-DM-IA5-TERMINAL MH-DM-VIDEOTEX MH-DM-TELEPHONE Initial Value: MH-PTY-NORMAL Enumerated Values: MH-PTY-NORMAL MH-PTY-LOW MH-PTY-URGENT Max.
Object Classes and Attribute Types MH-C-DELIVERY-ENVELOPE MH-T-CRITICAL-FOR-DELIVERY Are integers denoting the attribute types of attributes of this class that have values requiring extended processing, which is critical for delivery of the message. MH-T-CRITICAL-FOR-SUBMISSION Are integers denoting the attribute types of attributes of this class that have values requiring extended processing, which is critical for submission of the message.
Object Classes and Attribute Types MH-C-EITS MH-T-PREFERRED-DELIVERY-MODES Identifies the delivery modes requested by the originator in order of decreasing preference. This attribute is included for future use and is relevant only when the form of an O/R name is a directory name. (Currently, the GPI does not support the Directory name attribute.) The DDL names for enumerated values of this attribute indicate the delivery modes. (See the enumerated values in the Value Characteristics column in Table 3-9.
MH-C-EITS Object Classes and Attribute Types Table 3-10.
Object Classes and Attribute Types MH-C-EITS MH-T-BUILTIN-EITS Identifies the kinds of information contained in a message. DDL names for the enumerated values of this attribute (omitting the MH-BE- prefix) indicate the information types as follows: G3-FAX Group 3 (G3) facsimile images G4-CLASS1 Group 4 (G4) class 1 facsimile final-form documents IA5-TEXT International Alphabet No.
Object Classes and Attribute Types MH-C-EITS Implementation and Usage Note • OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64 kilobytes. For the attribute MH-T-G4-FAX-NBPS, this value syntax is an alternative to OM-SOCTET-STRING. When this attribute has the syntax OM-S-ONFILE-STRING, the GPI library stores the value in a file, and the value retains the characteristics of its primary syntax.
MH-C-ENVIRONMENT Object Classes and Attribute Types MH-C-ENVIRONMENT This class of object consists of information about the MTA’s environment, especially information about the MD that contains the MTA. Table 3-12 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-12.
Object Classes and Attribute Types MH-C-ENVIRONMENT Meanings of Attributes The attribute types specify the following information: MH-T-ADMD-NAME Is the name of the ADMD that the MTA is a part of or the name of the ADMD to which the PRMD containing the MTA is attached. The values of this attribute are defined by the country specified in the MH-T-COUNTRY-NAME attribute. MH-T-COUNTRY-NAME Is the name of the country of the ADMD specified by the MH-T-ADMD-NAME attribute.
MH-C-EXPANSION-RECORD Object Classes and Attribute Types MH-C-EXPANSION-RECORD This class of object documents the submission of a message, probe, or report and the expansion of a distribution list. Table 3-14 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-14.
MH-C-EXTENSION Object Classes and Attribute Types MH-C-EXTENSION The MH-C-EXTENSION class allows all 1988 extensions (even unrecognized extensions) to be made available at the GPI’s external interface. However, explicit GPI support is limited to a subset of actively supported extensions. The GPI explicitly supports the following subset of the 1988 X.400 extensions: X.
MH-C-EXTENSION Object Classes and Attribute Types Some attribute types have additional value characteristics, as shown in Table 3-17. Table 3-17.
MH-C-EXTENSION Object Classes and Attribute Types Implementation and Usage Notes • • The correspondence between the following DDL names and the ASN.1-defined names in Recommendation X.411 (1988) are: GPI Name X.
MH-C-EXTERNAL-TRACE-ENTRY Object Classes and Attribute Types MH-C-EXTERNAL-TRACE-ENTRY This class of object describes one or more actions taken by a management domain (MD) with respect to a communication. Table 3-18 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-18.
MH-C-EXTERNAL-TRACE-ENTRY Object Classes and Attribute Types Table 3-19. MH-C-EXTERNAL-TRACE-ENTRY Attributes—Additional Characteristics (page 2 of 2) Attribute Type Value Characteristics MH-T-ATTEMPTEDADMD-NAME Max. Value Length: MH-VL-ATTEMPTED-ADMDNAME MH-T-ATTEMPTEDCOUNTRY-NAME Max. Value Length: MH-VL-ATTEMPTED-COUNTRYNAME MH-T-ATTEMPTED-PRMDIDENTIFIER Max.
Object Classes and Attribute Types MH-C-EXTERNAL-TRACE-ENTRY MH-T-ATTEMPTED-ADMD-NAME Is the name of the attempted domain (if an ADMD) or the name of an ADMD to which the attempted domain is attached (if a PRMD). The values of this attribute are defined by the country specified in the MH-T-ATTEMPTED-COUNTRY-NAME attribute. MH-T-ATTEMPTED-COUNTRY-NAME Is the name of the country of the ADMD specified by the MH-T-ATTEMPTED-ADMDNAME attribute. The values for this attribute are numbers X.
Object Classes and Attribute Types MH-C-EXTERNAL-TRACE-ENTRY MH-T-DEFERRED-TIME Indicates the date and time at which the tracing domain released the message. This attribute is present only if the external trace entry is for a message and the tracing domain held the message because its originator requested deferred delivery.
MH-C-G3-FAX-NBPS Object Classes and Attribute Types MH-C-G3-FAX-NBPS This class of object specifies the nonbasic parameters of a set of G3 facsimile images. Each parameter identifies a nonbasic capability of a G3 facsimile terminal. Table 3-20 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-20.
Object Classes and Attribute Types MH-C-G3-FAX-NBPS MH-T-B4-LENGTH Indicates whether the images require B4-length. MH-T-B4-WIDTH Indicates whether the images require B4-width. MH-T-FINE-RESOLUTION Indicates whether the images require fine resolution. MH-T-TWO-DIMENSIONAL Indicates whether the images require two-dimensional capability. MH-T-UNCOMPRESSED Indicates whether the images require the uncompressed capability. MH-T-UNLIMITED-LENGTH Indicates whether the images require unlimited length.
MH-C-GENERAL-CONTENT Object Classes and Attribute Types MH-C-GENERAL-CONTENT This class of object consists of the information that a message conveys to its recipients. Table 3-22 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-22.
Object Classes and Attribute Types MH-C-GENERAL-CONTENT specified in the max-in-memory-string-len parameter of the GPI_MT_START_TRANSFER_IN_ call. Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings, regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_.
MH-C-INTERNAL-TRACE-ENTRY Object Classes and Attribute Types 3 Object Classes and Attribute Types 3 Object Classes and Attribute Types MH-C-INTERNAL-TRACE-ENTRY This class of object describes one or more actions taken by a message transfer agent (MTA) with respect to a message, probe, or report. This class is a 1988 extension. Table 3-23 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-23.
MH-C-INTERNAL-TRACE-ENTRY Object Classes and Attribute Types Table 3-24. MH-C-INTERNAL-TRACE-ENTRY Attributes—Additional Characteristics Attribute Type Value Characteristics MH-T-ADMD-NAME Initial Value: supplied by GPI 1 Max. Value Length: MH-VL-ADMD-NAME Initial Value: supplied by GPI 1 Max. Value Length: MH-VL-COUNTRY-NAME Initial Value: supplied by GPI if available 1 Max. Value Length: MH-VL-PRMD-IDENTIFIER MH-T-MTA-NAME Max. Value Length: MH-VL-MTA-NAME MH-T-ATTEMPTED-MTA-NAME Max.
Object Classes and Attribute Types MH-C-INTERNAL-TRACE-ENTRY MH-T-COUNTRY-NAME Is the name of the country of the ADMD specified by the MH-T-ADMD-NAME attribute. The values for this attribute are numbers X.121 assigns to the country, or the character pairs ISO 3166 assigns to it. MH-T-PRMD-IDENTIFIER Is the identifier of the domain of the tracing MTA (if a PRMD). The values of this attribute are defined by the ADMD. This attribute is not present unless the domain is a PRMD.
Object Classes and Attribute Types MH-C-INTERNAL-TRACE-ENTRY MH-T-ACTION Identifies the routing action taken by the tracing MTA.
MH-C-MESSAGE Object Classes and Attribute Types MH-C-MESSAGE This class defines a primary information object (a message) that conveys arbitrary binary data from one user, the originator, to one or more users, the recipients. Table 3-25 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-25.
MH-C-MESSAGE Object Classes and Attribute Types Table 3-25.
MH-C-MESSAGE Object Classes and Attribute Types Table 3-26. MH-C-MESSAGE Attributes—Additional Characteristics Attribute Type Value Characteristics MH-T-ALTERNATE-RECIPALLOWED Initial Value: OM-FALSE MH-T-BILATERAL-INFORMATION Max. Value Number: MH-VN-BILATERALINFORMATION MH-T-CONTENT-IDENTIFIER Max.
Object Classes and Attribute Types MH-C-MESSAGE Meanings of Attributes The attribute types specify the following information: MH-T-ALTERNATE-RECIP-ALLOWED Indicates whether the originator permits the MTS to deliver the message to an alternate recipient. An MD may assign an alternate recipient to accept delivery of messages whose MH-T-RECIPIENT-DESCRIPTORS attribute contains O/R names that are invalid but recognized as denoting users of the MD.
Object Classes and Attribute Types MH-C-MESSAGE MH-CTO-INNERMESSAGE Content encodes an object of the Submitted Message class according to the rules of X.400 (1988), which include the BER. The ASN.1 object identifier is specified by an object ID string (the DDL-constant value “\x56\x03\x03\x01”). The originator can secure the inner message from unauthorized examination or modification by securing the MH-T-CONTENT attribute of the outer message.
Object Classes and Attribute Types MH-C-MESSAGE MH-T-EXPANSION-PROHIBITED Indicates whether the originator instructs the MTS to issue a non-delivery report rather than expand a distribution list in the case that a recipient’s O/R name denotes a distribution list rather than a user. MH-T-EXTENSIONS Are requests for extended processing as part of the object’s submission, transfer, or delivery. MH-T-EXPANSION-HISTORY Is a record of each attempt to add recipients to the distribution list of the message.
MH-C-MESSAGE-RD Object Classes and Attribute Types MH-T-MTS-IDENTIFIER Is the MTS identifier of the message. If copies of the message are made for routing to recipients at different locations, each copy contains the same MTS identifier. When you omit this attribute from a message you are transferring out to the GPI service, the value is assigned by the GPI_MT_TRANSFER_OUT_ procedure. MH-T-ORIGINAL-EITS Provides the EITs of the MH-T-CONTENT attribute that were present when the message was submitted.
MH-C-MESSAGE-RD Object Classes and Attribute Types Table 3-27.
MH-C-MESSAGE-RD Object Classes and Attribute Types Table 3-28.
MH-C-MESSAGE-RD Object Classes and Attribute Types Table 3-28. MH-C-MESSAGE-RD Attributes—Additional Characteristics (page 2 of 2) Attribute Type MH-T-PREFERREDDELIVERY-MODES Value Characteristics Enumerated Values: MH-RQ-NEVER MH-RQ-NON-DELIVERY MH-RQ-ALWAYS Max.
MH-C-MESSAGE-RD Object Classes and Attribute Types MH-T-EXTENSIONS Are requests for extended processing as part of the object’s submission, transfer, or delivery. MH-T-MTA-REPORT-REQUEST Indicates the kinds of reports that the originating MD requests in circumstances prescribed for such reports.
MH-C-MTS-IDENTIFIER Object Classes and Attribute Types MTS indicates delivery through the message transfer system. The other names indicate types of terminals. MH-T-RECIPIENT-NAME Is the recipient’s O/R name. MH-T-RECIPIENT-NUMBER Is the ordinal position of the recipient in the list of recipients originally specified by the originator of the message. For the first recipient, the value is 1. The minimum value is ZGPI-MIN-RECIPIENTS, and the maximum value is ZGPI-MAX-RECIPIENTS.
MH-C-MTS-IDENTIFIER Object Classes and Attribute Types Table 3-30. MH-C-MTS-IDENTIFIER Attributes—Additional Characteristics Attribute Type Value Characteristics MH-T-ADMD-NAME Initial Value: supplied by GPI 1 Max. Value Length: MH-VL-ADMD-NAME Initial Value: supplied by GPI 1 Max. Value Length: MH-VL-COUNTRY-NAME MH-T-LOCAL-IDENTIFIER Max. Value Length: MH-VL-LOCAL-IDENTIFIER MH-T-PRMD-IDENTIFIER Initial Value: supplied by GPI if available 1 Max.
MH-C-OR-NAME Object Classes and Attribute Types • • It is recommended that you allow the GPI to generate the value of the MH-T-LOCAL-IDENTIFIER attribute to ensure its uniqueness in the MTS. The local identifier, MH-T-LOCAL-IDENTIFIER, can be generated by the client or automatically by the GPI. This identifier is used in the MH-C-MTS-IDENTIFER class of object and can affect the behavior of OSI/MHS.
MH-C-OR-NAME Object Classes and Attribute Types Table 3-31.
MH-C-OR-NAME Object Classes and Attribute Types Table 3-32. MH-C-OR-NAME Attributes—Additional Characteristics (page 2 of 3) Attribute Type Value Characteristics Max. Value Length: MH-VL-COUNTRY-NAME MH-T-DOMAIN-TYPE-1 Max. Value Length: MH-VL-DOMAIN-TYPE MH-T-DOMAIN-TYPE-2 Max. Value Length: MH-VL-DOMAIN-TYPE MH-T-DOMAIN-TYPE-3 Max. Value Length: MH-VL-DOMAIN-TYPE MH-T-DOMAIN-TYPE-4 Max. Value Length: MH-VL-DOMAIN-TYPE MH-T-DOMAIN-VALUE-1 Max.
MH-C-OR-NAME Object Classes and Attribute Types Table 3-32. MH-C-OR-NAME Attributes—Additional Characteristics (page 3 of 3) Attribute Type Value Characteristics MH-T-TERMINAL-IDENTIFIER Max. Value Length: MH-VL-TERMINAL-IDENTIFIER MH-T-TERMINAL-TYPE Enumerated Values: MH-TT-TELEX MH-TT-TELETEX MH-TT-G3-FAX MH-TT-G4-FAX MH-TT-IA5-TERMINAL MH-TT-VIDEOTEX 1 These values are the same as returned in the GPI_OPEN_ environment parameter (MH-C-ENVIRONMENT object).
Object Classes and Attribute Types MH-C-OR-NAME MH-T-DOMAIN-TYPE-2 Is the name of a class of information defined by the user’s ADMD or ADMD and PRMD. MH-T-DOMAIN-TYPE-3 Is the name of a class of information defined by the user’s ADMD or ADMD and PRMD. MH-T-DOMAIN-TYPE-4 Is the name of a class of information defined by the user’s ADMD or ADMD and PRMD. MH-T-DOMAIN-VALUE-1 Is an instance of the class of information denoted by the MH-T-DOMAIN-TYPE-1 attribute.
Object Classes and Attribute Types MH-C-OR-NAME MH-T-NUMERIC-USER-IDENTIFIER Is a number identifying the user relative to the ADMD specified by the MH-T-ADMDNAME attribute. The ADMD defines the values of this attribute. MH-T-ORGANIZATION-NAME Is the name of the organization to which the user belongs. The names can be assigned by the country, ADMD, or PRMD. MH-T-ORGANIZATIONAL-UNIT-NME-1 Is the name of a unit of the organization specified by the MH-T-ORGANIZATIONNAME attribute.
MH-C-OR-NAME Object Classes and Attribute Types Implementation and Usage Notes • • • The MH-T-COMMON-NAME and MH-T-TERMINAL-TYPE attributes are 1988 extension attributes. They do not have criticality associated with them; you should not specify them as values of the MH-T-CRITICAL-FOR- attributes. All other extension attributes in the MH-C-OR-NAME class are mapped to values of the MH-T-EXTENSIONS attribute. For each occurrence of MH-T-DOMAIN-TYPE-n, there must be a corresponding MH-T-DOMAIN-VALUE-n.
MH-C-P1-ENCODED-PDU Object Classes and Attribute Types • If a user is not accessed through a PRMD, the ADMD governs whether all conditional attributes are present. MH-C-P1-ENCODED-PDU This class of object defines an encoded P1 transmission (message, probe, or report). Table 3-33 describes the attribute types for this class and the syntax, length, and number of values for each type Table 3-33.
Object Classes and Attribute Types MH-C-P1-ENCODED-PDU For inbound messages, the Gateway Interface Process automatically specifies OMS-ONFILE-STRING for those strings that exceed the value in the max-table-data parameter of the GPI_INITIALIZE_ call or that exceed the maximum length specified in the max-in-memory-string-len parameter of the GPI_MT_START_TRANSFER_IN_ call.
MH-C-PER-RECIPIENT-DR Object Classes and Attribute Types 3 Object Classes and Attribute Types 3 Object Classes and Attribute Types MH-C-PER-RECIPIENT-DR This class of object gives information about the successful delivery of a message to a particular recipient or, if the report pertains to a probe, the deliverability of the message. This class of object is an attribute of a report. Table 3-34 describes the attribute types for this class and the syntax, length, and number of values for each type.
MH-C-PER-RECIPIENT-DR Object Classes and Attribute Types Table 3-35. MH-C-PER-RECIPIENT-DR Attributes—Additional Characteristics Attribute Type Value Characteristics MH-T-ARRIVAL-TIME Max. Value Length: MH-VL-TIME MH-T-DELIVERY-POINT Initial Value: MH-DP-PRIVATE-UA Enumerated Values: MH-DP-PUBLIC-UA MH-DP-PRIVATE-UA MH-DP-MS MH-DP-DL MH-DP-PDAU MH-DP-PDS-PATRON MH-DP-OTHER-AU MH-T-DELIVERY-TIME Max.
Object Classes and Attribute Types MH-C-PER-RECIPIENT-DR MH-T-ARRIVAL-TIME Indicates the date and time at which the message or probe entered the MD that produced the per-recipient report. (The date and time are in UTC format.) MH-T-CONVERTED-EITS Provides the EITs that characterize, or would characterize, the message after the MTS converted it. This attribute is present only if the MTS converted, or would have converted, the message.
MH-C-PER-RECIPIENT-DR Object Classes and Attribute Types MH-T-MTA-REPORT-REQUEST Indicates the kinds of reports that the originating MD requests in circumstances prescribed for such reports.
MH-C-PER-RECIPIENT-NDR Object Classes and Attribute Types MH-C-PER-RECIPIENT-NDR This class of object gives information about the unsuccessful delivery of a message to a particular recipient or, if the report pertains to a probe, the undeliverability of the message. This class of object is an attribute of a report. Table 3-36 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-36.
MH-C-PER-RECIPIENT-NDR Object Classes and Attribute Types Table 3-37. MH-C-PER-RECIPIENT-NDR Attributes—Additional Characteristics (page 1 of 2) Attribute Type Value Characteristics MH-T-ARRIVAL-TIME Max.
MH-C-PER-RECIPIENT-NDR Object Classes and Attribute Types Table 3-37.
MH-C-PER-RECIPIENT-NDR Object Classes and Attribute Types Meanings of Attributes The attribute types specify the following information: MH-T-ACTUAL-RECIPIENT-NAME Is the O/R name of the recipient to which the per-recipient report pertains. If the report concerns a message (not a probe) and the recipient is an alternate recipient, this attribute’s value is the O/R name of the alternate recipient.
Object Classes and Attribute Types MH-C-PER-RECIPIENT-NDR This attribute does not exclude reports or call for less external trace information than the MH-T-ORIGINATOR-REPORT-REQUEST attribute. MH-T-MTA-RESPONSIBILITY Indicates whether the message in which the recipient descriptor is contained is to be delivered to the recipient. If the value is OM-FALSE, another copy of the message is being independently routed to this recipient.
MH-C-PROBE Object Classes and Attribute Types MH-C-PROBE This class defines a secondary information object (a probe) that tests the deliverability to prescribed users of a message having prescribed characteristics. Table 3-38 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-38.
MH-C-PROBE Object Classes and Attribute Types Table 3-38.
MH-C-PROBE Object Classes and Attribute Types Table 3-39. MH-C-PROBE Attributes—Additional Characteristics (page 2 of 2) Attribute Type Value Characteristics MH-T-INTERNAL-TRACE-INFO Max. Value Number: MH-VN-TRACE-INFO MH-T-MTS-IDENTIFIER Initial Value: assigned by GPI_MT_TRANSFER_OUT_ MH-T-RECIPIENT-DESCRIPTORS Max.
Object Classes and Attribute Types MH-C-PROBE MH-T-CRITICAL-FOR-SUBMISSION Are integers denoting the attribute types of attributes of this class that have values requiring extended processing, which is critical for submission of the probe. MH-T-CRITICAL-FOR-TRANSFER Are integers denoting the attribute types of attributes of this class that have values requiring extended processing, which is critical for transfer of the probe.
Object Classes and Attribute Types MH-C-PROBE MH-T-ORIGINATOR-NAME Is the O/R name of the probe’s originator. MH-T-RECIPIENT-DESCRIPTORS Are the recipient descriptors of the intended recipients of the probe. Implementation and Usage Note • The MH-T-EXPANSION-HISTORY, MH-T-EXPANSION-PROHIBITED and MH-T-INTERNAL-TRACE-INFO attributes are 1988 extension attributes. All other extension attributes in the MH-C-PROBE class are mapped to values of the MH-T-EXTENSIONS attribute.
MH-C-PROBE-RD Object Classes and Attribute Types MH-C-PROBE-RD This class of object defines an intended recipient of a probe and records information about that recipient. Table 3-40 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-40.
MH-C-PROBE-RD Object Classes and Attribute Types Table 3-41.
MH-C-PROBE-RD Object Classes and Attribute Types Table 3-41. MH-C-PROBE-RD Attributes—Additional Characteristics (page 2 of 2) Attribute Type Value Characteristics MH-T-PREFERRED-DELIVERYMODES Max. Value Number: MH-VN-PREFERRED-DELIVERYMODES Enumerated Values: MH-DM-ANY MH-DM-MTS MH-DM-PDS MH-DM-TELEX MH-DM-TELETEX MH-DM-G3-FAX MH-DM-G4-FAX MH-DM-IA5-TERMINAL MH-DM-VIDEOTEX MH-DM-TELEPHONE 1 A value of MH-RQ-NEVER is invalid for the attribute MH-T-MTA-REPORT-REQUEST.
MH-C-PROBE-RD Object Classes and Attribute Types MH-T-EXTENSIONS Are requests for extended processing as part of the object’s submission, transfer, or delivery. MH-T-MTA-REPORT-REQUEST Indicates the kinds of reports that the originating MD requests in circumstances prescribed for such reports.
Object Classes and Attribute Types MH-C-PROBE-RD MH-T-RECIPIENT-NAME Is the recipient’s O/R name. MH-T-RECIPIENT-NUMBER Is the ordinal position of the recipient in the list of recipients originally specified by the originator of the probe (or message). For the first recipient, the value is one. The minimum value is ZGPI-MIN-RECIPIENTS, and the maximum value is ZGPI-MAXRECIPIENTS. Implementation and Usage Notes • • The MH-T-PREFERRED-DELIVERY-MODES attribute is a 1988 extension attribute.
MH-C-REPORT Object Classes and Attribute Types MH-C-REPORT This class defines a secondary information object (a report) that reports the successful or unsuccessful delivery of a message to some or all of its recipients, or, if the report pertains to a probe, the deliverability or undeliverability of the message. A report can contain mixed results: success with some recipients and no success with others.
MH-C-REPORT Object Classes and Attribute Types Table 3-42.
MH-C-REPORT Object Classes and Attribute Types Table 3-43. MH-C-REPORT Attributes—Additional Characteristics Attribute Type Value Characteristics MH-T-CONTENT-IDENTIFIER Max. Value Length: MH-VL-CONTENT-IDENTIFIER MH-T-CONTENT-TYPE Integer Values: MH-CTI-UNIDENTIFIED MH-CTI-EXTERNAL MH-CTI-P2-1984 MH-CTI-P2-1988 MH-CTI-PEDI Object Identifier Values: MH-CTO-INNER-MESSAGE MH-CTO-UNIDENTIFIED MH-CTO-P772 MH-T-EXPANSION-HISTORY Max.
Object Classes and Attribute Types MH-C-REPORT MH-T-CONTENT-EXTENSIONS Are requests for extended processing as part of a report’s content submission, transfer, or delivery. MH-T-CONTENT-IDENTIFIER Provides information used to correlate a message with any reports generated about it. This attribute is the same as the like-named attribute of the message to which the report pertains. MH-T-CONTENT-TYPE Identifies the syntax and semantics of the value of the MH-T-CONTENT attribute of the message.
Object Classes and Attribute Types MH-C-REPORT MH-T-MTS-IDENTIFIER Is the MTS identifier of the message or probe. This attribute is the same as the likenamed attribute of the message or probe. MH-T-ORIGINAL-EITS Provides the EITs of the MH-T-CONTENT attribute that were present when the message was submitted. This attribute is present only if the message content was converted or, in the case of a probe, would have been converted for one or more of the recipients to which the report applies.
MH-C-REPORT Object Classes and Attribute Types A single MTA may add one or several trace entries, as follows: • • If the report is transferred to the MTA of first choice, the transferring MTA adds a trace entry with an MH-T-ACTION attribute value of MH-AC-RELAYED. If the report is transferred to an MTA that is not the first choice, the transferring MTA adds one or more trace entries with an MH-T-ACTION attribute value of MH-AC-REROUTED.
Object Classes and Attribute Types MH-C-REPORT When this attribute has the syntax OM-S-ONFILE-STRING, the GPI library stores the value in a file, and the value retains the characteristics of its primary syntax. For outbound messages, the client program should specify OM-S-ONFILE-STRING as the syntax of an attribute when the memory storage space might be insufficient to accommodate the value of the attribute.
MH-C-SECURITY-LABEL Object Classes and Attribute Types MH-C-SECURITY-LABEL This class of object supports the Clear Service. This element of service indicates to the recipient military messaging user agent (MM-UA) that a message containing classified information has been transmitted over an unsecure channel prior to entering the MMHS domain and may have been compromised. Table 3-44 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-44.
Object Classes and Attribute Types MH-C-SECURITY-LABEL MH-T-SECURITY-CATEGORY Is an extension attribute which provides further restrictions within the context of MH-TSECURITY-CLASSIFICATION and MH-T-PRIVACY-MARK. The categories and their values may be defined by a security policy as a local matter or by bilateral agreement. MH-T-SECURITY-CLASSIFICATION Specifies the classification of the security. MH-T-SECURITY-POLICY-ID Specifies the security policy identifier.
MH-C-TELETEX-NBPS Object Classes and Attribute Types MH-C-TELETEX-NBPS This class of object provides nonbasic parameters of a teletex document. Each parameter identifies a nonbasic capability of a teletex terminal. In the teletex service, nonbasic parameters are conveyed between terminals by means of the Command Document Start (CDS) data structure of Recommendation T.62. Table 3-46 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-46.
Object Classes and Attribute Types MH-C-TELETEX-NBPS MH-T-PAGE-FORMATS Is the information that signals in a CDS the page-format capability of a teletex terminal. MH-T-PRIVATE-USE Is the information that signals in a CDS the private-use capability of a teletex terminal.
Interpersonal Messaging Classes Object Classes and Attribute Types 3 Object Classes and Attribute Types 3 Object Classes and Attribute Types Interpersonal Messaging Classes This subsection describes objects and attributes of the interpersonal messaging classes. For an overview of how each class relates to other classes, see Appendix D, Class Hierarchies. IM-C-ACP127-DATA-BODY-PART This class of object conveys ACP 127 data pattern traffic.
IM-C-ACP127-NOTIFICATION Object Classes and Attribute Types IM-C-ACP127-NOTIFICATION This class of object reports the receipt, non-receipt, or transfer notification from the ACP127 domain. Table 3-50 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-50.
Object Classes and Attribute Types IM-C-ACP127-NOTIFICATION IM-T-IPN-ORIGINATOR Is the O/R descriptor for the IPN's originator (who is either an intended or alternate recipient of the IPM). IM-T-SUBJECT-IPM Is the IPM identifier of the IPM to which the notification applies.
IM-C-ACP127-NOTIFICATION-RSP Object Classes and Attribute Types IM-C-ACP127-NOTIFICATION-RSP This class of object reports the results of an attempt to transfer a message into an ACP127 domain. Table 3-51 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-51.
Object Classes and Attribute Types IM-C-ACP127-NOTIFICATION-RSP Meanings of Attributes The attribute types specify the following information: IM-T-ACP127-NOTIFICATION-TYPE Indicates whether the transfer was positive or negative, or positive but without responsibility. IM-T-ACP127-RECIPIENT Contains the ACP 127 recipient address. IM-T-ACP127-SUPP-INFO Contains any supplementary information. IM-T-RECEIPT-TIME Indicates the receipt time. IM-T-ADDRESS-LIST-INDICATOR Contains the Address List of the message.
IM-C-ADATP3-BODY-PART Object Classes and Attribute Types IM-C-ADATP3-BODY-PART This class of object conveys military AdatP3 messages. Table 3-53 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-53.
IM-C-ADDRESS-LIST-DESIGNATOR Object Classes and Attribute Types IM-C-ADDRESS-LIST-DESIGNATOR This class conveys the name of a predefined list of recipients to which the originator has sent the message. Table 3-54 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-54.
Object Classes and Attribute Types IM-C-ADDRESS-LIST-DESIGNATOR IM-T-ALD-NOTIFICATION-REQUEST Defines if notifications are required from recipients of the address list. These recipients can be action recipients, information recipients, or both types of recipients. IM-T-ALD-REPLY-REQUEST Defines if replies are required from recipients of the address list. These recipients can be action recipients, information recipients, or both types of recipients.
IM-C-BILAT-DEFINED-BODY-PART Object Classes and Attribute Types IM-C-BILAT-DEFINED-BODY-PART This class of object consists of arbitrary binary data of unspecified syntax and semantics that are agreed upon by two communicating parties. Table 3-56 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-56.
IM-C-CORRECTIONS-BODY-PART Object Classes and Attribute Types Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings, regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_. Thus, you can use only the procedure calls GPI_OM_READ_ and GPI_OM-WRITE_ to read and write the values of strings that have the syntax OM-S-ONFILE-STRING.
IM-C-DISTRIBUTION-CODES Object Classes and Attribute Types IM-C-DISTRIBUTION-CODES This class of object is used by the originating military messaging user agent (MM-UA) to give distribution information to a recipient MM-UA. The recipient MM-UA can use this information to distribute a message locally. Table 3-58 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-58.
IM-C-EXTERN-DEFINED-BODY-PART Object Classes and Attribute Types IM-C-EXTERN-DEFINED-BODY-PART This class of object contains an information object whose syntax and semantics are denoted by an object identifier that the body part carries. Table 3-60 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-60.
IM-C-G3-FAX-BODY-PART Object Classes and Attribute Types IM-C-G3-FAX-BODY-PART This class of object consists of a G3 facsimile message. Table 3-61 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-61.
Object Classes and Attribute Types IM-C-G3-FAX-BODY-PART specific strings when the accumulated length of the strings might overflow the total string area specified in the max-table-data parameter of the GPI_INITIALIZE_ procedure call.
IM-C-FORWARDED-ENC-BODY-PART Object Classes and Attribute Types IM-C-FORWARDED-ENC-BODY-PART This class of object is used to convey a message that has been forwarded by a military messaging user agent (MM-UA). Table 3-62 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-62.
IM-C-G4-CLASS-1-BODY-PART Object Classes and Attribute Types IM-C-G4-CLASS-1-BODY-PART This class of object is a final-form document of the kind that Group 4 (G4) class 1 facsimile terminals can process. Table 3-63 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-63.
IM-C-IA5-TEXT-BODY-PART Object Classes and Attribute Types specified in the max-in-memory-string-len parameter of the GPI_MT_START_TRANSFER_IN_ call. Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings, regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_.
Object Classes and Attribute Types IM-C-IA5-TEXT-BODY-PART IM-T-TEXT Is the text, which may contain lines of any length. When the text is displayed or printed for a recipient, all of the text is included. Lines can be folded but not truncated. The end of a line is usually denoted by a carriage return followed by a line feed. Implementation and Usage Note • OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64 kilobytes.
IM-C-INTERPERSONAL-MESSAGE Object Classes and Attribute Types IM-C-INTERPERSONAL-MESSAGE This class defines a primary information object (an interpersonal message) that conveys information between users. An interpersonal message is like a business memo. Table 3-66 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-66.
IM-C-INTERPERSONAL-MESSAGE Object Classes and Attribute Types Table 3-66.
IM-C-INTERPERSONAL-MESSAGE Object Classes and Attribute Types Table 3-66.
IM-C-INTERPERSONAL-MESSAGE Object Classes and Attribute Types Table 3-67. IM-C-INTERPERSONAL-MESSAGE Attributes—Additional Characteristics Attribute Type Value Characteristics IM-T-PRIMARYPRECEDENCE Integer Values: IM-DEFERRED-PRECEDENCE IM-ROUTINE-PRECEDENCE IM-PRIORITY-PRECEDENCE IM-IMMEDIATE-PRECEDENCE IM-FLASH-PRECEDENCE IM-OVERRIDE-PRECEDENCE IM-T-REPLY-TIME Max.
Object Classes and Attribute Types IM-C-INTERPERSONAL-MESSAGE IM-T-BODY Are the information objects (documents) that the IPM conveys from the originator to its recipients, one information object per attribute value. IM-T-CODRESS-MESSAGE Enables the originating MM-UA to indicate to the recipient MM-UA that the message is in codress format. This attribute applies only to codress encrypted messages, which are restricted to a single body part.
Object Classes and Attribute Types IM-C-INTERPERSONAL-MESSAGE IM-T-HANDLING-INSTRUCTIONS Enables the originating military messaging user agent (MM-UA) to indicate to the recipient MM-UAs that: • • Local handling instructions accompany the message. The message requires manual handling by a traffic operator. IM-T-IMPORTANCE Identifies the importance that the authorizing users attach to the IPM. DDL names for the enumerated values describe the levels of importance: for example, IM-LOW.
Object Classes and Attribute Types IM-C-INTERPERSONAL-MESSAGE names of recipients that can be reached through MMHS. You can specify other recipients with this element of service. IM-T-PILOT-FORWARDING-INFO Used with ACP127 gateways, this attribute allows a gateway to translate a pilot message. A pilot message contains information which equals or supersedes the received header information with regard to precedence, classification, local handling instructions, and addressing.
IM-C-INTERPERSONAL-MESSAGE Object Classes and Attribute Types IM-T-SENSITIVITY Indicates how sensitive the authorizing users consider the IPM to be. DDL names for the enumerated values of this attribute (omitting the prefix IM-) describe the degrees of sensitivity as follows: NOT-SENSITIVE The IPM is not sensitive. PERSONAL The IPM is conveyed to recipients as individuals without regard to their professional capacities. PRIVATE The IPM should be conveyed only to its preferred recipients.
IM-C-IPM-IDENTIFIER Object Classes and Attribute Types IM-C-IPM-IDENTIFIER This class of object uniquely identifies an IPM. The IPM identifier unambiguously distinguishes one IPM from other IPMs originated by the same user and possibly other users. Table 3-68 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-68.
IM-C-ISO-6937-TEXT-BODY-PART Object Classes and Attribute Types IM-C-ISO-6937-TEXT-BODY-PART This class of object represents a body part in the form of ISO 6937 text. Table 3-70 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-70.
Object Classes and Attribute Types IM-C-MESSAGE-BODY-PART For the attribute IM-T-ISO-6937-TEXT, this value syntax is an alternative to OM-SOCTET-STRING. When this attribute has the syntax OM-S-ONFILE-STRING, the GPI library stores the value in a file, and the value retains the characteristics of its primary syntax.
IM-C-MESSAGE-TYPE Object Classes and Attribute Types IM-T-ENVELOPE Is the delivery envelope (without the MTS identifier) accompanying the forwarded IPM when it is delivered to the originator of the forwarding IPM. IM-T-IPM Is the forwarded IPM.
IM-C-MIXED-MODE-BODY-PART Object Classes and Attribute Types IM-C-MIXED-MODE-BODY-PART This class of object is a final-form document of the kind that mixed-mode teletex and G4 Classes 2 and 3 facsimile terminals can process. Table 3-75 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-75.
IM-C-MM-MESSAGE-BODY-PART Object Classes and Attribute Types specified in the max-in-memory-string-len parameter of the GPI_MT_START_TRANSFER_IN_ call. Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings. regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_.
IM-C-NAT-DEFINED-BODY-PART Object Classes and Attribute Types Table 3-77 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-77.
IM-C-NON-RECEIPT-NOTIFICATION Object Classes and Attribute Types Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings, regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_. Thus, you can use only the procedure calls GPI_OM_READ_ and GPI_OM-WRITE_ to read and write the values of strings that have the syntax OM-S-ONFILE-STRING.
IM-C-NON-RECEIPT-NOTIFICATION Object Classes and Attribute Types Table 3-79. IM-C-NON-RECEIPT-NOTIFICATION Attributes—Additional Characteristics Attribute Type Value Characteristics IM-T-AUTO-FORWARDCOMMENT Max.
IM-C-OR-DESCRIPTOR Object Classes and Attribute Types IM-T-NON-RECEIPT-REASON Indicates why the originator of the nonreceipt notification did not receive the IPM even though it was delivered correctly. DDL names for the enumerated values describe the reasons: for example, IM-IPM-DISCARDED. See the Value Characteristics column in Table 3-79. IM-T-RETURNED-IPM Is the IPM identifier of the IPM to which the notification applies.
Object Classes and Attribute Types IM-C-OR-DESCRIPTOR IM-T-FORMAL-NAME Is one of the user’s O/R names. This attribute is present if (but not only if) one of the following conditions apply: • • • The IM-T-FREE-FORM-NAME is absent. The O/R descriptor is specified as a value of the IM-T-REPLY-RECIPIENTS attribute of an IPM. The O/R descriptor is the value of an IM-T-RECIPIENT attribute of an IM-C-RECIPIENT-SPECIFIER object and the conditions stated in the description of that attribute are satisfied.
IM-C-OTHER-RECIP-DESIGNATOR Object Classes and Attribute Types IM-C-OTHER-RECIP-DESIGNATOR This class of object enables the originator of a military message to give the recipient the names of one or more other recipients that are meant to receive, or have received, the message through other means. Table 3-82 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-82.
IM-C-PILOT-INFORMATION Object Classes and Attribute Types IM-C-PILOT-INFORMATION This class of object is used with ACP 127 gateways; it allows a gateway to translate a pilot message. Table 3-84 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-84.
Object Classes and Attribute Types IM-C-PILOT-INFORMATION IM-T-PILOT-RECIPIENT Specifies the recipient of the pilot message. IM-T-PILOT-SECURITY Specifies the security of the pilot message.
IM-C-RECEIPT-NOTIFICATION Object Classes and Attribute Types IM-C-RECEIPT-NOTIFICATION This class of object reports the receipt or the expected and arranged future receipt of an IPM by the report’s originator. (The report’s originator is the recipient of the message or probe.) Table 3-86 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-86.
Object Classes and Attribute Types IM-C-RECEIPT-NOTIFICATION Meanings of Attributes The attribute types specify the following information: IM-T-ACKNOWLEDGMENT-MODE Indicates how the receipt notification was originated. DDL names for the enumerated values indicate whether the receipt notification originated manually or automatically. IM-T-CONVERSION-EITS Are the EITs of the IPM at the time of its delivery to the originator of the interpersonal notification (IPN).
IM-C-RECIPIENT-SPECIFIER Object Classes and Attribute Types IM-C-RECIPIENT-SPECIFIER This class of object identifies and, optionally, makes requests of a recipient of an IPM. Table 3-88 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-88.
Object Classes and Attribute Types IM-C-RECIPIENT-SPECIFIER IM-T-IPM-RETURN-REQUESTED Indicates whether the recipient is asked to return the IPM in any nonreceipt notification. IM-T-NOTIFICATION-REQUEST Indicates the kinds of interpersonal notification requested of the preferred recipient in specific circumstances. DDL names for the enumerated values describe the circumstances as follows: IM-NEVER Neither a receipt notification nor a nonreceipt notification is issued.
IM-C-TELETEX-BODY-PART Object Classes and Attribute Types 3 Object Classes and Attribute Types 3 Object Classes and Attribute Types IM-C-TELETEX-BODY-PART This class of object is a teletex document. Table 3-90 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-90.
Object Classes and Attribute Types IM-C-TELETEX-BODY-PART IM-T-TELEX-COMPATIBLE Indicates whether the teletex document is compatible with telex. If the value is OM-TRUE, the document is restricted to the ITA2 character set, and no line can be longer than 69 characters. Implementation and Usage Note • OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64 kilobytes. For the attribute IM-T-TELETEX-DOCUMENT, this value syntax is an alternative to OM-S-TELETEX-STRING.
IM-C-UNIDENTIFIED-BODY-PART Object Classes and Attribute Types IM-C-UNIDENTIFIED-BODY-PART This class of object comprises data for a body part not among those tagged body parts defined in this specification. Table 3-92 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-92.
IM-C-VIDEOTEX-BODY-PART Object Classes and Attribute Types For inbound messages, the Gateway Interface Process automatically specifies OMS-ONFILE-STRING for those strings that exceed the value in the max-table-data parameter of the GPI_INITIALIZE_ call or that exceed the maximum length specified in the max-in-memory-string-len parameter of the GPI_MT_START_TRANSFER_IN_ call.
Object Classes and Attribute Types Electronic Data Interchange Messaging Classes IM-T-VIDEOTEX-DATA Is the videotex data, which must conform to the videotex syntax denoted by the IM-T-VIDEOTEX-SYNTAX attribute (unless the value is IM-UNSPECIFIED). IM-T-VIDEOTEX-SYNTAX Identifies the syntax of the videotex data. The syntaxes are defined in Recommendations T.100 and T.101. DDL names of the enumerated values describe the syntax choices. See the Value Characteristics column in Table 3-94.
EDI-C-CROSS-REF-INFO Object Classes and Attribute Types Table 3-95 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-95.
EDI-C-CROSS-REF-INFO Object Classes and Attribute Types Table 3-97. EDI-C-CROSS-REF-INFO Attributes—General Characteristics Attribute Type Value Syntax Value Length Number of Values EDI-T-APP-CROSS-REFERENCE OM-S-OCTET-STRING -- 1 or OM-S-ONFILE-STRING EDI-T-BODYPART-REFERENCE OM-S-INTEGER -- 1 EDI-T-MSG-REFERENCE OM-S-OBJECT (EDI-C-EDIM-ID) -- 0-1 OM-T-CLASS OM-S-OBJECT-ID-STRING 7 1 Some attribute types have additional value characteristics, as shown in Table 3-98. Table 3-98.
EDI-C-EDI-APP-SECUR-ELTS Object Classes and Attribute Types For outbound messages, the client program should specify OM-S-ONFILE-STRING as the syntax of an attribute when the memory storage space might be insufficient to accommodate the value of the attribute. The client can specify this syntax for specific strings when the accumulated length of the strings might overflow the total string area specified in the max-table-data parameter of the GPI_INITIALIZE_ procedure call.
EDI-C-EDI-APP-SECUR-ELTS Object Classes and Attribute Types Table 3-100. EDI-C-EDI-APP-SECUR-ELTS Attributes—Additional Characteristics Attribute Type Value Characteristics EDI-T-EDI-APP-SECUR-ELEMENT Max. Value Length: EDI-VL-APP-SECUR-ELEMENT OM-T-CLASS Max. Value Length: ZGPI-EDI-CLASS-OBJ-ID-LEN Meanings of Attributes The attribute types specify the following information: EDI-T-EDI-APP-SECUR-ELEMENT Indicates the application security elements referred to in this class.
EDI-C-EDI-BODYPART Object Classes and Attribute Types Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings, regardless of their actual length: that is, they are treated as if they were longer than the specification of the max-string-len parameter of GPI_INITIALIZE_. Thus, you can use only the procedure calls GPI_OM_READ_ and GPI_OM-WRITE_ to read and write the values of strings that have the syntax OM-S-ONFILE-STRING.
EDI-C-EDI-EXTENSION Object Classes and Attribute Types For outbound messages, the client program should specify OM-S-ONFILE-STRING as the syntax of an attribute when the memory storage space might be insufficient to accommodate the value of the attribute. The client can specify this syntax for specific strings when the accumulated length of the strings might overflow the total string area specified in the max-table-data parameter of the GPI_INITIALIZE_ procedure call.
Object Classes and Attribute Types EDI-C-EDI-HEADING Meanings of Attributes The attribute types specify the following information: EDI-T-CRITICALITY Indicates whether the extension is critical for acceptance of responsibility. An extension marked as non-critical (criticality set to OM-FALSE) may be ignored or discarded, while an extension marked as critical must be known and performed for acceptance of responsibility of an EDIM. EDI-T-EXTENSION-TYPE Indicates the type of the extension.
EDI-C-EDI-HEADING Object Classes and Attribute Types Table 3-105 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-105.
EDI-C-EDI-HEADING Object Classes and Attribute Types Table 3-105. EDI-C-EDI-HEADING Attributes—General Characteristics (page 2 of 2) Value Length Number of Values Attribute Type Value Syntax EDI-T-SERVICE-STRINGADVICE OM-S-OBJECT (EDI-C-SERV-STRINGADVICE) -- 0-1 EDI-T-SYNTAX-ID OM-S-OBJECT (EDI-C-SYNTAX-ID) -- 0-1 OM-T-CLASS OM-S-OBJECT-ID-STRING 7 1 Some attribute types have additional value characteristics, as shown in Table 3-106. Table 3-106.
Object Classes and Attribute Types EDI-C-EDI-HEADING EDI-T-APP-REFERENCE Provides a general reference to a client application. EDI-T-DATE-AND-TIME-OF-PREP Indicates the date and time of preparation of the EDIM. EDI-T-CROSS-REFERENCING-INFO Allows an EDI application to reference individual body parts within the same EDIM or within other EDIMs. It contains a set of cross reference data.
EDI-C-EDI-HEADING Object Classes and Attribute Types complies. The MTS uses this information, if the recipient EDI-UA has registered delivery restrictions on encoded information types, to decide if it can deliver the EDIM. EDI-T-EDI-MSG-TYPE Indicates the EDI message types present in the EDIM. The values of this attribute are distinct strings that identify the message types defined.
Object Classes and Attribute Types EDI-C-EDI-NOTIF-REQUESTS EDI-T-THIS-EDIM Identifies the EDIM. EDI-T-RECIPS Identifies the users and distribution lists that are the preferred recipients of the EDIM and specifies whether notification requests are desired. The values of this attribute are objects of the EDI-C-RECIPS class, one object for each recipient. EDI-T-RESPONS-FORWARD Indicates whether responsibility was forwarded.
EDI-C-EDI-NOTIF-REQUESTS Object Classes and Attribute Types Table 3-107 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-107.
Object Classes and Attribute Types EDI-C-EDIM Meanings of Attributes The attribute types specify the following information: EDI-T-FORWARD-NOTIF Requests a forwarded notification (FN) that reports responsibility of an EDIM has been forwarded together with the EDIM. EDI-T-NEGATIVE-NOTIF Requests a negative notification (NN) that reports an entity has refused to accept responsibility of an EDIM.
EDI-C-EDIM Object Classes and Attribute Types parts. The primary body part contains a single EDI interchange that may be original (EDI-C-EDI-BODYPART) or may be contained in a forwarded EDIM (EDI-C-EDIMBODYPART). Additional body parts may contain information associated with the EDI interchange, such as drawings or explanatory text. Table 3-109 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-109.
EDI-C-EDIM-BODYPART Object Classes and Attribute Types EDI-C-EDIM-BODYPART This class of object contains a forwarded EDIM. When an EDIM is forwarded, its structure shall comply with the rules given in the EDI messaging standards. Table 3-111 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-111.
Object Classes and Attribute Types EDI-C-EDIM-EX-DF-BODYPART the latter case, the OM-S-OBJECT-ID-STRING and EDI-T-BODYPART-REFERENCE of the removed body part are preserved. From the IM-T-EXTERNAL-PARAMETERS attribute (if present) and IM-T-EXTERNAL-DATA attribute of the removed body part, only the object identifier and the identifier octets of the appropriate encoding attribute of the OM-C-EXTERNAL object are preserved.
EDI-C-EDIM-EX-DF-BODYPART Object Classes and Attribute Types Table 3-113.
EDI-C-EDIM-ID Object Classes and Attribute Types EDI-T-EX-BODYPART The content of the body part. The value of this attribute is an instance of the class IM-CEXTERN-DEFINED-BODY-PART which is part of the IM package. EDI-C-EDIM-ID This class of object identifies an EDIM. It contains an O/R name and a string which may contain a time, sequence number, or other information sufficient to uniquely identify an EDIM.
EDI-C-EDIN-RECEIVER Object Classes and Attribute Types 3 Object Classes and Attribute Types EDI-C-EDIN-RECEIVER This class of object identifies the recipient to whom EDINs are to be sent. The object is created by the originator of the EDIM when the recipient of a requested notification is different from the originator of the message. Table 3-117 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-117.
EDI-C-FN-PDAU-REASON-CODE Object Classes and Attribute Types Implementation and Usage Note • The EDI-T-ORIGINAL-EDIM-ID and EDI-T-FIRST-RECIP attributes must not be present when the primary body part is an EDI body part (EDI-C-EDI-BODYPART). The EDI-T-ORIGINAL-EDIM-ID and EDI-T-FIRST-RECIP attributes are included in order to allow the recipient to construct the EDIN for a forwarded EDIM.
EDI-C-FN-UAMS-REASON-CODE Object Classes and Attribute Types EDI-C-FN-UAMS-REASON-CODE This class of object indicates why the subject EDIM could not be passed to the user by the EDI-UA or EDI-MS originating the forwarded notification (FN). An object of this class contains reasons indicated by the EDI-UA or EDI-MS for issuing the forwarded notification. Table 3-121 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-121.
EDI-C-FN-USER-REASON-CODE Object Classes and Attribute Types EDI-T-DIAGNOSTIC Provides additional detail to supplement the basic code. EDI-T-FN-SECUR-CHECK Indicates whether all security features present have been validated. EDI-C-FN-USER-REASON-CODE This class of object indicates why the subject EDIM could not be passed to the user by the EDI-UA, EDI-MS, or PDAU originating the forwarded notification (FN).
EDI-C-FORWARD-NOTIF Object Classes and Attribute Types Meanings of Attributes EDI-T-BASIC-CODE Provides the basic reason the user could not process the EDIM. EDI-T-DIAGNOSTIC Provides additional detail to supplement the basic code. This is a user-defined integer in the range 1 through 32767. The meaning of this optional field is agreed on by the originator and recipient of the EDIN.
EDI-C-FORWARD-NOTIF Object Classes and Attribute Types Table 3-125. EDI-C-FORWARD-NOTIF Attributes—General Characteristics (page 2 of 2) Attribute Type Value Syntax Value Length Number of Values EDI-T-SUBJECT-EDIM OM-S-OBJECT (EDI-C-EDIM-ID) -- 1 EDI-TSUPPLEMENTARYINFO OM-S-TELETEX-STRING 1-512 0-1 OM-T-CLASS OM-S-OBJECT-ID-STRING 7 1 Some attribute types have additional value characteristics, as shown in Table 3-126. Table 3-126.
Object Classes and Attribute Types EDI-C-INTER-SENDER-RECIP EDI-T-FN-REASON-CODE Indicates why the subject EDIM could not be processed by an EDI-UA, EDI-MS, or PDAU or its associated user. Additional information may be carried in EDI-T-SUPPLEMENTARY-INFO. EDI-T-FN-NOTIF-EXTENSIONS Reserves space for future extensions to the notification. EDI-T-FORWARD-TO Indicates the O/R name of the recipient to whom the EDIM is forwarded. EDI-T-NOTIF-EXTENSIONS Reserves space for future extensions to the notification.
EDI-C-NEGATIVE-NOTIF Object Classes and Attribute Types Table 3-127. EDI-C-INTER-SENDER-RECIP Attributes—General Characteristics Attribute Type Value Syntax Value Length Number of Values EDI-T-IDENTIFICATION-CODE OM-S-TELETEX-STRING 1-70 1 EDI-T-IDENTIFICATION-CODE-Q OM-S-TELETEX-STRING 1-8 0-1 EDI-T-ROUTING-ADDRESS OM-S-TELETEX-STRING 1-28 0-1 OM-T-CLASS OM-S-OBJECT-ID-STRING 7 1 Some attribute types have additional value characteristics, as shown in Table 3-128. Table 3-128.
EDI-C-NEGATIVE-NOTIF Object Classes and Attribute Types Table 3-129 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-129.
Object Classes and Attribute Types EDI-C-NEGATIVE-NOTIF Meanings of Attributes EDI-T-EDIN-INITIATOR Indicates the notification initiator; that is, the entity which caused a notification to be sent. This attribute has one of three values depending on whether the initiator was a user or PDAU (EDI-EI-EX-UA), EDI-UA (EDI-EI-INTERNAL-UA), or EDI-MS (EDI-EIINTERNAL-MS).
EDI-C-NN-PDAU-REASON-CODE Object Classes and Attribute Types EDI-C-NN-PDAU-REASON-CODE This class of object indicates why the subject EDIM could not be forwarded or passed to the user by the PDAU originating the negative notification (NN). An object of this class contains reasons indicated by the PDAU for issuing the negative notification. Table 3-131 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-131.
EDI-C-NN-UAMS-REASON-CODE Object Classes and Attribute Types Meanings of Attributes EDI-T-BASIC-CODE Provides the basic reason the PDAU could not process the EDIM. EDI-T-DIAGNOSTIC Provides additional detail to supplement the basic code. EDI-C-NN-UAMS-REASON-CODE This class of object indicates why the subject EDIM could not be forwarded or passed to the user by the EDI-UA or EDI-MS originating the negative notification (NN).
EDI-C-NN-UAMS-REASON-CODE Object Classes and Attribute Types Some attribute types have additional value characteristics, as shown in Table 3-134. Table 3-134.
EDI-C-NN-USER-REASON-CODE Object Classes and Attribute Types Meanings of Attributes EDI-T-BASIC-CODE Provides the basic reason the EDI-UA or EDI-MS could not process the EDIM. EDI-T-DIAGNOSTIC Provides additional detail to supplement the basic code. EDI-C-NN-USER-REASON-CODE This class of object indicates why the subject EDIM could not be forwarded or passed to the user by the EDI-UA, EDI-MS, or PDAU originating the negative notification (NN).
EDI-C-POSITIVE-NOTIF Object Classes and Attribute Types Meanings of Attributes EDI-T-BASIC-CODE Provides the basic reason the user could not process the EDIM. EDI-T-DIAGNOSTIC Provides additional detail to supplement the basic code. This is a user-defined integer in the range 1 through 32767. The meaning of this optional field is agreed on by the originator and recipient of the EDIN. EDI-C-POSITIVE-NOTIF This class of object reports that responsibility for an EDIM has been accepted.
EDI-C-POSITIVE-NOTIF Object Classes and Attribute Types Table 3-138. EDI-C-POSITIVE-NOTIF Attributes—Additional Characteristics Attribute Type Value Characteristics EDI-T-EDIN-INITIATOR Enumerated Values: EDI-EI-INTERNAL-UA EDI-EI-EX-UA EDI-EI-INTERNAL-MS EDI-T-NOTIF-TIME Max Value Length: EDI-VL-TIME EDI-T-SUPPLEMENTARYINFO Max Value Length: EDI-VL-SUPPLEMENTARY-INFO OM-T-CLASS Max.
EDI-C-RECIP-REFERENCE Object Classes and Attribute Types EDI-T-SUBJECT-EDIM Contains the identifier of the EDIM that is the subject of the notification. EDI-T-SUPPLEMENTARY-INFO Contains optional additional information about the notification. EDI-C-RECIP-REFERENCE This object identifies a reference meaningful to the recipient’s EDI application. Table 3-139 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-139.
EDI-C-RECIPS Object Classes and Attribute Types EDI-C-RECIPS This class of object identifies the users and distribution lists (DLs) that are the preferred recipients of the EDIM. This class also contains attributes used to make certain requests of the recipients including requests for notifications and acknowledgments. Table 3-141 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-141.
EDI-C-RECIPS Object Classes and Attribute Types Table 3-142.
Object Classes and Attribute Types EDI-C-RECIPS EDI-T-COMMS-AGREEMENT-ID Indicates the type of communications agreement controlling the EDI interchange, for example a customs agreement. EDI-T-EDI-NOTIF-REQUESTS Contains requests made of the preferred recipient denoted by the EDI-T-RECIP attribute. Requests may include the type of notification and security constraints on the notification. EDI-T-INTER-RECIP Identifies the EDI interchange recipient. The MC-OR-NAME class is defined in the MH package.
EDI-C-SECUR-ELEMENTS Object Classes and Attribute Types EDI-C-SECUR-ELEMENTS This class is used to indicate whether proof or non-repudiation of content received, or EDI application security services are required for the notification. For detailed information about these security options, refer to CCITT Recommendation X.411|ISO/IEC 10021-4. Table 3-143 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-143.
EDI-C-SERV-STRING-ADVICE Object Classes and Attribute Types EDI-C-SERV-STRING-ADVICE This class of object indicates the service string advice of an EDI interchange. The service string advice is information about how to process the interchange. Table 3-144 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-144.
EDI-C-SYNTAX-ID Object Classes and Attribute Types EDI-T-RESERVED Reserved for future use. EDI-T-SEGMENT-TERMINATOR Indicates the character used to terminate a data segment (a segment consists of a uniform number of data elements). EDI-C-SYNTAX-ID This class of object indicates the syntax used in an EDI interchange. Table 3-146 describes the attribute types for this class and the syntax, length, and number of values for each type. Table 3-146.
Object Classes and Attribute Types EDI-C-SYNTAX-ID OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 3 -180
4 Procedure Calls This section contains detailed reference information about the GPI procedures provided with the OSI/MHS GPI subsystem. The information includes: • • • • A description of each procedure The syntax of each procedure Parameter descriptions for each procedure Considerations (added information about the procedure) Before using this section, you should be familiar with the material in Section 2, Information Architecture and Data Structures, and Section 3, Object Classes and Attribute Types.
Procedure Names and Categories Procedure Calls The GPI procedures fall into three major categories: • • • GPI environment management procedures enable you to initialize and manage a GPI session and retrieve information about error conditions. The names of these procedures have only the GPI_ prefix. GPI object management procedures enable you to create, manage, and examine objects. The names of these procedures have the prefix GPI_OM_.
Procedure Call Descriptions Procedure Calls Table 4-3. GPI Message Transfer Procedures Procedure Name Purpose GPI_MT_FINISH_TRANSFER_IN_ Changes the state of a reserved object by either removing it permanently from the GPI service’s input queue, moving it from the input queue to the archive queue, making it unreserved and leaving it in the input queue, or removing it from the input queue and resubmitting it to the MTA.
Procedure Call Descriptions Procedure Calls Figure 4-1. Sample GPI Procedure Call Description 1 2 3 status := GPI_OM_CREATE_ ( , , , , , , status class initialize object [root-object] [session] ) ; [class-obj-id ] [class-obj-id-len ] ) ; 4 ! ! ! ! ! ! ! I I 0 I I I I returned value INT:value indicates the outcome of the call ... 5 class input 6 INT:value 7 is an integer that identifies ... Legend 1 2 3 This indicates the type of value that the procedure returns.
Procedure Call Descriptions Procedure Calls Figure 4-2. Sample GPI Procedure Call Description (continued) 5 This line indicates whether the parameter is an input or an output parameter (or both). 6 This line indicates the parameter type, which begins with one of the following: INT INT(32) STRING integer (one word) doubleword integer string Next, the following notation can appear: .EXT means that the parameter is a reference parameter accessed by an extended pointer.
GPI_CLOSE_ Procedure Calls GPI_CLOSE_ This procedure ends a GPI session between a client and the GPI service. status := GPI_CLOSE_ ( session ) ; status ! I returned value INT:value indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a successful call. For additional values of status, see Appendix B, Return Codes. session input INT:value specifies the session identifier of the established GPI session to be ended.
GPI_INITIALIZE_ Procedure Calls GPI_INITIALIZE_ This procedure sets up an environment that allows other GPI procedures to operate correctly. You should call this procedure before calling any other GPI procedure in your client application program. status := GPI_INITIALIZE_ ( status [ swap-volume ] , [ max-table-entries ] , [ max-table-data ] , [ max-string-length ] ) ; ! ! ! ! I I I I returned value INT:value indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a successful call.
GPI_INITIALIZE_ Procedure Calls In addition to specifying maximum length of string data space for object trees, max-table-data specifies the maximum size of inbound and outbound messages that can be handled without using a temporary file. The value of maxtable-data cannot exceed 10,485,760. If max-table-data has a value in the range from the minimum allowed (2,048) through the default value (2,097,152), messages with size greater than 2MB will be transferred through use of a temporary file.
Procedure Calls GPI_INITIALIZE_ also limited by the amount of string data space used by the object trees, which must fit in a 134,217,727-byte segment (with some space reserved for GPI internal information). If you use the default values for max-table-entries and maxtable-data, you can have as many as 15 root objects.
GPI_MT_FINISH_TRANSFER_IN_ Procedure Calls GPI_MT_FINISH_TRANSFER_IN_ This procedure changes the state of a reserved object. There are four options. You can remove the object permanently from the GPI service’s input queue, move the object from the input queue to the archive queue, make the object unreserved and leave it in the input queue, or remove the object from the input queue and resubmit it to the MTA.
GPI_MT_FINISH_TRANSFER_IN_ Procedure Calls If you omit this parameter, the default value is OM-FALSE. input all INT(32):value specifies whether you want to change the state of all currently reserved objects or only the object specified in the object parameter. The value can be: OM-TRUE specifies that the procedure operates on all currently reserved objects. OM-FALSE specifies that the procedure operates on only one object. If you omit this parameter, the default value is OM-FALSE.
Procedure Calls • • GPI_MT_FINISH_TRANSFER_IN_ If you specify OM-TRUE for the all parameter, objects not processed before an error condition occurs remain as reserved objects on the input queue. Objects processed before the error occurs are removed and become the responsibility of the client. If the status parameter is ZGPI-RC-TMF-ERROR, the object is deleted from the memory space of the GPI library and placed back on the input queue, as if you specified MH-CANCEL for the remove parameter.
GPI_MT_START_TRANSFER_IN_ Procedure Calls GPI_MT_START_TRANSFER_IN_ This procedure reserves an object in the input queue and makes that object available to your client application. The object can be a message, probe, report, or a P1-encoded PDU. You can examine but not modify the reserved object. status := GPI_MT_START_TRANSFER_IN_ ( session , object ) ; , [ encoded ] , [ tag ] , [ max-in-memory-string-len ]); ! ! ! ! ! I O I I I returned value status INT:value indicates the outcome of the call.
GPI_MT_START_TRANSFER_IN_ Procedure Calls tag input INT(32) is a reserved parameter and should not be specified. max-in-memory-string-len input INT(32) specifies the maximum length for a string that the Gateway Interface Process can write to the in-memory string area. Strings of a greater length are written to a temporary file. The minimum value you can assign to max-in-memory-string-len is 512 bytes. The maximum value is 8 megabytes. The default value is 8 megabytes.
Procedure Calls GPI_MT_START_TRANSFER_IN_ Instead, the GIP writes such strings to a temporary file and sets the string syntax to OM-S-ONFILE-STRING in the object tree. Whenever the GIP finds that the in-memory string length is exceeded (that is, it is greater than max-string-length specified in GPI_INITIALIZE_), it attempts to copy the string to the temporary file even if the length of the string is less than max-in-memory-string-length specified in GPI_MT_START_TRANSFER_IN_.
GPI_MT_TRANSFER_OUT_ Procedure Calls GPI_MT_TRANSFER_OUT_ This procedure adds an object to the output queue of the GPI service. The object must be a message, probe, report, or P1-encoded object and must not be reserved. You can retain the object and add a copy to the output queue. If you do not retain the object, the GPI service assumes responsibility for it, and you have no more access to it.
GPI_MT_TRANSFER_OUT_ Procedure Calls input retain INT(32):value specifies whether you want to retain the object after this procedure call completes. The value can be: OM-TRUE specifies that the object is to be retained and a copy of the object is to be transferred out. All client program resources associated with the retained object remain allocated. The object is the responsibility of the client application, which can examine and modify the object.
GPI_MT_WAIT_ Procedure Calls GPI_MT_WAIT_ This procedure monitors the input queue of the GPI service for a specified time interval to determine whether any unreserved objects are available. status := GPI_MT_WAIT_ ( , , session interval available ) ; ! I ! I ! O returned value status INT:value indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a successful call. For additional values of status, see Appendix B, Return Codes.
Procedure Calls GPI_MT_WAIT_ Considerations • • You should not issue a call to GPI_MT_WAIT__ within a current TMF transaction defined in your program, because the wait can be extensive and transactions should not be outstanding for a long period of time. GPI_MT_WAIT_ does not make use of your transaction. If multiple GPI_MT_WAIT_ calls are made that refer to the same input queue (gateway), each call receives an indication when a new communication is available.
GPI_OM_COPY_ Procedure Calls GPI_OM_COPY_ This procedure creates a new object that is an exact but independent copy of a specified object. The new object includes all subobjects of the object you are copying. status := GPI_OM_COPY_ ( status original , copy , [ copy-root-object ] , [ copy-session ] ) ; ! ! ! ! I O I I returned value INT:value indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a successful call. For additional values of status, see Appendix B, Return Codes.
Procedure Calls GPI_OM_COPY_ Considerations • • • You can copy a reserved object. You can modify the newly created copy in the same way you modify an object created by GPI_OM_CREATE_. If you copy an inbound object and do not remove the local identifier attribute of the MTS identifier object, the local identifier will be used again by the GPI if you transfer the object out to an X.400 MTA.
GPI_OM_CREATE_ Procedure Calls GPI_OM_CREATE_ This procedure creates a new object of a specified class. The GPI allocates the required resources to represent the object and then, optionally, adds to the object those attributes and their values that are defined by their class as having initial values.
GPI_OM_CREATE_ Procedure Calls root-object input INT(32):value specifies the object identifier of the root object with which the new object is to be associated. The specified root object must already exist. If the object you are creating is not a root object, you must specify a value for this parameter. If you are creating a root object, this parameter is ignored. session input INT:value specifies the session identifier of the session in which the object is being created.
Procedure Calls • • GPI_OM_CREATE_ Before you transfer an object out to the GPI service output queue, the object must be completely defined. Any subobjects you have created and associated with the root object (by using the root-object parameter) must be inserted by a call to GPI_OM_INSERT_. If class-obj-id specifies an object class of the electronic data interchange package, then specify ZGPI-EDI-CLASS-OBJ-ID-LEN as the value of the object identifier length in the class-obj-id-len parameter.
GPI_OM_DELETE_ Procedure Calls GPI_OM_DELETE_ This procedure deletes an object by invalidating the object identifier and releasing all resources allocated by the GPI for the object. All subobjects of the deleted object are also deleted. status := GPI_OM_DELETE_ ( object ) ; status ! I returned value INT:value indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a successful call. For additional values of status, see Appendix B, Return Codes.
GPI_OM_EXAMINE_ Procedure Calls GPI_OM_EXAMINE_ This procedure informs you about the types of single-valued and multivalued attributes of an object and, optionally, the syntax and values of single-valued attributes that have a value present. You can request the attribute descriptors of one or more attributes beginning at a specified attribute position.
GPI_OM_EXAMINE_ Procedure Calls maximum-number input INT(32):value specifies the number of attribute descriptors to be returned. If the value of this parameter exceeds the number of attributes available, the number available is used. The maximum value for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT (10,240). To determine the total number of attributes in the object without retrieving any attribute descriptors, specify 0 as the value of this parameter.
GPI_OM_EXAMINE_ Procedure Calls You must include this parameter if you specify a value greater than 0 for the string-buffer-length parameter. string-buffer-length input INT(32):value specifies the maximum number of octets of string data that string-buffer can contain. The minimum value you can specify is 0. You must specify this parameter if you specify the string-buffer parameter. actual-string-length output INT(32) .EXT:ref:1 is the actual number of octets of string data returned.
Procedure Calls GPI_OM_EXAMINE_ (string-buffer-length) or examine only one attribute by specifying its attribute position and maximum-number value of 1. If an attribute following one for which a value is not returned has a shorter string value that fits in the buffer, that value is returned. You should continue examining the descriptor list after detecting OM-ELEMENTS-UNSPECIFIED to check the remaining contents of the string buffer.
GPI_OM_FETCH_ Procedure Calls GPI_OM_FETCH_ This procedure indicates whether specific attributes are present in an object. Optionally, you can request the syntax and values of single-valued attributes that have a value present.
GPI_OM_FETCH_ Procedure Calls descriptor-count input INT(32):value specifies the number of attribute descriptors you are supplying. The minimum value for this parameter is ZGPI-MIN-DESCRIPTOR-COUNT (1). The maximum value for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT (10,240). descriptor-list-out output STRING .EXT:ref:* is a buffer in your program’s memory space to which you want the attribute descriptors returned.
GPI_OM_FETCH_ Procedure Calls Considerations • GPI_OM_FETCH_ arranges the descriptors in the descriptor-list-out buffer in the same order as the descriptors in the descriptor-list-in buffer. To determine whether an attribute is present, check the output descriptor type field. If the attribute is present, the type from the input list is copied to the output list. If the attribute is not present, the type is OM-T-UNSPECIFIED (and the value field is undefined).
GPI_OM_INSERT_ Procedure Calls GPI_OM_INSERT_ This procedure adds attribute values to an object. You cannot add values to a reserved object. A single call to this procedure can either insert a list of single-valued attributes or a list of multivalued attributes of the same type, or both. status := GPI_OM_INSERT_ ( status object , value-position , descriptor-list , descriptor-count ) ; ! ! ! ! I I I I returned value INT:value indicates the outcome of the call.
Procedure Calls GPI_OM_INSERT_ specified type, and the value must satisfy the value length limits for the object’s class. For lists of types allowed for specific classes, see Section 3, Object Classes and Attribute Types. GPI_OM_INSERT_ does some checking of the actual syntax of a value in relation to the syntax represented by the integer in the syntax field of the descriptor. The final checking is done when you transfer the root object out to the GPI service.
GPI_OM_LIST_ Procedure Calls GPI_OM_LIST_ This procedure retrieves the values of a multivalued attribute of an object. The procedure returns a single attribute descriptor for each value. You can limit the request to a specific number of values, beginning at a specific position. This is the only way to retrieve the values of a multivalued attribute.
GPI_OM_LIST_ Procedure Calls To determine the total number of values in the attribute without retrieving any attribute descriptors, specify 0 as the value of this parameter. The total number of values in the attribute is returned in the total-number parameter. descriptor-list output STRING .EXT:ref:* is a buffer in your program’s memory space to which you want the attribute descriptors returned.
GPI_OM_LIST_ Procedure Calls actual-string-length output INT(32) .EXT:ref:1 is the actual number of octets of string data returned. If the procedure call is unsuccessful, the parameter is unchanged. total-string-length output INT(32) .EXT:ref:1 is the total number of octets of string data available in the attribute descriptors of the attributes you requested with respect to the maximum-number or value-position parameters.
GPI_OM_READ_ Procedure Calls GPI_OM_READ_ This procedure reads a segment of a long string value of a specified type of attribute. A segment is a portion of a string made up of zero or more contiguous octets of its representation. You should call this procedure as many times as needed to read all segments of the value. Each call returns a next position, which you can use as the starting position for the next call.
GPI_OM_READ_ Procedure Calls On output, string-offset is the offset (in octets) of the start of the next string segment to be read or 0 if the value contains no more segments to be read. You can use the returned string-offset value in the next GPI_OM_READ_ call. If the procedure call is unsuccessful, the parameter value is unchanged. maximum-number input INT(32):value specifies the maximum number of octets to read.
GPI_OM_REMOVE_ Procedure Calls GPI_OM_REMOVE_ This procedure removes and discards values of an attribute of an object. You cannot remove values from a reserved object.
GPI_OM_REMOVE_ Procedure Calls To determine the total number of values in the attribute without removing any values, specify 0 as the value of this parameter. The total number of values in the attribute is returned in the total-number parameter. total-number output INT(32) .EXT:ref:1 is the total number of values in the attribute before the current remove operation. If the procedure call is unsuccessful, the parameter is unchanged.
GPI_OM_WRITE_ Procedure Calls GPI_OM_WRITE_ This procedure writes a segment of a string value to a specified type of attribute. A segment is a portion of a string made up of zero or more contiguous octets of its representation. Typically, this procedure is used to add to an attribute value an arbitrarily long value, such as a noninterpersonal message content or large body part.
GPI_OM_WRITE_ Procedure Calls string-offset input, output INT(32) .EXT:ref:1 on input, specifies how a string is to be written, as follows: • • A string offset of ZGPI-NEW-VALUE (-1) specifies that you are adding or inserting a new string value as specified by the value-position parameter. A string offset equal to or greater than 0 specifies that you are appending a string segment to an existing value and possibly overwriting existing octets in the string.
GPI_OM_WRITE_ Procedure Calls If you omit this parameter and the attribute can have more than one syntax, the procedure call fails. Otherwise, the string syntax defined for the attribute type is used. Considerations • Table 4-4 summarizes the ways you can use the GPI_OM_WRITE_ procedure. For each type of write operation, the table indicates what values to specify for the string-offset and value-position parameters. Table 4-4.
Procedure Calls GPI_OM_WRITE_ a performance penalty when the message exceeds memory limits and the GPI library automatically converts the value syntax to ON-S-ONFILE-STRING.
GPI_OPEN_ Procedure Calls GPI_OPEN_ This procedure establishes a session between a client and the GPI service. You must call this procedure to obtain a session identifier before calling any of the object management or message transfer procedures. GPI_OPEN_ also provides the identifier of an object that describes the environment of the local MTA or gateway. You can examine attributes of this object to obtain the information.
GPI_OPEN_ Procedure Calls session output INT.EXT:ref:1 is a valid session identifier that the GPI generates if the call establishes a session successfully. If the call does not succeed, this parameter is unchanged. Use the session identifier when calling the object management and message transfer procedures that require a session parameter. environment output INT(32) .EXT:ref:1 is the object identifier of an object that represents the local environment.
GPI_OPEN_ Procedure Calls gateway-password-length input INT:value specifies the length (in octets) of the gateway-password string. If you specify a gateway password, you must include this parameter. If you omit the gateway password, this parameter is ignored. The minimum value you can specify is 0. Considerations • • • • • • After initializing the environment, you can call the GPI_OPEN_ procedure at any time that your client application needs to start GPI operations with the GPI service and the X.
GPI_STATUS_ Procedure Calls GPI_STATUS_ This procedure provides additional status and error information about the most recently reported GPI failure. You can request information about the most recent failure within the GPI (in any context), within a specified session context, or outside a specified session context.
GPI_STATUS_ Procedure Calls request-type output INT .EXT:ref:1 contains the request type for the most recent GPI error in the specified context. The request type identifies the GPI procedure in which the returned error occurred.
GPI_STATUS_ Procedure Calls error-class output INT .EXT:ref:1 contains the class or category of the most recent GPI error in the specified context. An error class indicates the severity classification of an error. For information about interpreting error classes, see Error Classes on page B-11. primary-code output INT .EXT:ref:1 contains the XAPIA-standard or Compaq proprietary code for the most recent GPI error in the specified context.
GPI_STATUS_ Procedure Calls buffer remains unchanged. For a complete description of the information buffer, see Appendix B, Return Codes. info-buffer-length input INT:value specifies the length (in octets) of the buffer specified by info-buffer. If you specify 0, GPI_STATUS_ returns the total number of octets of error information in the total-info-length parameter. You can use this technique to determine the amount of information available without retrieving it.
A DDL Definitions This appendix contains Data Definition Language (DDL) definitions of the data structures used in parameters to the GPI procedures. The information in this appendix is in DDL format. As part of the OSI/MHS GPI product, you receive the DDL in two forms: • • The equivalent of TAL code (in the file GPIDEFS) is provided for you to include in your TAL program by using the ?SOURCE directive.
First-Level Data Types DDL Definitions OM-SINT16 This data type defines a signed 16-bit integer. DEFINITION OM-SINT16 TYPE BINARY 16. OM-SINT32 This data type defines a signed 32-bit integer. DEFINITION OM-SINT32 TYPE BINARY 32. OM-UINT This data type defines an unsigned 16-bit integer. DEFINITION OM-UINT TYPE BINARY 16 UNSIGNED. OM-UINT16 This data type defines an unsigned 16-bit integer. DEFINITION OM-UINT16 TYPE BINARY 16 UNSIGNED.
First-Level Data Types DDL Definitions OM-CLASS This data type defines a field used for the class of an object. DEFINITION OM-CLASS TYPE OM-UINT16. OM-ENUMERATION This data type defines a field used for enumerated values of attributes. DEFINITION OM-ENUMERATION TYPE OM-SINT32. OM-INTEGER This data type defines a field used for integer values of attributes. DEFINITION OM-INTEGER TYPE OM-SINT32. OM-OBJECT This data type defines a field used for object identifiers.
Second-Level Data Types DDL Definitions Second-Level Data Types The GPI defines second-level data type for fields of attribute descriptors. Second-level (secondary) data types are made from one or more first-level data types, described in First-Level Data Types on page A-2. OM-SYNTAX This data type defines a field for the syntax of an attribute value in an attribute descriptor. DEFINITION OM-SYNTAX TYPE OM-UINT16.
Named Values DDL Definitions Named Values The following pages present named data values defined for use by application programs when calling the GPI procedures. All syntax, object management, message handling, and interpersonal messaging constants are taken from XAPIA-1988 specification unless otherwise stated. Some constants have been abbreviated for this implementation. Symbolic Constants The GPI defines symbolic constants for Boolean values, parameter values, and indicators.
Object Management Classes and Types DDL Definitions OM-S-xxx These syntax constants are used to specify the syntax in an attribute descriptor.
Message Handling Classes and Types DDL Definitions OM-T-xxx These constants define attribute types of the object management package. CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT OM-T-ARBITRARY-ENCODING OM-T-ASN1-ENCODING OM-T-CLASS OM-T-DATA-VALUE-DESCRIPTOR OM-T-DIRECT-REFERENCE OM-T-INDIRECT-REFERENCE OM-T-OCTET-ALIGNED-ENCODING OM-T-UNSPECIFIED VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE IS IS IS IS IS IS IS IS 1. 2. 3. 4. 5. 6. 9. 0.
DDL Definitions Message Handling Classes and Types Note that a different notation is used to encode ASN.1 object identifiers in TAL; for example, in TAL , the first value is: %h56, %h06, %h01, %h02, %h05, %h0B, %h00 CONSTANT MH-C-ALGORITHM VALUE IS "\x56\x06\x01\x02\x05\x0B\x00". CONSTANT MH-C-ALGORITHM-AND-RESULT VALUE IS "\x56\x06\x01\x02\x05\x0B\x01". CONSTANT MH-C-BILATERAL-INFORMATION VALUE IS 203. CONSTANT MH-C-DELIVERY-ENVELOPE VALUE IS 212. CONSTANT MH-C-EITS VALUE IS 213.
Message Handling Classes and Types DDL Definitions MH-T-xxx These constants define attribute types of the message handling package.
Message Handling Classes and Types DDL Definitions CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT
Message Handling Value Limits DDL Definitions CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT MH-T-REPORT-ADDITIONAL-INFO MH-T-REPORT-DESTINATION MH-T-REPORT-EXTERNAL-TRCE-INFO MH-T-REPORT-INTERNAL-TRCE-INFO MH-T-REPORT-MTS-IDENTIFIER MH-T-REPORTING-DL-NAME MH-T-SECURITY-CATEGORY MH-T-SECURITY-CLASSIFICATION MH-T-SECURITY-POLICY-ID MH-T-SUBMISSION-TIME MH-T-SUPPLEMENTARY-INF
Message Handling Value Limits DDL Definitions MH-VL-xxx These constants are used to specify maximum value lengths. The first line shows the complete definition for each constant, which is followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition. CONSTANT MH-VL-xxx TYPE BINARY 32 UNSIGNED VALUE IS x.
Message Handling Enumerated Values DDL Definitions MH-VN-xxx These constants are used to specify the maximum number of values for multivalued attributes. CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT MH-VN-BILATERAL-INFORMATION MH-VN-ENCODED-INFO-TYPES MH-VN-EXPANSION-HISTORY MH-VN-PREFERRED-DELIVERY-MODES MH-VN-RECIPIENT-DESCRIPTORS MH-VN-REPORT-SUBSTANCE MH-VN-TRACE-INFO VALUE VALUE VALUE VALUE VALUE VALUE VALUE IS IS IS IS IS IS IS 512. 8. 512. 10. 32767. 32767. 512.
Message Handling Enumerated Values DDL Definitions MH-BE-xxx These constants define the enumerated values for the MH-T-BUILTIN-EITS attribute.
Message Handling Enumerated Values DDL Definitions MH-CTI-xxx These constants define the enumerated values of syntax OM-S-INTEGER for the MH-T-CONTENT-TYPE attribute. CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT MH-CTI-UNIDENTIFIED MH-CTI-EXTERNAL MH-CTI-P2-1984 MH-CTI-P2-1988 MH-CTI-PEDI TYPE TYPE TYPE TYPE TYPE BINARY BINARY BINARY BINARY BINARY 32 32 32 32 32 VALUE VALUE VALUE VALUE VALUE IS IS IS IS IS 0. 1. 2. 22. 35.
Message Handling Enumerated Values DDL Definitions followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition. CONSTANT MH-EC-xxx CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT TYPE BINARY 32 VALUE IS x.
Message Handling Enumerated Values DDL Definitions which is followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition.
Message Handling Enumerated Values DDL Definitions CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT MH-DG-MAIL-RECIPIENT-DEPARTED MH-DG-MAIL-NEW-ADDRESS-UNKNOWN MH-DG-MAIL-FORWARDING-UNWANTED MH-DG-MAIL-FORWARDING-PROHIB MH-DG-SECURE-MESSAGING-ERROR MH-DG-DOWNGRADING-IMPOSSIBLE ... ... ... ... ... ... VALUE VALUE VALUE VALUE VALUE VALUE IS IS IS IS IS IS 42. 43. 44. 45. 46. 47. MH-RE-xxx These constants define the enumerated values for the MH-T-NON-DELIVERYREASON attribute.
Message Handling Enumerated Values DDL Definitions MH-PTY-xxx These constants define the enumerated values for the MH-T-PRIORITY attribute. CONSTANT MH-PTY-NORMAL CONSTANT MH-PTY-LOW CONSTANT MH-PTY-URGENT TYPE BINARY 32 TYPE BINARY 32 TYPE BINARY 32 VALUE IS 0. VALUE IS 1. VALUE IS 2. MH-TT-xxx These constants define the enumerated values for the MH-T-TERMINAL-TYPE attribute.
DDL Definitions Interpersonal Messaging Classes and Types Interpersonal Messaging Classes and Types The interpersonal messaging constants are used to specify the objects of the interpersonal messaging package. For descriptions of the object classes and attribute types, see Interpersonal Messaging Classes in Section 3. IM-C-xxx These constants define object classes of the interpersonal messaging package.
DDL Definitions Interpersonal Messaging Classes and Types IM-T-xxx These constants define attribute types of the interpersonal messaging package.
DDL Definitions IM-T-IPN-ORIGINATOR IM-T-ISO-6937-REPERTOIRE IM-T-ISO-6937-TEXT IM-T-LINE-ORIENTED-DATA IM-T-MESSAGE-IDENTIFIER IM-T-MESSAGE-INSTRUCTIONS IM-T-MESSAGE-TYPE IM-T-MIXED-MODE-DOCUMENT IM-T-MM-MESSAGE-DATA IM-T-MM-MESSAGE-ENVELOPE IM-T-NATIONAL-DATA IM-T-NON-RECEIPT-REASON IM-T-NOTIFICATION-REQUEST IM-T-OBSOLETED-IPMS IM-T-ORD-DESIGNATOR IM-T-ORD-TYPE IM-T-ORIGINATOR IM-T-ORIGINATOR-IDENTIFIER IM-T-ORIGINATOR-PLAD IM-T-OTHER-RECIP-INDICATOR IM-T-PILOT-FORWARDING-INFO IM-T-PILOT-HANDLING IM-T-PI
DDL Definitions IM-T-TYPE-MESSAGE IM-T-THIS-IPM IM-T-UNIDENTIFIED-DATA IM-T-UNIDENTIFIED-TAG IM-T-USER IM-T-USER-RELATIVE-IDENTIFIER IM-T-VIDEOTEX-DATA IM-T-VIDEOTEX-SYNTAX Interpersonal Messaging Classes and Types VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE IS IS IS IS IS IS IS IS OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 A -23 171. 151. 195. 196. 152. 153. 154. 155.
Interpersonal Messaging Value Limits DDL Definitions Interpersonal Messaging Value Limits Interpersonal messaging constants are also used to specify maximum value lengths. IM-xxx for IM-T-SIC These constants are used to specify minimum and maximum value lengths and the maximum number of values for the attribute IM-T-SIC. he first line shows the complete definition for each constant, which is followed by an abbreviated definition that substitutes ...
Interpersonal Messaging Enumerated Values DDL Definitions IM-xxx (IM-T-ACKNOWLEDGMENT-MODE) These constants define the enumerated values for the IM-T-ACKNOWLEDGMENTMODE attribute. CONSTANT IM-MANUAL CONSTANT IM-AUTOMATIC TYPE BINARY 32 TYPE BINARY 32 VALUE IS 0. VALUE IS 1. IM-xxx (IM-T-DISCARD-REASON) These constants define the enumerated values for the IM-T-DISCARD-REASON attribute.
Electronic Data Interchange (EDI) Classes and Types DDL Definitions IM-xxx (IM-T-NON-RECEIPT-REASON) These constants define the enumerated values for the IM-T-NON-RECEIPT-REASON attribute. CONSTANT IM-IPM-DISCARDED CONSTANT IM-IPM-AUTO-FORWARDED TYPE BINARY 32 TYPE BINARY 32 VALUE IS 0. VALUE IS 1. IM-xxx (IM-T-NOTIFICATION-REQUEST) These constants define the enumerated values for the IM-T-NOTIFICATIONREQUEST attribute.
DDL Definitions Electronic Data Interchange (EDI) Classes and Types EDI-C-xxx These constants define object classes of the electronic data interchange package. The values are ASN.1 object identifiers. Note that a different notation is used to encode ASN.1 object identifiers in TAL; for example, in TAL, the first value is: %h56, %h06, %h01, %h02, %h07, %h01, %h00 CONSTANT EDI-C-AUTHORIZATION-INFO VALUE IS "\x56\x06\x01\x02\x07\x01\x00". CONSTANT EDI-C-CROSS-REF-INFO VALUE IS "\x56\x06\x01\x02\x07\x01\x01".
DDL Definitions Electronic Data Interchange (EDI) Classes and Types CONSTANT EDI-C-EDIM-BODYPART VALUE IS "\x56\x06\x01\x02\x07\x01\x09". CONSTANT EDI-C-EDIM-EX-DF-BODYPART VALUE IS "\x56\x06\x01\x02\x07\x01\x0A". CONSTANT EDI-C-EDIM-ID VALUE IS "\x56\x06\x01\x02\x07\x01\x0B". CONSTANT EDI-C-EDIN-RECEIVER VALUE IS "\x56\x06\x01\x02\x07\x01\x0C". CONSTANT EDI-C-FN-PDAU-REASON-CODE VALUE IS "\x56\x06\x01\x02\x07\x01\x0D". CONSTANT EDI-C-FN-UAMS-REASON-CODE VALUE IS "\x56\x06\x01\x02\x07\x01\x0F".
DDL Definitions Electronic Data Interchange (EDI) Classes and Types EDI-T-xxx These constants define attribute types of the electronic data interchange package.
DDL Definitions EDI-T-BODYPART-PLACE-HOLDER EDI-T-BODYPART-REFERENCE EDI-T-COMMS-AGREEMENT-ID EDI-T-COMPONENT-DATA-ELEMENT-S EDI-T-CRITICALITY EDI-T-CROSS-REFERENCING-INFO EDI-T-DATA-ELEMENT-SEPARATOR EDI-T-DATE-AND-TIME-OF-PREP EDI-T-DECIMAL-NOTATION EDI-T-DELIV-ENVELOPE EDI-T-DIAGNOSTIC EDI-T-EDI-APP-SECUR-ELEMENT EDI-T-EDI-APP-SECUR-ELEMENTS EDI-T-EDI-APP-SECUR-EXTENSIONS EDI-T-EDI-BODYPART-TYPE EDI-T-EDI-ENCRYPTED-PRIMARY-BP EDI-T-EDI-MSG-TYPE EDI-T-EDI-NOTIF-REQUESTS EDI-T-EDI-SUPPLEMENTARY-INFO EDI-T
Electronic Data Interchange (EDI) Classes and Types DDL Definitions EDI-T-ORIGINAL-EDIM-ID EDI-T-PN-NOTIF-EXTENSIONS EDI-T-POSITIVE-NOTIF EDI-T-PRIMARY-BODYPART EDI-T-PROCESSING-PRIORITY-CODE EDI-T-PROOF-OF-NOTIFICATION EDI-T-PROOF-OF-RECEPTION EDI-T-RECIP EDI-T-RECIP-EXTENSIONS EDI-T-RECIP-REFERENCE EDI-T-RECIP-REFERENCE-Q EDI-T-RECIPS EDI-T-RELATED-EDI-MSGS EDI-T-RELATED-NON-EDI-MSGS EDI-T-RELEASE-INDICATOR EDI-T-RESERVED EDI-T-RESPONS-FORWARD EDI-T-RESPONS-PASSING-ALLOWED EDI-T-ROUTING-ADDRESS EDI-T-RS
EDI Forwarded Notification Codes DDL Definitions CONSTANT CONSTANT CONSTANT CONSTANT EDI-BPO-UNTDI-T61 EDI-BPO-UNTDI-OCTET EDI-BPO-PRIVATE-OCTET EDI-BPO-UNDEFINED-OCTET VALUE VALUE VALUE VALUE IS IS IS IS "\x56\x07\x0B\x08". "\x56\x07\x0B\x09". "\x56\x07\x0B\x0A". "\x56\x07\x0B\x0B". EDI-ARO-xxx These constants define action request attributes of the electronic data interchange package. The values are ASN.1 object identifiers. Note that a different notation is used to encode ASN.
EDI Forwarded Notification Codes DDL Definitions EDI-FUMB-xxx These constants specify basic codes related to a user agent or message store (UAMS). The first line shows the complete definition for each constant. This line is followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition.
EDI Negative Notification Codes DDL Definitions EDI Negative Notification Codes A negative notification reports that responsibility of an EDIM has been refused together with the subject EDIM. The negative notification codes indicate why EDIM responsibility has been refused. The notification code constants are contained within the EDI-T-NN-REASON-CODE attribute of the EDI-C-NEGATIVE-NOTIF class. EDI-NPB-xxx These constants specify basic codes related to a physical delivery access unit (PDAU).
EDI Negative Notification Codes DDL Definitions EDI-NUMB-xxx These constants specify basic codes related to a user agent or message store (UAMS). The first line shows the complete definition for each constant. This line is followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition.
EDI Negative Notification Codes DDL Definitions followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition.
EDI Notification Initiator Enumerated Values DDL Definitions EDI-NUB-xxx These constants specify basic codes related to a user. The first line shows the complete definition for each constant. This line is followed by an abbreviated definition that substitutes ... for the TYPE portion of the definition.
GPI External Constants DDL Definitions EDI-EI-xxx CONSTANT EDI-VL-xxx CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT TYPE BINARY 32 EDI-VL-APP-REFERENCE EDI-VL-APP-SECUR-ELEMENT EDI-VL-AUTHORIZATION-INFO EDI-VL-AUTHORIZATION-INFO-Q EDI-VL-COMMS-AGREEMENT-ID EDI-VL-EDI-MSG-TYPE EDI-VL-IDENTIFICATION-CODE EDI-VL-IDENTIFICATION-CODE-Q EDI-VL-INTER-CONTROL-REF EDI-VL-PROC-PRIORITY-CODE EDI-VL-R
GPI External Constants DDL Definitions ZGPI-xxx These names define the GPI external constants. Descriptions of the constants follow the definitions.
DDL Definitions GPI External Constants ZGPI-WAIT-MODE indicates that message transfers should be waited operations. ZGPI-MIN-STATUS-BUF-LEN is the minimum buffer size allocated for the processing status of a GPI request. ZGPI-MAX-STATUS-BUF-LEN is the maximum buffer size allocated for the processing status of a GPI request. ZGPI-MIN-DANGLING-OBJ is the minimum number of dangling objects checked and returned to your program during a message transfer.
DDL Definitions GPI External Constants ZGPI-DEFAULT-OT-TBL-COUNT is the default number of object tree tables allocated when the GPI segment is initialized. ZGPI-GWY-NAME-LEN is the valid length (in octets) of a gateway name. ZGPI-GWY-INSTANCE-NAME-LEN is the valid length (in octets) of a gateway instance name. ZGPI-MAX-GWY-PASSWORD-LEN is the maximum length (in octets) of a gateway password. ZGPI-MIN-GWY-PASSWORD-LEN is the minimum length (in octets) of a gateway password.
DDL Definitions GPI External Constants ZGPI-MAX-OT-DATA-LEN is the maximum length (in octets) of string data space for each object tree. ZGPI-DEFAULT-OT-DATA-LEN is the default length (in octets) of string data space for each object tree. ZGPI-MIN-LONG-STRING-LEN is the minimum value (in octets) that can be specified when defining the upper bound of a short string. The GPI must be initialized such that long strings are at least 1 octet longer than this constant.
DDL Definitions GPI Parameter Positions ZGPI-MAX-CONTENT-LEN is the maximum length that can be specified for the MH-T-CONTENT-LENGTH attribute of the MH-C-PROBE class. Currently, the GPI does not support an X.400 communication that is larger than 10 MB. ZGPI-MIN-CONTENT-LEN is the minimum length that can be specified for the MH-T-CONTENT-LENGTH attribute of the MH-C-PROBE class.
DDL Definitions GPI Parameter Positions OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 A -44
B Return Codes This appendix provides the information you need to check the status of a procedure call and determine the cause of failures.
Standard X.400 API Return Codes Return Codes such as finishing a transfer-in, but the object is not reserved. In this case, you might be able to recover without further information. • Call the GPI_STATUS_ procedure to request more information about the cause of a failure. You can request information about the last error in a specific session, the last procedure call in any session, or the last error that occurred outside a session.
0 OM-RC-SUCCESS Return Codes Table B-1. Return Code Values for Object Management (page 2 of 2) Constant (OM-RC-) Value Meaning PERMANENT-ERROR 20 Service encountered an error condition (more serious than a warning condition). POINTER-INVALID 21 Invalid pointer specified as a parameter (argument). SYSTEM-ERROR 22 Service encountered a GPI or operating system error. TEMPORARY-ERROR 23 Service encountered a temporary error (warning condition).
3 OM-RC-FUNCTION-INTERRUPTED Return Codes 3 OM-RC-FUNCTION-INTERRUPTED Cause. Your program or an operator has taken an action that caused the function to be aborted. The interruption was not caused by a GPI action. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 4 OM-RC-MEMORY-INSUFFICIENT Cause. The GPI service cannot allocate the main memory required to complete the function.
12 OM-RC-NO-SUCH-SYNTAX Return Codes 12 OM-RC-NO-SUCH-SYNTAX Cause. You specified a syntax that is not defined. Effect. The function is not performed. Recovery. Specify one of the DDL names for syntax that is described in the DDL definitions in Appendix A, DDL Definitions.. You can call GPI_STATUS_ , which returns the invalid syntax as the secondary code. 13 OM-RC-NO-SUCH-TYPE Cause. You specified an attribute type that is not defined. Effect. The function is not performed. Recovery.
22 OM-RC-SYSTEM-ERROR Return Codes 22 OM-RC-SYSTEM-ERROR Cause. An error has occurred that requires further examination. For example, the structure of an object tree is damaged or contains invalid information. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix ZGPI-SEC-). The secondary code might also be a Guardian 90 file error code. Take the recovery action recommended for the error class. 23 OM-RC-TEMPORARY-ERROR Cause.
27 OM-RC-WRONG-VALUE-MAKEUP Return Codes 27 OM-RC-WRONG-VALUE-MAKEUP Cause. A value does not conform to the syntax of the attribute or an attribute that is a subobject contains an invalid attribute value. For example, the subobject contains an incorrect O/R name. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix ZGPI-WVMC-). Take the recovery action recommended for the error class.
100 MH-RC-FEATURE-CONFLICTS Return Codes Table B-2. Return Code Values for Message Handling Constant (MH-RC-) Value Meaning FEATURE-CONFLICTS 100 Requested feature conflicts with existing session feature. NOT-RESERVED 106 Specified object not reserved. NOT-UNRESERVED 107 Specified object is reserved. QUEUE-EMPTY 109 No objects in input queue awaiting transfer in. SESSION-BUSY 110 Exceeded maximum number of transfers in. SESSION-NOT-BUSY 111 No transfer-in operations in progress.
109 MH-RC-QUEUE-EMPTY Return Codes 109 MH-RC-QUEUE-EMPTY Cause. The input queue does not contain any objects that are ready to be transferred in. Effect. No action is taken. Recovery. Call the GPI_MT_WAIT_ procedure again. 110 MH-RC-SESSION-BUSY Cause. The session cannot accommodate any more objects being transferred in. The maximum number of root objects that can be processed at a time (regardless of the number of open sessions) is 15.
GPI_STATUS_ Information Return Codes GPI_STATUS_ Information When your program calls GPI_STATUS_ , the following types of information are returned: Request type Indicates the GPI procedure in which the most recent error occurred. Error class Indicates the severity of an error and the recommended recovery action. Old status Is the status returned to the procedure that caused the error, usually an XAPIA standard return code (OM-RC- or MH-RCcode).
Error Classes Return Codes Table B-3.
0 ZGPI-RC-CLASS-SUCCESS Return Codes Table B-4. Error Class Values (page 2 of 2) Constant (ZGPI-RC-CLASS-) Value Meaning FAILED 30 Procedure failed due to a client or GPI problem, or a partial inbound communication was transferred, but the calling program can continue processing. CLIENT 40 Client program error such as invalid parameter occurred. BLOCKED-INT 50 Session is unusable because of internal problem.
30 ZGPI-RC-CLASS-FAILED Return Codes 30 ZGPI-RC-CLASS-FAILED Cause. A failure occurred that might be caused by your client program or a GPI problem. For example, the GPI environment you specified by using GPI_INITIALIZE_ might not satisfy your application needs. A partial communication might have been transferred. Effect. The function is not performed. The condition might be temporary. Recovery.
70 ZGPI-RC-CLASS-FATAL Return Codes including the installed software release IDs, and make sure the necessary SCF objects are in the correct state. Reset your applications’ session environment and open a new session. 70 ZGPI-RC-CLASS-FATAL Cause. A failure occurred from which your program can recover only by reinitializing the GPI environment. For example, the GPI cannot access its reserved extended segment. Effect. All GPI retained memory structures for all current sessions are lost. Recovery.
2000 ZGPI-RC-MISSING-REQUIRED-PARAM Return Codes Table B-5. ZGPI-RC- Codes for Parameter-Validation Errors Constant (ZGPI-RC-) Value Meaning PARAMETER-OUT-OF-RANGE 2003 Parameter value not within valid range. INT-PARAM-OUT-OF RANGE 2004 Internal parameter value not within valid range. INT-PARAM-OUT-OF-BOUND 2005 Internal parameter length or address is incorrect. MISSING-INT-OPT-PARAM 2006 Optional internal parameter (required because of presence of another parameter) is missing.
2003 ZGPI-RC-PARAMETER-OUT-OF-RANGE Return Codes 2003 ZGPI-RC-PARAMETER-OUT-OF-RANGE Cause. The value of a parameter is not within the range of values allowed. (This code can be returned as the status of GPI_INITIALIZE_ and GPI_STATUS_ .) Effect. The function is not performed. Recovery. Revise the parameter value. You can call GPI_STATUS_ and check the secondary code, which indicates the position of the parameter that is out of range.
2008 ZPGI-RC-CLASS-ERROR Return Codes Table B-6. ZGPI-RC- Codes for GPI-Internal Errors Constant (ZGPI-RC-) Value Meaning EXCEEDED-MAX-OT-COUNT 2100 No more root objects can be created at this time. FOUND-DANGLING-OBJECT 2101 Created subobject not inserted as an attribute of the root object. BUF-ELMT-NOT-FOUND 2200 GPI internal protocol elements cannot be found in the IPC buffer. BAD-IPC-BUF 2201 IPC buffer contains invalid GPI internal protocol elements.
2100 ZGPI-RC-EXCEEDED-MAX-OT-COUNT Return Codes Recovery. Determine whether the value syntax OM-S-ONFILE-STRING is supported for the attribute or that enough disk space is available for the message. 2100 ZGPI-RC-EXCEEDED-MAX-OT-COUNT Cause. The maximum number of object trees allowed by the GPI will be exceeded if you create, copy, or transfer in an object. Effect. Your request is rejected. Recovery. Delete, transfer out, or finish transferring in some other object, and then try this operation again.
2203 ZGPI-RC-BAD-GRP-HDR-TYPE Return Codes 2203 ZGPI-RC-BAD-GRP-HDR-TYPE Cause. The GPI internal protocol element returned by the GIP is not the correct one for the GPI procedure you called. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 2204 ZGPI-RC-BAD-GRP-HDR-LEN Cause. The length of a GPI internal protocol element returned by the GIP does not match the total length expected by the GPI library.
2209 ZGPI-RC-BAD-SESSION-ID Return Codes Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 2209 ZGPI-RC-BAD-SESSION-ID Cause. The specified session identifier is not the one expected for the session. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 2210 ZGPI-RC-INVALID-MGR-NAME Cause.
2501 ZGPI-RC-WRITEREADX-ERROR Return Codes Table B-7. ZGPI-RC- Codes for Guardian 90 Procedure Errors (page 2 of 2) Constant (ZGPI-RC-) Value Meaning FNAME32COLLAPSE-ERROR 2510 Guardian 90 FNAME32COLLAPSE procedure error occurred. FNAMEEXPAND-ERROR 2511 Guardian 90 FNAMEEXPAND procedure error occurred. RESIZESEGMENT-ERROR 2512 Guardian 90 RESIZESEGMENT procedure error occurred. SSGET-ERROR 2513 Guardian 90 SSGET procedure error occurred.
2503 ZGPI-RC-ALLOCATESEGMENT-ERROR Return Codes Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class. 2503 ZGPI-RC-ALLOCATESEGMENT-ERROR Cause. An error occurred during a GPI call to the Guardian 90 ALLOCATESEGMENT procedure. (This code can be returned as the status of GPI_INITIALIZE_ .) Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class.
2508 ZGPI-RC-MOVEX-ERROR Return Codes Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class. The secondary code contains the GPI internal pool ID. 2508 ZGPI-RC-MOVEX-ERROR Cause. An error occurred during a GPI call to the Guardian 90 MOVEX procedure. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class. 2509 ZGPI-RC-READUPDATEX-ERROR Cause.
2513 ZGPI-RC-SSGET-ERROR Return Codes 2513 ZGPI-RC-SSGET-ERROR Cause. An error occurred during a GPI call to the Guardian 90 SSGET procedure. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class. 2514 ZGPI-RC-SSGETTKN-ERROR Cause. An error occurred during a GPI call to the Guardian 90 SSGETTKN procedure. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class.
2519 ZGPI-RC-BEGINTRANSACTION-ERROR Return Codes 2519 ZGPI-RC-BEGINTRANSACTION-ERROR Cause. An error occurred during a GPI call to the Guardian 90 BEGINTRANSACTION procedure. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the error class. Follow the recommended recovery procedure for the error class. 2520 ZGPI-RC-GETTMPNAME-ERROR Cause. An error occurred during a GPI call to the Guardian 90 GETTMPNAME procedure. Effect. The function is not performed. Recovery.
4000 ZGPI-RC-SEGMENT-ALREADY-IN-USE Return Codes Table B-8. ZGPI-RC- Codes for GPI-Library Errors (page 2 of 2) Constant (ZGPI-RC-) Value Meaning NO-OUTPUT-FROM-GIP 4005 Expected output parameters not returned from GIP process. STRING-TOO-LONG 4006 Long string must be accessed by GPI_OM_READ_ or GPI_OM_WRITE_. OT-COUNT-MISMATCH-TBL 4007 GPI internal statistics and object tree are not synchronized. EXCEEDED-RESERVED-OTS 4008 Maximum number of TMF transactions exceeded.
4005 ZGPI-RC-NO-OUTPUT-FROM-GIP Return Codes 4005 ZGPI-RC-NO-OUTPUT-FROM-GIP Cause. The GPI did not receive any output parameters from the GIP although the status indicates the procedure operated successfully. Effect. The session is unusable. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action for the error class. 4006 ZGPI-RC-STRING-TOO-LONG Cause. The string is a long string according to the length you specified in GPI_INITIALIZE_.
4011 ZGPI-RC-SPI-CMD-ERROR Return Codes Effect. A session could not be established. Recovery. You can call GPI_STATUS_ and check the secondary code, which contains the Guardian 90 file-system error code. Check the operational environment. Try reinitializing the GPI. 4011 ZGPI-RC-SPI-CMD-ERROR Cause. The MHS manager process reported an error. Effect. A session could not be established. Recovery. You can call GPI_STATUS_ and check the secondary code, which contains the SPI error code.
5000 ZGPI-RC-OBJ-ALREADY-ATTACHED Return Codes Table B-9. ZGPI-RC- Codes for Object Tree Management Errors Constant (ZGPI-RC-) Value Meaning ATT-MTA-NAME-ERROR 5005 Values of MH-T-ATTEMPTED- and MH-T-ACTION attributes inconsistent in internal trace object. MD-NAME-ERROR 5006 Values of MH-T-ATTEMPTED- and MH-T-ACTION attributes inconsistent in internal or external trace object. BAD-STRING-OFFSET 5007 Specified offset in GPI_OM_WRITE_ call is not within current bounds of the string.
5005 ZGPI-RC-ATT-MTA-NAME-ERROR Return Codes Recovery. Call GPI_STATUS_ and check the error class and the secondary code, which contains the type value. Take the recovery action recommended for the error class. 5005 ZGPI-RC-ATT-MTA-NAME-ERROR Cause. The values of an MH-C-INTERNAL-TRACE-ENTRY object are inconsistent with the MH-T-ATTEMPTED- attributes or the MH-T-ACTION attribute, or both. Effect. The function is not performed. Recovery.
5007 ZGPI-RC-BAD-STRING-OFFSET Return Codes Table B-10. ZGPI-RC- Codes for GIP Errors (page 2 of 3) Constant (ZGPI-RC-) Value Meaning INVALID-PID 6004 GIP received request from process that is not process that opened existing session. UNKNOWN-GPI-REQUEST 6005 GIP received GPI request that is not recognized. OTT-FAILURE 6006 Object-tree-transport module failed during start-transfer-in or transfer-out operation.
6000 ZGPI-RC-NOT-STARTED-STATE Return Codes Table B-10. ZGPI-RC- Codes for GIP Errors (page 3 of 3) Constant (ZGPI-RC-) Value Meaning MRP-UNAVAILABLE 6028 Unable to connect to MRP, because it was unavailable. INVALID-GW-PASSWORD 6029 Gateway password rejected during attempt to connect to MRP. NO-GATEWAY 6030 GATEWAY object could not be found during attempt to connect to MRP. CONNECT-FAILURE 6031 Unrecoverable error occurred during attempt to connect to MRP.
6002 ZGPI-RC-GIP-BUSY Return Codes Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 6002 ZGPI-RC-GIP-BUSY Cause. The GIP received a request to open a session with a client program but is already in session with another client program. Effect. The request is rejected. Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action recommended for the error class. 6003 ZGPI-RC-NO-PREVIOUS-GPI-OPEN Cause.
6007 ZGPI-RC-UNEXPECTED-OTT-REQ Return Codes 6007 ZGPI-RC-UNEXPECTED-OTT-REQ Cause. The GIP received a request from the object-tree-transport module but was in the wrong state to respond to the request. Effect. The request is rejected. Recovery. Call GPI_STATUS_ and check the secondary code, which contains the GIP transfer state. Take the recovery action recommended for the error class. 6008 ZGPI-RC-IPC-PROTOCOL-ERROR Cause.
6013 ZGPI-RC-GW-AUX-P-AUX-UNEXP-REPLY Return Codes Effect. The function is not performed. Recovery. Call GPI_STATUS_ . Take the recovery action recommended for the error class. Check the information buffer. 6013 ZGPI-RC-GW-AUX-P-AUX-UNEXP-REPLY Cause. The GIP failed due to an unexpected response from the gateway auxiliary process. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error class.
6018 ZGPI-RC-ILLEGAL-WAIT-INTERVAL Return Codes 6018 ZGPI-RC-ILLEGAL-WAIT-INTERVAL Cause. The specified interval in a GPI_MT_WAIT_ call is invalid. Effect. The wait request is rejected. Recovery. Revise the GPI_MT_WAIT_ call, specifying a valid interval. 6019 ZGPI-RC-PDU-SUBSYS-INIT-ERROR Cause. An unrecoverable error occurred during initialization of the PDU store subsystem. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and examine the information buffer.
6026 ZGPI-RC-MRP-NOT-COMPATIBLE Return Codes 6026 ZGPI-RC-MRP-NOT-COMPATIBLE Cause. The version of the MHS-interface module is not compatible with the MRP. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the secondary code, which contains the version code of the MRP. Take the recovery action recommended for the error class. Check that the versions of the GPI library and OSI/MHS on your system are from the same release (or compatible releases).
6031 ZGPI-RC-CONNECT-FAILURE Return Codes 6031 ZGPI-RC-CONNECT-FAILURE Cause. An unrecoverable error occurred when the GIP attempted a connection with the MRP. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error class. Check the operational environment. 6032 ZGPI-RC-OT-INIT-FAILURE Cause. The GIP could not initialize the object tree memory. Effect. The function is not performed. Recovery.
6036 ZGPI-RC-GW-NAME-NOT-CONFIGURED Return Codes 6036 ZGPI-RC-GW-NAME-NOT-CONFIGURED Cause. No configuration record was found for the gateway name passed to the GPI as a parameter in GPI_OPEN_. It is assumed that the gateway name is therefore invalid. There is no secondary code. Effect. The function is not performed. Recovery. Check the gateway name which was configured and ensure it is the same as the name passed by the client as a parameter to GPI_OPEN_. 6037 ZGPI-RC-NO-PDU-MEMORY-BUFFER Cause.
6040 ZGPI-RC-ARCHIVE-WRITE-FAILED Return Codes 6040 ZGPI-RC-ARCHIVE-WRITE-FAILED Cause. The queue entry found on the input queue is bad and has been archived. However, a request to write an archive log record for the bad PDU has failed. Effect. The bad PDU is removed from the input queue, an event message with the PDU ID is generated, and the PDU is physically left in the PDU store. Recovery. Call GPI_MT_START_TRANSFER_IN_ or GPI_MT_WAIT_ again to see if there is anything else on the input queue.
8001 ZGPI-RC-OTM-OUTBOUND-ERROR Return Codes Table B-11. ZGPI-RC- Codes for Outbound-Mapping Errors (page 2 of 2) Constant (ZGPI-RC-) Value Meaning BAD-ATTR-TYPE 8013 Outbound-mapping module cannot find required attribute for criticality or extension. NO-MATCHING-EXTENSION 8014 Outbound-mapping module cannot find required extension for criticality. BAD-TABLE-OPERATION 8015 Outbound-mapping module was not able to add or delete entry from the PDUID table.
8004 ZGPI-RC-BAD-CN-DIGIT Return Codes Recovery. Call GPI_STATUS_ and check the secondary code, which contains the unmatched character, and the information buffer. Take the recovery action recommended for the error class. 8004 ZGPI-RC-BAD-CN-DIGIT Cause. The outbound-mapping module found a nonnumeric character in a three-digit country name. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the secondary code, which contains the unmatched digit, and the information buffer.
8009 ZGPI-RC-BAD-ENUMERATION-CASE Return Codes Recovery. Call GPI_STATUS_ and check the secondary code, which contains the unmatched GPI-internal indicator, and the information buffer. Take the recovery action recommended for the error class. 8009 ZGPI-RC-BAD-ENUMERATION-CASE Cause. The outbound-mapping module cannot match an enumerated value for the MH-T-BUILTIN-EITS attribute. Effect. The function is not performed. Recovery.
8014 ZGPI-RC-NO-MATCHING-EXTENSION Return Codes Recovery. Call GPI_STATUS_ and check the secondary code, which contains the type value, and the information buffer. Take the recovery action recommended for the error class. 8014 ZGPI-RC-NO-MATCHING-EXTENSION Cause. The outbound-mapping module cannot find the required extension for criticality. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the secondary code, which contains the type value, and the information buffer.
8019 ZGPI-RC-PDU-ID-UNAVAILABLE Return Codes Recovery. Call GPI_STATUS_ and check the information buffer (which contains the ZGPI-ST-ERROR-ATTR structure). Take the recovery action recommended for the error class. 8019 ZGPI-RC-PDU-ID-UNAVAILABLE Cause. The outbound-mapping module cannot obtain an PDU ID for a P2 encode. Effect. The function is not performed. Recovery.
8500 ZGPI-RC-ILLEGAL-RECIPIENT-DR Return Codes Table B-12. ZGPI-RC- Codes for Inbound-Mapping Errors Constant (ZGPI-RC-) Value Meaning ILLEGAL-RECIPIENT-DR 8500 Inbound-mapping module received invalid PDU. OTM-INBOUND-ERROR 8501 Object-management module returned error to inbound-mapping module. UNSUPPORTED-EXTENSION 8502 Inbound-mapping module encountered extension not supported by XAPIA-1988 specification.
8501 ZGPI-RC-OTM-INBOUND-ERROR Return Codes 8501 ZGPI-RC-OTM-INBOUND-ERROR Cause. The inbound-mapping module failed due to an error returned by the objectmanagement module. Effect. If the error class is ZGPI-RC-CLASS-FAILED, the function is partially completed, and a partial communication is returned. Recovery. Call GPI_STATUS_ and check the information buffer. Take the recovery action recommended for the error class. 8502 ZGPI-RC-UNSUPPORTED-EXTENSION Cause.
8506 ZGPI-RC-CLASS-NOT-FOUND Return Codes 8506 ZGPI-RC-CLASS-NOT-FOUND Cause. The input-mapping module could not find an object class for a GPI-internal indicator. Effect. If the error class is ZGPI-RC-CLASS-FAILED, the function is partially completed, and a partial communication is returned. Recovery. Call GPI_STATUS_ and check the secondary code, which contains the GPI internal indicator. Take the recovery action recommended for the error class. 8507 ZGPI-RC-UNDECODABLE-MESSAGE Cause.
8511 ZGPI-RC-UNREADABLE-PDU Return Codes 8511 ZGPI-RC-UNREADABLE-PDU Cause. The inbound-mapping module could not read the inbound PDU from the PDU store. Effect. The function is not performed. Recovery. Call GPI_STATUS_ and check the information buffer. Take the recovery action recommended for the error class. 8512 ZGPI-RC-UNSUPPORTED-BODY-PART Cause. A body part has been encountered that is not supported by the GPI. The secondary code contains the kind code of the unsupported body part. Effect.
1004 ZGPI-FDC-XFER-OUT-IN-PROGRESS Return Codes A more detailed description of what causes a value to be returned follows each table. The effect and recommendations for recovery are determined by and documented with the associated OM-RC-, MH-RC-, or ZGPI-RC- code. Table B-13. ZGPI-FDC- Secondary Codes Constant (ZGPI-) Value Meaning FDC-XFER-OUT-IN-PROGRESS 1004 Object cannot be modified when being transferred out. FDC-NOT-MODIFIABLE 1007 Reserved object or attribute cannot be modified.
1012 ZGPI-FDC-NOWAIT-NOT-SUPPORTED Return Codes 1012 ZGPI-FDC-NOWAIT-NOT-SUPPORTED Cause. The current release of the GPI product does not support nowait operations. Table B-14. ZGPI-MIC- Secondary Codes Constant (ZGPI-RC-) Value Meaning MIC-NO-MORE-OT-ENTRIES 1050 Object exceeded initialized size of object-tree table. MIC-NO-MORE-OT-DATA 1051 Object exceeded initialized string data space. MIC-NO-MORE-OTS 1052 GIP cannot allocate memory required for object tree.
1100 ZGPI-NSOC-NULL-OBJ-ID Return Codes Table B-15. ZGPI-NSOC- Secondary Codes Constant (ZGPI-) Value Meaning NSOC-ELMT-IS-AN-ATTR 1104 Object pointer points to attribute instead of object. NSOC-BAD-DSCR-OBJ-PTR 1105 Internal descriptor contains pointer to illegal address or nonobject. NSOC-OBJ-NOT-IN-SESSION 1106 Session did not create or transfer in the specified root object. 1100 ZGPI-NSOC-NULL-OBJ-ID Cause. The object identifier is null (all zeros).
1150 ZGPI-PIC-OBJ-ID-PTR Return Codes Table B-16. ZGPI-PIC- Secondary Codes Constant (ZGPI-RC-) Value Meaning PIC-OBJ-PTR 1153 Object identifier or object pointer is invalid. PIC-SESSION-PTR 1154 Session pointer is invalid. PIC-DSCR-STR-PTR 1155 String pointer is invalid. 1150 ZGPI-PIC-OBJ-ID-PTR Cause. The object-identifier pointer is invalid. 1151 ZGPI-PIC-OTD-PTR Cause. A GPI-internal pointer (to an object-tree-dictionary) is invalid. 1152 ZGPI-PIC-ATTR-PTR Cause.
1200 ZGPI-SEC-NOT-AN-ATTR-PTR Return Codes Table B-17. ZGPI-SEC- Secondary Codes (page 2 of 2) Constant (ZGPI-RC-) Value Meaning SEC-OT-ALLOCATION-ERROR 1207 Attempt to allocate object-tree table failed. SEC-NUM-EXCEEDED-MAX-OTS 1208 Attempt to allocate more object trees than maximum allowed failed. SEC-BAD-SESSION-ID 1209 Session identifier does not match expected value. SEC-VALUE-N-CNT-NOT-MATCH 1210 Value count inconsistent with actual number of values.
1205 ZGPI-SEC-BAD-MV-TYPE Return Codes 1205 ZGPI-SEC-BAD-MV-TYPE Cause. The type of a multivalued attribute passed to the object-management module is not consistent with other internal information about the attribute. 1206 ZGPI-SEC-ILLEGAL-MV-HDR-OPEN Cause. An attempt to replace a GPI internal protocol element for a multivalued attribute was made during an object management operation but was not allowed. 1207 ZGPI-SEC-OT-ALLOCATION-ERROR Cause.
1214 ZGPI-SEC-BAD-MAX-OT-TBL-NUM Return Codes caused by running with GPI software from more than one release installed at the same time.) 1214 ZGPI-SEC-BAD-MAX-OT-TBL-NUM Cause. The maximum number of object-tree tables that can be used by a GPI application is less than one or greater than ZGPI-MAX-OT-COUNT. 1215 ZGPI-SEC-BAD-IPC-HDR-LEN Cause. The total length of the GPI internal protocol element used for the GPI-to-GIP interface is not the expected value. 1216 ZGPI-SEC-BAD-IPC-ELMT-LEN Cause.
1350 ZGPI-PEC-OTT-RSP-ERROR Return Codes Table B-19. ZGPI-PEC- Secondary Codes Constant (ZGPI-RC-) Value Meaning PEC-OTT-RSP-ERROR 1350 Error returned from object-tree-transport module. PEC-OTT-TYPE-ERROR 1351 Internal type from object-tree-transport module is not the expected one. PEC-OTT-OFFSET-ERROR 1352 GPI internal protocol element from object-treetransport module is not the expected one. PEC-OTT-INDEX-ERROR 1353 Internal index from object-tree-transport module is not the expected one.
1401 ZGPI-IRDC-NEITHER-BIT-SET Return Codes 1401 ZGPI-IRDC-NEITHER-BIT-SET Cause. The inbound-mapping module found an incorrect bit string (neither bit set) for the node being translated. Table B-21. ZGPI-WVMC- Secondary Codes Constant (ZGPI-RC-) Value Meaning WVMC-BAD-BIT-STRING 1500 Incorrect bit string value in attribute’s string value. WVMC-BAD-CONTENT-TYPE 1501 Incorrect content type specified for attribute.
1503 ZGPI-WVMC-BAD-OR-NAME Return Codes 1503 ZGPI-WVMC-BAD-OR-NAME Cause. The attribute values of an MH-C-OR-NAME object violate the protocol rules specified for an O/R name and address. 1504 ZGPI-WVMC-BAD-ACTION Cause. The value of an MH-T-ACTION attribute violates the protocol rules specified for the attribute. 1505 ZGPI-WVMC-BAD-COUNTRY-NAME Cause. The value of an MH-T-COUNTRY-NAME attribute violates the protocol rules specified for the attribute. 1506 ZGPI-WVMC-BAD-SYNTAX-TYPE Cause.
1550 ZGPI-NPC-TYPE-NOT-FOUND Return Codes 1550 ZGPI-NPC-TYPE-NOT-FOUND Cause. The specified attribute type is valid, but the type does not exist in the object. 1551 ZGPI-NPC-POSITION-NOT-FOUND Cause. The specified multivalued attribute is valid for the specified object, but the specified value position does not exist for that object. Table B-23. ZGPI-IGIC- Secondary Codes Constant (ZGPI-RC-) Value Meaning IGIC-TOO-MANY-PNAMES 1600 Too many gateways processes configured.
1650 ZGPI-PFIC-INFO--NOT-INIT Return Codes Table B-24. ZGPI-PFIC- Secondary Codes Constant (ZGPI-RC-) Value Meaning PFIC-INFO-NO-STORE 1652 PDU store not available or does not exist. PFIC-INFO-NO-TMF 1653 TMF not started. PFIC-UNEXPECTED-ERROR 1654 Unexpected error when GIP attempted to access PDU store. 1650 ZGPI-PFIC-INFO--NOT-INIT Cause. The PDU store was not initialized correctly by the GIP. 1651 ZGPI-PFIC-INFO--NO-PDU Cause.
1750 ZGPI-QEAC-UNKOWN-PDU Return Codes Table B-26. ZGPI-QEAC- Secondary Codes Constant (ZGPI-QEAC-) Value Meaning UNKNOWN-PDU 1750 The PDU identifier is null, or the PDU cannot be found in the PDU store. INVALID-GW-PDU 1751 The PDU is known, but has not been delivered to a gateway. INVALID-GW-ID 1752 The PDU has been delivered to the wrong gateway. The gateway id associated with the PDU is put into the error code field in the information buffer. 1750 ZGPI-QEAC-UNKOWN-PDU Cause.
Information Buffer Return Codes Z-STRUCT-TYPE The first 32 bits of the information buffer always contains this structure type. CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT ZGPI-ST-NULL ZGPI-ST-ERROR-ATTR ZGPI-ST-DANGLING-OBJ ZGPI-ST-INFO-3 ZGPI-ST-INFO-4 ZGPI-ST-INFO-5 TYPE TYPE TYPE TYPE TYPE TYPE BINARY BINARY BINARY BINARY BINARY BINARY 32 32 32 32 32 32 VALUE VALUE VALUE VALUE VALUE VALUE 0. 10. 20. 30. 40. 50.
Information Buffer Return Codes Z-ATTR-DSCR is the attribute descriptor. For a description of the structure of the attribute descriptor, see the definition of OM-DESCRIPTOR on page A-4. Z-ATTR-STRING-VALUE is the first 16 octets of the string value. The actual length of the string is given in the string length of the attribute descriptor. If that length is zero, or the syntax of the attribute is not OM-S-xxx-STRING, ignore this field.
Information Buffer Return Codes Figure B-1. Information Buffer for Attribute in Error ZGPI-ERROR-ATTR-DATA Information Buffer Z-OBJ-ID Object Identifier (32-Bit Unsigned Integer) Z-OBJ-CLASS Object Class (16-Bit Unsigned Integer) Z-OBJ-TYPE Object Type (16-Bit Unsigned Integer) Z-ATTR-DSCR Attribute Type (16-Bit Unsigned Integer) Attribute Syntax (16-Bit Unsigned Integer) Attribute Value (64-Bits: Structure depends on syntax.
Information Buffer Return Codes ZGPI-ST-DANGLING-OBJ (Value 20) This structure returns information about a created object that is not inserted as an attribute of a root object. DEFINITION ZGPI-INFO-2. 02 Z-STRUCT-TYPE 02 Z-DATA END TYPE BINARY 32. TYPE ZGPI-DANGLING-OBJ-DATA. DEFINITION ZGPI-DANGLING-OBJ-DATA. 02 Z-ROOT-OBJ-ID TYPE OM-OBJECT. 02 Z-OBJ-COUNT TYPE BINARY 16. 02 Z-OBJ-LST TYPE ZGPI-DANGLING-OBJ-ELMT. OCCURS ZGPI-MAX-DANGLING-OBJ-TIMES. END DEFINITION ZGPI-DANGLING-OBJ-ELMT.
Information Buffer Return Codes Figure B-2. Information Buffer for Dangling Objects ZGPI-ERROR-ATTR-DATA Information Buffer Z-OBJ-ID Object Identifier (32-Bit Unsigned Integer) Z-OBJ-CLASS Object Class (16-Bit Unsigned Integer) Z-OBJ-TYPE Object Type (16-Bit Unsigned Integer) Z-ATTR-DSCR Attribute Type (16-Bit Unsigned Integer) Attribute Syntax (16-Bit Unsigned Integer) Attribute Value (64-Bits: Structure depends on syntax.
Information Buffer Return Codes ZGPI-ST-INFO-3 (Value 30) This structure provides extended error information in format 3 to be reported to your Compaq representative. DEFINITION ZGPI-INFO-3. 02 Z-STRUCT-TYPE 02 Z-DATA END TYPE BINARY 32. TYPE ZGPI-INFO-3-DATA. DEFINITION ZGPI-INFO-3-DATA. 02 Z-CODE-1 02 Z-CODE-2 02 Z-CODE-3 02 Z-CODE-4 02 Z-CODE-5 END TYPE TYPE TYPE TYPE TYPE BINARY BINARY BINARY BINARY BINARY 16. 16. 16. 8. 8. Z-CODE-1 is a primary code. Z-CODE-2 is a secondary code.
Information Buffer Return Codes ZGPI-ST-INFO-5 (Value 50) This structure provides extended error information in format 5 to be reported to your Compaq representative. DEFINITION ZGPI-INFO-5. 02 Z-CODE-1 02 Z-CODE-2 02 Z-CODE-3 02 Z-CODE-4 02 Z-CODE-5 END TYPE TYPE TYPE TYPE TYPE BINARY BINARY BINARY BINARY BINARY 16. 32. 32. 32. 16. All Z-CODE-n values contain internal GPI information defined by Compaq.
Return Codes Information Buffer OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 B -70
C GPI Procedure Calls for the C Language This appendix provides a summary of the GPI procedure calls for use in C language programs. For descriptions of the procedures and arguments (parameters), see Section 4, “Procedure Calls.” For information about interpreting C language syntax, see the C Reference Manual. An asterisk (*) indicates that the parameter is a pointer.
GPI Procedure Calls for the C Language status GPI_MT_WAIT_ ( short unsigned long extptr unsigned long ) ; session, interval, *available status GPI_OM_COPY_ ( unsigned long extptr unsigned long unsigned long short ) ; original, *copy, copy_root_object, copy_session status GPI_OM_CREATE_ ( unsigned short unsigned long extptr unsigned long unsigned long short extptr char short ) ; class, initialize, *object, root_object, session, *class-obj-id, class-obj-id-len status GPI_OM_DELETE_ ( unsigned long ) ;
GPI Procedure Calls for the C Language status GPI_OM_FETCH_ ( unsigned long unsigned long extptr char unsigned long extptr char extptr char unsigned long extptr unsigned long extptr unsigned long ) ; object, values, *descriptor_list_in, descriptor_count, *descriptor_list_out, *string_buffer, string_buffer_length, *actual_string_length, *total_string_length status GPI_OM_INSERT_ ( unsigned long long extptr char unsigned long ) ; object, value_position, *descriptor_list, descriptor_count status GPI_OM_LI
GPI Procedure Calls for the C Language status GPI_OM_REMOVE_ ( unsigned long unsigned short long unsigned long extptr unsigned long ) ; object, attribute_type, value_position, maximum_number, *total_number status GPI_OM_WRITE_ ( unsigned long unsigned short long extptr long extptr char unsigned long unsigned short ) ; object, attribute_type, value_position, *string_offset, *data_string, element_number, syntax status GPI_OPEN_ ( extptr char extptr char extptr short extptr unsigned long extptr char unsig
D Class Hierarchies This appendix provides diagrams of the hierarchies of object classes. The four main figures show the root objects: message, probe, report, and P1-encoded object. Due to the complexity of the class structures, some subobjects are shown in separate figures. When reading the diagrams, be aware of the following conventions: • • • • The DDL names of object classes and attribute types are replaced with simplified names for readability.
Class Hierarchies Figure D-1 shows the structure of the MH-C-MESSAGE object class. Figure D-1. Message Object Class MESSAGE o o o o o o o o o o Alternate recipient allowed Bilateral information ( Bilateral information ( 5 attributes ) ) Content can be External ( 7 attributes ) or General content ( 2 attributes ) or Interpersonal message (See Figure D-4.) or Receipt notification (See Figure D-6.) or Nonreceipt notification (See Figure D-6.) or EDI message (See Figure D-9.
Class Hierarchies Figure D-2 shows the structure of the MH-C-PROBE object class. Figure D-2. Probe Object Class PROBE Alternate recipient allowed o o Bilateral information ( Bilateral information ( 5 attributes ) ) Content identifier o Content length Content type Conversion prohibited o Critical-for-delivery o Critical-for-submission o Critical-for-transfer o Expansion history ( Expansion record ) Name ( OR name (See Figure D-8.
Class Hierarchies Figure D-3 shows the structure of the MH-C-REPORT object class. Figure D-3. Report Object Class REPORT o Content can be External ( 7 attributes ) or General content ( 2 attributes ) or Interpersonal message (See Figure D-4.) or Receipt notification (See Figure D-6.) or Nonreceipt notification (See Figure D-6.) or EDI message (See Figure D-9.) or EDI forwarded notification (See Figure D-9.) or EDI negative notification (See Figure D-10.) or EDI positive notification (See Figure D-10.
Class Hierarchies Figure D-4 shows the structure of the IM-C-INTERPERSONAL-MESSAGE object class. Figure D-4. Interpersonal Message Object Class INTERPERSONAL MESSAGE Authorizing users( OR descriptor) o Formal name (OR name(See Figure D-8.
Class Hierarchies Figure D-5 shows the structure of the IM-C-MESSAGE-BODY-PART object class. Note that an MH-C-DELIVERY-ENVELOPE object may be contained within (is an optional subobject of) this structure. Figure D-5. Message Body Part and Delivery Envelope Object Classes MESSAGE-BODY-PART o Envelope ( Delivery envelope ) o Actual recipient name ( OR name (See Figure D-8.) ) o o o o Content identifier Content type o o Conversion prohibited Converted EITS ( EITS (See Figure D-8.
Class Hierarchies Figure D-6 shows the structures of the IM-C-RECEIPT-NOTIFICATION and IM-C-NON-RECEIPT-NOTIFICATION object classes. Figure D-6. Receipt and Nonreceipt Notification Object Classes RECEIPT NOTIFICATION Acknowledgment mode o Conversion EITS ( EITS (See Figure D-8.) ) o IPM intended recipient ( OR descriptor ) o Formal name ( OR name (See Figure D-8.) ) o ( 3 attributes ) IPN originator ( OR descriptor ) o Formal name ( OR name (See Figure D-8.
Class Hierarchies Figure D-7 shows the structures of the MH-C-PER-RECIPIENT-DR and MH-C-PERRECIPIENT-NDR object classes. Figure D-7. Per-Recipient DR and NDR Object Classes PER-RECIPIENT DR Actual recipient name ( OR name (See Figure D-8.) ) Arrival time o o o Converted EITS ( EITS (See Figure D-8.) ) Delivery point Delivery time Extensions ( Extension ( 6 attributes ) ) Intended recipient name ( OR name (See Figure D-8.
Class Hierarchies Figure D-8 shows the structure of the MH-C-OR-NAME and MH-C-EITS object classes. Figure D-8.
Class Hierarchies Figure D-9 shows the structures of the EDI-C-EDIM and EDI-C-FORWARD-NOTIF object classes. Figure D-9. EDI Message (EDIM) and Forwarded Notification Object Classes EDI MESSAGE o Additional body parts ( EDIM externally defined body part ) External body part ( Externally defined body part ) ( 3 attributes ) External data ( OM external ( 7 attributes ) ) o External parms ( OM external ( 7 attributes ) ) ( 1 attribute ) Heading ( Heading (See Figure D-11.
Class Hierarchies Figure D-10 shows the structure of the EDI-C-NEGATIVE-NOTIF and EDI-C-POSITIVE-NOTIF object classes. Figure D-10. Negative Notification and Positive Notification Object Classes NEGATIVE NOTIFICATION o o o o o EDI notification initiator EDI notification originator ( OR name (See Figure D-8.) ) First recipient ( OR name (See Figure D-8.
Class Hierarchies Figure D-11 shows the structure of the EDI-C-EDI-HEADING class. Figure D-11.
Class Hierarchies Figure D-12 shows the structure of the EDI-C-EDIM-BODYPART object class. Note that an MH-C-DELIVERY-ENVELOPE object may be contained within (is an optional subobject of) this structure. Figure D-12. EDI Message Body Part and Delivery Envelope Object Classes EDIM BODYPART o Envelope ( Delivery envelope ) o o o o o o o o o o o o o o o o o o o Actual recipient name ( OR name (See Figure D-8.) ) Content identifier Content type Conversion prohibited Converted EITS ( EITS (See Figure D-8.
Class Hierarchies Figure D-13 shows the structure of the EDI-C-SECUR-ELEMENTS object class. Figure D-13. Security Elements Object Class SECURITY o Application security elements ( Application security elements) o Application security extensions ( EDI extension ( 4 attributes ) ) ( 3 attributes ) o Application security extensions ( EDI extension ( 4 attributes ) ) o Original content can be EDI message (See Figure D-9.) or EDI forwarded notification (See Figure D-9.
E Event Messages An event message is a special kind of Subsystem Programmatic Interface (SPI) message that describes an event occurring in the system or network. Event messages are generated by various processes within a subsystem, including the GPI. This appendix lists the event messages generated by the GPI within the OSI/MHS subsystem; specifically, the messages generated by a GIP process when performing operations for the GPI.
Event Messages OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 E- 2
Glossary The following glossary defines terms used in this manual and in other Compaq OSI/MHS manuals. Both industry-standard terms and Compaq terms are included. This list covers Compaq OSI/MHS as a whole; therefore, not all terms given here are used in this particular manual. abstract syntax. A representation of the way in which components of information are to be specified in a communication.
ASE (application service element) Glossary ASE (application service element). A set of functions in the Application Layer that supports either a large range of applications or a particular type of application, such as file transfer or transaction processing. ASN.1 (Abstract Syntax Notation One). A data description language for expressing abstract syntaxes in OSI. See also abstract syntax and BER. association. In OSI, a connection between Application Layer entities. See also connection.
BER (Basic Encoding Rules) Glossary BER (Basic Encoding Rules). The standard for an associated transfer syntax (CCITT Recommendation X.209). These rules were defined to provide a transfer syntax for use by ASN.1 compilers. bind. The act of establishing a connection. An MTA bind enables one MTA to establish an association with another MTA; an MS bind enables a user agent to establish an association with a message store. bit string. A series of bits treated as a unit. body part.
command file Glossary command file. An EDIT file that contains sequences of commands. Sometimes called an OBEY file. command message. An SPI message, containing a command, sent from an application program to a subsystem. See also response message or event message. command/response interface. In DSM, a management interface that performs operations on subsystem-defined objects. common definition.
content Glossary content. One of two basic parts of a message or report, containing the information to be conveyed to the recipients. The other part is called the “envelope.” Probes contain a description of the content rather than the content itself. context token. In DSM programmatic interfaces, a token in an SPI response message that indicates (by its presence or absence) whether or not the response is continued in the following message. control and inquiry.
definition Glossary definition. A declaration provided by Compaq for use in applications that use a specific procedural interface, such as the APS or SPI procedures. Definitions are commonly provided in definition files. definition files. A set of files containing declarations for use in applications that use a specific procedural interface.
Glossary DSV (distribution subvolume) data communications subsystems, the Subsystem Programmatic Interface (SPI), the Event Management Service (EMS), the Distributed Name Service (DNS), and management programming interfaces for various Compaq subsystems. DSV (distribution subvolume). The grouping in which Compaq releases software for installation. Names are in the form Yxxxxzzz, where xxxx is the product number and zzz is the release number—for instance, Y9110C20. See also ISV. EDI forwarding.
EDIM responsibility Glossary a single EDI interchange (which may be original or forwarded). Additional body parts contain information related to the EDI interchange, such as drawings or explanatory text. EDIM responsibility. An EDIM cannot leave the EDI messaging system unless its responsibility is accepted by some user (recipient).
encoding Glossary encoding. The process of translating local message information into ASN.1 (BER) format. See also decoding and BER. entry manager process. A queue manager process that you must specify when configuring the Transfer X400 gateway. You can specify up to five entry manager processes. envelope. The part of a message that contains information needed to transfer the message and to deliver it to its intended recipients.
Glossary event messaging interface event messaging interface. In DSM, a management interface that reports significant events detected by the subsystem. exception report. In the OSI Session Layer, a report indicating that a problem has occurred on a connection. Exception reports can be issued by applications and by the service provider. The severity of the problem varies, as does the corrective action.
forwarded IPM Glossary forwarded IPM. An interpersonal message that is enclosed in and being forwarded by another interpersonal message. forwarded notification (FN). An EDIN that reports responsibility for an EDIM has been forwarded together with the subject EDIM. A forwarded notification is generated by a receiving EDI-UA, EDI-MS, or PDAU when EDIM responsibility can not be given to the associated user, and the EDIM is forwarded to another recipient.
header Glossary header. The initial part of a message, which typically contains descriptive information pertinent to the message as a whole and also possibly control information. In SPI, see also header token. header token. In an SPI message, a token that provides information pertaining to the message as a whole. Examples of header tokens for commands are the command number, the object type, the maximum-response token, the server-version token, the maximum-field-version token, and the checksum token.
interpersonal notification (IPN) Glossary interpersonal notification (IPN). See IPN. IPM (interpersonal message, interim product modification). A type of message comparable to a business memo. It consists of a heading and one or more body parts. The heading identifies the body parts, which contain the information. Alternatively, a slightly modified version of a software product, made available to customers between regular releases. IPN (interpersonal notification).
LO (local operations) process Glossary LO (local operations) process. The process in the LO group that provides local functions analogous those of the Remote Operations Service Element (ROSE) defined in OSI. The LO process manages associations from local client applications and creates PDUs in the MR or MS PDU stores during submit operations. local identifier.
message Glossary message. A communication, typically consisting of multiple, related data elements and control information. In X.400, an information object that consists of an envelope and its contents. The envelope identifies the originator and the potential recipient of the message and documents its path through the system. message store. The part of an MHS subsystem that provides capabilities for message storage. message transfer agent. See MTA. MHS (Message Handling System).
MS group Glossary MS group. The OSI/MHS group that implements the message store-and-forward function. The MS group consists of a single MS process, an MS SQL catalog, an MS SQL database, and an MS PDU store. There can be zero, one, or more MS groups in a single OSI/MHS subsystem. MS process. A process in the MS group that provides mailbox management, access management, submittal, delivery, retrieval, and recovery. MS SQL catalog.
node Glossary node. In general, a system or device that follows the protocols of a specific network and that other systems or devices in that network can address. In Expand (the Compaq proprietary network), a computer system that is part of a Compaq Expand network of computer systems. A node address is designated by a symbol before the name (for example, \NY in Guardian 90 file names or @NY in Transfer correspondent names). nonadjacent MTA. An MTA in the X.
numeric O/R address Glossary application has made no explicit assignment to that field after calling the SSNULL procedure to initialize the structure. numeric O/R address. An O/R address that identifies a user by a number. See also mnemonic O/R address. OBEY file. See command file. object. In general, an entity subject to independent reference or control, and having welldefined characteristics or behavior.
originator Glossary originator. The person or application that prepares and submits messages for delivery through an X.400 message handling system. O/R (originator/recipient) address. A list of attributes that describes a user and locates that user in relation to the physical or organizational structure of the MHS or the underlying network. An O/R address, which is part of the O/R name, provides routing information for an X.400 message handling system. O/R (originator/recipient) name.
outbound communication Glossary presentation, and application services provider, TAPS, handles layers 5, 6, and 7, and is provided by OSI/AS. outbound communication. A communication sent to the X.400 network from a client. See also inbound communication. output queue. A queue for messages, probes, and reports that are outbound from the gateway application to X.400. P1-encoded object. The BER-encoded form of a P1 message. See also BER and P1 message. P1 protocol. The X.
PDAU (physical delivery access unit) Glossary PDAU (physical delivery access unit). A commonly-used type of access unit (AU) within an EDI messaging system as defined in CCITT Recommendation X.435. The PDAU provides the ability to send messages to EDIMS users (recipients) through a physical delivery system (PDS). Other types of access units (for example, facsimile machines) may be the subject of future CCITT standards. PDU (protocol data unit).
primitive Glossary primitive. See service primitive. printing distributor. An EMS distributor process that obtains formatted text for select event messages and distributes it to a printer or other display device, or to a file. priority. In OSI/MHS, the order in which alternate routes are attempted. Priority values are relative only to the other priorities for a particular MTA. Private Management Domain. See PRMD. PRMD (Private Management Domain). An X.
queue file Glossary queue file. In the Transfer X400 gateway, a file in the queue manager that consists of three logical queues: the ADMIN queue with entries for MR group registration, the MESSAGE queue with entries for import work, and the EXPORT queue with entries for export work. queue manager. A queuing facility that lets Transfer requesters add an entry and retrieve an entry from a queue for processing.
response message Glossary response message. An SPI message sent from a subsystem to an application program in reaction to a command message. See also command message or event message. response primitive. In OSI, a primitive issued when a service user wants to respond to an event. This is one of the four types of service primitives and is used only for confirmed services. See also service primitive. response record.
routing tables Glossary routing tables. The internal databases that hold the information about the O/R names. RS (remote operations service) class. The OSI/MHS CLASS object that identifies the set of all RS groups in an OSI/MHS subsystem. RS (remote operations service) process. The process in the RS group that implements the ROSE protocol.
segment Glossary instance of this process, which in turn sends the commands on to the manager processes of the target subsystems. SCP also processes a few commands itself. It provides security features, version compatibility, support for tracing, and support for applications implemented as NonStop™ process pairs. segment. See string segment. selector.
session identifier Glossary established, the client program can request P7 operations by calling other P7 API procedures. A session is ended by calling the LOS_CLOSE_ procedure. session identifier. A designator generated by the GPI when the client program establishes a session and used by the program to indicate which session is requesting a GPI service. Session Layer. Layer 5 in the OSI Reference Model.
SPI standard definitions Glossary SPI standard definitions. In DSM programmatic interfaces, the set of declarations available for use with the SPI procedures, regardless of the subsystem. There is also a set of subsystem-specific declarations for each subsystem, and some sets of declarations that apply to multiple subsystems. See also definition and definition files, data communications standard definitions or EMS standard definitions. SQL. See NonStop™ SQL. SSAP.
Subsystem Control Facility Glossary Subsystem Control Facility. See SCF. Subsystem Control Point. See SCP. subsystem ID. See SSID. Subsystem Programmatic Interface. See SPI. summary state. In DSM interfaces to Compaq data communications subsystems, one of the generally defined possible conditions of an object, with respect to the management of that object. A summary state differs from a state in two ways.
terminal O/R address Glossary terminal O/R address. An O/R address that identifies a user by a network address and, if required, a terminal type. TLAM (Tandem LAN access method). A Compaq product that implements the services of the Data Link and Physical Layers for LANs. TMF (Transaction Management Facility). A data management product that maintains the consistency of a database and provides the tools for database recovery. token. In DSM, a distinguishable unit in an SPI message.
transport address Glossary transport address. See TSAP. transport layer. Layer 4 in the OSI Reference Model. This layer provides reliable, transparent transfer of data between end systems and ensures that the data arrives at the correct destination. transport selector. See TSEL. TSAP (transport service access point).
wait manager process Glossary wait manager process. A type of queue manager process. warning. In DSM interfaces, a condition, encountered in performing a command or other operation, that can be significant but does not cause the command or operation to fail. A warning is less serious than an error. wild-card character. A character that stands for any possible character(s) in a search string or in a name applying to multiple objects.
Index Numbers 1984 and 1988 standards 1-7 1984 X.400, extensions to 3-22 1988 X.
B Index Attribute descriptor (continued) description of 2-2 O/R 3-124 Attribute, Class 3-2 Authorizing users of IPM 3-110 Auto-forwarded comment 3-123 Auto-forwarded IPM 3-110 B B4-length images 3-30 B4-width images 3-30 Basic DDL data types A-1 Bilateral data, IPM 3-97 Bilateral information 3-9 message 3-40 probe 3-70 Bit-string syntax 2-4 structure 2-6 Blind-copy recipients 3-110 Body of IPM 3-111 Body part 1-2 additional 3-151 bilaterally defined 3-97 externally defined 3-100 G3-facsimile 3-101 G4-cla
D Index Content length 3-70 Content object, description of 3-31 Content type delivery envelope 3-13 message 3-40 probe 3-70 report 3-81 Control character sets, teletex 3-87 Conversion explicit 3-46 of content 3-15 prohibited delivery envelope 3-13 message 3-41 probe 3-70 Conversion EITS nonreceipt notification 3-123 receipt notification 3-130 Converted EITS delivery envelope 3-13 external trace 3-27 per-recipient DR 3-61 per-recipient NDR 3-66 Copy See GPI_OM_COPY_ Copy recipient, IPM 3-111 Country name b
E Index Delivery (continued) delivery envelope 3-14 per-recipient DR 3-61 See also Deferred delivery time Descriptor See Attribute descriptor and O/R descriptor Descriptor list 2-7 order of attributes in 4-27, 4-31 Directives, program 4-1, A-1 Discard reason, nonreceipt notification 3-123 Disclosure allowed 3-41 Distribution lists, unsupported 3-50 Document G4-class 1 3-104 mixed-mode 3-119 teletex 3-133 Domain types in O/R name 3-53 Domain values in O/R name 3-54 E EDI message See EDIM 3-151 EDI notific
E Index EDI-T- (continued) APP-CROSS-REFERENCE 3-139 APP-REFERENCE 3-147 AUTHORIZATION-INFO 3-138 AUTHORIZATION-INFO-Q 3-138 BASIC-CODE FN PDAU reason code 3-158 FN user reason code 3-161 NN UAMS reason code 3-170 NN user reason code 3-171 BODY 3-142 BODYPART-PLACE-HOLDER 3-155 BODYPART-REFERENCE cross reference information 3-139 externally defined body part 3-155 COMMS-AGREEMENT-ID 3-176 COMPONENT-DATAELEMENT 3-178 CRITICALITY 3-144 CROSS-REFERENCING-INFO 3-147 DATA-ELEMENT-SEPARATOR 3-178 DATE-AND-TIME-
E Index EDI-T- (continued) INTER-CONTROLREFERENCE 3-176 INTER-RECIP 3-176 INTER-SENDER 3-148 MSG-REFERENCE 3-139 NEGATIVE-NOTIF 3-151 NN-NOTIF-EXTENSIONS 3-166 NN-REASON-CODE 3-166 NON-REPUD-OF-NOTIF 3-151 NON-REPUD-OF-RECEPTION 3-151 NOTIF-EXTENSIONS forwarded notification 3-163 negative notification 3-166 positive notification 3-172 NOTIF-TIME forwarded notification 3-163 negative notification 3-166 positive notification 3-172 OBSOLETED-EDIMS 3-148 ORIG 3-148 ORIGINAL-CONTENT 3-177 ORIGINAL-CONTENT-INTE
F Index Electronic data interchange classes of objects 3-137 DDL constant values A-26 types of attributes 3-137 Electronic data interchange (EDI) See EDI Enumerated values DDL constants for internal messaging A-24 DDL constants for message handling A-37 Enumeration syntax 2-4 Envelope 1-2 delivery 3-11 forwarded EDIM 3-154 forwarded IPM 3-118 Environment GPI 1-3 initializing 4-7 local MD 1-4 management procedures 4-2 object class description 3-19 Error checking attribute descriptor B-63 dangling object B-
G Index Forwarded EDIM 3-153 Forwarded IPM 3-117, 3-118 Forwarded notification 3-158 Forwarding IPM 3-117 Free-form name attribute 3-125 Functions See Procedure calls G G3 facsimile images 3-101 NBPS 3-101 object description 3-29 of EITS 3-17 G4 facsimile, NBPS of EITS 3-17 G4-class 1 body part 3-104 Gateway environment of local 4-46 instance 1-3 specifying name for 4-46 interface programs 1-3 password 1-3 X.
I Index I IA5-character set 3-105 IA5-string syntax 2-4 IA5-text-body part 3-105 Images characteristics of 3-29 G3 facsimile 3-101 Importance attribute, IPM 3-112 IM- enumerated values for IA5-text-body part 3-105 IM-CACP127-DATA-BODY-PART 3-89 ACP127-NOTIFICATION 3-90 ACP127-NOTIFICATION-RSP 3-92 ADATP3-BODY-PART 3-94 ADDRESS-LIST-DESIGNATOR 3-95 BILAT-DEFINED-BODY-PART 3-97 CORRECTIONS-BODY-PART 3-98 DDL constants for A-25 DISTRIBUTION CODES 3-99 EXTERN-DEFINED-BODYPART 3-100 FORWARDED-ENC-BODYPART 3-10
I Index IM-T- (continued) CORRECTIONS-DATA 3-98 CORRECTIONS-PARAMETERS 3-98 DDL constant values for A-21 DISCARD-REASON 3-123 enumerated values, DDL for A-25 DISTRIBUTION-CODES 3-111 DIST-EXTENSIONS 3-99 ENVELOPE 3-118 EXEMPTED-ADDRESS 3-111 EXPIRY-TIME 3-111 EXTENDED-AUTH-INFO 3-111 EXTENSIONS 3-111 EXTERNAL-DATA 3-100 EXTERNAL-PARAMETERS 3-100 FORMAL-NAME 3-125 FORWARDED-ENC-DATA 3-103 FORWARDED-ENVELOPE 3-103 FREE-FORM-NAME 3-125 G3-FAX-NBPS 3-101 G4-CLASS-1-DOCUMENT 3-104 HANDLING-INSTRUCTIONS 3-112 I
I Index IM-T- (continued) SUBJECT 3-114 SUBJECT-IPM 3-91, 3-130 nonreceipt notification 3-124 SUPPL-RECEIPT-INFO 3-130 TELEPHONE-NUMBER 3-125 TELETEX-DOCUMENT 3-133 TELETEX-NBPS 3-133 TELEX-COMPATIBLE 3-134 TEXT 3-106 THIS-IPM 3-114 TYPE-MESSAGE 3-118 UNIDENTIFIED-DATA 3-135 UNIDENTIFIED-TAG 3-135 USER 3-115 USER-RELATIVE-IDENTIFIER 3-115 VIDEOTEX-DATA 3-137 VIDEOTEX-SYNTAX 3-137 enumerated values, DDL for A-26 IM-VL- constant values A-24 Inbound communications copying 4-21 managing 1-4 transferring 1-5 I
L Index IPM (continued) identifier, description of object class 3-115 intended recipient 3-123, 3-130 purpose of 1-2 returned 3-124 IPN originator 3-123, 3-130 purpose of 1-2 ITA2-character set 3-105 L Languages, programming 1-1 Large messages, alternative syntax 2-5, 4-8, 4-14 Large messages,alternative syntax 4-14 Length limits, DDL constants for A-12, A-24 Length-specified string 2-9 Library, GPI 1-1 List See GPI_OM_LIST_ Local identifier 4-16 attribute 3-49 in copied object 4-21 Local MTA environment
M Index MH-CALGORITHM 3-5 ALGORITHM-AND-RESULT 3-7 BILATERAL-INFORMATION 3-9 DDL constants for A-7 DELIVERY-ENVELOPE 3-11 diagram of D-6, D-13 EITS 3-15 diagram of D-9 ENVIRONMENT 3-19 concatenate with local identifier 4-16 provided by GPI_OPEN_ 4-46 EXPANSION-RECORD 3-21 EXTENSION 3-22 EXTERNAL-TRACE-ENTRY 3-25 G3-FAX-NBPS 3-29 GENERAL-CONTENT 3-31 INTERNAL-TRACE-ENTRY 3-33 MESSAGE description 3-37 diagram of D-2 MESSAGE-RD 3-43 MTS-IDENTIFIER 3-48 OR-NAME 3-50 diagram of D-9 PER-RECIPIENT-DR 3-59 diagra
M Index MH-T- (continued) MTS identifier 3-49 O/R name 3-53 ALGORITHM 3-7 ALGORITHM-DATUM 3-6 ALGORITHM-ID 3-6 ALGORITHM-RESULT 3-7 ALTERNATE-RECIP-ALLOWED message 3-40 probe 3-70 ARRIVAL-TIME external trace 3-27 internal trace 3-36 per-recipient DR 3-61 per-recipient NDR 3-66 ASNI-DATA 3-57 ATTEMPTED-ADMD-NAME external trace 3-27 internal trace 3-35 ATTEMPTED-COUNTRY-NAME external trace 3-27 internal trace 3-35 ATTEMPTED-MTA-NAME 3-35 ATTEMPTED-PRMD-IDENTIFIER external trace 3-27 internal trace 3-35 B4-L
M Index MH-T- (continued) CRITICAL-FOR-SUBMISSION delivery envelope 3-14 message 3-41 message RD 3-46 probe 3-71 probe RD 3-75 report 3-81 CRITICAL-FOR-TRANSFER delivery envelope 3-14 message 3-41 message RD 3-46 probe 3-71 probe RD 3-75 report 3-81 DDL constant values for A-9 DEFERRED-DELIVERY-TIME message 3-41 DEFERRED-TIME external trace 3-28 internal trace 3-36 DELIVERY-POINT 3-61 enumerated values, DDL for A-15 DELIVERY-TIME per-recipient DR 3-61 DELIVERY-TIME attribute delivery envelope 3-14 DISCLOS
M Index MH-T- (continued) per-recipient NDR 3-66 INTERNAL-TRACE-INFO message 3-42 probe 3-71 LOCAL-IDENTIFIER 3-49 MISC-CAPABILITIES 3-87 MTA-NAME 3-35 MTA-REPORT-REQUEST enumerated values, DDL for A-16 message RD 3-47, 3-62, 3-66 probe RD 3-76 MTA-RESPONSIBILITY message RD 3-47, 3-62, 3-67 probe RD 3-76 MTS-IDENTIFIER message 3-43 probe 3-71 report 3-82 NAME 3-21 NON-DELIVERY-DIAGNOSTIC 3-66 enumerated values, DDL for A-16 NON-DELIVERY-REASON 3-67 enumerated values, DDL for A-18 NUMERIC-USER-IDENTIFIER 3
M Index MH-T- (continued) REPORT-EXTERNAL-TRCEINFO 3-82 REPORT-INTERNAL-TRCEINFO 3-82 REPORT-MTS-IDENTIFIER 3-83 SECURITY-CATEGORY 3-86 SECURITY-CLASSIFICATION 3-86 SECURITY-POLICY-ID 3-86 SUBMISSION-TIME delivery envelope 3-15 SUPPLEMENTARY-INFO per-recipient DR 3-62 per-recipient NDR 3-67 SURNAME 3-55 TELETEX-NBPS 3-17 TERMINAL-IDENTIFIER 3-55 TERMINAL-TYPE 3-55 enumerated values, DDL for A-19 TIME 3-21 TWO-DIMENSIONAL 3-30 UNCOMPRESSED 3-30 UNLIMITED-LENGTH 3-30 X121-ADDRESS 3-55 MH-VL- constant values
N Index Military messaging attributes (continued) receipt time 3-93 recipients not reached through MMHS 3-112 replies from recipients of address list 3-96 security category 3-86 security classification 3-86 security policy 3-86 set oriented data 3-94 SIC 3-99 specifying AD recipients as primary or secondary 3-95, 3-96 subject IPM 3-91 type of message 3-118 Miscellaneous capabilities, teletex 3-87 Mixed-mode body part 3-119 Mnemonic O/R address 3-56 MTA 1-1, 1-5 environment of local 4-46 name attempted 3-3
O Index Object (continued) See also Class transferring out 4-16 Object identifier 2-1 invalidating 4-25 Object Management 3-2 package 2-1 Object management 1-4 classes of objects 3-3 DDL constant values A-6 procedures 4-2 types of attributes 3-3 Object Management Class 3-2 Object syntax 2-4 Object tree 4-7 management errors B-28 Object-ID-string syntax 2-4 Obsoleted IPMs 3-112 Octet 2-4 Octet-string syntax 2-4 OM-CDDL constants for A-6 OM-C-EXTERNAL 3-3 OM-ELEMENTS-UNSPECIFIED 2-9 OM-RCcodes, summary of B
P Index O/R name (continued) domain types in 3-53 domain values in 3-54 expansion record 3-21 P P1 protocol 1-2 P1User Exit 1-5 P1-EXIT 1-1, 1-5, 4-11 P2 protocol 1-2 Page formats, teletex 3-88 Parameter DDL constants for position in call A-43 Parameter-validation errors B-14 Password, gateway 1-3, 4-47 Per-recipient delivery report 3-59 nondelivery report 3-63 reports 3-82 Pilot message 3-113 Plain language address 3-112 Positive notification 3-171 Preferred delivery modes delivery envelope 3-15 message
S Index Recipient descriptors (continued) probe 3-72 Recipient name message RD 3-48 probe RD 3-77 Recipient number message RD 3-48 probe RD 3-77 Recipient specifier object 3-131 Recommendations 1-7 X400-X420 xxviii Record, expansion 3-21 Related IPMs 3-113 Remove See GPI_OM_DELETE_ and GPI_OM_REMOVE_ Repertoire attribute 3-105 Replied-to IPMs 3-113 Reply recipients, IPM 3-113 requested 3-132 time, IPM 3-113 Report additional information attribute 3-82 description of object class 3-78 destination 3-82 exte
T Index String buffer structure 2-9 exceeding in-memory table data space 2-5 handling of values in buffer 4-30 long, specifying 4-8 offset 2-10 retrieving by segments 4-38 segment 2-10 syntax of 2-4 writing segments of 4-42 Structure See Information architecture and DDL Subject IPM (nonreceipt notification) 3-124 IPM (receipt notification) 3-130 of IPM 3-114 Submission of communication, history of 3-21 Submission time delivery envelope 3-15 expansion record 3-21 Subobject 2-2 deleting 4-25 inserting attri
U Index Two-dimensional images 3-30 Type DDL constant values EDI-T- A-29 IM-T- A-21 MH-T- A-9 OM-T- A-7 description of 2-1 electronic data interchange attribute 3-137 example of 2-2 in object, examining 4-26 message handling attribute 3-5 object management attribute 3-3 representation 2-3 Value (continued) use in inserting 4-34 removing attribute 4-40 retrieving from single-valued attribute 4-26 retrieving multivalued attribute 2-8 retrieving segment of string 4-38 single-valued attribute 4-30 writing st
Special Characters Index ZGPI-RC- (continued) inbound-mapping errors B-45 object tree management errors B-28 outbound-mapping errors B-40 parameter validation errors B-14 ZGPI-STDANGLING-OBJ structure B-66 ERROR-ATTR structure B-63 INFO-3 structure B-68 INFO-4 structure B-68 INFO-5 structure B-69 Z-STRUCT-TYPE B-62 Special Characters ?SOURCE directive 4-1, A-1 OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001 Index -24
