OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual
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.
Part Number
Published
522223-001
November 2001
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.
Document Disclaimer
Information contained in a manual is subject to change without notice. Please check with your authorized
representative to make sure you have the most recent information.
Export Statement
Export of the information contained in this manual may require authorization from the U.S. Department of
Commerce.
Examples
Examples and sample programs are for illustration only and may not be suited for your particular purpose. The
inclusion of examples and sample programs in the documentation does not warrant, guarantee, or make any
representations regarding the use or the results of the use of any examples or sample programs in any
documentation. You should verify the applicability of any example or sample program before placing the software
into productive use.
U.S. Government Customers
FOR U.S. GOVERNMENT CUSTOMERS REGARDING THIS DOCUMENTATION AND THE ASSOCIATED
SOFTWARE:
These notices shall be marked on any reproduction of this data, in whole or in part.
NOTICE: Notwithstanding any other lease or license that may pertain to, or accompany the delivery of, this
computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in
Section 52.227-19 of the FARS Computer Software—Restricted Rights clause.
RESTRICTED RIGHTS NOTICE: Use, duplication, or disclosure by the Government is subject to the
restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at
DFARS 52.227-7013.
RESTRICTED RIGHTS LEGEND: Use, duplication or disclosure by the Government is subject to restrictions
as set forth in paragraph (b)(3)(B) of the rights in Technical Data and Computer Software clause in
DAR 7-104.9(a). This computer software is submitted with “restricted rights.” Use, duplication or disclosure is
subject to the restrictions as set forth in NASA FAR SUP 18-52 227-79 (April 1985) “Commercial Computer
Software—Restricted Rights (April 1985).” If the contract contains the Clause at 18-52 227-74 “Rights in Data
General” then the “Alternate III” clause applies.
U.S. Government Users Restricted Rights — Use, duplication or disclosure restricted by GSA ADP Schedule
Contract.
Unpublished — All rights reserved under the Copyright Laws of the United States.
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.400 Messages 1-2
Gateway Interface Programs
GPI Initialization
1-3
Gateway Sessions
1-3
Object Management
1-3
1-4
1-5
Message Transfer
Status Checking
1-5
Military Messaging Support 1-6
Conformance of the GPI to X.400 API Specifications 1-7
2. Information Architecture and Data Structures
Attributes and Objects
2-1
Classes of Objects
2-1
Class Hierarchy
2-2
Attribute Descriptors 2-2
Compaq Computer Corporation —522223-001
i
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. Object Classes and Attribute Types
Object Class Descriptions 3-1
Object Management Classes 3-3
OM-C-EXTERNAL
3-3
Message Handling Classes 3-5
MH-C-ALGORITHM 3-5
MH-C-ALGORITHM-AND-RESULT
3-7
MH-C-BILATERAL-INFORMATION
3-9
MH-C-DELIVERY-ENVELOPE
3-11
MH-C-EITS 3-15
MH-C-ENVIRONMENT 3-19
MH-C-EXPANSION-RECORD
MH-C-EXTENSION
3-21
3-22
MH-C-EXTERNAL-TRACE-ENTRY
MH-C-G3-FAX-NBPS
3-29
MH-C-GENERAL-CONTENT
3-31
MH-C-INTERNAL-TRACE-ENTRY
MH-C-MESSAGE
3-33
3-37
MH-C-MESSAGE-RD
3-43
MH-C-MTS-IDENTIFIER
MH-C-OR-NAME
3-25
3-48
3-50
MH-C-P1-ENCODED-PDU
MH-C-PER-RECIPIENT-DR
3-57
3-59
MH-C-PER-RECIPIENT-NDR 3-63
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
ii
3. Object Classes and Attribute Types (continued)
Contents
3. Object Classes and Attribute Types (continued)
MH-C-PROBE
3-68
MH-C-PROBE-RD
3-73
MH-C-REPORT 3-78
MH-C-SECURITY-LABEL
MH-C-TELETEX-NBPS
3-85
3-87
Interpersonal Messaging Classes 3-89
IM-C-ACP127-DATA-BODY-PART
IM-C-ACP127-NOTIFICATION
3-89
3-90
3-92
IM-C-ACP127-NOTIFICATION-RSP
IM-C-ADATP3-BODY-PART 3-94
IM-C-ADDRESS-LIST-DESIGNATOR
3-95
3-97
IM-C-BILAT-DEFINED-BODY-PART
IM-C-CORRECTIONS-BODY-PART
3-98
IM-C-DISTRIBUTION-CODES 3-99
IM-C-EXTERN-DEFINED-BODY-PART
IM-C-G3-FAX-BODY-PART
3-100
3-101
IM-C-FORWARDED-ENC-BODY-PART
3-104
IM-C-G4-CLASS-1-BODY-PART
IM-C-IA5-TEXT-BODY-PART
3-103
3-105
IM-C-INTERPERSONAL-MESSAGE 3-107
IM-C-IPM-IDENTIFIER
3-115
IM-C-ISO-6937-TEXT-BODY-PART 3-116
IM-C-MESSAGE-BODY-PART
IM-C-MESSAGE-TYPE
3-117
3-118
IM-C-MIXED-MODE-BODY-PART
3-119
IM-C-MM-MESSAGE-BODY-PART
3-120
3-120
IM-C-NAT-DEFINED-BODY-PART
IM-C-NON-RECEIPT-NOTIFICATION 3-122
IM-C-OR-DESCRIPTOR
3-124
IM-C-OTHER-RECIP-DESIGNATOR
IM-C-PILOT-INFORMATION
3-126
3-127
IM-C-RECEIPT-NOTIFICATION
3-129
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
iii
3. Object Classes and Attribute Types (continued)
Contents
3. Object Classes and Attribute Types (continued)
IM-C-RECIPIENT-SPECIFIER 3-131
IM-C-TELETEX-BODY-PART
3-133
IM-C-UNIDENTIFIED-BODY-PART
IM-C-VIDEOTEX-BODY-PART
3-135
3-136
Electronic Data Interchange Messaging Classes 3-137
3-137
EDI-C-AUTHORIZATION-INFO
EDI-C-CROSS-REF-INFO
3-138
EDI-C-EDI-APP-SECUR-ELTS 3-140
3-142
EDI-C-EDI-BODYPART
EDI-C-EDI-EXTENSION
EDI-C-EDI-HEADING
3-143
3-144
EDI-C-EDI-NOTIF-REQUESTS
EDI-C-EDIM
3-149
3-151
EDI-C-EDIM-BODYPART 3-153
EDI-C-EDIM-EX-DF-BODYPART
EDI-C-EDIM-ID
3-154
3-156
EDI-C-EDIN-RECEIVER
3-157
EDI-C-FN-PDAU-REASON-CODE 3-158
EDI-C-FN-UAMS-REASON-CODE 3-159
EDI-C-FN-USER-REASON-CODE
3-160
EDI-C-FORWARD-NOTIF 3-161
EDI-C-INTER-SENDER-RECIP 3-163
EDI-C-NEGATIVE-NOTIF
3-164
EDI-C-NN-PDAU-REASON-CODE
3-167
EDI-C-NN-UAMS-REASON-CODE
3-168
EDI-C-NN-USER-REASON-CODE
3-170
EDI-C-POSITIVE-NOTIF 3-171
EDI-C-RECIP-REFERENCE
3-173
EDI-C-RECIPS 3-174
EDI-C-SECUR-ELEMENTS
3-177
EDI-C-SERV-STRING-ADVICE 3-178
EDI-C-SYNTAX-ID
3-179
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
iv
4. Procedure Calls
Contents
4. Procedure Calls
Files Provided by Compaq 4-1
Procedure Names and Categories
4-1
Procedure Call Descriptions 4-3
GPI_CLOSE_
4-6
GPI_INITIALIZE_
4-7
GPI_MT_FINISH_TRANSFER_IN_
4-10
GPI_MT_START_TRANSFER_IN_
4-13
GPI_MT_TRANSFER_OUT_ 4-16
4-18
GPI_MT_WAIT_
GPI_OM_COPY_ 4-20
GPI_OM_CREATE_ 4-22
GPI_OM_DELETE_ 4-25
GPI_OM_EXAMINE_
4-26
GPI_OM_FETCH_ 4-30
GPI_OM_INSERT_ 4-33
GPI_OM_LIST_
4-35
GPI_OM_READ_ 4-38
4-40
GPI_OM_REMOVE_
GPI_OM_WRITE_ 4-42
GPI_OPEN_ 4-46
GPI_STATUS_ 4-49
A. DDL Definitions
Basic Data Types
A-1
Intermediate Data Types A-1
First-Level Data Types
A-2
Second-Level Data Types
A-4
Third-Level Data Types A-4
Named Values
A-5
Symbolic Constants
A-5
Object Management Classes and Types
Message Handling Classes and Types
Message Handling Value Limits
A-6
A-7
A-11
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
v
A. DDL Definitions (continued)
Contents
A. DDL Definitions (continued)
Message Handling Enumerated Values
A-13
Interpersonal Messaging Classes and Types
Interpersonal Messaging Value Limits
A-20
A-24
Interpersonal Messaging Enumerated Values
A-24
Electronic Data Interchange (EDI) Classes and Types A-26
A-32
EDI Forwarded Notification Codes
EDI Negative Notification Codes A-34
EDI Notification Initiator Enumerated Values A-37
EDI Value Limits A-37
GPI External Constants
GPI Parameter Positions
A-38
A-43
B. Return Codes
Status Checking B-1
Standard X.400 API Return Codes B-2
Object-Management Return Codes
B-2
0 OM-RC-SUCCESS B-3
2 OM-RC-FUNCTION-DECLINED
B-3
3 OM-RC-FUNCTION-INTERRUPTED
B-4
4 OM-RC-MEMORY-INSUFFICIENT B-4
5 OM-RC-NETWORK-ERROR
6 OM-RC-NO-SUCH-CLASS
B-4
B-4
9 OM-RC-NO-SUCH-OBJECT
B-4
12 OM-RC-NO-SUCH-SYNTAX B-5
13 OM-RC-NO-SUCH-TYPE B-5
17 OM-RC-NOT-PRESENT
B-5
20 OM-RC-PERMANENT-ERROR
B-5
21 OM-RC-POINTER-INVALID B-5
22 OM-RC-SYSTEM-ERROR B-6
23 OM-RC-TEMPORARY-ERROR B-6
24 OM-RC-TOO-MANY-VALUES B-6
25 OM-RC-VALUES-NOT-ADJACENT B-6
26 OM-RC-WRONG-VALUE-LENGTH
B-6
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
vi
B. Return Codes (continued)
Contents
B. Return Codes (continued)
27 OM-RC-WRONG-VALUE-MAKEUP
B-7
28 OM-RC-WRONG-VALUE-NUMBER B-7
B-7
29 OM-RC-WRONG-VALUE-SYNTAX
30 OM-RC-WRONG-VALUE-TYPE
Message-Handling Return Codes
B-7
B-7
100 MH-RC-FEATURE-CONFLICTS
106 MH-RC-NOT-RESERVED
B-8
B-8
107 MH-RC-NOT-UNRESERVED
B-8
109 MH-RC-QUEUE-EMPTY
B-9
110 MH-RC-SESSION-BUSY
B-9
111 MH-RC-SESSION-NOT-BUSY B-9
B-9
113 MH-RC-TOO-MANY-SESSIONS
115 MH-RC-NO-SUCH-SESSION
GPI_STATUS_ Information
Request Types
Error Classes
B-9
B-10
B-10
B-11
0 ZGPI-RC-CLASS-SUCCESS
B-12
10 ZGPI-RC-CLASS-WARNING
B-12
20 ZGPI-RC-CLASS-IMMINENT
B-12
30 ZGPI-RC-CLASS-FAILED
B-13
40 ZGPI-RC-CLASS-CLIENT
B-13
50 ZGPI-RC-CLASS-BLOCKED-INT
60 ZGPI-RC-CLASS-BLOCKED
B-13
B-13
70 ZGPI-RC-CLASS-FATAL B-14
80 ZGPI-RC-CLASS-INTERNAL
Compaq Proprietary Codes
B-14
B-14
2000 ZGPI-RC-MISSING-REQUIRED-PARAM
2001 ZGPI-RC-PARAMETER-OUT-OF-BOUND
B-15
B-15
2002 ZGPI-RC-MISSING-OPTIONAL-PARAM B-15
2003 ZGPI-RC-PARAMETER-OUT-OF-RANGE
B-16
2004 ZGPI-RC-INT-PARAM-OUT-OF-RANGE B-16
2005 ZGPI-RC-INT-PARAM-OUT-OF-BOUND B-16
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
vii
B. Return Codes (continued)
Contents
B. Return Codes (continued)
2006 ZGPI-RC-MISSING-INT-OPT-PARAM
B-16
2007 ZGPI-RC-MISSING-INT-REQ-PARAM
B-16
2008 ZPGI-RC-CLASS-ERROR
B-17
2100 ZGPI-RC-EXCEEDED-MAX-OT-COUNT B-18
2101 ZGPI-RC-FOUND-DANGLING-OBJECT B-18
B-18
2200 ZGPI-RC-BUF-ELMT-NOT-FOUND
2201 ZGPI-RC-BAD-IPC-BUF B-18
2202 ZGPI-RC-BAD-REQUEST-TYPE
B-18
2203 ZGPI-RC-BAD-GRP-HDR-TYPE
B-19
2204 ZGPI-RC-BAD-GRP-HDR-LEN
B-19
2205 ZGPI-RC-BAD-ELMT-HDR-TYPE
B-19
2206 ZGPI-RC-BAD-ELMT-SUBTYPE
B-19
2207 ZGPI-RC-BAD-ELMT-HDR-LEN
B-19
2208 ZGPI-RC-BAD-ELMT-LEN
B-19
B-20
2209 ZGPI-RC-BAD-SESSION-ID
2210 ZGPI-RC-INVALID-MGR-NAME
B-20
2501 ZGPI-RC-WRITEREADX-ERROR
B-21
2502 ZGPI-RC-REPLYX-ERROR B-21
2503 ZGPI-RC-ALLOCATESEGMENT-ERROR
2504 ZGPI-RC-USESEGMENT-ERROR
2505 ZGPI-RC-DEFINEPOOL-ERROR
B-22
B-22
2506 ZGPI-RC-GETPOOL-ERROR
B-22
2507 ZGPI-RC-PUTPOOL-ERROR
B-22
2508 ZGPI-RC-MOVEX-ERROR
B-22
B-23
2509 ZGPI-RC-READUPDATEX-ERROR
B-23
2510 ZGPI-RC-FNAME32COLLAPSE-ERROR B-23
2511 ZGPI-RC-FNAMEEXPAND-ERROR
B-23
2512 ZGPI-RC-RESIZESEGMENT-ERROR B-23
2513 ZGPI-RC-SSGET-ERROR B-24
2514 ZGPI-RC-SSGETTKN-ERROR
B-24
2515 ZGPI-RC-SSINIT-ERROR B-24
2516 ZGPI-RC-SSPUTTKN-ERROR
B-24
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
viii
B. Return Codes (continued)
Contents
B. Return Codes (continued)
2517 ZGPI-RC-SETMODE-ERROR
B-24
2518 ZGPI-RC-SIGNALTIMEOUT-ERROR B-24
B-25
2519 ZGPI-RC-BEGINTRANSACTION-ERROR
2520 ZGPI-RC-GETTMPNAME-ERROR
B-25
2521 ZGPI-RC-OPEN-ERROR B-25
2522 ZGPI-RC-AWAITIOX-ERROR B-25
4000 ZGPI-RC-SEGMENT-ALREADY-IN-USE
4001 ZGPI-RC-OPEN-WAIT-GIP-ERROR
B-26
B-26
4003 ZGPI-RC-CLOSE-WAIT-GIP-ERROR
4005 ZGPI-RC-NO-OUTPUT-FROM-GIP
4006 ZGPI-RC-STRING-TOO-LONG
B-26
B-27
B-27
4007 ZGPI-RC-OT-COUNT-MISMATCH-TBL
B-27
4008 ZGPI-RC-EXCEEDED-RESERVED-OTS
B-27
4009 ZGPI-RC-CLOSE-SCP-ERROR
B-27
4010 ZGPI-RC-OPEN-SCP-ERROR
4011 ZGPI-RC-SPI-CMD-ERROR
4012 ZGPI-RC-NO-GIPS
B-27
B-28
B-28
B-28
4013 ZGPI-RC-SESSION-ABORTED
5000 ZGPI-RC-OBJ-ALREADY-ATTACHED
B-29
5001 ZGPI-RC-ILLEGAL-NON-ROOT-COPY
B-29
B-29
5002 ZGPI-RC-ILLEGAL-ROOT-COPY
5003 ZGPI-RC-PROTOCOL-ERROR B-29
5004 ZGPI-RC-NO-SUCH-POSITION
B-29
5005 ZGPI-RC-ATT-MTA-NAME-ERROR
5006 ZGPI-RC-MD-NAME-ERROR
B-30
B-30
5007 ZGPI-RC-BAD-STRING-OFFSET
B-30
6000 ZGPI-RC-NOT-STARTED-STATE
B-32
6001 ZGPI-RC-ILLEGAL-GPI-OPEN
6002 ZGPI-RC-GIP-BUSY
B-32
B-33
6003 ZGPI-RC-NO-PREVIOUS-GPI-OPEN
6004 ZGPI-RC-INVALID-PID
B-33
B-33
6005 ZGPI-RC-UNKNOWN-GPI-REQUEST
B-33
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
ix
B. Return Codes (continued)
Contents
B. Return Codes (continued)
6006 ZGPI-RC-OTT-FAILURE
B-33
6007 ZGPI-RC-UNEXPECTED-OTT-REQ
B-34
B-34
6008 ZGPI-RC-IPC-PROTOCOL-ERROR
6009 ZGPI-RC-TMF-ERROR B-34
6010 ZGPI-RC-GIP-SEND-FAILURE
B-34
6011 ZGPI-RC-WAIT-CANCELLED B-34
6012 ZGPI-RC-GIP-INTERNAL-ERROR
B-34
6013 ZGPI-RC-GW-AUX-P-AUX-UNEXP-REPLY B-35
B-35
6014 ZGPI-RC-GW-AUX-PNAME-ERROR
6015 ZGPI-RC-GW-PNAME-ERROR B-35
6016 ZGPI-RC-PDU-FILE-INACCESSIBLE B-35
6017 ZGPI-RC-PREVIOUS-OT-DELETED
B-35
6018 ZGPI-RC-ILLEGAL-WAIT-INTERVAL
B-36
6019 ZGPI-RC-PDU-SUBSYS-INIT-ERROR
B-36
6020 ZGPI-RC-GW-DATABASE-OPEN-ERROR B-36
6023 ZGPI-RC-GW-DATABASE-READ-ERROR B-36
6024 ZGPI-RC-INVALID-GATEWAY-INFO
B-36
6025 ZGPI-RC-UNUSABLE-ADMIN-QUEUE B-36
6026 ZGPI-RC-MRP-NOT-COMPATIBLE B-37
6027 ZGPI-RC-VERSION-CHECK-ERROR
6028 ZGPI-RC-MRP-UNAVAILABLE
B-37
B-37
6029 ZGPI-RC-INVALID-GW-PASSWORD
6030 ZGPI-RC-NO-GATEWAY
B-37
B-37
6031 ZGPI-RC-CONNECT-FAILURE
6032 ZGPI-RC-OT-INIT-FAILURE
B-38
B-38
6033 ZGPI-RC-INCOMPATIBLE-GIP
B-38
6034 ZGPI-RC-INVALID-REMOVE-FLAG
B-38
6035 ZGPI-RC-PDU-STORES-TOO-FULL
B-38
6036 ZGPI-RC-GW-NAME-NOT-CONFIGURED
6037 ZGPI-RC-NO-PDU-MEMORY-BUFFER
B-39
B-39
6038 ZGPI-RC-ENCODED-MSG-TOO-LONG B-39
6039 ZGPI-RC-QUEUE-ENTRY-ARCHIVED
B-39
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
x
B. Return Codes (continued)
Contents
B. Return Codes (continued)
6040 ZGPI-RC-ARCHIVE-WRITE-FAILED B-40
8001 ZGPI-RC-OTM-OUTBOUND-ERROR
B-41
B-41
8002 ZGPI-RC-GW-OUTBOUND-ERROR
8003 ZGPI-RC-BAD-CN-CHAR
B-41
8004 ZGPI-RC-BAD-CN-DIGIT
B-42
8005 ZGPI-RC-BAD-SYNTAX
8006 ZGPI-RC-BAD-TYPE
B-42
B-42
8007 ZGPI-RC-BAD-ACTION-SELECTOR
B-42
8008 ZGPI-RC-BAD-SPECIAL-SELECTOR B-42
8009 ZGPI-RC-BAD-ENUMERATION-CASE
8010 ZGPI-RC-BAD-ROOT-CHECK
B-43
B-43
8011 ZGPI-RC-MAX-ARCS-EXCEEDED
8012 ZGPI-RC-CONTENT-ERROR
8013 ZGPI-RC-BAD-ATTR-TYPE
B-43
B-43
B-43
8014 ZGPI-RC-NO-MATCHING-EXTENSION B-44
8015 ZGPI-RC-BAD-TABLE-OPERATION
B-44
8016 ZGPI-RC-BAD-KIND B-44
8017 ZGPI-RC-DEFAULT-CLASS
B-44
8018 ZGPI-RC-BAD-PDU-OPERATION
B-44
8019 ZGPI-RC-PDU-ID-UNAVAILABLE B-45
8020 ZGPI-RC-BAD-EDI-PLACEHOLDER B-45
8021 ZGPI-RC-ADD-BODYPART-ERROR
B-45
8500 ZGPI-RC-ILLEGAL-RECIPIENT-DR B-46
8501 ZGPI-RC-OTM-INBOUND-ERROR
B-47
8502 ZGPI-RC-UNSUPPORTED-EXTENSION
B-47
8503 ZGPI-RC-UNSUPPORTED-ATTR-TYPE
B-47
8504 ZGPI-RC-GW-INBOUND-ERROR B-47
8505 ZGPI-RC-EXT-TYPE-MISMATCH
8506 ZGPI-RC-CLASS-NOT-FOUND
B-47
B-48
8507 ZGPI-RC-UNDECODABLE-MESSAGE
B-48
8508 ZGPI-RC-UNDECODABLE-CONTENT
B-48
8509 ZGPI-RC-ILLEGAL-NOTIF-REQ
B-48
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xi
B. Return Codes (continued)
Contents
B. Return Codes (continued)
8510 ZGPI-RC-INIT-MEMORY-FAILURE B-48
8511 ZGPI-RC-UNREADABLE-PDU
B-49
B-49
8512 ZGPI-RC-UNSUPPORTED-BODY-PART
Secondary Codes
B-49
1004 ZGPI-FDC-XFER-OUT-IN-PROGRESS B-50
B-50
1007 ZGPI-FDC-NOT-MODIFIABLE
1008 ZGPI-FDC-ENVIRONMENT-OBJ
B-50
1009 ZGPI-FDC-NOT-A-ROOT-OBJ B-50
1010 ZGPI-FDC-WRONG-ROOT-OBJ
B-50
1011 ZGPI-FDC-REMOTE-MGR-NAME
B-50
1012 ZGPI-FDC-NOWAIT-NOT-SUPPORTED B-51
1050 ZGPI-MIC-NO-MORE-OT-ENTRIES
1051 ZGPI-MIC-NO-MORE-OT-DATA
B-51
B-51
1052 ZGPI-MIC-NO-MORE-OTS B-51
B-51
1053 ZGPI-MIC-NO-MORE-PDUS
1100 ZGPI-NSOC-NULL-OBJ-ID
B-52
1101 ZGPI-NSOC-ELMT-ALREADY-DELETED
1102 ZGPI-NSOC-BAD-OBJ-ID-OT-OR-REV
1103 ZGPI-NSOC-BAD-OBJ-ID-INDEX
1104 ZGPI-NSOC-ELMT-IS-AN-ATTR
B-52
B-52
B-52
B-52
1105 ZGPI-NSOC-BAD-DSCR-OBJ-PTR B-52
1106 ZGPI-NSOC-OBJ-NOT-IN-SESSION
1150 ZGPI-PIC-OBJ-ID-PTR
B-52
B-53
1151 ZGPI-PIC-OTD-PTR B-53
1152 ZGPI-PIC-ATTR-PTR B-53
1153 ZGPI-PIC-OBJ-PTR B-53
1154 ZGPI-PIC-SESSION-PTR
B-53
1155 ZGPI-PIC-DSCR-STR-PTR
B-53
1200 ZGPI-SEC-NOT-AN-ATTR-PTR
1201 ZGPI-SEC-MISSING-PTR
B-54
B-54
1202 ZGPI-SEC-BAD-PTR B-54
1203 ZGPI-SEC-BAD-OT-SIZE B-54
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xii
B. Return Codes (continued)
Contents
B. Return Codes (continued)
1204 ZGPI-SEC-BAD-MV-HDR B-54
1205 ZGPI-SEC-BAD-MV-TYPE B-55
1206 ZGPI-SEC-ILLEGAL-MV-HDR-OPEN
B-55
1207 ZGPI-SEC-OT-ALLOCATION-ERROR
B-55
1208 ZGPI-SEC-NUM-EXCEEDED-MAX-OTS B-55
B-55
1209 ZGPI-SEC-BAD-SESSION-ID
1210 ZGPI-SEC-VALUE-N-CNT-NOT-MATCH
1211 ZGPI-SEC-BAD-OT-TBL-ENTRIES
B-55
B-55
B-55
1212 ZGPI-SEC-BAD-OT-TBL-DATA
1213 ZGPI-SEC-BAD-INIT-OT-TBL-NUM
B-55
1214 ZGPI-SEC-BAD-MAX-OT-TBL-NUM
B-56
B-56
1215 ZGPI-SEC-BAD-IPC-HDR-LEN
1216 ZGPI-SEC-BAD-IPC-ELMT-LEN B-56
1250 ZGPI-TMVC-MULTI-VALUED-ATTR
B-56
1251 ZGPI-TMVC-SINBLE-VALUED-ATTR
B-56
1300 ZGPI-WVNC-ENUMERATED-VALUE
B-56
1350 ZGPI-PEC-OTT-RSP-ERROR B-57
1351 ZGPI-PEC-OTT-TYPE-ERROR B-57
1352 ZGPI-PEC-OTT-OFFSET-ERROR
B-57
1353 ZGPI-PEC-OTT-INDEX-ERROR B-57
1354 ZGPI-PEC-SIZE-ERROR
B-57
1400 ZGPI-IRDC-BOTH-BITS-SET
B-57
1401 ZGPI-IRDC-NEITHER-BIT-SET
B-58
1500 ZGPI-WVMC-BAD-BIT-STRING B-58
1501 ZGPI-WVMC-BAD-CONTENT-TYPE
B-58
1502 ZGPI-WVMC-BAD-CRITICALITY B-58
1503 ZGPI-WVMC-BAD-OR-NAME
1504 ZGPI-WVMC-BAD-ACTION
B-59
B-59
1505 ZGPI-WVMC-BAD-COUNTRY-NAME
1506 ZGPI-WVMC-BAD-SYNTAX-TYPE
1507 ZGPI-WVMC-EXTRA-ENCODING
1508 ZGPI-WVMC-RPT-REQS-CONFLICT
B-59
B-59
B-59
B-59
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xiii
B. Return Codes (continued)
Contents
B. Return Codes (continued)
1509 ZGPI-WVMC-BAD-CONTENT-LEN
B-59
1510 ZGPI-WVMC-BAD-OBJECT-ID-STRING B-59
B-60
1550 ZGPI-NPC-TYPE-NOT-FOUND
1551 ZGPI-NPC-POSITION-NOT-FOUND
B-60
1600 ZGPI-IGIC-TOO-MANY-PNAMES B-60
B-60
1601 ZGPI-IGIC-BAD-PNAME-LEN
1602 ZGPI-IGIC-BAD-AUX-PNAME-LEN
1603 ZGPI-IGIC-BAD-AUX-PANME
B-60
B-60
1604 ZGPI-IGIC-BAD-GATEWAY-TYPE
1650 ZGPI-PFIC-INFO--NOT-INIT
1651 ZGPI-PFIC-INFO--NO-PDU
B-61
B-61
B-61
1652 ZGPI-PFIC-INFO--NO-STORE
1653 ZGPI-PFIC-INFO--NO-TMF
B-60
B-61
1654 ZGPI-PFIC-UNEXPECTED-ERROR
1700 ZGPI-UAQC-INVALID-MGR-NAME
B-61
B-61
1701 ZGPI-UAQC-INVALID-GATEWAY-NAME
1750 ZGPI-QEAC-UNKOWN-PDU
B-62
1751 ZGPI-QEAC-INVALID-GW-PDU
1752 ZGPI-QEAC-INVALID-GW-ID
Information Buffer
B-61
B-62
B-62
B-62
C. GPI Procedure Calls for the C Language
D. Class Hierarchies
E. Event Messages
Glossary
Index
Figures
Figure i.
Related Publications xxix
Figure ii.
Compaq OSI/MHS Manual Set xxxi
Figure 1-1.
GPI Service
1-1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xiv
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.
Sample GPI Procedure Call Description (continued)
Figure B-1.
Information Buffer for Attribute in Error
Figure B-2.
Information Buffer for Dangling Objects B-67
Figure D-1.
Message Object Class D-2
Figure D-2.
Probe Object Class D-3
Figure D-3.
Report Object Class
Figure D-4.
Interpersonal Message Object Class
Figure D-5.
Message Body Part and Delivery Envelope Object Classes D-6
Figure D-6.
Receipt and Nonreceipt Notification Object Classes
Figure D-7.
Per-Recipient DR and NDR Object Classes
Figure D-8.
OR Name and EITS Object Classes D-9
Figure D-9.
EDI Message (EDIM) and Forwarded Notification Object Classes
2-9
4-5
B-65
D-4
D-5
D-7
D-8
Figure D-10. Negative Notification and Positive Notification Object Classes
Figure D-11. EDI Heading Object Class
D-10
D-11
D-12
Figure D-12. EDI Message Body Part and Delivery Envelope Object Classes
D-13
Figure D-13. Security Elements Object Class D-14
Tables
Table 3-1.
OM-C-EXTERNAL Attributes—General Characteristics
3-3
Table 3-2.
MH-C-ALGORITHM Attributes—General Characteristics
Table 3-3.
MH-C-ALGORITHM Attributes—Additional Characteristics 3-5
Table 3-4.
MH-C-ALGORITHM-AND-RESULT Attributes—General
Characteristics 3-7
Table 3-5.
MH-C-ALGORITHM-AND-RESULT Attributes—Additional
Characteristics 3-7
3-5
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xv
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.
MH-C-EITS Attributes—Additional Characteristics
Table 3-12.
MH-C-ENVIRONMENT Attributes—General Characteristics
Table 3-13.
MH-C-ENVIRONMENT Attributes—Additional Characteristics 3-19
Table 3-14.
MH-C-EXPANSION-RECORD Attributes—General
Characteristics 3-21
Table 3-15.
MH-C-EXPANSION-RECORD Attributes—Additional
Characteristics 3-21
Table 3-16.
MH-C-EXTENSION Attributes—General Characteristics
Table 3-17.
MH-C-EXTENSION Attributes—Additional Characteristics
Table 3-18.
MH-C-EXTERNAL-TRACE-ENTRY Attributes—General
Characteristics 3-25
Table 3-19.
MH-C-EXTERNAL-TRACE-ENTRY Attributes—Additional
Characteristics (page 1 of 2) 3-25
Table 3-20.
MH-C-G3-FAX-NBPS Attributes—General Characteristics 3-29
Table 3-21.
MH-C-G3-FAX-NBPS Attributes—Additional Characteristics
Table 3-22.
MH-C-GENERAL-CONTENT Attributes—General
Characteristics 3-31
Table 3-23.
MH-C-INTERNAL-TRACE-ENTRY Attributes—General
Characteristics 3-33
Table 3-24.
MH-C-INTERNAL-TRACE-ENTRY Attributes—Additional
Characteristics 3-34
Table 3-25.
MH-C-MESSAGE Attributes—General
Characteristics (page 1 of 2) 3-37
Table 3-26.
MH-C-MESSAGE Attributes—Additional Characteristics
Table 3-27.
MH-C-MESSAGE-RD Attributes—General Characteristics 3-43
3-16
3-16
3-19
3-22
3-23
3-29
3-39
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xvi
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.
MH-C-P1-ENCODED-PDU Attributes—General Characteristics
Table 3-34.
MH-C-PER-RECIPIENT-DR Attributes—General Characteristics
Table 3-35.
MH-C-PER-RECIPIENT-DR Attributes—Additional
Characteristics 3-60
Table 3-36.
MH-C-PER-RECIPIENT-NDR Attributes—General
Characteristics 3-63
Table 3-37.
MH-C-PER-RECIPIENT-NDR Attributes—Additional
Characteristics (page 1 of 2) 3-64
Table 3-38.
MH-C-PROBE Attributes—General Characteristics (page 1 of 2)
Table 3-39.
MH-C-PROBE Attributes—Additional
Characteristics (page 1 of 2) 3-69
Table 3-40.
MH-C-PROBE-RD Attributes—General Characteristics
Table 3-41.
MH-C-PROBE-RD Attributes—Additional
Characteristics (page 1 of 2) 3-74
Table 3-42.
MH-C-REPORT Attributes—General
Characteristics (page 1 of 2) 3-78
Table 3-43.
MH-C-REPORT Attributes—Additional Characteristics
Table 3-44.
MH-C-SECURITY-LABEL Attributes—General Characteristics 3-85
Table 3-45.
MH-C-SECURITY-LABEL Attributes—Additional
Characteristics 3-85
Table 3-46.
MH-C-TELETEX-NBPS Attributes—General Characteristics 3-87
Table 3-47.
MH-C-TELETEX-NBPS Attributes—Additional Characteristics
Table 3-48.
IM-C-ACP127-DATA-BODY-PART Attributes—General
Characteristics 3-89
Table 3-49.
IM-C-ACP127-DATA-BODY-PART Attributes—Additional
Characteristics 3-89
3-57
3-59
3-68
3-73
3-80
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xvii
3-87
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.
IM-C-ADDRESS-LIST-DESIGNATOR Attributes—Additional
Characteristics 3-95
Table 3-56.
IM-C-BILAT-DEFINED-BODY-PART Attributes—General
Characteristics 3-97
Table 3-57.
IM-C-CORRECTIONS-BODY-PART Attributes—General
Characteristics 3-98
Table 3-58.
IM-C-DISTRIBUTION-CODES Attributes—General
Characteristics 3-99
Table 3-59.
IM-C-DISTRIBUTION-CODES Attributes—Additional
Characteristics 3-99
Table 3-60.
IM-C-EXTERN-DEFINED-BODY-PART Attributes—General
Characteristics 3-100
Table 3-61.
IM-C-G3-FAX-BODY-PART Attributes—General
Characteristics 3-101
Table 3-62.
IM-C-FORWARDED-ENC-BODY-PART Attributes—General
Characteristics 3-103
Table 3-63.
IM-C-G4-CLASS-1-BODY-PART Attributes—General
Characteristics 3-104
Table 3-64.
IM-C-IA5-TEXT-BODY-PART Attributes—General
Characteristics 3-105
Table 3-65.
IM-C-IA5-TEXT-BODY-PART Attributes—Additional
Characteristics 3-105
Table 3-66.
IM-C-INTERPERSONAL-MESSAGE Attributes—General
Characteristics (page 1 of 3) 3-107
Table 3-67.
IM-C-INTERPERSONAL-MESSAGE Attributes—Additional
Characteristics 3-109
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xviii
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.
IM-C-MESSAGE-TYPE Attributes—General Characteristics
Table 3-74.
IM-C-MESSAGE_TYPE Attributes—Additional Characteristics
Table 3-75.
IM-C-MIXED-MODE-BODY-PART Attributes—General
Characteristics 3-119
Table 3-76.
IM-C-MM-MESSAGE-BODY-PART Attributes—General
Characteristics 3-120
Table 3-77.
IM-C-NAT-DEFINED-BODY-PART Attributes—General
Characteristics 3-121
Table 3-78.
IM-C-NON-RECEIPT-NOTIFICATION Attributes—General
Characteristics 3-122
Table 3-79.
IM-C-NON-RECEIPT-NOTIFICATION Attributes—Additional
Characteristics 3-123
Table 3-80.
IM-C-OR-DESCRIPTOR Attributes—General Characteristics
Table 3-81.
IM-C-OR-DESCRIPTOR Attributes—Additional Characteristics
Table 3-82.
IM-C-OTHER-RECIP-DESIGNATOR Attributes—General
Characteristics 3-126
Table 3-83.
IM-C-OTHER-RECIP-DESIGNATOR Attributes—Additional
Characteristics 3-126
Table 3-84.
IM-C-PILOT-INFORMATION Attributes— General
Characteristics 3-127
Table 3-85.
IM-C-PILOT-INFORMATION Attributes—Additional
Characteristics 3-127
Table 3-86.
IM-C-RECEIPT-NOTIFICATION Attributes—General
Characteristics 3-129
Table 3-87.
IM-C-RECEIPT-NOTIFICATION Attributes—Additional
Characteristics 3-129
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xix
3-115
3-115
3-118
3-118
3-124
3-124
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.
IM-C-VIDEOTEX-BODY-PART Attributes—General
Characteristics 3-136
Table 3-94.
IM-C-VIDEOTEX-BODY-PART Attributes—Additional
Characteristics 3-136
Table 3-95.
EDI-C-AUTHORIZATION-INFO Attributes—General
Characteristics 3-138
Table 3-96.
EDI-C-AUTHORIZATION-INFO Attributes—Additional
Characteristics 3-138
Table 3-97.
EDI-C-CROSS-REF-INFO Attributes—General Characteristics 3-139
Table 3-98.
EDI-C-CROSS-REF-INFO Attributes—Additional
Characteristics 3-139
Table 3-99.
EDI-C-EDI-APP-SECUR-ELTS Attributes—General
Characteristics 3-140
Table 3-100. EDI-C-EDI-APP-SECUR-ELTS Attributes—Additional
Characteristics 3-141
Table 3-101. EDI-C-EDI-BODYPART Attributes—General Characteristics
3-142
Table 3-102. EDI-C-EDI-BODYPART Attributes—Additional Characteristics 3-142
Table 3-103. EDI-C-EDI-EXTENSION Attributes—General Characteristics
3-143
Table 3-104. EDI-C-EDI-EXTENSION Attributes—Additional
Characteristics 3-143
Table 3-105. EDI-C-EDI-HEADING Attributes—General
Characteristics (page 1 of 2) 3-145
Table 3-106. EDI-C-EDI-HEADING Attributes—Additional Characteristics 3-146
Table 3-107. EDI-C-EDI-NOTIF-REQUESTS Attributes—General
Characteristics 3-150
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xx
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. EDI-C-EDIM-EX-DF-BODYPART Attributes—Additional
Characteristics 3-155
Table 3-115. EDI-C-EDIM-ID Attributes—General Characteristics
3-156
Table 3-116. EDI-C-EDIM-ID Attributes—Additional Characteristics 3-156
Table 3-117. EDI-C-EDIN-RECEIVER Attributes—General Characteristics
Table 3-118. EDI-C-EDIN-RECEIVER Attributes—Additional
Characteristics 3-157
Table 3-119. EDI-C-FN-PDAU-REASON-CODE Attributes—General
Characteristics 3-158
Table 3-120. EDI-C-FN-PDAU-REASON-CODE Attributes—Additional
Characteristics 3-158
Table 3-121. EDI-C-FN-UAMS-REASON-CODE Attributes—General
Characteristics 3-159
Table 3-122. EDI-C-FN-UAMS-REASON-CODE Attributes—Additional
Characteristics 3-159
Table 3-123. EDI-C-FN-USER-REASON-CODE Attributes—General
Characteristics 3-160
Table 3-124. EDI-C-FN-USER-REASON-CODE Attributes—Additional
Characteristics 3-160
Table 3-125. EDI-C-FORWARD-NOTIF Attributes—General
Characteristics (page 1 of 2) 3-161
Table 3-126. EDI-C-FORWARD-NOTIF Attributes—Additional
Characteristics 3-162
Table 3-127. EDI-C-INTER-SENDER-RECIP Attributes—General
Characteristics 3-164
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxi
3-157
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. EDI-C-NN-UAMS-REASON-CODE Attributes—General
Characteristics 3-168
Table 3-134. EDI-C-NN-UAMS-REASON-CODE Attributes—Additional
Characteristics 3-169
Table 3-135. EDI-C-NN-USER-REASON-CODE Attributes—General
Characteristics 3-170
Table 3-136. EDI-C-NN-USER-REASON-CODE Attributes—Additional
Characteristics 3-170
Table 3-137. EDI-C-POSITIVE-NOTIF Attributes—General Characteristics
3-171
Table 3-138. EDI-C-POSITIVE-NOTIF Attributes—Additional
Characteristics 3-172
Table 3-139. EDI-C-RECIP-REFERENCE Attributes—General
Characteristics 3-173
Table 3-140. EDI-C-RECIP-REFERENCE Attributes—Additional
Characteristics 3-173
Table 3-141. EDI-C-RECIPS Attributes—General Characteristics 3-174
Table 3-142. EDI-C-RECIPS Attributes—Additional Characteristics
3-175
Table 3-143. EDI-C-SECUR-ELEMENTS Attributes—General
Characteristics 3-177
Table 3-144. EDI-C-SERV-STRING-ADVICE Attributes—General
Characteristics 3-178
Table 3-145. EDI-C-SERV-STRING-ADVICE Attributes—Additional
Characteristics 3-178
Table 3-146. EDI-C-SYNTAX-ID Attributes—General Characteristics
3-179
Table 3-147. EDI-C-SYNTAX-ID Attributes—Additional Characteristics 3-179
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxii
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.
ZGPI-RC- Codes for Parameter-Validation Errors B-14
Table B-6.
ZGPI-RC- Codes for GPI-Internal Errors
Table B-7.
ZGPI-RC- Codes for Guardian 90 Procedure Errors (page 1 of 2)
Table B-8.
ZGPI-RC- Codes for GPI-Library Errors (page 1 of 2)
Table B-9.
ZGPI-RC- Codes for Object Tree Management Errors
Table B-10.
ZGPI-RC- Codes for GIP Errors (page 1 of 3)
Table B-11.
ZGPI-RC- Codes for Outbound-Mapping Errors (page 1 of 2)
Table B-12.
ZGPI-RC- Codes for Inbound-Mapping Errors
Table B-13.
ZGPI-FDC- Secondary Codes
Table B-14.
ZGPI-MIC- Secondary Codes B-51
Table B-15.
ZGPI-NSOC- Secondary Codes B-51
Table B-16.
ZGPI-PIC- Secondary Codes B-52
Table B-17.
ZGPI-SEC- Secondary Codes (page 1 of 2)
Table B-18.
ZGPI-TMVC- and ZGPI-WVNC- Secondary Codes
Table B-19.
ZGPI-PEC- Secondary Codes B-57
Table B-20.
ZGPI-IRDC- Secondary Codes B-57
Table B-21.
ZGPI-WVMC- Secondary Codes B-58
Table B-22.
ZGPI-NPC- Secondary Codes B-59
Table B-23.
ZGPI-IGIC- Secondary Codes
Table B-24.
ZGPI-PFIC- Secondary Codes B-60
Table B-25.
ZGPI-UAQC- Secondary Codes B-61
Table B-26.
ZGPI-QEAC- Secondary Codes B-62
Table E-1.
GPI Event Messages E-1
4-2
B-2
B-11
B-11
B-17
B-20
B-25
B-28
B-30
B-46
B-50
B-53
B-56
B-60
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxiii
B-40
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.
Part Number
Published
522223-001
November 2001
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
New and Changed Information
This manual has been revised to document support for military messaging.
•
•
In Section 1, “Introduction to the GPI,” a new subsection, Military Messaging
Support, has been added.
In Section 3, “Object Classes and Attributes,” contains the following new object
classes:
° IM-C-ACP127-DATA-BODY-PART on page 3-89
° IM-C-ACP127-NOTIFICATION on page 3-90
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxv
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
Section 3, “Object Classes and Attribute Types,” contains new attribute types added
to the following object classes:
°
°
°
°
IIM-C-INTERPERSONAL-MESSAGE on page 3-107
IM-C-RECIPIENT-SPECIFIER on page 3-131
MH-C-MESSAGE on page 3-37
MH-C-REPORT on page 3-78
Appendix A, “DDL Definitions,” contains the following additions:
° “Message Handling Classes and Types,” contains new constants under MH-Cxxx on page A-7 and MH-T-xxx on page A-9.
° “Message Handling Value Limits” contains new constants under MH-VL-xxx on
page A-12.
° “Message Handling Enumerated Values’ contains a new heading, MH-xxx for
MH-T-SECURITY-POLICY-ID on page A-13, and new constants under MHEE-xxx on page A-14 and MH-CTO-xxx on page A-15.
° “Interpersonal Messaging Classes and Types” contains new constants under IMC-xxx on page A-20 and IM-T-xxx on page A-21,
° “Interpersonal Messaging Value Limits” contains a new heading, IM-xxx for
IM-T-SIC on page A-24 and new constants under IM-VL-xxx on page A-24.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxvi
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. The manual provides formal, detailed descriptions of the
language architecture, procedure syntax, return codes, and Data Definition Language
(DDL) structures and constants used by the GPI.
Who Should Read This Manual?
Application programmers who are writing gateway interface programs should use this
manual to obtain reference information about the GPI. All readers should be
experienced in using the Compaq Transaction Application Language (TAL) or the
C programming language and know how to develop application programs to be run on a
Compaq NonStop™ system. Readers should also have some understanding of X.400
networks and the Compaq OSI/MHS subsystem.
What’s in This Manual?
•
•
•
•
•
•
•
•
Section 1, Introduction to the GPI, provides a brief overview of the GPI and its
relation to the Compaq OSI/MHS subsystem and introduces some important
concepts that affect the programs you develop.
Section 2, Information Architecture and Data Structures, describes an object-based
structure used to create and interpret messages, probes, and reports that are
transferred to or from an X.400 network through the GPI service. This section also
describes data structures such as attribute descriptors and string buffers, which you
use when requesting GPI services through procedure calls.
Section 3, Object Classes and Attribute Types, describes the purpose and
characteristics of object classes and their attributes.
Section 4, Procedure Calls, provides the syntax and semantics of the procedure calls
in the GPI library.
Appendix A, DDL Definitions, provides a summary of the DDL definitions used by
the GPI except those related to status information, which are described in
Appendix B.
Appendix B, Return Codes, describes the codes that provide status and error
information about a procedure call, explains how to retrieve additional information,
and suggests ways to recover from errors.
Appendix C, GPI Procedure Calls for the C Language, provides a summary of the
GPI procedure calls as used in a C language program.
Appendix D, Class Hierarchies, provides an overview—in diagrams—of the
structure of object classes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxvii
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. Other related
publications fall into three categories: documents prepared by standards groups,
Compaq programming manuals, and other Compaq OSI/MHS manuals.
Documents Prepared by Standards Groups
To obtain the most current and definitive information about the X.400 API, refer to the
X.400 Application Program Interface Association (XAPIA) and X/Open Company
Limited specifications and the International Telegraph and Telephone Consultative
Committee (CCITT) recommendations listed below:
•
•
•
•
•
•
CCITT Blue Book (Volume VIII - Fascicle VIII.7, Data Communications Networks,
Message Handling Systems), Recommendations X.400-X.420 provide the most
detailed descriptions of elements of the MHS service, message transfer protocol, and
interpersonal messaging protocol (for the X.400 1988 standard). In this manual, the
title of this document is abbreviated to Recommendations X.400-X.420 (1988).
CCITT Recommendation X.435 (Message Handling Systems: Electronic Data
Interchange) provides descriptions of elements of the MHS service that relate to
electronic data interchange messaging (EDIMG).
X.400 API Association and X/Open Company Limited, X.400 API Specification,
Version 2.0, © 1989-1990, provides descriptions of object classes and attribute
types (for the X.400 1984 and 1988 standards). In this manual, the title of this
document is referred to as the XAPIA-1988 specification.
X.400 API Association and X/Open Company Limited, OSI Object Management
API Specification describes the object management API functions.
X.400 API Association and X/Open Company Limited, EDI Messaging Package
Specification, © 1991, describes the electronic data interchange API functions.
X.400 API Association, X.400 Gateway API Specification, Version 4.0 (20 June,
1989) provides descriptions of the Gateway API functions, object classes, and
attribute types (for the X.400 1984 standard). In this manual, the title of this
document is referred to as the XAPIA-1984 specification.
In addition to the preceding documents, references to other CCITT recommendations
appear in this manual and are identified by their number only: for example,
Recommendation T.501 or Recommendation T.61[3].
Programming Manuals
For information about calling procedures from TAL and C programs, see the following
Compaq manuals:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxviii
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.420
OSI/MHS
GPI
Reference
Manual
For information on
OSI/MHS
OSI/MHS
GPI
Programming
Guide
VST 001.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxix
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.
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide contains
information to teach TAL and C programmers how to use the Compaq OSI/MHS
GPI product effectively.
OSI/MHS P7 Application Programmatic Interface (P7 API) Manual contains
programming and reference information for C programmers who use the P7 API
procedures.
OSI/MHS Configuration and Management Manual describes how to configure and
manage the Compaq OSI/MHS subsystem.
OSI/MHS Administrative Utility (AU) Manual describes how to install, configure,
and use the AU, a Compaq utility that allows users to obtain information about
messages, reports, or probes (communications sent by an originator to the message
transfer system (MTS) to test delivery of a message or report) in the form of
Protocol Data Units (PDUs).
Operator Messages Manual describes system messages and provides an explanation
of the cause, a discussion of the effect on the system, and suggestions for corrective
action.
OSI/MHS SCF Reference Manual describes the Subsystem Control Facility (SCF)
commands used to manage the OSI/MHS system.
OSI/MHS Management Programming Manual describes the programmatic interface
to SCF.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxx
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. Compaq OSI/MHS Manual Set
Concepts
OSI/MHS
Orientation
Guide
OSI/MHS
GPI
Programming
Guide
OSI/MHS
GPI
Reference
Manual
OSI/MHS
Configuration
and
Management
Manual
OSI/MHS
Administrative
Utility
(AU)
Manual
OSI/MHS
P7 API
Manual
Programming
Management
Methods
and
Tools
Management
Reference
for
Operators
Operator
Messages
Manual
Reference
for
Automating
Management
OSI/MHS
Management
Programming
Manual
OSI/MHS
SCF
Reference
Manual
VST 999.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxi
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.
Also provided on the Reader Comment Card is an Internet mail address. When you
send an Internet mail message to us, we immediately acknowledge receipt of your
message. A detailed response to your message is sent as soon as possible. Be sure to
include your name, company name, address, and phone number in your message. If
your comments are specific to a particular manual, also include the part number and title
of the manual.
Many of the improvements you see in manuals are a result of suggestions from our
customers. Please take this opportunity to help us improve future manuals.
Notation Conventions
General Syntax Notation
The following list summarizes the notation conventions for syntax presentation in this
manual.
UPPERCASE LETTERS. Uppercase letters indicate keywords and reserved words; enter
these items exactly as shown. Items not enclosed in brackets are required. For example:
MAXATTACH
lowercase italic letters. Lowercase italic letters indicate variable items that you supply.
Items not enclosed in brackets are required. For example:
file-name
[ ] Brackets. Brackets enclose optional syntax items. For example:
TERM [\system-name.]$terminal-name
INT[ERRUPTS]
A group of items enclosed in brackets is a list from which you can choose one item or
none. The items in the list may be arranged either vertically, with aligned brackets on
each side of the list, or horizontally, enclosed in a pair of brackets and separated by
vertical lines. For example:
LIGHTS [ ON
]
[ OFF
]
[ SMOOTH [ num ] ]
K [ X | D ] address-1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxii
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. A vertical line separates alternatives in a horizontal list that is enclosed in
brackets or braces. For example:
INSPECT { OFF | ON | SAVEABEND }
… Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you
can repeat the enclosed sequence of syntax items any number of times. For example:
M address-1 [ , new-value ]...
[ - ] {0|1|2|3|4|5|6|7|8|9}...
An ellipsis immediately following a single syntax item indicates that you can repeat that
syntax item any number of times. For example:
"s-char..."
Punctuation. Parentheses, commas, semicolons, and other symbols not previously described
must be entered as shown. For example:
error := NEXTFILENAME ( file-name ) ;
LISTOPENS SU $process-name.#su-name
Quotation marks around a symbol such as a bracket or brace indicate the symbol is a
required character that you must enter as shown. For example:
"[" repetition-constant-list "]"
Item Spacing. Spaces shown between items are required unless one of the items is a
punctuation symbol such as a parenthesis or a comma. For example:
CALL STEPMOM ( process-id ) ;
If there is no space between two items, spaces are not permitted. In the following
example, there are no spaces permitted between the period and any other items:
$process-name.#su-name
Line Spacing. If the syntax of a command is too long to fit on a single line, each continuation
line is indented three spaces and is separated from the preceding line by a blank line.
This spacing distinguishes items in a continuation line from items in a vertical list of
selections. For example:
ALTER [ / OUT file-spec / ] CONTROLLER
[ , attribute-spec ]...
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxiii
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). For
example:
error := COMPRESSEDIT ( filenum ) ;
!i,o
!i:i. In procedure calls, the !i:i notation follows an input string parameter that has a
corresponding parameter specifying the length of the string in bytes. For example:
error := FILENAME_COMPARE_ (
filename1:length
, filename2:length ) ;
!i:i
!i:i
!o:i. In procedure calls, the !o:i notation follows an output buffer parameter that has a
corresponding input parameter specifying the maximum length of the output buffer in
bytes. For example:
error := FILE_GETINFO_ (
filenum
, [ filename:maxlen ] ) ;
!i
!o:i
Notation for Messages
The following list summarizes the notation conventions for the presentation of displayed
messages in this manual.
Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or
returned exactly as shown. For example:
Backup Up.
lowercase italic letters. Lowercase italic letters indicate variable items whose values are
displayed or returned. For example:
p-register
process-name
[ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For
example:
Event number = number [ Subject = first-subject-value ]
A group of items enclosed in brackets is a list of all possible items that can be displayed,
of which one or none might actually be displayed. The items in the list might be
arranged either vertically, with aligned brackets on each side of the list, or horizontally,
enclosed in a pair of brackets and separated by vertical lines. For example:
LDEV ldev [ CU %ccu | CU %... ] UP [ (cpu,chan,%ctlr,%unit) ]
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxiv
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. }
{ Unknown.
}
| Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in
brackets or braces. For example:
Transfer status: { OK | Failed }
% Percent Sign. A percent sign precedes a number that is not in decimal notation. The
%þnotation precedes an octal number. The %Bþnotation precedes a binary number.
The %Hþnotation precedes a hexadecimal number. For example:
%005400
P=%p-register E=%e-register
Notation for Management Programming Interfaces
UPPERCASE LETTERS. Uppercase letters indicate names from definition files; enter these
names exactly as shown. For example:
ZCOM-TKN-SUBJ-SERV
lowercase letters. Words in lowercase letters are words that are part of the notation,
including Data Definition Language (DDL) keywords. For example:
token-type
!r.
The !r notation following a token or field name indicates that the token or field is
required. For example:
ZCOM-TKN-OBJNAME
!o.
token-type ZSPI-TYP-STRING.
!r
The !o notation following a token or field name indicates that the token or field is
optional. For example:
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!o
Abbreviations
The following list defines abbreviations used in this manual and in other Compaq
OSI/MHS manuals. Both industry-standard terms and Compaq terms are included;
Compaq terms are marked as such.
ADMD. Administration management domain
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxv
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. EDI user agent
EIT. Encoded information type
G3. Group 3 (facsimile)
G4. Group 4 (facsimile)
GIP. Gateway Interface Process (Compaq term)
GPI. Gateway Programmatic Interface (Compaq term)
IA5. International Alphabet No. 5
IDU. Internal data unit
IM. Interpersonal messaging
IPC. Interprocess communication
IPM. Interpersonal message
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxvi
Abbreviations
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. Open Systems Interconnection/Message Handling System (Compaq term)
P1. Protocol 1 (message-transfer protocol)
P2. Protocol 2 (interpersonal-messaging protocol)
P3. Protocol 3 (message-submission-and-delivery protocol)
PDAU. Physical delivery access unit
PDU. Protocol data unit
PRMD. Private management domain
RTS. Reliable transfer service
RTSE. Reliable Transfer Service Entity
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxvii
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. By clicking a passage of
text with a blue underline, you are taken to the location described. For example:
This requirement is described under Backup DAM Volumes and Physical Disk
Drives on page 3-2.
Change Bar Notation
Change bars are used to indicate substantive differences between this edition of the
manual and the preceding edition. Change bars are vertical rules placed in the right
margin of changed portions of text, figures, tables, examples, and so on. Change bars
highlight new or revised information. For example:
The message types specified in the REPORT clause are different in the COBOL85
environment and the Common Run-Time Environment (CRE).
The CRE has many new message types and some new message type codes for old
message types. In the CRE, the message type SYSTEM includes all messages
except LOGICAL-CLOSE and LOGICAL-OPEN.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxxviii
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.400 network through an Open Systems Interconnection/Message Handling System
(OSI/MHS) subsystem. The OSI/MHS subsystem functions as an X.400 message
transfer agent (MTA).
GPI Overview
The GPI service consists of the GPI Procedure Library and the Gateway Interface
Process (GIP). The GPI service and the client program together function as an X.400
gateway enabling the exchange of messages between a proprietary message system and
the X.400 network. Figure 1-1 illustrates the gateway components.
The GPI library procedures can be called from programs written in the Transaction
Application Language (TAL) or the C language. The GPI library procedures translate
messages between the proprietary format and the equivalent X.400 form and manage the
queues used to transfer messages to and from the OSI/MHS MTA.
Figure 1-1. GPI Service
X.400 Gateway
GPI Library Interface
Proprietary
Message
System
Client
GPI
Library
GIP
OSI/MHS
MTA
GPI Service
CDT 101.CDD
The gateway is configured as part of the OSI/MHS subsystem. There are two types of
gateway: NORMAL type and P1-EXIT type. For the NORMAL type gateway, routing
decisions are made by the OSI/MHS MTA and the client receives only those messages
bound for the Proprietary Message System. For the P1-EXIT type gateway, the client
program receives messages before the MTA performs routing, optionally makes changes
(such as address adjustment), then optionally transfers them back to the MTA using the
MH-TRANSFER option of the GPI_MT_FINISH_TRANSFER_IN_ procedure.
For a more complete discussion of X.400 networks and the OSI/MHS subsystem, refer
to the OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide and the
OSI/MHS Configuration and Management Manual.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -1
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.
A probe is used to verify an address and determine whether or not a communication
can be delivered. A probe consists of an envelope only.
A report provides status information about an attempted delivery of a message or
probe. A report consists of an envelope and optional content.
Note. In the X.400 specifications, the generic term “message” refers to a message, a probe, or
a report. In this manual, “X.400 message” (or simply “communication”) refers generically to a
message, probe, or report. When the discussion refers to a specific type of communication,
the specific name is used.
The envelope of a message conforms to the P1 protocol; that is, MTA-to-MTA.
The content of a message or report can be one of the following:
•
•
•
•
•
An interpersonal message (IPM) is like an office memo. It contains a heading and
body parts that conform to the P2 protocol; that is, User Agent to User Agent.
An interpersonal notification (IPN) is like an acknowledgment that indicates
whether or not an intended or alternate recipient has received an IPM. A nonreceipt
IPN indicates the IPM was discarded or forwarded. A receipt IPN indicates the IPM
was received or future receipt was arranged. IPNs conform to the P2 protocol.
General content does not necessarily conform to the P2 protocol. It consists of
binary data encoded in an unidentified format agreed upon by two parties or
encoded to other standards.
External content denotes a content reserved for use in interworking between 1988
and 1984 X.400 systems.
Electronic data interchange (EDI) denotes a content reserved for use in
exchanging electronic data (for instance, information specific to particular
application programs) and associated notifications concerning EDI traffic.
The structures of X.400 communications conform to the information architecture
described in Section 2, Information Architecture and Data Structures. Detailed
specifications for the architecture are provided in Section 3, Object Classes and
Attribute Types.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -2
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.
Transfer messages, probes, and reports in from an OSI/MHS MTA by way of the
GPI service’s input queue and examine the objects you have received.
Request detailed status information when you detect an error or failure of a
procedure.
The following description of how the procedures are used provides an overview only.
For detailed information about the design of a client program and examples of actual
programs, see the OSI/MHS Gateway Programmatic Interface (GPI) Programming
Guide.
GPI Initialization
Before calling any other GPI procedures, you must initialize the GPI environment by
calling the GPI_INITIALIZE_ procedure. Using this procedure, you specify
characteristics about the environment, such as the disk volume to be used for the GPI
extended data segment and limits on the sizes of tables and string values.
Gateway Sessions
Before you can gain access to an OSI/MHS MTA, you open a session by calling the
GPI_OPEN_ procedure. A client process (executing client program) can have at most
15 sessions open at the same time.
When opening a session, you specify the following characteristics:
•
•
•
Information about the gateway through which you are communicating. You specify
the name of the GATEWAY object, as configured by the system manager or operator
using Distributed Systems Management (DSM), and a gateway password. For more
information about GATEWAY objects, see the OSI/MHS Configuration and
Management Manual and the SCF Reference Manual for OSI/MHS.
The name of the MHS manager process that controls the gateway of which your
program is part.
A gateway instance name that uniquely identifies a session, which is typically
sharing the gateway (and its input and output queues) with other sessions. You can
use this name as a logging or tracing mechanism or for archiving and auditing
gateway activity.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -3
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.
Each session is supported by a server called the Gateway Interface Process (GIP).
When a session is established, the GPI connects the session to an available GIP. The
GIPs are configured as a group and managed by the MHS manager process.
To end a session, you call the GPI_CLOSE_ procedure.
Object Management
An object is a set of attributes that characterize all or part of an X.400 communication.
For example, the attributes of a report include its content, descriptions of recipients, and
tracing information about its path through the network. A communication is called a
root object. An object can have an attribute that is itself an object, which is called a
subobject. For example, the attribute specifying the content of a message is a
subobject. You can transfer only root objects to and from the GPI service queues.
Objects are described in detail in Section 3, Object Classes and Attribute Types.
Within a session, you manage inbound and outbound X.400 communications by using
the GPI object management procedures. A client program receives inbound
communications and sends outbound communications. These procedures enable you to
examine the attributes of inbound objects and to create outbound objects.
You can create a new object by using the GPI_OM_CREATE_ procedure, and you can
insert attributes into the object by using the GPI_OM_INSERT_ procedure. The
GPI_OM_WRITE_ procedure enables you to write a string one segment at a time, using
sequential calls. You can remove an attribute’s values by calling the
GPI_OM_REMOVE_ procedure.
When interpreting an inbound object, you can do the following:
•
•
•
•
Identify what types of attributes are present by using the GPI_OM_EXAMINE_
procedure. You can also use this procedure to retrieve the values of single-valued
attributes. Single-valued attributes can have only one value; multivalued attributes
can have multiple values. For example, a message’s content attribute can have only
one value, but its recipient-descriptors attribute can have multiple values.
Determine whether specific attributes are present by using the GPI_OM_FETCH_
procedure and, optionally, retrieve their values.
Retrieve the values of multivalued attributes by using the GPI_OM_LIST_
procedure.
Retrieve a string one segment at a time by using sequential calls to
GPI_OM_READ_. This procedure is typically used for very long string values.
You can copy an object and its subobjects by using the GPI_OM_COPY_ procedure,
and you can delete an object by using the GPI_OM_DELETE_ procedure.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -4
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. A reserved communication is assigned an object identifier
and can be examined, using the object management procedures, but cannot be
modified. You can copy a reserved object.
After delivering a message or report to the intended recipients or after examining a
probe to determine whether or not a communication can be delivered to the intended
recipients, you can call the GPI_MT_FINISH_TRANSFER_IN_ procedure to
indicate you have finished processing an inbound communication.
GPI_MT_FINISH_TRANSFER_IN_ can be used to:
•
•
•
•
Cancel processing and leave the object in the input queue.
Remove the object from the input queue.
Move the object to an archive queue, where nondecodable communications are
stored for future examination.
Transfer the object back to the MTA for X.400 routing (this option is valid only
for gateways that are configured as P1-EXIT type).
You call the GPI_MT_TRANSFER_OUT_ procedure to transfer a root object out to the
GPI service.
Status Checking
Each GPI procedure returns a code that indicates the status (success or failure) of the
procedure call. If the procedure is not successful, you can either take immediate action
based on the information provided by the return code, or you can call the
GPI_STATUS_ procedure to request more information about the cause of the 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. The GPI_STATUS_
procedure returns an error class that indicates the severity of the problem.
For a description of the information returned by GPI_STATUS_ , see Appendix B,
Return Codes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -5
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. IM-C-ADDRESS-LIST-DESIGNATOR on page 3-95
6. IM-C-CORRECTIONS-BODY-PART on page 3-98
7. IM-C-DISTRIBUTION-CODES on page 3-99
8. IM-C-FORWARDED-ENC-BODY-PART on page 3-103
9. IM-C-MESSAGE-TYPE on page 3-118
10. IM-C-MM-MESSAGE-BODY-PART on page 3-120
11. IM-C-OTHER-RECIP-DESIGNATOR on page 3-126
12. IIM-C-PILOT-INFORMATION on page 3-127
13. MH-C-SECURITY-LABEL on page 3-85
The following classes have attributes that support military messaging.
1. IIM-C-INTERPERSONAL-MESSAGE on page 3-107
2. IM-C-RECIPIENT-SPECIFIER on page 3-131
3. MH-C-MESSAGE on page 3-37
4. MH-C-REPORT on page 3-78
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -6
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.400 (1984) standard. The X.400 Gateway API Specification, Version 4.0,
includes information architecture and functions.
The second version was specified by the X.400 APIA and the X/Open Company
Limited. The OSI Object Management API Specification describes the functions and
the X.400 API Specification, Version 2.0, describes the information architecture.
The GPI conforms to the two versions of the specifications as follows:
•
•
The object management and message transfer procedures closely conform to the
functionality specified in the first version.
The information architecture closely conforms to the second version. In the object
class descriptions in Section 3, all 1988 extensions are noted.
For error checking and gateway control, the GPI provides proprietary procedures not
specified by the X.400 APIA.
For a list of specifications, see the preface, About This Manual.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -7
Introduction to the GPI
Conformance of the GPI to X.400 API Specifications
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
1 -8
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. For example, a message object consists of attributes defining the message
content, the priority for sending the message, and many other items of information about
the message.
When your client program creates or copies an object, or reserves an inbound
communication, the GPI assigns an object identifier to the new object. You use this
object identifier to refer to the object in calls to procedures that operate on it. For
example, to transfer an object out to the output queue, you specify its object identifier.
(The object identifier is an integer encoded with information that is meaningful to the
GPI software and is not an ASN.1 object identifier.)
An attribute consists of its type, a syntax, and one or more values.
•
•
•
The attribute type is a category indicating the purpose of the attribute’s values. For
example, priority is a type of attribute with a value indicating the priority for
sending the message.
A syntax is a category for the form of a value. Boolean and integer are examples of
attribute syntax.
A value is an item of information representing a characteristic or property of the
object of which it is part. For example, the value of the priority attribute indicates
whether the priority is normal, low, or urgent.
For more information about how you describe an attribute, see Attribute Descriptors on
page 2-2.
Classes of Objects
A class is a category of objects. The purpose and internal structure of an object are
defined by its class. Each class has one or more attribute types that can appear in
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -1
Information Architecture and Data Structures
Class Hierarchy
objects of that class. Classes available through the GPI are referred to by Data
Definition Language (DDL) constant names that begin with the following prefixes:
OM-C-
Classes of the object management (OM) package
MH-C-
Classes of the message handling (MH) package
IM-C-
Classes of the interpersonal messaging (IM) package
EDI-C-
Classes of the electronic data interchange (EDI) package
For example, MH messages are defined by the class MH-C-MESSAGE, and IM receipt
notifications are defined by the class IM-C-RECEIPT-NOTIFICATION. A package is
a set of classes that are grouped together because they are functionally related. Detailed
descriptions of classes are given in Section 3, Object Classes and Attribute Types.
Class Hierarchy
An object can be an attribute of another object. For example, the attribute value
identifying the originator of a message is an object of class MH-C-OR-NAME. The
message is the superobject and the originator object is the message’s subobject.
Classes of objects are related to each other in a tree hierarchy consisting of a root object
and objects that are its attributes (subobjects). The subobjects can also have attributes
that are objects. You can transfer to and from the GPI service only root objects, which
are of the following classes:
•
•
•
•
MH-C-MESSAGE
MH-C-PROBE
MH-C-REPORT
MH-C-P1-ENCODED-PDU
All other classes define objects that are subobjects of these classes. Interpersonal
messages (IPMs) and interpersonal notifications (IPNs) are subobjects of the
MH-C-MESSAGE and MH-C-REPORT classes, respectively.
The class hierarchies for the message handling and interpersonal messaging packages
are defined in the various X.400 API specifications and cannot be modified. For
diagrams of the class hierarchies, see Appendix D, Class Hierarchies.
Attribute Descriptors
An attribute descriptor is the form you use to exchange a value with the GPI. Each
descriptor contains a type, syntax, and value. The type and syntax are integers. The
data type of the value is determined by the syntax.
Figure 2-1 represents the same descriptor in two ways, as DDL names and as integers:
•
The type is represented by the DDL constant MH-T-B4-WIDTH, which is a 16-bit
integer value of 215.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -2
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.
If you request attributes of an object by calling the GPI_OM_EXAMINE_ or
GPI_OM_FETCH_ procedure, the type or syntax might be invalid or unspecified. Your
program must check the descriptor to determine whether it contains valid information.
For more information, see Section 4, Procedure Calls.
A single-valued attribute has only one value; a multivalued attribute has multiple
values. For example, the originator name attribute of a message is single-valued but the
recipient-descriptors attribute is multivalued (it can include several message-recipientdescriptor objects as values).
A descriptor can include only one value. To specify values for multivalued attributes,
you must provide a descriptor for each value. Each descriptor has the same type and
syntax but the values are typically different.
Figure 2-1. Example of Attribute Descriptor
Type
Syntax
Value
MH-T-B4-WIDTH OM-S-BOOLEAN
OM-TRUE
(16 Bits)
(16 Bits)
(32 Bits)
(32 Bits)
215
1
1
——
VST 201.VSD
Types
Each attribute type is represented by an integer. DDL constant names for types
available through the GPI begin with the following prefixes:
MH-T-
Types of the message handling (MH) attributes
IM-T-
Types of the interpersonal messaging (IM) attributes
OM-T-
Types of the object management (OM) attributes
EDI-T-
Types of the electronic data interchange (EDI) attributes
For example, the type of the priority attribute of an MH message is MH-T-PRIORITY,
and the type of the originator attribute of an IM message is IM-T-ORIGINATOR. The
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -3
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.
OM-S-ENUMERATION
Value is any of a specified set of distinct values, such as MH-PTY-NORMAL and
MH-PTY-URGENT.
OM-S-INTEGER
Value is a positive or negative integer, or zero.
OM-S-OBJECT
Value is an object identifier of a specified class.
OM-S-BIT-STRING
Value is an ordered sequence of zero or more bits, accompanied by its length (in
number of octets). The first octet indicates the number of unused bits in the last
octet.
OM-S-ENCODING-STRING
Value is an ordered sequence of octets, which are those the basic encoding rules
permit. The string contains a complete BER encoding including an ASN.1 type and
length field.
OM-S-IA5-STRING
Value is an ordered sequence of zero or more characters (7-bit codes) chosen from
the International Alphabet No. 5 (IA5) and preceded by the string’s length in octets.
Each octet contains one code. The string conforms to the ASN.1 defined type: IA5
string.
OM-S-NUMERIC-STRING
Value is an ordered sequence of zero or more characters that collectively encode
numeric information in textual form, preceded by the string’s length in octets. The
string conforms to the ASN.1 defined type: numeric string.
OM-S-OBJECT-DESCRIPTOR-STRING
Value is an ordered sequence of readable characters within the encoding of a value
of an ASN.1 object-descriptor type, accompanied by its length in octets.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -4
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.
OM-S-ONFILE-STRING
Value is an alternate syntax value for certain attributes (see Object Classes and
Attribute Types on page 3-1) and not a basic syntax value defined by standards.
Client applications can specify this syntax value for outbound messages when
creating and/or inserting strings that might exceed the in-memory table data space.
Choice of this syntax causes the string to be written to a file, rather than into the
string-data memory space. If the client does not choose this syntax value for strings
that exceed the in-memory, string-table data space, GPI automatically converts the
syntax to OM-S-ONFILE-STRING and stores the string in a file.
OM-S-PRINTABLE-STRING
Value is an ordered sequence of zero or more characters preceded by the string’s
length in octets. The string conforms to the ASN.1 printable string defined type . In
addition to spaces and alphanumeric characters, the string can include the following:
‘()+,-./:=?
OM-S-TELETEX-STRING
Value is an ordered sequence of zero or more characters and presentation commands
chosen from the set defined by Recommendation T.61[3]. The characters are
preceded by the string’s length in octets. The string conforms to the ASN.1 defined
type: T.61 string.
OM-S-UTC-TIME-STRING
Value is one of the ordered sequences of characters permitted by the ASN.1 defined
type: Universal Coordinated Time (UTC). The string is accompanied by its length
in octets.
OM-S-VIDEOTEX-STRING
Value is an ordered sequence of zero or more characters chosen from the set defined
by the Data Syntaxes of Recommendation T.101 [9] or the options from
Recommendation T.100 [4]. The characters are preceded by the string’s length in
octets. Each octet contains a single numeric code. The string conforms to the
ASN.1 defined type: Videotex string.
Data Structures
The object management procedures use specific data structures for attribute descriptors,
bit strings, descriptor lists, and string buffers.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -5
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. A value of
syntax OM-S-OBJECT is a 32-bit field, which is ignored, followed by a 32-bit object
identifier (Z-OBJ-ID). For the maximum length allowed for values of a particular
syntax, see Section 3, Object Classes and Attribute Types.
Figure 2-2. Attribute Descriptor Structure
Type
(Example)
Value
16 Bits
Syntax
OM-S16 Bits
MH-T-A3-WIDTH
BOOLEAN
Integer 1 or 0
OM-TRUE or OM-FALSE
MH-T-ACTION
ENUMERATION
Integer Value of
Enumeration Constant
-——
-——
MH-TCONTENT-TYPE
INTEGER
Integer Value
-——
-——
MH-T-NAME
OBJECT
Padding
Object Identifier
Z-OBJ-ID
xxx-STRING
String Length
Pointer to String
Element
IM-T-TEXT
32 Bits
32 Bits
-——
-——
VST 202.VSD
Bit-String Structure
Figure 2-3 shows the structure of an attribute descriptor and string element for a value of
OM-S-BIT-STRING syntax. The bits of a bit string are represented as a sequence of
octets. The length of the string includes all octets. The first octet stores the number of
unused bits in the last octet. The first bit of actual data in the bit string is at bit 0 of the
second octet and the trailing bits fill the octet to bit 7. Additional bits continue in
successive octets from bit 0 to 7 until the final octet, which can be partially filled as
indicated in the first octet. (On Compaq NonStop™ systems, bit 0 is the most
significant bit, and bit 7 is the least significant bit.)
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -6
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.VSD
A zero-length or empty bit string consists of a string length of 1 and a string element of
1 octet, containing all zeros.
Note. This bit-string representation follows the rules specified by the BER for indicating the
number of unused bits in the last octet, but the GPI does not require encoding of the BER type
and value.
Descriptor Lists
To provide values for the attributes of an object, you pass an array of attribute
descriptors called a descriptor list. The list might include values for single-valued
attributes and multivalued attributes.
Figure 2-4 shows the descriptor list of an object in the input queue. If you reserve the
object, you can examine it to determine what types of attributes are present. The
GPI_OM_EXAMINE_ procedure returns to the descriptor-list buffer one descriptor for
each attribute you request. An attribute position indicates the position of the attribute
in the object, regardless of how many values a previous attribute might have. The first
attribute is at attribute position 0. A value position indicates the position of a value of a
specific attribute. The first value is at value position 0.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -7
Descriptor Lists
Information Architecture and Data Structures
Figure 2-4. Descriptor List of GPI_OM_EXAMINE_
Reserved Object
Attribute
Position 0
Attribute
Position 1
GPI_OM_EXAMINE_
Descriptor-List
Buffer
Descriptor of
Single-Valued
Attribute
Descriptor of
Multivalued
Attribute
Descriptor of
Multivalued
Attribute
Descriptor of
Multivalued
Attribute
Attribute
Position 2
Descriptor of
Single-Valued
Attribute
Attribute
Position 3
Descriptor of
Single-Valued
Attribute
Attribute
Position 4
Descriptor of
Multivalued
Attribute
Value
Position 0
Value
Position 1
Descriptor
with
Indicators
Value
Position 2
Value
Position 0
•••
VST 204.VSD
In the figure, four attributes are requested, beginning at attribute position 0.
GPI_OM_EXAMINE_ returns only one descriptor for the multivalued attribute. This
descriptor contains the attribute type, syntax OM-S-UNSPECIFIED, and element
OM-ELEMENTS-UNSPECIFIED. The syntax and element indicate that the attribute is
multivalued. You must use the GPI_OM_LIST_ procedure to retrieve the actual
descriptors of a multivalued attribute (shown in value positions 0, 1, and 2).
When you create an object, you can specify that you want it to contain the attributes that
are defined as having initial values. If you create an object with initialized values, these
attributes begin at position zero. You can insert values for other attributes by calling the
GPI_OM_INSERT_ procedure (or the GPI_OM_WRITE_ procedure to insert string
values).
To get the values of multivalued attributes, you call the GPI_OM_LIST_ procedure.
Figure 2-5 shows an example of calling this procedure to get the values of the attribute
in position 1, beginning at value position 0.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -8
String Buffers
Information Architecture and Data Structures
Figure 2-5. Descriptor List for Multivalued Attribute
Reserved Object
Attribute
Position 0
Attribute
Position 1
Descriptor of
Multivalued
Attribute
Value
Position 0
Descriptor of
Multivalued
Attribute
Descriptor of
Multivalued
Attribute
Value
Position 1
Descriptor of
Multivalued
Attribute
Value
Position 2
Descriptor of
Multivalued
Attribute
Descriptor of
Multivalued
Attribute
Attribute
Position 2
Attribute
Position 3
Attribute
Position 4
GPI_OM_LIST_
Descriptor-List
Buffer
Descriptor of
Single-Valued
Attribute
Descriptor of
Single-Valued
Attribute
Descriptor of
Single-Valued
Attribute
Descriptor of
Multivalued
Attribute
Value
Position 0
VST 205.VSD
String Buffers
As shown in the preceding data structures, the descriptor of an attribute of syntax OM-Sxxx-STRING contains a string length and pointer. The GPI always returns lengthspecified strings. Strings are never terminated by a null character. You must use the
length to determine the location of the end of the string.
Figure 2-6 shows an example of how string values are returned in a string buffer by the
GPI_OM_EXAMINE_ , GPI_OM_FETCH_ , and GPI_OM_LIST_ procedures. If a
value does not fit, the pointer to the string element (in the descriptor) is
OM-ELEMENTS-UNSPECIFIED. The string length returned in the descriptor is the
actual length of the string. If a subsequent string fits in the buffer, the GPI returns that
value, even though the preceding one is not returned.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2 -9
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.VSD
For more information about retrieving string values, see the procedure descriptions for
GPI_OM_EXAMINE_ on page 4-26, GPI_OM_FETCH_ on page 4-30,
GPI_OM_LIST_ on page 4-35, and GPI_OM_READ_ on page 4-38.
String Segments
When you call the GPI_INITIALIZE_ procedure at the beginning of your program, you
specify the maximum length for strings that can be processed by the
GPI_OM_EXAMINE_ , GPI_OM_FETCH_ , and GPI_OM_LIST_ procedures. A
string that is longer than the length you specify is called a long string and must be
retrieved by using the GPI_OM_READ_ procedure. Using this procedure, you can read
string segments in successive calls. You specify a string offset to indicate where you
want to begin reading and the maximum number of octets that you want to read.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2- 10
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. Example of Retrieving String Segments
String Value
at Attribute Position 5
Value Position 0
String Offset 0
First
Call
MaximumNumber
(32,767 Octets)
MaximumNumber
(32,767 Octets)
String Offset 32,767
GPI_OM_READ_
String Buffer
Second
Call
String Offset 65,534
VST 207.VSD
You can use GPI_OM_READ_ to read any string, but it is usually used to read long
strings. To insert a long string value in an object you are creating, you must call the
GPI_OM_WRITE_ procedure successively and specify a string offset in each call.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2- 11
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. The classes are divided into the following five categories:
•
•
•
•
Object management package
Message handling package
Interpersonal messaging package
Electronic data interchange messaging package
Refer to Section 2, Information Architecture and Data Structures, for an overview of the
structure of objects and attributes. Refer to the CCITT Recommendations X.400-X.420
(1988) for more definitive descriptions of elements of the message transfer and
interpersonal messaging protocols and services. Refer to CCITT Recommendation
X.435 for more definitive descriptions of the elements of the electronic data interchange
package.
Object Class Descriptions
This section covers all the object classes supported by the GPI. Within each package the
classes are arranged alphabetically. Each of the object class descriptions includes the
following information:
•
•
The purpose of objects of the class.
A table of the types of attributes specific to the class and the following information
about each type:
Attribute Type
Is the DDL name of the attribute type.
Value Syntax
Is the DDL name of the syntax of the attribute. Descriptions
of syntax are provided in Section 2, Information Architecture
and Data Structures.
Value Length
Is the allowable length (in octets) of string values. For
example, 3-1024 indicates the value can be from 3 through
1024 octets in length. Two short lines (– –) indicate the
value does not have a length limit.
Number of Values
Is the number of values you can specify for the attribute. A
zero indicates that the attribute is optional. For example, 0-1
indicates an optional, single-valued attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -1
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.
Maximum Value
Length
Is a DDL name for the maximum length (in octets) allowed
for a string value.
Maximum Value
Number
Is the maximum number of values you can insert in a
multivalued attribute.
Integer Values
Are DDL names representing the valid integer values for the
attribute. These are similar to enumerated values but are
provided for syntax OM-S-INTEGER.
Object Identifier
Values
Are DDL names representing the valid values for an attribute
of syntax OM-S-OBJECT-IDENTIFIER-STRING (or, OMS-OBJECT-ID-STRING).
A description of each attribute (except OM-T-CLASS, described below), indicating
its purpose and use.
Notes about the way the GPI implements the CCITT X.400 standards and
recommendations for using attributes and objects.
The GPI simplifies the task of maintaining object management information by including
the OM-T-CLASS attribute in each object class. The GPI automatically inserts the OMT-CLASS attribute into every object as it is created. The value of OM_T_CLASS
identifies the class of the object. You can examine the OM-T-CLASS attribute, but you
cannot use GPI_OM_INSERT_ or GPI_OM_REMOVE_ to insert or remove it,
respectively.
There are two syntaxes for OM-T-CLASS: OM-S-OBJECT-IDENTIFIER-STRING and
OM-S-INTEGER. All EDI object classes and the following two MH object classes use
the OM-S-OBJECT-IDENTIFIER-STRING syntax: MH-C-ALGORITHM and MH-CALGORITHM-AND-RESULT. All other MH object classes and the OM and IM object
classes use the OM-S-INTEGER syntax.
Note. The DDL names in this section are all uppercase and contain hyphens (-). When you
refer to a DDL name in a C or TAL program, you must substitute an underscore (_) for each
hyphen. In C programs, you must also use uppercase and lowercase letters as they appear in
the GPIDEFSH declaration file. For information about declaration files, see Appendix A, DDL
Definitions.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -2
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.
Table 3-1 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-1. OM-C-EXTERNAL Attributes—General Characteristics
Value
Length
Number of
Values
OM-S-BIT-STRING
or
OM-S-ONFILE-STRING
--
0-1 1
OM-T-ASN1-ENCODING
OM-S-ENCODING-STRING
or
OM-S-ONFILE-STRING
2-n
0-1 1
OM-T-DATA-VALUEDESCRIPTOR
OM-S-OBJECTDESCRIPTOR-STRING
--
0-1
OM-T-DIRECTREFERENCE
OM-S-OBJECTIDENTIFIER-STRING
2-n
0-1
OM-T-INDIRECT
REFERENCE
OM-S-INTEGER
--
0-1
OM-T-OCTET-ALIGNEDENCODING
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
--
0-1 1
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
OM-T-ARBITRARYENCODING
1
Exactly one of these three attributes shall be present.
Meanings of Attributes
The attribute types specify the following information:
OM-T-ARBITRARY-ENCODING
A representation of the data value as a bit string.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -3
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.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute OM-T-ARBITRARY-ENCODING, this value syntax is an
alternative to OM-S-BIT-STRING.
For the attribute OM-ASN1-ENCODING, this value syntax is an alternative to OMENODING-STRING.
For the attribute OM-OCTET-ALIGNED-ENCODING, this value syntax is an
alternative to OM-S-OCTET-STRING.
When these attributes have the syntax OM-S-ONFILE-STRING, the GPI library
stores the values in a file, and the values retain the characteristics of their 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. 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.
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.
Attributes that have the syntax of OM-S-ONFILE-STRING are treated as long
strings, regardless of their actual length: that is, they are treated as if they were
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -4
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.
MH-C-ALGORITHM
This class of object identifies a mathematical (usually cryptographic) algorithm. This
object typically identifies an algorithm that was used to encrypt message content and
will be used to decrypt that content.
Table 3-2 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-2. MH-C-ALGORITHM Attributes—General Characteristics
Value
Length
Number of
Values
OM-S-ENCODING-STRING
or
OM-S-ONFILE-STRING
2-n
0-1
MH-T-ALGORITHM-ID
OM-S-OBJECT-ID-STRING
2-n
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Attribute Type
Value Syntax
MH-T-ALGORITHM-DATUM
Some attribute types have additional value characteristics, as shown in Table 3-3.
Table 3-3. MH-C-ALGORITHM Attributes—Additional Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -5
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.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-ALGORITHM-DATUM, this value syntax is an alternative
to OM-S-ENCODING-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.
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.
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.
Attributes that have the syntax of 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_OMWRITE_ to read and write the values of strings that have the syntax OM-SONFILE-STRING.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -6
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. MH-C-ALGORITHM-AND-RESULT Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ALGORITHM
OM-S-OBJECT
(MH-C-ALGORITHM)
--
1
MH-T-ALGORITHM-RESULT
OM-S-BIT-STRING
or
OM-S-ONFILE-STRING
1-n
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-5.
Table 3-5. MH-C-ALGORITHM-AND-RESULT Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
MH-T-ALGORITHM
Identifies the mathematical algorithm used to encrypt the message.
MH-T-ALGORITHM-RESULT
Identifies the result of executing the algorithm on a particular occasion.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-ALGORITHM-AND-RESULT, this syntax value is an
alternative to OM-S-BIT-STRING.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -7
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. 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.
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.
Attributes that have the syntax the 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_OMWRITE_ to read and write the values of strings that have the syntax OM-SONFILE-STRING.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -8
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.
Table 3-6 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-6. MH-C-BILATERAL-INFORMATION Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
1
MH-T-INFORMATION
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-1024
1
MH-T-PRMD-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-7.
Table 3-7. MH-C-BILATERAL-INFORMATION 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-INFORMATION
Max. Value Length:
MH-VL-INFORMATION
MH-T-PRMD-IDENTIFIER
Initial Value:
supplied by GPI if available 1
Max. Value Length:
MH-VL-PRMD-NAME
MH-T-COUNTRY-NAME
1
These values are the same as returned in the GPI_OPEN_ environment parameter (MH-CENVIRONMENT object).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -9
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.121 assigns to the country, or the character pairs ISO 3166 assigns to it.
MH-T-INFORMATION
Is binary data that follows the BER. You can specify a zero-length octet string as
hexadecimal ‘04 00’.
MH-T-PRMD-IDENTIFIER
Identifies the source domain, if it is a PRMD, relative to the ADMD specified by the
MH-T-ADMD-NAME attribute. The defined values of this attribute may be identical to
those of the PRMD name (MH-T-PRMD-NAME attribute) of an O/R name (MH-C-ORNAME object) of a user served by the source domain.
Implementation and Usage Note
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-INFORMATION, 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.
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.
For inbound messages, the Gateway Interface Process automatically specifies OM-SONFILE-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.
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
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 10
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 Attributes—General
Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ACTUAL-RECIPIENTNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1 1
MH-T-CONTENT-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-CONTENT-TYPE
OM-S-INTEGER
or OM-S-OBJECT-ID-STRING
−−
2-n
0-1 1
MH-T-CONVERSIONPROHIBITED
OM-S-BOOLEAN
--
0-1 2
MH-T-CONVERTED-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-CRITICAL-FORDELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORSUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORTRANSFER
OM-S-INTEGER
--
0-more
MH-T-DELIVERY-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
MH-T-EXPANSION-HISTORY
OM-S-OBJECT
(MH-C-EXPANSIONRECORD)
--
0-512
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
MH-T-INTENDEDRECIPIENT-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
MH-T-ORIGINAL-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1 2
MH-T-ORIGINATOR-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1 1
MH-T-OTHER-RECIPIENTNAMES
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-32767
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 11
MH-C-DELIVERY-ENVELOPE
Object Classes and Attribute Types
Table 3-8. MH-C-DELIVERY-ENVELOPE Attributes—General
Characteristics (page 2 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-PREFERREDDELIVERY-MODES
OM-S-ENUMERATION
--
0-10
MH-T-PRIORITY
OM-S-ENUMERATION
--
0-1 1
MH-T-SUBMISSION-TIME
OM-S-UTC-TIME-STRING
0-17
0-1 1
OM-T-CLASS
OM-S-INTEGER
--
1
1
When an object of the above class, MH-C-DELIVERY-ENVELOPE, is a subobject of
IM-C-MESSAGE-BODY-PART or EDI-C-EDIM-BODYPART, this attribute may be absent only when all
other attributes, except MH-T-DELIVERY-TIME, are absent. If any other attributes, except
MH-T-DELIVERY-TIME, are present, then the following attributes must be present for 1988 messages:
MH-T-ACTUAL-RECIPIENT-NAME, MH-T-CONTENT-TYPE, MH-T-ORIGINATOR-NAME,
MH-T-PRIORITY, and MH-T-SUBMISSION-TIME.
2 In addition to attributes listed in (1) above, the following attributes are required for 1984 X.400 messages and
recommended for 1988 messages interworking with 1984 systems: MH-T-CONVERSION-PROHIBITED,
and MH-T-ORIGINAL-EITS.
Some attribute types have additional value characteristics, as shown in Table 3-9.
Table 3-9. MH-C-DELIVERY-ENVELOPE Attributes—Additional
Characteristics (page 1 of 2)
Attribute Type
Value Characteristics
MH-T-CONTENTIDENTIFIER
Max. Value Length:
MH-VL-CONTENT-IDENTIFIER
MH-T-CONTENT-TYPE
Initial Value:
MH-CTI-P2-1984
Integer Values:
MH-CTI-UNIDENTIFIED
MH-CTI-EXTERNAL
MH-CTI-P2-1984
MH-CTI-P2-1988
HM-CTI-PEDI
Object Identifier Values:
MH-CTO-INNER-MESSAGE
MH-CTO-UNIDENTIFIED
MH-T-CONVERSIONPROHIBITED
Initial Value:
OM-FALSE
MH-T-DELIVERY-TIME
Max. Value Length:
MH-VL-TIME
MH-T-EXPANSIONHISTORY
Max. Value Number:
MH-VN-EXPANSION-HISTORY
MH-T-PREFERREDDELIVERY-MODES
Max. Value Number:
MH-VN-PREFERREDDELIVERY-MODES
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 12
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. Value Length:
MH-VL-TIME
Meanings of Attributes
The attribute types specify the following information:
MH-T-ACTUAL-RECIPIENT-NAME
Is the actual recipient’s O/R name.
MH-T-CONTENT-IDENTIFIER
Provides information used to correlate a message with any reports generated about it.
MH-T-CONTENT-TYPE
Identifies the syntax and semantics of the value of the MH-T-CONTENT attribute of the
message. For more information, see the MH-T-CONTENT-TYPE attribute description in
MH-C-MESSAGE on page 3-37.
MH-T-CONVERSION-PROHIBITED
Indicates whether the originator prohibited the MTS from converting the message under
any circumstances.
MH-T-CONVERTED-EITS
Provides the encoded information types (EITs) that characterize the message after the
MTS converted it. This attribute is present only if the MTS converts the message for the
recipient.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 13
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.
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 message.
MH-T-DELIVERY-TIME
Indicates the date and time at which the message was delivered to the recipient.
MH-T-EXPANSION-HISTORY
Is a record of each attempt to add recipients to the distribution list of the message. The
first record documents the message’s submission and the O/R name of the originator.
The expansion records follow in chronological order.
MH-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
MH-T-INTENDED-RECIPIENT-NAME
Is the O/R name of the originally intended recipient. This attribute is present only if the
MH-T-ACTUAL-RECIPIENT-NAME attribute denotes an alternate recipient.
MH-T-ORIGINAL-EITS
Provides the EITs of the MH-T-CONTENT attribute that were present when the
message was submitted.
MH-T-ORIGINATOR-NAME
Is the O/R name of the message’s originator.
MH-T-OTHER-RECIPIENT-NAMES
Provides the O/R names of any recipients not specified as the actual or intended
recipient. This attribute is present only if the value of the message’s MH-TDISCLOSURE-ALLOWED attribute is OM-TRUE.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 14
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.) In the
DDL names, PDS indicates physical delivery system (for example, postal system) and
MTS indicates delivery through the message transfer system. The other names indicate
types of terminals.
MH-T-PRIORITY
Is the relative priority at which the message was transferred. The DDL names for
enumerated values of this attribute indicate the priorities. See the enumerated values in
the Value Characteristics column in Table 3-9.
MH-T-SUBMISSION-TIME
Indicates the date and time at which the message was submitted.
Implementation and Usage Notes
•
•
•
•
The MH-C-DELIVERY-ENVELOPE class is derived from the set of X.400
definitions for the P3 protocol.
The GPI does not include the MH-T-MTS-IDENTIFIER in this class.
The MH-T-EXPANSION-HISTORY and MH-T-PREFERRED-DELIVERYMODES attributes are 1988 extension attributes. All other extension attributes in the
MH-C-DELIVERY-ENVELOPE class are mapped to values of the
MH-T-EXTENSIONS attribute.
Recommendation X.411 recommends that the criticality setting of the
MH-T-PREFERRED-DELIVERY-MODES attribute be critical-for-delivery.
MH-C-EITS
This class of object summarizes the encoded information types (EITs) represented in the
content attribute of a message or report. The information indicates whether the object
can be delivered without conversion.
Table 3-10 describes the attribute types for this class and the syntax, length, and number
of values for each type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 15
MH-C-EITS
Object Classes and Attribute Types
Table 3-10. MH-C-EITS Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-BUILTIN-EITS
OM-S-ENUMERATION
--
0-8
MH-T-EXTERNAL-EITS
OM-S-OBJECT-ID-STRING
2-n
0-1024
MH-T-G3-FAX-NBPS
OM-S-OBJECT
(MH-C-G3-FAX-NBPS)
--
0-1
MH-T-G4-FAX-NBPS
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-n 1
0-1
MH-T-TELETEX-NBPS
OM-S-OBJECT
(MH-C-TELETEX-NBPS)
--
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
As described for Group 4 facsimile. The value follows the rules for signalling G4 facsimile presentation
capabilities, which include the BER, except the minimum value length is 2 octets.
Some attribute types have additional value characteristics, as shown in Table 3-11.
Table 3-11. MH-C-EITS Attributes—Additional Characteristics
Attribute Type
Value Characteristics
MH-T-BUILTIN-EITS
Initial Value:
MH-BE-IA5-TEXT
Max. Value Number:
MH-VN-ENCODED-INFORMATIONTYPES
Enumerated Values:
MH-BE-G3-FAX
MH-BE-G4-CLASS1
MH-BE-IA5-TEXT
MH-BE-MIXED-MODE
MH-BE-TELETEX
MH-BE-TELEX
MH-BE-UNDEFINED
MH-BE-VIDEOTEX
Meanings of Attributes
The attribute types specify the following information:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 16
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. 5 text
MIXED-MODE
Mixed-mode teletex and G4 classes 2 and 3 facsimile final-form
documents
TELETEX
Teletex documents
TELEX
International Alphabet No. 2 (ITA2) text
UNDEFINED
Information not identified in this list
VIDEOTEX
Videotex data
MH-T-EXTERNAL-EITS
Identifies additional kinds of information contained in a message. Values are ASN.1
object identifiers representing the same types of information as the enumerated values
for the MH-T-BUILTIN-EITS attribute. For a description of ASN.1 object identifiers,
see Recommendations X.400-X.420 (1988).
MH-T-G3-FAX-NBPS
Provides G3 facsimile nonbasic parameters that further characterize the G3 facsimile
images. This attribute is present only if MH-BE-G3-FAX is a value of the
MH-T-BUILTIN-EITS attribute, or G3-FAX is encoded in the MH-T-EXTERNALEITS attribute.
MH-T-G4-FAX-NBPS
Provides nonbasic parameters that further characterize the final-form documents. These
parameters characterize the presentation capabilities (control and graphic character sets,
resolution, and so forth) of Recommendations T.400, T.503, and T.501. This attribute is
present only if MH-BE-G4-CLASS1 or MH-BE-MIXED-MODE is a value of the MHT-BUILTIN-EITS attribute, or if G4-class-1 or mixed-mode are encoded in the MH-TEXTERNAL-EITS attribute. You can specify a zero-length octet string as hexadecimal
‘04 00’.
MH-T-TELETEX-NBPS
Provides nonbasic parameters that further characterize the teletex documents. This
attribute is included only if MH-BE-TELETEX is a value of the MH-T-BUILTIN-EITS
attribute, or if teletex is encoded in the MH-T-EXTERNAL-EITS attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 17
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.
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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 18
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. MH-C-ENVIRONMENT Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
1
MH-T-PRMD-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-13.
Table 3-13. MH-C-ENVIRONMENT 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-COUNTRY-NAME
MH-T-PRMD-IDENTIFIER
1
These values are the same as returned in the GPI_OPEN_ environment parameter (MH-CENVIRONMENT object).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 19
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. 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 a PRMD. The values of this attribute are defined by the ADMD. This
attribute is not present unless the MTA is part of a PRMD.
Implementation and Usage Note
•
This class is replaced by MH-C-SESSION in the XAPIA-1988 specification and is
retained to maintain compatibility with the GPI procedures based on the
XAPIA-1984 specification. An object of this class is created when your client
program opens a GPI session. You can examine an object of this class but not
modify or create one.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 20
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-EXPANSION-RECORD Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-TIME
OM-S-UTC-TIME-STRING
0-17
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-15.
Table 3-15. MH-C-EXPANSION-RECORD Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
MH-T-TIME
Max. Value Length:
MH-VL-TIME
Meanings of Attributes
The attribute types specify the following information:
MH-T-NAME
Is the originator/recipient (O/R) name of the message’s originator (or of the distribution
list, if the record documents a distribution list expansion).
MH-T-TIME
Indicates the date and time the message, probe, or report was submitted (or the date and
time the distribution list was expanded).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 21
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.411 Name
GPI Name
CommonName
MH-T-COMMON-NAME
DLExpansionHistory
MH-T-EXPANSION-HISTORY
DLExpansionProhibited
MH-T-EXPANSION-PROHIBITED
InternalTraceInformation
MH-T-INTERNAL-TRACE-INFO
OriginatorAndDLExpansionHistory
MH-T-EXPANSION-HISTORY
ReportingDLName
MH-T-REPORTING-DL-NAME
RequestedDeliveryMethod
MH-T-PREFERRED-DELIVERY-MODES
TerminalType
MH-T-TERMINAL-TYPE
Table 3-16 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-16. MH-C-EXTENSION Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-EXT-CRIT-FORDELIVERY
OM-S-BOOLEAN
--
1
MH-T-EXT-CRIT-FORSUBMISSION
OM-S-BOOLEAN
--
1
MH-T-EXT-CRIT-FORTRANSFER
OM-S-BOOLEAN
--
1
MH-T-EXTENSION-TYPE
OM-S-INTEGER
or OM-S-OBJECTIDENTIFIER-STRING
−−
2-n
1 1
MH-T-EXTENSION-VALUE
OM-S-ENCODING-STRING
or
OM-S-ONFILE-STRING
2-n
0-1 2
OM-T-CLASS
OM-S-INTEGER
--
1
1
An integer is used to denote standard forms of extended processing, an object identifier to denote proprietary
forms. Only an integer is permitted upon entry to an ADMD, and only an integer is present upon exit from
an ADMD.
2 The value for MH-T-EXTENSION-VALUE shall follow the BER. The MH-T-EXTENSION-VALUE
attribute must be present when the MH-C-EXTENSION object is included as an attribute of the MH-C-ORNAME object.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 22
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 Attributes—Additional Characteristics
Attribute Type
Value Characteristics
MH-T-EXT-CRIT-FOR-DELIVERY
Initial Value:
OM-FALSE
MH-T-EXT-CRIT-FOR-SUBMISSION
Initial Value:
OM-FALSE
MH-T-EXT-CRIT-FOR-TRANSFER
Initial Value:
OM-FALSE
Meanings of Attributes
The attribute types specify the following information:
MH-T-EXT-CRIT-FOR-DELIVERY
Indicates that the extensions are critical to the delivery of the communication. When
MH-T-EXT-CRIT-FOR-DELIVERY is set to OM-TRUE, the extensions in the
communication must be delivered with the communication. If the communication is to
be delivered in a system that can not accept the extensions, then the entire message is
returned as non-deliverable. When MH-T-EXT-CRIT-FOR-DELIVERY is set to
OM-FALSE and the communication is to be delivered in a system that can not accept
the extensions, the extensions are deleted and the communication is delivered without
them.
MH-T-EXT-CRIT-FOR-SUBMISSION
Indicates that the extensions are critical to the communication’s submission. When MHT-EXT-CRIT-FOR-SUBMISSION is set to OM-TRUE, the extensions in the
communication must be submitted with the communication. If the communication is
submitted to a system that can not accept the extensions, the entire communication is
returned as non-deliverable.
MH-T-EXT-CRIT-FOR-TRANSFER
Indicates that the extensions are deemed critical to the communication’s transfer. When
MH-T-EXT-CRIT-FOR-TRANSFER is set to OM-TRUE, the extensions in the
communication must be transferred with the communication. If the communication is
transferred through a system that cannot accept the extensions, the entire communication
is returned as non-deliverable.
MH-T-EXTENSION-TYPE
Identifies the extended processing.
MH-T-EXTENSION-VALUE
Parameterizes the extended processing.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 23
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.411 Name
MH-T-COMMON-NAME
CommonName
MH-T-EXPANSION-HISTORY
DLExpansionHistory
MH-T-EXPANSION-PROHIBITED
DLExpansionProhibited
MH-T-INTERNAL-TRACE-INFO
InternalTraceInformation
MH-T-EXPANSION-HISTORY
OriginatorAndDLExpansionHistory
MH-T-REPORTING-DL-NAME
ReportingDLName
MH-T-PREFERRED-DELIVERY-MODES
RequestedDeliveryMethod
MH-T-TERMINAL-TYPE
TerminalType
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-EXTENSION-VALUE, this value syntax is an alternative to
OM-S-ENCODING-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.
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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 24
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 Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
1
MH-T-PRMD-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-ATTEMPTED-ADMDNAME
OM-S-PRINTABLE-STRING
0-16
0-1 1
MH-T-ATTEMPTEDCOUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
0-1 1
MH-T-ATTEMPTED-PRMDIDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1 1
MH-T-ACTION
OM-S-ENUMERATION
--
1-3
MH-T-ARRIVAL-TIME
OM-S-UTC-TIME-STRING
0-17
1
MH-T-CONVERTED-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-DEFERRED-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
These attributes will be present if and only if the value of MH-T-ACTION is MH-AC-REROUTED.
Some attribute types have additional value characteristics, as shown in Table 3-19.
Table 3-19. MH-C-EXTERNAL-TRACE-ENTRY Attributes—Additional
Characteristics (page 1 of 2)
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-COUNTRY-NAME
MH-T-PRMD-IDENTIFIER
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 25
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. Value Length:
MH-VL-ATTEMPTED-PRMDIDENTIFIER
MH-T-COUNTRY-NAME
Initial Value:
supplied by GPI 1
MH-T-ACTION
Initial Value:
MH-AC-RELAYED
Enumerated Values:
MH-AC-EXPANDED
MH-AC-REDIRECTED
MH-AC-RELAYED 2
MH-AC-REROUTED 2
MH-T-ARRIVAL-TIME
Max. Value Length:
MH-VL-TIME
MH-T-DEFERRED-TIME
Max. Value Length:
MH-VL-TIME
1
These values are the same as returned in the GPI_OPEN_ environment parameter (MH-CENVIRONMENT object).
2 The values MH-AC-RELAYED and MH-AC-REROUTED are mutually exclusive.
Meanings of Attributes
The first three attribute types specify the following information about the tracing domain
(the management domain that produced the entry):
MH-T-ADMD-NAME
Is the name of a tracing domain (if an ADMD) or the name of an ADMD to which the
tracing domain is attached (if a 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 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 tracing domain (if a PRMD). The values of this attribute are
defined by the ADMD. This attribute is not present unless the tracing domain is a
PRMD.
If the MH-T-ACTION attribute value is MH-AC-REROUTED, the next three attribute
types specify the information about the attempted domain (the management domain to
which the tracing domain attempted but failed to transfer the communication).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 26
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.121 assigns to the country,
or the character pairs ISO 3166 assigns to it.
MH-T-ATTEMPTED-PRMD-IDENTIFIER
Is the identifier of the attempted domain (if a PRMD). The values of this attribute are
defined by the ADMD. This attribute is not present unless the attempted domain is a
PRMD.
The remaining attributes indicate how the tracing domain handled the communication:
MH-T-ACTION
Identifies the routing action taken by the tracing domain. DDL names for the
enumerated values of this attribute (omitting the MH-AC- prefix) indicate the following
possible actions taken by the tracing domain:
EXPANDED
Expands a distribution list
REDIRECTED
Redirects the message or probe (but not the report)
RELAYED
Transfers the communication to another MD
REROUTED
Attempts but fails to transfer the communication to another MD
The first value of MH-T-ACTION must always be MH-AC-RELAYED or
MH-AC-REROUTED. MH-AC-REDIRECTED can be a second or third value of
MH-T-ACTION.
MH-T-ARRIVAL-TIME
Indicates the date and time at which the communication entered the tracing domain. If
the message or probe originated at the tracing domain, the value is the submission time.
If the report originated at the tracing domain, the value is the delivery or nondelivery
time.
MH-T-CONVERTED-EITS
Provides the EITs that characterize, or would characterize, the communication after its
conversion. This attribute is present only if the communication to which the external
trace applies is a message or probe (not a report), and the tracing domain converted, or
would have converted, the communication.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 27
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.
Implementation and Usage Note
•
If you call the GPI_OM_INSERT_ procedure to insert in an object values for the
MH-T-ATTEMPTED- attributes, the object must contain an MH-AC-REROUTED
value for the MH-T-ACTION attribute or an error is returned. You can insert both
types of attribute values in the same procedure call, but you must insert the
MH-T-ATTEMPTED- attributes first.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 28
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. MH-C-G3-FAX-NBPS Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-A3-WIDTH
OM-S-BOOLEAN
--
1
MH-T-B4-LENGTH
OM-S-BOOLEAN
--
1
MH-T-B4-WIDTH
OM-S-BOOLEAN
--
1
MH-T-FINE-RESOLUTION
OM-S-BOOLEAN
--
1
MH-T-TWO-DIMENSIONAL
OM-S-BOOLEAN
--
1
MH-T-UNCOMPRESSED
OM-S-BOOLEAN
--
1
MH-T-UNLIMITED-LENGTH
OM-S-BOOLEAN
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-21.
Table 3-21. MH-C-G3-FAX-NBPS Attributes—Additional Characteristics
Attribute Type
Value Characteristics
MH-T-A3-WIDTH
Initial Value:
OM-FALSE
MH-T-B4-LENGTH
Initial Value:
OM-FALSE
MH-T-B4-WIDTH
Initial Value:
OM-FALSE
MH-T-FINE-RESOLUTION
Initial Value:
OM-FALSE
MH-T-TWO-DIMENSIONAL
Initial Value:
OM-FALSE
MH-T-UNCOMPRESSED
Initial Value:
OM-FALSE
MH-T-UNLIMITED-LENGTH
Initial Value:
OM-FALSE
Meanings of Attributes
The attribute types specify the following information about which capabilities of the G3
facsimile terminal are required:
MH-T-A3-WIDTH
Indicates whether the images require A3-width.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 29
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 30
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. MH-C-GENERAL-CONTENT Attributes—General Characteristics
Value
Length
Number of
Values
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
--
1
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
MH-T-BINARY-CONTENT
OM-T-CLASS
Meanings of Attributes
The first attribute type specifies the following information:
MH-T-BINARY-CONTENT
Is the binary data to be conveyed to the recipients of the message. The MTS modifies
this attribute’s value only if the message is converted.
Implementation and Usage Notes
•
•
This class of object is valid as an attribute of MH-C-MESSAGE only if the
message’s MH-T-CONTENT-TYPE attribute value is MH-CTI-UNIDENTIFIED,
MH-CTO-UNIDENTIFIED, MH-CTO-INNER-MESSAGE, or any other undefined
value.
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-BINARY CONTENT, this value syntax is an alternative to
OM-S-OCTET-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.
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.
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
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 31
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_. 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 32
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 Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
1
MH-T-PRMD-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-MTA-NAME
OM-S-IA5-STRING
0-32
1
MH-T-ATTEMPTED-MTANAME
OM-S-IA5-STRING
0-32
0-1 1
MH-T-ATTEMPTED-ADMDNAME
OM-S-PRINTABLE-STRING
0-16
0-1 2
MH-T-ATTEMPTED-COUNTRYNAME
OM-S-PRINTABLE-STRING
2-3
0-1 2
MH-T-ATTEMPTED-PRMDIDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1 2
MH-T-ACTION
OM-S-ENUMERATION
--
1-3
MH-T-ARRIVAL-TIME
OM-S-UTC-TIME-STRING
0-17
1
MH-T-CONVERTED-EITS
OM-S-OBJECT
--
0-1
(MH-C-EITS)
MH-T-DEFERRED-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
This attribute will be present if and only if the value of MH-T-ACTION is MH-AC-REROUTED.
2
This attribute is not present if MH-T-ATTEMPTED-MTA-NAME is present. This attribute must be present if
the value of MH-T-ACTION is MH-AC-REROUTED and the attribute MH-T-ATTEMPTED-MTA-NAME
is not present.
Some attribute types have additional value characteristics, as shown in Table 3-24.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 33
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. Value Length:
MH-VL-ATTEMPTED-MTANAME
MH-T-ATTEMPTED-ADMDNAME
Max. Value Length:
MH-VL-ATTEMPTEDADMD-NAME
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. Value Length:
MH-VL-ATTEMPTED-MTANAME
MH-T-ATTEMPTED-ADMDNAME
Max. Value Length:
MH-VL-ATTEMPTEDADMD-NAME
MH-T-COUNTRY-NAME
MH-T-PRMD-IDENTIFIER
MH-T-COUNTRY-NAME
MH-T-PRMD-IDENTIFIER
1
These values are the same as returned in the GPI_OPEN_ environment parameter (MH-C-ENVIRONMENT object).
2
The values MH-AC-RELAYED and MH-AC-REROUTED are mutually exclusive.
Meanings of Attributes
The first three attribute types specify the following information about the domain to
which the MTA that produced the entry belongs:
MH-T-ADMD-NAME
Is the name of the domain of the tracing MTA (if an ADMD) or the name of an ADMD
to which the domain of the tracing MTA is attached (if a PRMD). The values of this
attribute are defined by the country specified in the MH-T-COUNTRY-NAME attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 34
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.
The next two attribute types specify information about the tracing MTA and the
attempted MTA:
MH-T-MTA-NAME
Identifies the tracing MTA: the MTA that produced the entry.
MH-T-ATTEMPTED-MTA-NAME
Identifies the attempted MTA: the MTA to which the tracing MTA attempted but failed
to transfer the communication. The MTA is identified relative to the MD of which it is
part; that MD defines the values. This attribute is present only if the MH-T-ACTION
attribute value is MH-AC-REROUTED and the MTA attempted a transfer to another
MTA.
If the MH-T-ACTION attribute value is MH-AC-REROUTED, and rerouting to another
MD was attempted, the next three attribute types specify information about the
attempted domain (the management domain to which the domain of the tracing MTA
attempted but failed to transfer the communication).
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.121 assigns to the country,
or the character pairs ISO 3166 assigns to it.
MH-T-ATTEMPTED-PRMD-IDENTIFIER
Is the identifier of the attempted domain (if a PRMD). The values of this attribute are
defined by the ADMD. This attribute is not present unless the attempted domain is a
PRMD.
The remaining attributes indicate how the tracing MTA handled the communication:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 35
Object Classes and Attribute Types
MH-C-INTERNAL-TRACE-ENTRY
MH-T-ACTION
Identifies the routing action taken by the tracing MTA. DDL names for the enumerated
values of this attribute (omitting the MH-AC- prefix) indicate the following possible
actions taken by the tracing MTA:
EXPANDED
Expands a distribution list
REDIRECTED
Redirects the message or probe (but not the report)
RELAYED
Transfers the communication to another MD
REROUTED
Attempts but fails to transfer the communication to another MD
The first value of MH-T-ACTION must always be MH-AC-RELAYED or
MH-AC-REROUTED. MH-AC-REDIRECTED can be a second or third value of
MH-T-ACTION.
MH-T-ARRIVAL-TIME
Indicates the date and time at which the communication entered the tracing MTA.
MH-T-CONVERTED-EITS
Provides the EITs that characterize, or would characterize, the communication after its
conversion. This attribute is present only if the communication to which the internal
trace applies is a message or probe (not a report), and the tracing domain converted, or
would have converted, the communication.
MH-T-DEFERRED-TIME
Indicates the date and time at which the tracing MTA released the message. This
attribute is present only if the internal trace entry is a message and the tracing MTA held
the message because its originator requested deferred delivery.
Implementation and Usage Notes
•
•
•
The GPI does not support the ConvertedEITS attribute as defined in the
XAPIA-1984 specification.
The MH-T-ATTEMPTED-MTA-NAME attribute is mutually exclusive of the
MH-T-ATTEMPTED-ADMD-NAME, MH-T-ATTEMPTED-COUNTRY-NAME,
and MH-T-ATTEMPTED-PRMD-IDENTIFIER attributes.
If you call the GPI_OM_INSERT_ procedure to insert in an object values for the
MH-T-ATTEMPTED- attributes, the object must contain an MH-AC-REROUTED
value for the MH-T-ACTION attribute or an error is returned. You can insert both
types of attribute values in the same procedure call, but you must insert the
MH-T-ATTEMPTED- attributes first.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 36
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 Attributes—General Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ALTERNATERECIP-ALLOWED
OM-S-BOOLEAN
--
1
MH-T-BILATERALINFORMATION
OM-S-OBJECT
(MH-C-BILATERAL-INFORMATION)
--
0-512
MH-T-CONTENT
OM-S-OBJECT
(IM-C-ACP127-NOTIFICATION)
(IM-C-INTERPERSONAL-MESSAGE)
(IM-C-RECEIPT-NOTIFICATION)
(IM-C-NON-RECEIPT-NOTIFICATION)
(MH-C-GENERAL-CONTENT)
(OM-C-EXTERNAL)
(EDI-C-EDIM)
(EDI-C-FORWARD-NOTIF)
(EDI-C-NEGATIVE-NOTIF)
(EDI-C-POSITIVE-NOTIF)
--
1
MH-T-CONTENT-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-CONTENTRETURN-REQUESTED
OM-S-BOOLEAN
--
1
MH-T-CONTENT-TYPE
OM-S-INTEGER
or
OM-S-OBJECT-ID-STRING
--
1
MH-T-CONVERSIONPROHIBITED
OM-S-BOOLEAN
--
1
MH-T-CRITICAL-FORDELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORSUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORTRANSFER
OM-S-INTEGER
--
0-more
2-n
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 37
MH-C-MESSAGE
Object Classes and Attribute Types
Table 3-25. MH-C-MESSAGE Attributes—General Characteristics (page 2 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-DEFERREDDELIVERY-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
MH-T-DISCLOSUREALLOWED
OM-S-BOOLEAN
--
1
MH-T-EXPANSION-HISTORY
OM-S-OBJECT
(MH-C-EXPANSION-RECORD)
--
0-512
MH-T-EXPANSION-PROHIBITED
OM-S-BOOLEAN
--
0-1
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
MH-T-EXTERNALTRACE-INFO
OM-S-OBJECT
(MH-C-EXTERNAL-TRACEENTRY)
--
1-512
MH-T-INTERNALTRACE-INFO
OM-S-OBJECT
(MH-C-INTERNAL-TRACEENTRY)
--
0-512
MH-T-MTS-IDENTIFIER
OM-S-OBJECT
(MH-C-MTS-IDENTIFIER)
--
1
MH-T-ORIGINAL-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-ORIGINATORNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-PRIORITY
OM-S-ENUMERATION
--
1
MH-T-RECIPIENTDESCRIPTORS
OM-S-OBJECT
(MH-C-MESSAGE-RD)
--
1-32767
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-26.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 38
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. Value Length:
MH-VL-CONTENT-IDENTIFIER
MH-T-CONTENT-RETURNREQUESTED
Initial Value:
OM-FALSE
MH-T-CONTENT-TYPE
Initial Value:
MH-CTI-P2-1984
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-P772
MH-CTO-UNIDENTIFIED
MH-T-CONVERSION-PROHIBITED
Initial Value:
OM-FALSE
MH-T-DEFERRED-DELIVERY-TIME
Max. Value Length:
MH-VL-TIME
MH-T-DISCLOSUREALLOWED
Initial Value:
OM-FALSE
MH-T-EXPANSION-HISTORY
Max. Value Number:
MH-VN-EXPANSION-HISTORY
MH-T-EXTERNAL-TRACEINFO
Max. Value Number:
MH-VN-TRACE-INFO
MH-T-INTERNAL-TRACEINFO
Max. Value Number:
MH-VN-TRACE-INFO
MH-T-MTS-IDENTIFIER
Initial Value:
assigned by
GPI_MT_TRANSFER_OUT_
MH-T-PRIORITY
Initial Value:
MH-PTY-NORMAL
Enumerated Values:
MH-PTY-NORMAL
MH-PTY-LOW
MH-PTY-URGENT
Max. Value Number:
MH-VN-RECIPIENTDESCRIPTORS
MH-T-RECIPIENT-DESCRIPTORS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 39
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.
MH-T-BILATERAL-INFORMATION
Provides information to the MDs through which the message might be transferred.
MH-T-CONTENT
Is the arbitrary binary information the message is intended to convey to its recipients.
The MTS modifies this attribute’s value only for purposes of conversion.
MH-T-CONTENT-IDENTIFIER
Provides information used to correlate a message with any reports generated about it.
MH-T-CONTENT-RETURN-REQUESTED
Indicates whether the MH-T-CONTENT attribute is to be included as the like-named
attribute of any nondelivery reports the message provokes.
MH-T-CONTENT-TYPE
Identifies the syntax and semantics of the value of the MH-T-CONTENT attribute of the
message. DDL names for the enumerated values of this attribute indicate the following
possible content types:
MH-CTI-UNIDENTIFIED
Syntax and semantics of the content are unidentified. This value
is used by mutual agreement of the originator and recipients.
MH-CTI-EXTERNAL
Content is prescribed by X.419 for interworking between 1984
and 1988 systems.
MH-CTI-P2-1984
Content encodes an IPM or IPN according to the P2 protocol
rules of Recommendation X.420 (1984), which include the
BER.
MH-CTI-P2-1988
Content encodes an IPM or IPN according to the P2 protocol
rules of Recommendation X.420 (1988), which include the
BER.
MH-CTI-PEDI
Content encodes an EDIM or EDIN according to the protocol
rules of Recommendation X.435.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 40
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.
MH-CTO-P772
Content encodes an IPM or IPN according to the P772 Military
Messaging System protocol rules of the document ACP 123,
which include the BER.
MH-CTO-UNIDENTIFIED
Syntax and semantics of the content are unidentified. This value
is used by mutual agreement of the originator and recipients.
The ASN.1 object identifier is specified by an object ID string
(the DDL-constant value “\x56\x03\x03\x00”).
MH-T-CONVERSION-PROHIBITED
Indicates whether the originator prohibited the MTS from converting the message under
any circumstances.
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.
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 message.
MH-T-DEFERRED-DELIVERY-TIME
Indicates the earliest date and time that the message should be delivered. Because the
MD that originates the message is usually responsible for deferring the delivery,
messages with a value for this attribute are transferred between MDs only by bilateral
agreement of those MDs.
MH-T-DISCLOSURE-ALLOWED
Indicates whether the O/R names of other recipients are to be disclosed to each recipient
at delivery.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 41
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. The
expansion records appear in chronological order.
MH-T-EXTERNAL-TRACE-INFO
Documents how the message was processed by each MD that transferred it. The entries
appear in chronological order; the first entry is from the MD that originated the message.
A single MD can make one or more trace entries.
An MD may add one or several trace entries, as follows:
•
•
If the communication is transferred to the MD of first choice, the transferring MD
adds a trace entry with an MH-T-ACTION attribute value of MH-AC-RELAYED.
If the communication is transferred to an MD that is not the first choice, the
transferring MD adds one or more trace entries with an MH-T-ACTION attribute
value of MH-AC-REROUTED. These entries indicate attempts to transfer the
communication to one or several MDs.
You can use this attribute to detect loops.
MH-T-INTERNAL-TRACE-INFO
Documents how the message was processed by each MTA that transferred it. However, a
service can limit the scope of this attribute to the local MD, except that the scope of each
entry documenting expansion or redirection is global.
An MTA may add one or several trace entries, as follows:
•
•
•
If the communication 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 communication 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. These entries indicate attempts to transfer the
communication to one or several MTAs.
If the communication is redirected to an alternate recipient, the transferring MTA
adds a trace entry with an MH-T-ACTION attribute value of
MH-AC-REDIRECTED.
This attribute can be used for detecting loops.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 42
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-T-ORIGINATOR-NAME
Is the O/R name of the message’s originator.
MH-T-PRIORITY
Is the relative priority for transferring the message. The DDL names for enumerated
values of this attribute indicate the priorities. See the enumerated values in the Value
Characteristics column in Table 3-26.
MH-T-RECIPIENT-DESCRIPTORS
Are the recipient descriptors of the intended recipients of the message.
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-MESSAGE class are mapped to values of the
MH-T-EXTENSIONS attribute.
MH-C-MESSAGE-RD
This class of object identifies an intended recipient of a message and records
information about that recipient.
Table 3-27 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-27. MH-C-MESSAGE-RD Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
MH-T-CRITICAL-FOR-DELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FOR-SUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FOR-TRANSFER
OM-S-INTEGER
--
0-more
MH-T-EXPLICIT-CONVERSION
OM-S-ENUMERATION
--
1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 43
Number of
Values
MH-C-MESSAGE-RD
Object Classes and Attribute Types
Table 3-27. MH-C-MESSAGE-RD Attributes—General Characteristics
Value
Length
Number of
Values
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
MH-T-MTA-REPORT-REQUEST
OM-S-ENUMERATION
--
1
MH-T-MTA-RESPONSIBILITY
OM-S-BOOLEAN
--
1
MH-T-ORIGINATOR-REPORTREQUEST
OM-S-ENUMERATION
--
1
MH-T-PREFERRED-DELIVERYMODES
OM-S-ENUMERATION
--
0-10
MH-T-RECIPIENT-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-RECIPIENT-NUMBER
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
MH-T-EXTENSIONS
Some attribute types have additional value characteristics, as shown in Table 3-28.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 44
MH-C-MESSAGE-RD
Object Classes and Attribute Types
Table 3-28. MH-C-MESSAGE-RD Attributes—Additional
Characteristics (page 1 of 2)
Attribute Type
Value Characteristics
MH-T-EXPLICITCONVERSION
Initial Value:
MH-EC-NO-CONVERSION
Enumerated Values:
MH-EC-NO-CONVERSION
MH-EC-IA5-TEXT-TO-TELETEX
MH-EC-TELETEX-TO-TELEX
MH-EC-TELEX-TO-IA5-TEXT
MH-EC-TELEX-TO-TELETEX
MH-EC-TELEX-TO-G4-CLASS1
MH-EC-TELEX-TO-VIDEOTEX
MH-EC-IA5-TEXT-TO-TELEX
MH-EC-TELEX-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G4-CLASS1
MH-EC-IA5-TEXT-TO-VIDEOTEX
MH-EC-TELETEX-TO-IA5-TEXT
MH-EC-TELETEX-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G4-CLASS1
MH-EC-IA5-TEXT-TO-VIDEOTEX
MH-EC-TELETEX-TO-IA5-TEXT
MH-EC-TELETEX-TO-G3-FAX
MH-EC-TELETEX-TO-G4-CLASS1
MH-EC-TELETEX-TO-VIDEOTEX
MH-EC-VIDEOTEX-TO-TELEX
MH-EC-VIDEOTEX-TO-IA5-TEXT
MH-EC-VIDEOTEX-TO-TELETEX
Initial Value:
MH-RQ-NON-DELIVERY
Enumerated Values:
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-RQ-ALWAYS-AUDITED
MH-T-MTA-RESPONSIBILITY
Initial Value:
OM-TRUE
MH-T-ORIGINATORREPORT-REQUEST
Initial Value:
MH-RQ-NON-DELIVERY
MH-T-MTA-REPORTREQUEST
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 45
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. 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
Meanings of Attributes
The attribute types specify the following information:
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.
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 message.
MH-T-EXPLICIT-CONVERSION
Specifies the type of conversion the originator requests for the recipient. DDL names for
the enumerated values of this attribute describe the types of conversion: for example,
MH-T-TELEX-TO-TELETEX. See the list of enumerated values in the Value
Characteristics column in Table 3-28.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 46
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. DDL names for the enumerated values of this attribute
(omitting the prefix MH-RQ-) describe the reports that are issued:
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
ALWAYS-AUDITED
A delivery or nondelivery report containing all external trace
entries
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-T-ORIGINATOR-REPORT-REQUEST
Indicates the kinds of reports that the originator requests in circumstances prescribed for
such reports. DDL names for the enumerated values of this attribute (omitting the prefix
MH-RQ-) describe the reports that are issued:
NEVER
No report of either type
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
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-28.) In the
DDL names, PDS indicates physical delivery system (for example, postal system) and
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 47
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.
Implementation and Usage Notes
•
•
The MH-T-PREFERRED-DELIVERY-MODES attribute is a 1988 extension
attribute. It is named RequestedDeliveryMethod in Recommendation X.411. All
other extension attributes in the MH-C-MESSAGE-RD class are mapped to values
of the MH-T-EXTENSIONS attribute.
Recommendation X.411 recommends that the criticality setting of the
MH-T-PREFERRED-DELIVERY-MODES attribute be critical-for-delivery.
MH-C-MTS-IDENTIFIER
This class defines an MTS identifier that distinguishes a message, probe, report, or
P1-encoded object (root object) from all other root objects, regardless of their class,
ever conveyed by the MTS. The MTS identifier is assigned by the originating domain,
the MD at which the message or report originated. For example, when you transfer a
root object out to the GPI service, the GPI inserts an MTS identifier in the object (unless
one is already inserted).
Table 3-29 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-29. MH-C-MTS-IDENTIFIER Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
1
MH-T-LOCAL-IDENTIFIER
OM-S-IA5-STRING
1-32
1
MH-T-PRMD-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-30.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 48
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. Value Length:
MH-VL-PRMD-IDENTIFIER
MH-T-COUNTRY-NAME
1
These values are the same as returned in the GPI_OPEN_ environment parameter (MH-C-ENVIRONMENT object).
Meanings of Attributes
The attribute types specify the following information:
MH-T-ADMD-NAME
Is the name of the originating ADMD or of the ADMD to which the originating PRMD
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. The values for this attribute are numbers X.121 assigns to the country, or the
character pairs ISO 3166 assigns to it.
MH-T-LOCAL-IDENTIFIER
Identifies the message, probe, report, or P1-encoded object, distinguishing it from all
other root objects, regardless of their class, ever originated by the originating MD.
MH-T-PRMD-IDENTIFIER
Is the identifier of the originating PRMD. The values of this attribute are defined by the
ADMD. This attribute is not present unless the originating domain is a PRMD.
Implementation and Usage Notes
•
When your client program transfers a root object (class MH-C-MESSAGE,
MH-C-PROBE, MH-C-REPORT, or MH-C-P1-ENCODED-PDU) out to the GPI
service, the GPI checks the MH-T-MTS-IDENTIFIER attribute. If you already
inserted the attribute, it is not changed. If the attribute is not present, the GPI inserts
a value for it before placing the object in the output queue for eventual transfer to
the X.400 network.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 49
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. Avoid any value of
MH-T-LOCAL-IDENTIFIER that contains the MTA-DESIGNATOR string in
character positions 1-12, together with the letter “M” in the 13th position. The
MTA-DESIGNATOR string is configured as an attribute on the OSI/MHS SUBSYS
object.
If a value of MH-T-LOCAL-IDENTIFIER of this form is supplied in a report
transferred to the OSI/MHS MTA by the GPI, then the MTA incorrectly determines
that the report was generated internally by the MTA and not submitted by the
gateway. This affects which accounting option the MTA checks when producing
OSI/MHS accounting events.
MH-C-OR-NAME
This class of object distinguishes one user (potential originator and recipient) from
another and identifies the user’s point of access to the MTS. Each user is assigned one or
more MTS access points (originator/recipient addresses).
Table 3-31 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-31. MH-C-OR-NAME Attributes—General Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ADMD-NAME
OM-S-PRINTABLE-STRING
0-16
0-1
MH-T-COMMON-NAME
OM-S-PRINTABLE-STRING
1-64
0-1 1
MH-T-COUNTRY-NAME
OM-S-PRINTABLE-STRING
2-3
0-1
MH-T-DIRECTORY-NAME
OM-S-ENCODING-STRING
2-n
0-1
MH-T-DOMAIN-TYPE-1
OM-S-PRINTABLE-STRING
1-8
0-1 1
MH-T-DOMAIN-TYPE-2
OM-S-PRINTABLE-STRING
1-8
0-1 1
MH-T-DOMAIN-TYPE-3
OM-S-PRINTABLE-STRING
1-8
0-1 1
MH-T-DOMAIN-TYPE-4
OM-S-PRINTABLE-STRING
1-8
0-1 1
MH-T-DOMAIN-VALUE-1
OM-S-PRINTABLE-STRING
1-128
0-1 1
MH-T-DOMAIN-VALUE-2
OM-S-PRINTABLE-STRING
1-128
0-1 1
MH-T-DOMAIN-VALUE-3
OM-S-PRINTABLE-STRING
1-128
0-1 1
MH-T-DOMAIN-VALUE-4
OM-S-PRINTABLE-STRING
1-128
0-1 1
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more 2
MH-T-GENERATION
OM-S-PRINTABLE-STRING
1-3
0-1 1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 50
MH-C-OR-NAME
Object Classes and Attribute Types
Table 3-31. MH-C-OR-NAME Attributes—General Characteristics (page 2 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-GIVEN-NAME
OM-S-PRINTABLE-STRING
1-16
0-1 1
MH-T-INITIALS
OM-S-PRINTABLE-STRING
1-5
0-1 1
MH-T-NUMERIC-USER-IDENTIFIER
OM-S-NUMERIC-STRING
1-32
0-1
MH-T-ORGANIZATION-NAME
OM-S-PRINTABLE-STRING
1-64
0-1 1
MH-T-ORGANIZATIONALUNIT-NME-1
OM-S-PRINTABLE-STRING
1-32
0-1 1
MH-T-ORGANIZATIONALUNIT-NME-2
OM-S-PRINTABLE-STRING
1-32
0-1 1
MH-T-ORGANIZATIONALUNIT-NME-3
OM-S-PRINTABLE-STRING
1-32
0-1 1
MH-T-ORGANIZATIONALUNIT-NME-4
OM-S-PRINTABLE-STRING
1-32
0-1 1
MH-T-PRMD-NAME
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-SURNAME
OM-S-PRINTABLE-STRING
1-40
0-1 1
MH-T-TERMINAL-IDENTIFIER
OM-S-PRINTABLE-STRING
1-24
0-1
MH-T-TERMINAL-TYPE
OM-S-ENUMERATION
--
0-1
MH-T-X121-ADDRESS
OM-S-NUMERIC-STRING
1-15
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
The GPI does not support the teletex string (String (Teletex)) option for the syntax of these O/R name
attributes.
2
When the MH-C-EXTENSION object is present in MH-C-OR-NAME, the MH-T-EXTENSION-VALUE
attribute must be present in the MH-C-EXTENSION object. For more information, refer to the MH-CEXTENSION object.
Some attribute types have additional value characteristics, as shown in Table 3-32.
Table 3-32. MH-C-OR-NAME Attributes—Additional
Characteristics (page 1 of 3)
Attribute Type
Value Characteristics
MH-T-ADMD-NAME
Initial Value:
supplied by GPI 1
Max. Value Length:
MH-VL-ADMD-NAME
MH-T-COMMON-NAME
Max. Value Length:
MH-VL-COMMON-NAME
MH-T-COUNTRY-NAME
Initial Value:
supplied by GPI 1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 51
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. Value Length:
MH-VL-DOMAIN-VALUE
MH-T-DOMAIN-VALUE-2
Max. Value Length:
MH-VL-DOMAIN-VALUE
MH-T-DOMAIN-VALUE-3
Max. Value Length:
MH-VL-DOMAIN-VALUE
MH-T-DOMAIN-VALUE-4
Max. Value Length:
MH-VL-DOMAIN-VALUE
MH-T-GENERATION
Max. Value Length:
MH-VL-GENERATION
MH-T-GIVEN-NAME
Max. Value Length:
MH-VL-GIVEN-NAME
MH-T-INITIALS
Max. Value Length:
MH-VL-INITIALS
MH-T-X121-ADDRESS
Max. Value Length:
MH-VL-X121-ADDRESS
MH-T-NUMERIC-USERIDENTIFIER
Max. Value Length:
MH-VL-NUMERIC-USERIDENTIFIER
MH-T-ORGANIZATIONNAME
Max. Value Length:
MH-VL-ORGANIZATIONNAME
MH-T-ORGANIZATIONALUNIT-NME-1
Max. Value Length:
MH-VL-ORGANIZATIONALUNIT-NAMES
MH-T-ORGANIZATIONALUNIT-NME-2
Max. Value Length:
MH-VL-ORGANIZATIONALUNIT-NAMES
MH-T-ORGANIZATIONALUNIT-NME-3
Max. Value Length:
MH-VL-ORGANIZATIONALUNIT-NAMES
MH-T-ORGANIZATIONALUNIT-NME-4
Max. Value Length:
MH-VL-ORGANIZATIONALUNIT-NAMES
MH-T-PRMD-NAME
Initial Value:
supplied by GPI if available 1
Max. Value Length:
MH-VL-PRMD-NAME
Max. Value Length:
MH-VL-SURNAME
MH-T-SURNAME
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 52
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).
Meanings of Attributes
The attribute types specify the following information:
MH-T-ADMD-NAME
Is the name of the user’s ADMD. The values of this attribute are defined by the country
specified in the MH-T-COUNTRY-NAME attribute.
If the country denoted by the MH-T-COUNTRY-NAME attribute permits use of a single
space as the ADMD name, the space designates any ADMDs within the country. For
detailed considerations about using this designation, see the X.400 specifications.
MH-T-COMMON-NAME
Is the name commonly used to refer to the user. The values of this attribute are defined
by the organization specified in the MH-T-ORGANIZATION-NAME attribute. This
attribute is a 1988 extension.
MH-T-COUNTRY-NAME
Is the name of the country in which the user resides. The values for this attribute are
numbers X.121 assigns to the country, or the character pairs ISO 3166 assigns to it.
MH-T-DIRECTORY-NAME
Is the X.500 directory name of the user that is assigned by the Directory services.
MH-T-DOMAIN-TYPE-1
Is the name of a class of information defined by the user’s ADMD or ADMD and
PRMD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 53
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.
MH-T-DOMAIN-VALUE-2
Is an instance of the class of information denoted by the MH-T-DOMAIN-TYPE-2
attribute.
MH-T-DOMAIN-VALUE-3
Is an instance of the class of information denoted by the MH-T-DOMAIN-TYPE-3
attribute.
MH-T-DOMAIN-VALUE-4
Is an instance of the class of information denoted by the MH-T-DOMAIN-TYPE-4
attribute.
MH-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
MH-T-GENERATION
Is the generation of the user (for example, Jr.).
MH-T-GIVEN-NAME
Is the user’s given name or first name (for example, Michael).
MH-T-INITIALS
Is the user’s initials, not including a surname (for example, MA).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 54
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-T-ORGANIZATIONAL-UNIT-NME-2
Is the name of a unit of the organization specified by the MH-T-ORGANIZATIONNAME attribute.
MH-T-ORGANIZATIONAL-UNIT-NME-3
Is the name of a unit of the organization specified by the MH-T-ORGANIZATIONNAME attribute.
MH-T-ORGANIZATIONAL-UNIT-NME-4
Is the name of a unit of the organization specified by the MH-T-ORGANIZATIONNAME attribute.
MH-T-PRMD-NAME
Is the name of the user’s PRMD. This name can be assigned by the country or ADMD.
MH-T-SURNAME
Is the user’s surname (for example, Browning). This attribute must be present if
MH-T-GIVEN-NAME, MH-T-INITIALS, or MH-T-GENERATION is present.
MH-T-TERMINAL-IDENTIFIER
Is the identifier of the user’s terminal. For example, the value can identify a telex answer
back device or teletex terminal.
MH-T-TERMINAL-TYPE
Is the type of the user’s terminal. DDL names for the enumerated values of this attribute
describe the terminal types: for example, MH-TT-TELEX. See the list of enumerated
values in the Value Characteristics column in Table 3-32.
MH-T-X121-ADDRESS
Is the network address of the user’s terminal as defined by X.121.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 55
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. For example, MH-T-DOMAIN-TYPE-2 must have a
corresponding MH-T-DOMAIN-VALUE-2 specified.
An O/R name can be one of several forms, as described in the X.400 specifications.
The GPI supports the mnemonic, numeric, and terminal O/R address forms. A
mnemonic O/R address identifies an ADMD by ADMD and country names and a
user by a personal name. A numeric O/R address identifies an ADMD by ADMD
and country names and a user by a numeric user identifier. A terminal O/R address
identifies a user by the network address of the user’s terminal; it might also include
the ADMD and country names.
Although the Number of Values column in Table 3-32 indicates all attributes except
OM-T-CLASS are optional, some attributes are required for a specific form of an
O/R name. The attribute types that are mandatory (M) or conditional (C) for each
form are as follows:
Attribute Type
Mnemonic
Numeric
Terminal
MH-T-ADMD-NAME
M
M
C
MH-T-COMMON-NAME
C
MH-T-COUNTRY-NAME
M
M
C
MH-T-DOMAIN-TYPE-n and
MH-T-DOMAIN-VALUE-n (at least one pair)
C
C
C
MH-T-GENERATION, MH-T-GIVEN-NAME,
MH-T-INITIALS, or MH-T-SURNAME
C
MH-T-NUMERIC-USER-IDENTIFIER
M
MH-T-ORGANIZATION-NAME
C
MH-T-ORGANIZATIONAL-UNIT-NAME-n
(at least one)
C
MH-T-PRMD-NAME
C
C
C
MH-T-TERMINAL-IDENTIFIER
C
MH-T-TERMINAL-TYPE
C
MH-T-X121-ADDRESS
M
The ADMD specified by the MH-T-COUNTRY-NAME and MH-T-ADMD-NAME
attributes governs whether conditional attributes must be present as follows:
•
If a user is accessed through a PRMD, the ADMD governs whether attributes to
route messages to the PRMD are present.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 56
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. MH-C-P1-ENCODED-PDU Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ASN1-ENCODED-DATA
OM-S-ENCODING-STRING
2-n
1
--
1
or
OM-S-ONFILE-STRING
OM-T-CLASS
OM-S-INTEGER
Note. This class is a proprietary extension to the architecture and is instantiated as a root
object with no subobjects.
Meanings of Attributes
The attribute types specify the following information:
MH-T-ASN1-ENCODED-DATA
Is the ASN.1-encoded value of a complete P1-encoded message, probe, or report.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-ASN1-ENCODED-DATA, this value syntax is an alternative
to OM-S-ENCODING-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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 57
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 58
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.
Table 3-34. MH-C-PER-RECIPIENT-DR Attributes—General Characteristics
Value
Length
Number of
Values
Attribute Type
Value Syntax
MH-T-ACTUAL-RECIPIENTNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-ARRIVAL-TIME
OM-S-UTC-TIME-STRING
0-17
1
MH-T-CONVERTED-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-DELIVERY-POINT
OM-S-ENUMERATION
--
1
MH-T-DELIVERY-TIME
OM-S-UTC-TIME-STRING
0-17
1
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
MH-T-INTENDED-RECIPIENTNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
MH-T-INTENDED-RECIPIENTNUMBER
OM-S-INTEGER
--
1
MH-T-MTA-REPORT-REQUEST
OM-S-ENUMERATION
--
1
MH-T-MTA-RESPONSIBILITY
OM-S-BOOLEAN
--
1
MH-T-ORIGINATOR-REPORTREQUEST
OM-S-ENUMERATION
--
1
MH-T-SUPPLEMENTARY-INFO
OM-S-PRINTABLE-STRING
1-256
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
0-more
Some attribute types have additional value characteristics, as shown in Table 3-35.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 59
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. Value Length:
MH-VL-TIME
MH-T-INTENDED-RECIPIENTNUMBER
Integer Values:
1-32767
MH-T-MTA-REPORT-REQUEST 1
Initial Value:
MH-RQ-NON-DELIVERY
Enumerated Values:
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-RQ-ALWAYS-AUDITED
MH-T-MTA-RESPONSIBILITY
Initial Value:
OM-TRUE
MH-T-ORIGINATOR-REPORTREQUEST 2
Initial Value:
MH-RQ-NON-DELIVERY
Enumerated Values:
MH-RQ-NEVER
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
Max. Value Length:
MH-VL-SUPPLEMENTARYINFO
MH-T-SUPPLEMENTARY-INFO
1
A value of MH-RQ-NEVER is invalid for the attribute MH-T-MTA-REPORT-REQUEST.
2
A value of MH-RQ-ALWAYS-AUDITED is invalid for the attribute MH-T-ORIGINATOR-REPORTREQUEST.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 60
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-T-DELIVERY-POINT
Indicates the nature of the functional entity that was used to deliver the message or
probe. DDL names for the enumerated values of this attribute (omitting the prefix
MH-DP-) describe the reports that are issued:
PUBLIC-UA
User agent owned by a public-service provider
PRIVATE-UA
User agent owned by a private organization, such as an in-house
messaging system
MS
Message store
DL
Distribution list
PDAU
Physical delivery access unit
PDS-PATRON
Patron of a physical-delivery system
OTHER-AU
Access unit other than a PDAU
MH-T-DELIVERY-TIME
Indicates the date and time at which the message or probe was delivered. (The date and
time are in UTC format.)
MH-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
MH-T-INTENDED-RECIPIENT-NAME
Is the O/R name of the originally intended recipient. This attribute is present only if the
MH-T-ACTUAL-RECIPIENT-NAME attribute denotes an alternate recipient.
MH-T-INTENDED-RECIPIENT-NUMBER
Is the ordinal position of the intended recipient in the list of recipients specified by the
originator of the message or probe. The value for the first recipient is 1. The minimum
value is ZGPI-MIN-RECIPIENTS, and the maximum value is ZGPI-MAXRECIPIENTS.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 61
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. DDL names for the enumerated values of this attribute
(omitting the prefix MH-RQ-) describe the reports that are issued:
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
ALWAYS-AUDITED
A delivery or nondelivery report containing all external trace
entries
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-T-ORIGINATOR-REPORT-REQUEST
Indicates the kinds of reports that the originator requested in circumstances prescribed
for such reports. DDL names for the enumerated values of this attribute (omitting the
prefix MH-RQ-) describe the reports that are issued:
NEVER
No report of either type
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
MH-T-SUPPLEMENTARY-INFO
Provides supplementary information about the status of the message or probe. For
example, a teletex access unit (AU) or teletex-to-telex conversion facility might use this
attribute to provide the received reply (answer back), the telex transmission duration, or
the note and received recorded message. This attribute is present at the option of the MD
that produces the per-recipient report.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 62
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 Attributes—General Characteristics
Value
Length
Number of
Values
Attribute Type
Value Syntax
MH-T-ACTUAL-RECIPIENTNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-ARRIVAL-TIME
OM-S-UTC-TIME-STRING
0-17
1
MH-T-CONVERTED-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
MH-T-INTENDED-RECIPIENT-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
MH-T-INTENDED-RECIPIENT-NUMBER
OM-S-INTEGER
--
1
MH-T-MTA-REPORTREQUEST
OM-S-ENUMERATION
--
1
MH-T-MTA-RESPONSIBILITY
OM-S-BOOLEAN
--
1
MH-T-NON-DELIVERYDIAGNOSTIC
OM-S-ENUMERATION
--
1
MH-T-NON-DELIVERY-REASON
OM-S-ENUMERATION
--
1
MH-T-ORIGINATOR-REPORTREQUEST
OM-S-ENUMERATION
--
1
MH-T-SUPPLEMENTARYINFO
OM-S-PRINTABLE-STRING
1-256
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
0-more
Some attribute types have additional value characteristics, as shown in Table 3-37.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 63
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. Value
Length:
MH-VL-TIME
MH-T-INTENDEDRECIPIENT-NUMBER
Integer Values
1-32767
MH-T-MTA-REPORTREQUEST 1
Initial
Value:
MH-RQ-NON-DELIVERY
Enumerated
Values:
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-RQ-ALWAYS-AUDITED
MH-T-MTA-RESPONSIBILITY
Initial
Value:
OM-TRUE
MH-T-NON-DELIVERYDIAGNOSTIC
Initial
Value:
MH-DG-NO-DIAGNOSTIC
Enumerated
Values:
MH-DG-NO-DIAGNOSTIC
MH-DG-OR-NAME-UNRECOGNIZED
MH-DG-OR-NAME-AMBIGUOUS
MH-DG-MTS-CONGESTED
MH-DG-LOOP-DETECTED
MH-DG-RECIPIENT-UNAVAILABLE
MH-DG-MAXIMUM-TIME-EXPIRED
MH-DG-EITS-UNSUPPORTED
MH-DG-CONTENT-TOO-LONG
MH-DG-IMPRACTICAL-TO-CONVERT
MH-DG-PROHIBITED-TO-CONVERT
MH-DG-CONVERSION-UNSUBSCRIBED
MH-DG-PARAMETERS-INVALID
MH-DG-CONTENT-SYNTAX-IN-ERROR
MH-DG-LENGTH-CONSTRAINT-VIOLTD
MH-DG-NUMBER CONSTRAINT-VIOLTD
MH-DG-CONTENT-TYPE-UNSUPPORTED
MH-DG-TOO-MANY-RECIPIENTS
MH-DG-NO-BILATERAL-AGREEMENT
MH-DG-CRITICAL-FUNC-UNSUPPORTD
MH-DG-CONVERSION-LOSS-PROHIB
MH-DG-LINE-TOO-LONG
MH-DG-PAGE-TOO-LONG
MH-DG-PICTORIAL-SYMBOL-LOST
MH-DG-PUNCTUATION-SYMBOL-LOST
MH-DG-ALPHABETIC-CHAR-LOST
MH-DG-MULTIPLE-INFO-LOSSES
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 64
MH-C-PER-RECIPIENT-NDR
Object Classes and Attribute Types
Table 3-37. MH-C-PER-RECIPIENT-NDR Attributes—Additional
Characteristics (page 2 of 2)
Attribute Type
MH-T-NON-DELIVERYREASON
MH-T-ORIGINATORREPORT-REQUEST 2
MH-T-SUPPLEMENTARY-INFO
Value Characteristics
Enumerated
Values:
MH-DG-REASSIGNMENT-PROHIBITED
MH-DG-REDIRECTION-LOOP-DETECTD
MH-DG-EXPANSION-PROHIBITED
MH-DG-SUBMISSION-PROHIBITED
MH-DG-EXPANSION-FAILED
MH-DG-RENDITION-UNSUPPORTED
MH-DG-MAIL-ADDRESS-INCORRECT
MH-DG-MAIL-OFFICE-INCOR-OR-INV
MH-DG-MAIL-ADDRESS-INCOMPLETE
MH-DG-MAIL-RECIPIENT-UNKNOWN
MH-DG-MAIL-RECIPIENT-DECEASED
MH-DG-MAIL-ORGANIZATION-EXPIRD
MH-DG-MAIL-REFUSED
MH-DG-MAIL-UNCLAIMED
MH-DG-MAIL-RECIPIENT-MOVED
MH-DG-MAIL-RECIPIENT-TRAVELING
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-IMPOSSIBL
Initial
Value:
MH-RE-TRANSFER-FAILED
Enumerated
Values:
MH-RE-TRANSFER-FAILED
MH-RE-TRANSFER-IMPOSSIBLE
MH-RE-CONVERSION-NOT-PERFORMED
MH-RE-PHYSICAL-RENDTN-NOT-DONE
MH-RE-PHYSICAL-DELIV-NOT-DONE
MH-RE-RESTRICTED-DELIVERY
MH-RE-DIRECTORY-OPERATN-FAILED
Initial
Value:
MH-RQ-NON-DELIVERY
Enumerated
Values:
MH-RQ-NEVER
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
Max. Value
Length:
MH-VL-SUPPLEMENTARY-INFO
1
A value of MH-RQ-NEVER is invalid for the attribute MH-T-MTA-REPORT-REQUEST.
2
A value of MH-RQ-ALWAYS-AUDITED is invalid for the attribute MH-T-ORIGINATOR-REPORTREQUEST.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 65
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.
MH-T-ARRIVAL-TIME
Indicates the date and time at which the message or probe entered the MD that produced
the per-recipient report.
MH-T-CONVERTED-EITS
Provides the EITs that characterize, or would characterize, the message after the MTS
converted it.
MH-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
MH-T-INTENDED-RECIPIENT-NAME
Is the O/R name of the originally intended recipient. This attribute is present only if the
MH-T-ACTUAL-RECIPIENT-NAME attribute denotes an alternate recipient.
MH-T-INTENDED-RECIPIENT-NUMBER
Is the ordinal position of the intended recipient in the list of recipients specified by the
originator of the message or probe. The value for the first recipient is 1. The minimum
value is ZGPI-MIN-RECIPIENTS, and the maximum value is ZGPI-MAXRECIPIENTS.
MH-T-MTA-REPORT-REQUEST
Indicates the reports that the originating MD requests in circumstances prescribed for
such reports. DDL names for the enumerated values of this attribute (omitting the prefix
MH-RQ-) describe the reports issued:
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
ALWAYS-AUDITED
A delivery or nondelivery report containing all external trace
entries
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 66
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-T-NON-DELIVERY-DIAGNOSTIC
Provides a detailed diagnosis of why the message was not (or would not be) delivered to
the recipient. DDL names for the enumerated values of this attribute describe the
diagnosis: for example, MH-DG-CONTENT-TOO-LONG. See the list of enumerated
values in the Value Characteristics column in Table 3-37. For detailed descriptions of the
diagnostics, see Recommendations X.400-X.420 (1988).
MH-T-NON-DELIVERY-REASON
Identifies the factor that prevented (or would have prevented) the message from being
delivered to the recipient. DDL names for the enumerated values of this attribute
describe the reasons: for example, MH-RE-RESTRICTED-DELIVERY. See the list of
enumerated values in the Value Characteristics column in Table 3-37.
MH-T-ORIGINATOR-REPORT-REQUEST
Indicates reports that the originator requested in circumstances prescribed for such
reports. DDL names for the enumerated values of this attribute (omitting the prefix MHRQ-) describe the reports issued:
NEVER
No report of either type
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
MH-T-SUPPLEMENTARY-INFO
Provides supplementary information about the status of the message or probe. For
example, a teletex access unit (AU) or teletex-to-telex conversion facility might use this
attribute to provide the received reply (answer back), the telex transmission duration, or
the note and received recorded message.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 67
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 Attributes—General Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-ALTERNATE-RECIPALLOWED
OM-S-BOOLEAN
--
1
MH-T-BILATERAL-INFORMATION
OM-S-OBJECT
(MH-C-BILATERAL-INFORMATION)
--
0-512
MH-T-CONTENT-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-CONTENT-LENGTH
OM-S-INTEGER
--
0-1
MH-T-CONTENT-TYPE
OM-S-INTEGER
or
OM-S-OBJECT-ID-STRING
−−
1
MH-T-CONVERSION-PROHIBITED
OM-S-BOOLEAN
--
1
MH-T-CRITICAL-FORDELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FOR-SUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORTRANSFER
OM-S-INTEGER
--
0-more
MH-T-EXPANSION-HISTORY
OM-S-OBJECT
(MH-C-EXPANSIONRECORD)
--
0-512
MH-T-EXPANSION-PROHIBITED
OM-S-BOOLEAN
--
0-1
MH-T-EXTENSIONS
OM-S-OBJEXT
(MH-C-EXTENSION)
--
0-more
MH-T-EXTERNAL-TRACEINFO
OM-S-OBJECT
(MH-C-EXTERNAL-TRACEENTRY)
--
1-512
MH-T-INTERNAL-TRACEINFO
OM-S-OBJECT
(MH-C-INTERNAL-TRACEENTRY)
--
0-512
2-n
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 68
MH-C-PROBE
Object Classes and Attribute Types
Table 3-38. MH-C-PROBE Attributes—General Characteristics (page 2 of 2)
Value
Length
Number of
Values
OM-S-OBJECT
(MH-C-MTS-IDENTIFIER)
--
1
MH-T-ORIGINAL-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-ORIGINATOR-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-RECIPIENT-DESCRIPTORS
OM-S-OBJECT
(MH-C-PROBE-RD)
--
1-32767
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
MH-T-MTS-IDENTIFIER
Some attribute types have additional value characteristics, as shown in Table 3-39.
Table 3-39. MH-C-PROBE Attributes—Additional Characteristics (page 1 of 2)
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. Value Length:
MH-VL-CONTENT-IDENTIFIER
MH-T-CONTENT-LENGTH
Integer Values:
0-2147483647
MH-T-CONTENT-TYPE
Initial Value:
MH-CTI-P2-1984
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-T-CONVERSION-PROHIBITED
Initial Value:
OM-FALSE
MH-T-EXPANSION-HISTORY
Max. Value Number:
MH-VN-EXPANSION-HISTORY
MH-T-EXTERNAL-TRACE-INFO
Max. Value Number:
MH-VN-TRACE-INFO
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 69
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. Value Number:
MH-VN-RECIPIENTDESCRIPTORS
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 probe to an alternate
recipient. An MD may assign an alternate recipient to accept delivery of probes whose
MH-T-RECIPIENT-DESCRIPTORS attribute contains O/R names that are invalid but
recognized as denoting users of the MD.
MH-T-BILATERAL-INFORMATION
Provides information to the MDs through which the probe may be transferred.
MH-T-CONTENT-IDENTIFIER
Provides information used to correlate a probe with any reports generated about it.
MH-T-CONTENT-LENGTH
Is the length (in octets) of the MH-T-CONTENT attribute value of the message that the
probe is testing for deliverability. The minimum length is ZGPI-MIN-CONTENT-LEN.
The maximum length is ZGPI-MAX-CONTENT-LEN.
MH-T-CONTENT-TYPE
Identifies the syntax and semantics of the value of the MH-T-CONTENT attribute of the
message. For descriptions of the content types, see the MH-T-CONTENT-TYPE
attribute description in MH-C-MESSAGE on page 3-37.
MH-T-CONVERSION-PROHIBITED
Indicates whether the originator prohibits the MTS from converting the message under
any circumstances.
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 probe.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 70
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.
MH-T-EXPANSION-HISTORY
Is a record of each attempt to add recipients to the distribution list of the probe. The
expansion records appear in chronological order.
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-EXTERNAL-TRACE-INFO
Documents how the probe was processed by each MD that transferred it. The entries
appear in chronological order; the first entry is from the MD that originated the probe.
For additional information about this attribute, see the its description in MH-CMESSAGE on page 3-37.
MH-T-INTERNAL-TRACE-INFO
Documents how the probe was processed by each MTA that transferred it. For additional
information about this attribute, see its description in MH-C-MESSAGE on page 3-37.
MH-T-MTS-IDENTIFIER
Is the MTS identifier of the probe. If copies of the probe are made for routing to
recipients at different locations, each copy contains the same MTS identifier.
If you omit this attribute when transferring a probe to the GPI service, its 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 probe
was submitted.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 71
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 72
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 Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-CRITICAL-FOR-DELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FOR-SUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FOR-TRANSFER
OM-S-INTEGER
--
0-more
MH-T-EXPLICIT-CONVERSION
OM-S-ENUMERATION
--
1
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
MH-T-MTA-REPORT-REQUEST
OM-S-ENUMERATION
--
1
MH-T-MTA-RESPONSIBILITY
OM-S-BOOLEAN
--
1
MH-T-ORIGINATOR-REPORTREQUEST
OM-S-ENUMERATION
--
1
MH-T-PREFERRED-DELIVERYMODES
OM-S-ENUMERATION
--
0-10
MH-T-RECIPIENT-NAME
OM-S-OBJECT(MH-C-OR-NAME)
--
1
MH-T-RECIPIENT-NUMBER
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-41.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 73
MH-C-PROBE-RD
Object Classes and Attribute Types
Table 3-41. MH-C-PROBE-RD Attributes—Additional
Characteristics (page 1 of 2)
Attribute Type
Value Characteristics
MH-T-EXPLICIT-CONVERSION
Initial Value:
MH-EC-NO-CONVERSION
Enumerated
Values:
MH-EC-NO-CONVERSION
MH-EC-IA5-TEXT-TO-TELETEX
MH-EC-TELETEX-TO-TELEX
MH-EC-TELEX-TO-IA5-TEXT
MH-EC-TELEX-TO-TELETEX
MH-EC-TELEX-TO-G4-CLASS1
MH-EC-TELEX-TO-VIDEOTEX
MH-EC-IA5-TEXT-TO-TELEX
MH-EC-TELEX-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G4-CLASS1
MH-EC-IA5-TEXT-TO-VIDEOTEX
MH-EC-TELETEX-TO-IA5-TEXT
MH-EC-TELETEX-TO-G3-FAX
MH-EC-TELETEX-TO-G4-CLASS1
MH-EC-TELETEX-TO-VIDEOTEX
MH-EC-VIDEOTEX-TO-TELEX
MH-EC-VIDEOTEX-TO-IA5-TEXT
MH-EC-VIDEOTEX-TO-TELETEX
Initial Value:
MH-RQ-NON-DELIVERY
Enumerated
Values:
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-RQ-ALWAYS-AUDITED
MH-T-MTA-RESPONSIBILITY
Initial Value:
OM-TRUE
MH-T-ORIGINATOR-REPORTREQUEST 2
Initial Value:
MH-RQ-NON-DELIVERY
Enumerated
Values:
MH-RQ-NEVER
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-T-MTA-REPORT-REQUEST 1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 74
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.
2
A value of MH-RQ-ALWAYS-AUDITED is invalid for the attribute MH-T-ORIGINATOR-REPORTREQUEST.
Meanings of Attributes
The attribute types specify the following information:
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 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.
MH-T-EXPLICIT-CONVERSION
Specifies the type of conversion the originator requests for the recipient. DDL names for
the enumerated values of this attribute describe the types of conversion: for example,
MH-EC-TELEX-TO-TELETEX. See the list of enumerated values in the Value
Characteristics column in Table 3-41.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 75
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. DDL names for the enumerated values of this attribute
(omitting the prefix MH-RQ-) describe the reports that are issued:
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
ALWAYS-AUDITED
A delivery or nondelivery report containing all external trace
entries
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 probe (or 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 probe
(or message) is being independently routed to this recipient.
MH-T-ORIGINATOR-REPORT-REQUEST
Indicates the kinds of reports that the originator requests in circumstances prescribed for
such reports. DDL names for the enumerated values of this attribute (omitting the prefix
MH-RQ-) describe the reports that are issued:
NEVER
No report of either type
NON-DELIVERY
A nondelivery report containing information from the final
external trace only
ALWAYS
A delivery or nondelivery report containing information from
the final external trace only
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 Value Characteristics column in Table 3-41.) In the DDL names, PDS indicates
physical delivery system (for example, the postal system) and MTS indicates delivery
through the message transfer system. The other names indicate types of terminals.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 76
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. It is named RequestedDeliveryMethod in the Recommendation X.411. All
other extension attributes in the MH-C-PROBE-RD class are mapped to values of
the MH-T-EXTENSIONS attribute.
Recommendation X.411 recommends that the criticality setting of the
MH-T-PREFERRED-DELIVERY-MODES attribute be critical-for-delivery.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 77
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.
Table 3-42 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-42. MH-C-REPORT Attributes—General Characteristics (page 1 of 2)
Value
Length
Number of
Values
OM-S-OBJECT
(IM-C-INTERPERSONAL-MESSAGE)
(IM-C-ACP127-NOTIFICATION)
(IM-C-RECEIPT-NOTIFICATION)
(IM-C-NON-RECEIPT-NOTIFICATION)
(MH-C-GENERAL-CONTENT)
(OM-C-EXTERNAL)
(EDI-C-EDIM)
(EDI-C-FORWARD-NOTIF)
(EDI-C-NEGATIVE-NOTIF)
(EDI-C-POSITIVE-NOTIF)
--
0-1
MH-T-CONTENT-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
MH-T-CONTENT-IDENTIFIER
OM-S-PRINTABLE-STRING
1-16
0-1
MH-T-CONTENT-TYPE
OM-S-INTEGER
or
OM-S-OBJECT-ID-STRING
−−
0-1
MH-T-CRITICAL-FORDELIVERY
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORSUBMISSION
OM-S-INTEGER
--
0-more
MH-T-CRITICAL-FORTRANSFER
OM-S-INTEGER
--
0-more
MH-T-EXPANSION-HISTORY
OM-S-OBJECT
(MH-C-EXPANSION-RECORD)
--
0-512
MH-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
Attribute Type
Value Syntax
MH-T-CONTENT
2-n
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 78
MH-C-REPORT
Object Classes and Attribute Types
Table 3-42. MH-C-REPORT Attributes—General Characteristics (page 2 of 2)
Value
Length
Number of
Values
OM-S-OBJECT
(MH-C-EXTERNAL-TRACEENTRY)
--
0-512
MH-T-MTS-IDENTIFIER
OM-S-OBJECT
(MH-C-MTS-IDENTIFIER)
--
1
MH-T-ORIGINAL-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
MH-T-PER-RECIPIENTREPORTS
OM-S-OBJECT
(MH-C-PER-RECIPIENT-DR)
(MH-C-PER-RECIPIENT-NDR)
--
1-32767
MH-T-REPORT-ADDITIONAL-INFO 1
OM-S-OCTET-STRING
2-1024
0-1
Attribute Type
Value Syntax
MH-T-EXTERNALTRACE-INFO
or
OM-S-ONFILE-STRING
MH-T-REPORT-DESTINATION
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
MH-T-REPORT-EXTERNAL-TRCE-INFO
OM-S-OBJECT
(MH-C-EXTERNAL-TRACEENTRY)
--
1-512
MH-T-REPORT-INTERNAL-TRCE-INFO
OM-S-OBJECT
(MH-C-INTERNAL-TRACEENTRY)
--
0-512
MH-T-REPORT-MTSIDENTIFIER
OM-S-OBJECT
(MH-C-MTS-IDENTIFIER)
--
1
MH-T-REPORTING-DLNAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
The value for MH-T-REPORT-ADDITIONAL-INFO shall follow the Basic Encoding Rules.
Some attribute types have additional value characteristics, as shown in Table 3-43.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 79
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. Value
Number:
MH-VN-EXPANSION-HISTORY
MH-T-EXTERNAL-TRACE-INFO
Max. Value
Number:
MH-VN-TRACE-INFO
MH-T-PER-RECIPIENT-REPORTS
Max. Value
Number:
MH-VN-REPORT-SUBSTANCE
MH-T-REPORT-ADDITIONALINFO
Max. Value
Length:
MH-VL-REPORT-ADDITIONAL-INFO
MH-T-REPORT-EXTERNALTRCE-INFO
Max. Value
Number:
MH-VN-TRACE-INFO
MH-T-REPORT-INTERNALTRCE-INFO
Max. Value
Number:
MH-VN-TRACE-INFO
MH-T-REPORT-MTS-IDENTIFIER
Initial Value:
assigned by
GPI_MT_TRANSFER_OUT_
Meanings of Attributes
The attribute types specify the following information:
MH-T-CONTENT
Is the arbitrary binary information the message is intended to convey to its recipients.
This is the same as the MH-T-CONTENT attribute of the message to which the report
pertains. This attribute is present only if the following conditions exist:
•
•
The value of the MH-T-CONTENT-RETURN-REQUESTED attribute of the
message is OM-TRUE.
The MH-T-PER-RECIPIENT-REPORTS attribute of this report includes an
MH-C-PER-RECIPIENT-NDR attribute that has no MH-T-CONVERTED-EITS
attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 80
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. This attribute is the same as the like-named attribute of the message to which
the report pertains.
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 report.
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 report.
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 report.
MH-T-EXPANSION-HISTORY
Is a record of each attempt to add recipients to the distribution list of the message to
which the delivery report applies. The first record documents the message’s submission
and the O/R name of the originator. The expansion records follow in chronological
order.
MH-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
MH-T-EXTERNAL-TRACE-INFO
Documents how the message or probe was processed by each MD that transferred it.
This is the same as the like-named attribute of the message or probe. This attribute is
present only if a report identified in the MH-T-PER-RECIPIENT-REPORTS attribute
was delivered to a recipient whose descriptor (MH-C-MESSAGE-RD or
MH-C-PROBE-RD) has an MH-T-MTA-REPORT-REQUEST value of
MH-RQ-ALWAYS-AUDITED.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 81
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-T-PER-RECIPIENT-REPORTS
Are delivered per-recipient reports, one for each recipient to which the report applies.
MH-T-REPORT-ADDITIONAL-INFO
Is binary data that follows the BER, except the minimum value length is 2 octets. You
can specify a zero-length octet string as hexadecimal ‘04 00’. This attribute is present by
bilateral agreement between the MD that originates the report and the MD serving the
originator. The agreement includes specification of the data type of the attribute value.
MH-T-REPORT-DESTINATION
Is the O/R name of the report’s immediate destination. The MTA that originates the
report initializes this attribute either to the last O/R name in the MH-T-EXPANSIONHISTORY attribute, if it is present in the message (or probe), or to the O/R name of the
originator of the message or probe.
MH-T-REPORT-EXTERNAL-TRCE-INFO
Documents how the report was processed by each MD that transferred it. The entries
appear in chronological order; the first entry is from the MD that originated the report.
An MD may add one or several trace entries, as follows:
•
•
If the report is transferred to the MD of first choice, the transferring MD adds a trace
entry with an MH-T-ACTION attribute value of MH-AC-RELAYED.
If the report is transferred to an MD that is not the first choice, the transferring MD
adds one or more trace entries with an MH-T-ACTION attribute value of
MH-AC-REROUTED. These entries indicate attempts to transfer the report to one
or several MDs.
You can use this attribute to detect loops.
MH-T-REPORT-INTERNAL-TRCE-INFO
Documents how the report was processed by each MTA that transferred it. However, a
service can limit the scope of this attribute to the local MD, except that the scope of each
entry documenting expansion or redirection is global. The entries appear in
chronological order.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 82
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. These entries indicate attempts to transfer the
communication to one or several MTAs.
This attribute can be used for detecting loops.
MH-T-REPORT-MTS-IDENTIFIER
Is the MTS identifier of the report.
MH-T-REPORTING-DL-NAME
Is the O/R name of the distribution list, if any, whose expansion point forwarded the
delivery report to the distribution list’s owner, in line with the distribution list’s
reporting policy.
Implementation and Usage Notes
•
•
•
•
The MH-T-REPORT-INTERNAL-TRCE-INFO, MH-T-EXPANSION-HISTORY,
and MH-T-REPORTING-DL-NAME attributes are 1988 extension attributes. All
other extension attributes in the MH-C-REPORT class are mapped to values of the
MH-T-EXTENSIONS attribute.
The correspondence between the following DDL names and the ASN.1-defined
names in Recommendation X.411 (1988) are:
MH-T-CONTENT
ReturnedContent
MH-T-EXTERNAL-TRACE-INFO
SubjectIntermediateTraceInformation
MH-T-EXPANSION-HISTORY
OriginatorAndDLExpansionHistory
MH-T-MTS-IDENTIFIER
SubjectID
MH-T-REPORT-DESTINATION
DestinationName
MH-T-REPORT-EXTERNALTRCE-INFO
TraceInformation
The XAPIA-1988 standard uses MH-VN-REPORT-SUBSTANCE for the maximum
value of MH-T-PER-RECIPIENT-REPORTS, which is a carryover from the
XAPIA-1984 standard naming of this attribute.
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-REPORT-ADDITONAL-INFO, this value syntax is an
alternative to OM-S-OCTET-STRING.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 83
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. 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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 84
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. MH-C-SECURITY-LABEL Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-PRIVACY-MARK
OM-S-PRINTABLESTRING
1-128
0-1
MH-T-SECURITYCATEGORY
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-64
MH-T-SECURITYCLASSIFICATION
OM-S-INTEGER
--
0-1
MH-T-SECURITY-POLICYID
OM-S-OBJECT-IDSTRING
--
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-45.
Table 3-45. MH-C-SECURITY-LABEL Attributes—Additional Characteristics
Attribute Type
Value Characteristics
MH-T-PRIVACY-MARK
Max Value Length
MH-VL-PRIVACY-MARK
MH-T-SECURITYCLASSIFICATION
Integer Values:
MH-UNMARKED
MH-UNCLASSFIED
MH-RESTRICTED
MH-CONFIDENTIAL
MH-SECRET
MH-TOP-SECRET
MH-T-SECURITY-POLICYID
Object Identifier
Value:
MH-SECURITY-POLICY-ID
Meanings of Attributes
The attribute types specify the following information:
MH-T-PRIVACY-MARK
Specifies the privacy mark.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 85
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 86
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. MH-C-TELETEX-NBPS Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
MH-T-CONTROL-CHARACTER-SETS
OM-S-TELETEX-STRING
−− 1
0-1
MH-T-GRAPHIC-CHARACTER-SETS
OM-S-TELETEX-STRING
−− 1
0-1
MH-T-MISC-CAPABILITIES
OM-S-TELETEX-STRING
−− 1
0-1
MH-T-PAGE-FORMATS
OM-S-OCTET-STRING
−− 1
0-1
MH-T-PRIVATE-USE
OM-S-OCTET-STRING
0-128
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
1
Length as prescribed by teletex
Some attribute types have additional value characteristics, as shown in Table 3-47.
Table 3-47. MH-C-TELETEX-NBPS Attributes—Additional Characteristics
Attribute Type
Value Characteristics
MH-T-PRIVATE-USE
Max. Value Length:
MH-VL-PRIVATE-USE
Meanings of Attributes
The attribute types specify the following information:
MH-T-CONTROL-CHARACTER-SETS
Is the information that signals in a CDS the control-character capability of a teletex
terminal.
MH-T-GRAPHIC-CHARACTER-SETS
Is the information that signals in a CDS the graphic-character capability of a teletex
terminal.
MH-T-MISC-CAPABILITIES
Is the information that signals in a CDS miscellaneous capabilities of a teletex terminal.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 87
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 88
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.
Table 3-48 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-48. IM-C-ACP127-DATA-BODY-PART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ACP127-DATA-DATA
OM-S-IA5-STRING
0-65535
1-more
IM-T-ACP127-DATAPARAMETERS
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-49.
Table 3-49. IM-C-ACP127-DATA-BODY-PART Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ACP127-DATA-DATA
Max. Value Length:
IM-VL-ACP127-DATA-DATA
Meanings of Attributes
The attribute types specify the following information:
IM-T-ACP127-DATA-PARAMETERS
Is an integer parameter for this body part.
IM-T-ACP127-DATA-DATA
Is a IA5 string that conveys ACP 127 data pattern traffic.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 89
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. IM-C-ACP127-NOTIFICATION Attributes—General Characteristics
Value
Length
Number of
Values
OM-S-OBJECT
(IM-C-ACP127NOTIFICATION-RSP)
--
1
IM-T-CONVERSION-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
IM-T-IPM-INTENDEDRECIPIENT
OM-S-OBJECT
(IM-C-ORDESCRIPTOR)
--
0-1
IM-T-IPN-ORIGINATOR
OM-S-OBJECT
(IM-C-ORDESCRIPTOR)
--
0-1
IM-T-SUBJECT-IPM
OM-S-OBJECT
(IM-C-IPMIDENTIFIER)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-ACP127NOTIFICATION-RSP
Meanings of Attributes
The attribute types specify the following information:
IM-T-ACP127-NOTIFICATION-RSP
Conveys the results of an attempt to transfer a message into an ACP 127 domain.
IM-T-CONVERSION-EITS
Are the EITs of the interpersonal message (IPM) at the time of its delivery to the
originator of the interpersonal notification (IPN). This attribute is present only if the
subject IPM was converted for delivery to the IPN'S originator or that recipient.
IM-T-IPM-INTENDED-RECIPIENT
Is the O/R descirptor for the intended recipient. This attribute is present only if the
subject IPM was delivered to an alternate recipient.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 90
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 91
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. IM-C-ACP127-NOTIFICATION-RSP Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ACP127NOTIFICATION-TYPE
OM-S-ENUMERATION
--
1
IM-T-ACP127-RECIPIENT
OM-S-PRINTABLESTRING
1-128
0-1
IM-T-ACP127-SUPP-INFO
OM-S-PRINTABLESTRING
1-128
0-1
IM-T-ADDRESS-LISTINDICATOR
OM-S-OBJECT
(IM-C-ADDRESS-LISTDESIGNATOR
--
0-1
IM-T-RECEIPT-TIME
OM-S-UTC-TIMESTRING
0-17
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-52.
Table 3-52. IM-C-ACP127-NOTIFICATION-RSP Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ACP127NOTIFICATION-TYPE
Enumerated Values:
IM-ACP127-NEVER
IM-ACP127-NN
IM-ACP127-PN
IM-ACP127-TN
IM-ACP127-NN-PN
IM-ACP127-NN-TN
IM-ACP127-PN-TN
IM-ACP127-ALWAYS
IM-T-ACP127-RECIPIENT
Max Value Length:
IM-VL-ACP127-RECIPIENT
IM-T-ACP127-SUPP-INFO
Max Value Length:
IM-VL-SUPP-INFO
IM-T-RECEIPT-TIME
Max Value Length:
IM-VL-TIME
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 92
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 93
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-ADATP3-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ADATP3PARAMETERS
OM-S-INTEGER
--
0
IM-T-LINE-ORIENTEDDATA
OM-S-IA5-STRING
--
0-1
IM-T-SET-ORIENTEDDATA
OM-S-IA5-STRING
--
0-more
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The attribute types specify the following information:
IM-T-ADATP3-PARAMETERS
Specifies the message-index reference number for identification of the AdatP3 message
type.
IM-T-LINE-ORIENTED-DATA
Is an IA5 string delimited by carriage return/line feed.
Note that if you specify IM-T-SET-ORIENTED-DATA (described below), you cannot
specify IM-T-LINE-ORIENTED-DATA.
IM-T-SET-ORIENTED-DATA
Is an IA5 string that is set oriented.
Note that if you specify IM-T-LINE-ORIENTED-DATA (described above), you cannot
specify IM-T-SET-ORIENTED-DATA.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 94
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. IM-C-ADDRESS-LIST-DESIGNATOR Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OBJECT
(IM-C-ORDESCRIPTOR)
--
1
IM-T-ALDNOTIFICATION-REQUEST
OM-S-INTEGER
--
0-1
IM-T-ALD-REPLYREQUEST
OM-S-INTEGER
--
0-1
IM-T-ALD-TYPE
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-ALD-LIST-NAME
Some attribute types have additional value characteristics, as shown in Table 3-55.
Table 3-55. IM-C-ADDRESS-LIST-DESIGNATOR Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ALD-NOTIFICATIONREQUEST
IM-ACTION-REQUEST
IM-INFO-REQUEST
IM-BOTH-REQUEST
IIM-T-ALD-REPLYREQUEST
Integer Values:
IM-ACTION-REQUEST
IM-INFO-REQUEST
IM-BOTH-REQUEST
IM-T-ALD-TYPE
Integer Values:
IM-PRIMARY-ADDRESS-LIST
IM-COPY-ADDRESS-LIST
Meanings of Attributes
The attribute types specify the following information:
IM-T-ALD-LIST-NAME
Contains the address list of the recipients.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 95
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-T-ALD-TYPE
Specifies the list of recipients as either primary or copy recipient.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 96
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-BILAT-DEFINED-BODY-PART Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
--
1
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-BILATERAL-DATA
OM-T-CLASS
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-BILATERAL-DATA
Is the binary data encoded in some format.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-BILATERAL-DATA, this value syntax is an alternative to
OM-S-OCTET-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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 97
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-CORRECTIONS-BODY-PART
This class of objects enables the originating MM-UA to indicate to the recipient that
there are corrections required to the text body.
Table 3-57 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-57. IM-C-CORRECTIONS-BODY-PART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-CORRECTIONSDATA
OM-S-IA5-STRING
--
1
IM-T-CORRECTIONSPARAMETERS
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The attribute types specify the following information:
IM-T-CORRECTIONS-DATA
Is an IA5 string that indicates corrections to the text body.
IM-T-CORRECTIONS-PARAMETERS
Is an integer parameter for this body part.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 98
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-DISTRIBUTION-CODES Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-DIST-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-1
IM-T-SIC
OM-S-PRINTABLESTRING
3-8
1-8
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-59.
Table 3-59. IM-C-DISTRIBUTION-CODES Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-SIC
Min Value Length:
IM-LB-SIC
Max Value Length:
IM-UB-SIC
Meanings of Attributes
The attribute types specify the following information:
IM-T-DIST-EXTENSIONS
Allows for future definitions of distribution criteria by either national or allied use. Any
number of codes may be specified.
IM-T-SIC
Contains published codes that provide information for message distribution after
delivery to the recipient organization.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3- 99
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-EXTERN-DEFINED-BODY-PART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-EXTERNAL-DATA
OM-S-OBJECT
(OM-C-EXTERNAL)
--
1
IM-T-EXTERNAL-PARAMETERS
OM-S-OBJECT
(OM-C-EXTERNAL)
--
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The attribute types specify the following information:
IM-T-EXTERNAL-DATA
Is the information object that the body part is intended to convey. Its OM-T-DIRECTREFERENCE attribute shall be present, its OM-T-DATA-VALUE-DESCRIPTOR and
OM-T-INDIRECT-REFERENCE attributes shall be absent.
IM-T-EXTERNAL-PARAMETERS
Is an information object that, if present, characterizes the value of the
IM-T-EXTERNAL-DATA attribute. Its OM-T-DIRECT-REFERENCE attribute shall be
present and allocated by the naming authority that allocated the like-named attribute of
the IM-T-EXTERNAL-DATA attribute, and at the same time. Its OM-T-DATA-VALUEDESCRIPTOR and OM-T-INDIRECT-REFERENCE attributes shall be absent.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -100
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. IM-C-G3-FAX-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-G3-FAX-NBPS
OM-S-OBJECT
(MH-C-G3-FAX-NBPS)
--
0-1
IM-T-IMAGES
OM-S-BIT-STRING
or
--
0-more
--
1
OM-S-ONFILE-STRING
OM-T-CLASS
OM-S-INTEGER
Meanings of Attributes
The attribute types specify the following information:
IM-T-G3-FAX-NBPS
Provides the nonbasic parameters of the images. This attribute is always present if the
interpersonal message (IPM) contains two or more G3 facsimile body parts. If only a
single body part is present, the nonbasic parameters might be conveyed instead by
means of the MH-T-ORIGINAL-EITS attribute of the message (or report) containing the
IPM.
IM-T-IMAGES
Are the G3 facsimile images: sequences of bit strings, each encoding a single page of
Group 3 facsimile data conforming to Recommendations T.4 and T.30. The minimum
length is 0, represented by one octet containing all zero bits.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute MH-T-IMAGES, this value syntax is an alternative to OM-S-BITSTRING.
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. The client can specify this syntax for
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -101
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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -102
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-FORWARDED-ENC-BODY-PART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-FORWARDED-ENCDATA
OM-S-BIT-STRING
--
1
IM-T-FORWARDEDENVELOPE
OM-S-OBJECT
(MH-C-DELIVERYENVELOPE)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The attribute types specify the following information:
IM-T-FORWARDED-ENC-DATA
Is a forwarded IPM. The IPM is encrypted.
IM-T-FORWARDED-ENVELOPE
Is the delivery envelope (without the MTS identifier) accompanying the forwarded
interpersonal message (IPM) when it is delivered to the originator of the forwarding
IPM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -103
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-G4-CLASS-1-BODY-PART Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-n
0-more
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-G4-CLASS-1-DOCUMENT
OM-T-CLASS
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-G4-CLASS-1-DOCUMENT
Is the final-form document. Each value of this attribute is a protocol element that
contributes to a description of the document’s layout structure. Each value must follow
the rules for G4 class 1 facsimile, which include the BER, except the minimum length is
2 octets. You can specify a zero-length octet string as hexadecimal ‘04 00’.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-G4-CLASS-1-DOCUMENT, this value syntax is an
alternative to OM-S-OCTET-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.
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.
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
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -104
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_. 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-IA5-TEXT-BODY-PART
This class of object consists of IA5 text.
Table 3-64 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-64. IM-C-IA5-TEXT-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-REPERTOIRE
OM-S-ENUMERATION
--
1
IM-T-TEXT
OM-S-IA5-STRING
or
OM-S-ONFILE-STRING
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-65.
Table 3-65. IM-C-IA5-TEXT-BODY-PART Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-REPERTOIRE
Initial Value:
IM-IA5
Enumerated Values:
IM-ITA2
IM-IA5
Meanings of Attributes
The attribute types specify the following information:
IM-T-REPERTOIRE
Identifies the character set used for the text. DDL names of the enumerated values
describe the sets as follows:
ITA2
Is the International Alphabet No. 2 (ITA2) character set, used for telex.
IA5
Is the full International Alphabet No. 5 (IA5) character set, which is almost
identical to ASCII.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -105
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.
For the attribute IM-T-TEXT, this value syntax is an alternative to OM-S-IA5STRING.
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. 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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -106
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 Attributes—General
Characteristics (page 1 of 3)
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ACP127MESSAGEIDENTIFIER
OM-S-PRINTABLE-STRING
1-69
0-1
IM-T-ADDRESS-LISTINDICATOR
OM-S_OBJECT
(IM-C-ADDRESS-LISTDESIGNATOR)
--
0-more
IM-T-AUTHORIZINGUSERS
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-more
IM-T-AUTOFORWARDED
OM-S-BOOLEAN
--
1
IM-T-BLIND-COPYRECIPIENTS
OM-S-OBJECT
(IM-C-RECIPIENT-SPECIFIER)
--
0-more
IM-T-BODY
OM-S-OBJECT
(IM-C-ACP127-DATA-BODY-PART)
(IM-C-ADATP3-BODY-PART)
(IM-C-BILAT-DEFINED-BODY-PART)
(IM-C-CORRECTIONS-BODY-PART)
(IM-C-EXTERN-DEFINED-BODYPART)
(IM-C-FORWARDED-ENC-BODYPART)
(IM-C-G3-FAX-BODY-PART)
(IM-C-G4-CLASS-1-BODY-PART)
(IM-C-IA5-TEXT-BODY-PART)
(IM-C-ISO-6937-TEXT-BODY-PART)
(IM-C-MESSAGE-BODY-PART)
(IM-C-MIXED-MODE-BODY-PART)
(IM-C-MM-MESSAGE-BODY-PART)
(IM-C-NAT-DEFINED-BODY-PART)
(IM-C-TELETEX-BODY-PART)
OM-S-INTEGER
--
0-more
--
0-1
IM-T-COPYRECIPIENTS
OM-S-OBJECT
(IM-C-RECIPIENT-SPECIFIER)
--
0-more
IMT-COPYPRECEDENCE
OM-S-INTEGER
--
0-1
IM-T-CODRESSMESSAGE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -107
IM-C-INTERPERSONAL-MESSAGE
Object Classes and Attribute Types
Table 3-66. IM-C-INTERPERSONAL-MESSAGE Attributes—General
Characteristics (page 2 of 3)
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-DISTRIBUTIONCODES
OM-S-OBJECT
(IM-C-DISTRIBUTION-CODES)
--
0-1
IM-T-EXEMPTEDADDRESS
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-more
IM-T-EXPIRY-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
IM-T-EXTENDEDAUTH-INFO
OM-S-UTC-TIME-STRING
0-17
0-1
IM-T-EXTENSIONS
OM-S-OBJECT
(MH-C-EXTENSION)
--
0-more
IM-T-HANDLINGINSTRUCTIONS
OM-S-PRINTABLE-STRING
1-69
0-more
IM-T-IMPORTANCE
OM-S-ENUMERATION
--
1
IM-T-MESSAGEINSTRUCTIONS
OM-S-PRINTABLE-STRING
1-69
0-more
IM-T-MESSAGETYPE
OM-S-OBJECT
(IM-C-MESSAGE-TYPE)
--
0-1
IM-T-OBSOLETEDIPMS
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
0-more
IM-T-ORIGINATOR
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-1
IM-T-ORIGINATORIDENTIFIER
OM-S-PRINTABLE-STRING
1-69
0-1
IM-T-ORIGINATORPLAD
OM_PRINTABLE-STRING
1-69
0-1
IM-T-OTHER-RECIPINDICATOR
OM-S-OBJECT
(IM-C-OTHER-RECIP-DESIGNATOR)
--
0-more
IM-T-PILOTFORWARDING-INFO
OM-S-OBJECT
(IM-C-PILOT-INFORMATION)
--
0-more
IM-T-PRIMARYPRECEDENCE
OM-S-INTEGER
--
0-1
IM-T-PRIMARYRECIPIENTS
OM-S-OBJECT
(IM-C-RECIPIENT-SPECIFIER)
--
0-more
IM-T-RELATED-IPMS
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
0-more
IM-T-REPLIED-TOIPM
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
0-1
IM-T-REPLYRECIPIENTS
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-more
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -108
IM-C-INTERPERSONAL-MESSAGE
Object Classes and Attribute Types
Table 3-66. IM-C-INTERPERSONAL-MESSAGE Attributes—General
Characteristics (page 3 of 3)
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-REPLY-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
IM-T-SENSITIVITY
OM-S-ENUMERATION
--
1
IM-T-SUBJECT
OM-S-TELETEX-STRING
0-256
0-1
IM-T-THIS-IPM
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-67.
Table 3-67. IM-C-INTERPERSONAL-MESSAGE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ACP127-MESSAGEIDENTIFIER
Max Value Length:
IM-VL-ACP127-MESG-IDENTIFIER
IM-T-AUTO-FORWARDED
Initial Value:
OM-FALSE
IM-T-COPYPRECEDENCE
Integer Values:
IM-DEFERRED-PRECEDENCE
IM-ROUTINE-PRECEDENCE
IM-PRIORITY-PRECEDENCE
IM-IMMEDIATE-PRECEDENCE
IM-FLASH-PRECEDENCE
IM-OVERRIDE-PRECEDENCE
IM-T-EXPIRY-TIME
Max. Value Length:
IM-VL-TIME
IM-T-EXTENDED-AUTHINFO
Max. Value
Length:
IM-VL-TIME
IM-T-HANDLINGINSTRUCTIONS
Max Value Length:
IM-VL-HANDLINGINSTRUCTIONS
IM-T-IMPORTANCE
Initial Value:
IM-ROUTINE
Enumerated
Values:
IM-LOW
IM-ROUTINE
IM-HIGH
IM-T-MESSAGEINSTRUCTIONS
Max Value Length:
IM-VL-MESSAGE-INSTRUCTIONS
IM-T-ORIGINATORIDENTIFIER
Max Value Length:
IM-VL-ORIGINATOR-IDENTIFIER
IM-T-ORIGINATOR-PLAD
Max Value Length:
IM-VL-ORIGINATOR-PLAD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -109
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. Value Length:
IM-VL-TIME
IM-T-SENSITIVITY
Initial Value:
IM-NOT-SENSITIVE
Enumerated
Values:
IM-NOT-SENSITIVE
IM-PERSONAL
IM-PRIVATE
IM-COMPANY-CONFIDENTIAL
Max. Value Length:
IM-VL-SUBJECT
IM-T-SUBJECT
Meanings of Attributes
The attribute types specify the following information:
IM-T-ACP127-MESSAGE-IDENTIFIER
Conveys the message identifier of an ACP 127 message in the Military Message
Handling System (MMHS).
IM-T-ADDRESS-LIST-INDICATOR
Specifies the name of a pre-defined list of recipients to which the originator has sent a
message.
IM-T-AUTHORIZING-USERS
Are the O/R descriptors for the authorizing users. An authorizing user is one who
individually or collectively authorizes an IPM to be sent. This attribute is not present if
the only authorizing user is the originator.
IM-T-AUTO-FORWARDED
Indicates whether the IPM is the result of automatic forwarding.
IM-T-BLIND-COPY-RECIPIENTS
Specifies the blind copy recipients of the IPM. A blind copy recipient is one whose role
is not disclosed to a primary or copy recipient. This attribute is not present in the IPM
intended for a primary or copy recipient.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -110
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.
IM-T-COPY-PRECEDENCE
Enables an originating military message user agent (MM-UA) to convey the military
precedence level of a message in the content header for a copy recipient.
IM-T-COPY-RECIPIENTS
Specifies the copy recipients of the IPM. The term copy recipient is defined by users of
the interpersonal messaging system.
IM-T-DISTRIBUTION-CODES
Enables 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
perform local distribution of a message.
IM-T-EXEMPTED-ADDRESS
Specifies the names of members of an Address List (AL) that the originator wants to
exclude from receiving the message.
IM-T-EXPIRY-TIME
Indicates the date and time at which the authorizing users consider the IPM to lose its
validity.
IM-T-EXTENDED-AUTH-INFO
Consists of a Date-Time Group (DTG) which indicates either:
•
•
The date and time when the message is officially released by the releasing officer, or
The date and time when the message was handed into a communications facility for
transmission.
IM-T-EXTENSIONS
Are requests for extended processing as part of the object’s submission, transfer, or
delivery.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -111
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. See the
Value Characteristics column in the Table 3-67.
IM-T-MESSAGE-INSTRUCTIONS
Enables the originating military messaging user agent (MM-UA) to indicate to the
recipient MM-UA that message instructions accompany the message.
IM-T-MESSAGE-TYPE
Enables originating military messaging user agents (MM-UAs) to distinguish messages
that relate to a specific exercise, operation, project or drill.
IM-T-OBSOLETED-IPMS
Specifies the IPM identifiers of IPMs that the authorizing users consider obsolete as a
result of this IPM.
IM-T-ORIGINATOR
Is the O/R descriptor for the originator of the interpersonal message (IPM).
IM-T-ORIGINATOR-IDENTIFIER
Enables the originating MM-UA to indicate to a recipient military messaging user agent
(MM-UA) a reference called the originator's number. The originating organizational
unit uses the originator’s number.
IM-T-ORIGINATOR-PLAD
Enables the originating military messaging user agent (MM-UA) to indicate to a
recipient MM-UA or to a ACP 127 Access Unit the plain language address, as defined
in ACP 127, of the originator of the message. This attribute provides a consistent nontranslated reference across the domain types.
IM-T-OTHER-RECIP-INDICATOR
Enables the originator to indicate to the recipient the names of one or more recipients
that are intended to receive the message without the use of the Military Message
Handling System (MMHS). IM-T-PRIMARY-RECIPIENTS and IM-T-COPYRECIPIENTS (or the list indicated in IM-T-ADDRESS-LIST-INDICATOR) give the
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -112
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-T-PRIMARY-PRECEDENCE
Enables an originating military message user agent (MM-UA) to convey the military
precedence level of a message in the content header for a primary recipient.
IM-T-PRIMARY-RECIPIENTS
Specifies the primary recipients of the Interpersonal Message (IPM). The term primary
recipient is defined by users of the interpersonal messaging system.
IM-T-RELATED-IPMS
Specifies the IPM identifiers of IPMs that the authorizing users consider related to this
IPM.
IM-T-REPLIED-TO-IPM
Specifies an IPM identifier of the IPM to which this IPM is replying.
IM-T-REPLY-RECIPIENTS
Are the O/R descriptors of users who the authorizing users would like to receive a reply.
This attribute is not present if the only reply recipient is the originator of the IPM.
IM-T-REPLY-TIME
Indicates the date and time by which the authorizing users request any replies to the
IPM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -113
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.
COMPANY-CONFIDENTIAL
The IPM contains information that should be
handled according to company-specific procedures.
IM-T-SUBJECT
Is text that describes the IPM’s subject matter. The value length is expressed in octets
(not teletex characters).
IM-T-THIS-IPM
Is the IPM identifier of this interpersonal message(IPM).
Implementation and Usage Note
•
You should distinguish carefully between the forwarding IPM and the forwarded
IPM in relation to IPMs that are made obsolete by, replied to by, or related to, the
current IPM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -114
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-IPM-IDENTIFIER Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-USER
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
IM-T-USER-RELATIVEIDENTIFIER
OM-S-PRINTABLE-STRING
0-64
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-69.
Table 3-69. IM-C-IPM-IDENTIFIER Attributes—Additional Characteristics
Attribute Type
Value Characteristics
IM-T-USER-RELATIVEIDENTIFIER
Max. Value Length:
IM-VL-USER-RELATIVE-IDENTIFIER
Meanings of Attributes
The attribute types specify the following information:
IM-T-USER
Is the O/R name of the originator of the IPM.
IM-T-USER-RELATIVE-IDENTIFIER
Is the IPM identifier that uniquely identifies the IPM relative to the user who originates
it.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -115
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. IM-C-ISO-6937-TEXT-BODY-PART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ISO-6937-REPERTOIRE
OM-S-ENUMERATION
--
1
IM-T-ISO-6937-TEXT
OM-S-OCTET-STRING
or
--
1
--
1
OM-S-ONFILE-STRING
OM-T-CLASS
OM-S-INTEGER
Some attribute types have additional value characteristics, as shown in Table 3-71.
Table 3-71. IM-C-ISO-6937-TEXT-BODY-PART Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ISO-6937-REPERTOIRE
Initial Value:
IM-GRAPHIC
Enumerated Values:
IM-GRAPHIC
IM-PART1-AND-PART2
IM-TELETEX
Meanings of Attributes
The attribute types specify the following information:
IM-T-ISO-6937-REPERTOIRE
Identifies the character set to which the text is constrained. For its defined values, see
the ISO 6937 Repertoire enumeration.
IM-T-ISO-6937-TEXT
Is the sequence of lines that constitutes the text. It shall contain no control functions,
except that a carriage return followed by a line feed denotes the end of a line. Each line
may contain 0-80 graphic characters for guaranteed rendition.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -116
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.
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.
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.
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-MESSAGE-BODY-PART
This class of object represents an IPM and, optionally, its delivery envelope. You can
use an object of this class to forward an IPM. The enclosing IPM is called the
forwarding IPM; the enclosed IPM is the forwarded IPM.
Table 3-72 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-72. IM-C-MESSAGE-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ENVELOPE
OM-S-OBJECT
(MH-C-DELIVERY-ENVELOPE)
--
0-1
IM-T-IPM
OM-S-OBJECT
(IM-C-INTERPERSONAL-MESSAGE)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The attribute types specify the following information:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -117
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-MESSAGE-TYPE
This class enables originating military messaging user agents (MM-UAs) to distinguish
messages that relate to a specific exercise, operation, drill, or project
Table 3-73 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-73. IM-C-MESSAGE-TYPE Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-MESSAGEIDENTIFIER
OM-S-PRINTABLESTRING
1-69
0-1
IM-T-TYPE-MESSAGE
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-74.
Table 3-74. IM-C-MESSAGE_TYPE Attributes—Additional Characteristics
Attribute Type
Value Characteristics
IM-T-MESSAGE-IDENTIFIER
Max Value Length:
IM-VL-MESSAGE-IDENTIFIER
IM-T-TYPE-MESSAGE
Integer Values:
IM-EXERCISE
IM-OPERATION
IM-PROJECT
IM-DRILL
Meanings of Attributes
The attribute types specify the following information:
IM-T-MESSAGE-IDENTIFIER
Specifies the name of the type.
IM-T-TYPE-MESSAGE
Identifies the type of the message carried.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -118
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-MIXED-MODE-BODY-PART Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-n
0-more
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-MIXED-MODE-DOCUMENT
OM-T-CLASS
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-MIXED-MODE-DOCUMENT
Is the final-form document. Each value of this attribute is a protocol element that
contributes to a description of the document’s layout structure. Each value must follow
the rules for G4 Classes 2 and 3 facsimile, which include the BER, except the minimum
length is 2 octets. You can specify a zero-length octet string as hexadecimal ‘0400’.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-MIXED-MODE-DOCUMENT, this value syntax is an
alternative to OM-S-OCTET-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.
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.
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
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -119
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_. 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-MM-MESSAGE-BODY-PART
This class of object conveys a military message that has been forwarded by a military
messaging user agent (MM-UA). The military message body part contains the original
contents of the forwarded message.
Table 3-76 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-76. IM-C-MM-MESSAGE-BODY-PART Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OBJECT
(IM-CINTERPERSONALMESSAGE)
--
1
IM-T-MM-MESSAGEENVELOPE
OM-S-OBJECT
(MH-C-DELIVERYENVELOPE)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-MM-MESSAGEDATA
Meanings of Attributes
The attribute types specify the following information:
IM-T-MM-MESSAGE-DATA
Is the forwarded IPM.
IM-T-MM-MESSAGE-ENVELOPE
Is the delivery envelope (without the MTS identifier) accompanying the forwarded
interpersonal message (IPM) when it is delivered to the originator of the forwarding
IPM.
IM-C-NAT-DEFINED-BODY-PART
This class of object consists of binary data, which must follow the BER. The data type
of the data value encoded is nationally defined. The originator and all recipients are
assumed to know the country that defined the data type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -120
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-NAT-DEFINED-BODY-PART Attributes—General
Characteristics
Value
Length
Number of
Values
OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-n
1
OM-S-INTEGER
--
1
Attribute Type
Value Syntax
IM-T-NATIONAL-DATA
OM-T-CLASS
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-NATIONAL-DATA
Is the binary data, which must follow the BER, except the minimum length is 2 octets.
You can specify a zero-length octet string as hexadecimal ‘04 00’.
Implementation and Usage Note
•
•
Use of this class is discouraged and intended only for domestic communication in
which the country is implicitly that of the originator and all of the recipients of the
IPM that contains the nationally defined body part.
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-NATIONAL-DATA, this value syntax is an alternative to
OM-S-OCTET-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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -121
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
This class of object reports the failure of the report’s originator to receive or accept an
IPM or a delay in receiving an IPM. (The report’s originator is the intended recipient of
the message or probe to which the report applies.)
Table 3-78 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-78. IM-C-NON-RECEIPT-NOTIFICATION Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-AUTO-FORWARDCOMMENT
OM-S-PRINTABLE-STRING
0-256
0-1
IM-T-CONVERSION-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
IM-T-DISCARD-REASON
OM-S-ENUMERATION
--
1
IM-T-IPM-INTENDEDRECIPIENT
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-1
IM-T-IPN-ORIGINATOR
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-1
IM-T-NON-RECEIPT-REASON
OM-S-ENUMERATION
--
1
IM-T-RETURNED-IPM
OM-S-OBJECT
(IM-C-INTERPERSONALMESSAGE)
--
0-1
IM-T-SUBJECT-IPM
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-79.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -122
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. Value Length:
IM-VL-AUTO-FORWARDCOMMENT
IM-T-DISCARD-REASON
Initial Value:
IM-NO-DISCARD
Enumerated
Values:
IM-NO-DISCARD
IM-IPM-EXPIRED
IM-IPM-OBSOLETED
IM-USER-TERMINATED
Initial Value:
IM-IPM-DISCARDED
Enumerated
Values:
IM-IPM-DISCARDED
IM-IPM-AUTO-FORWARDED
IM-T-NON-RECEIPT-REASON
Meanings of Attributes
The attribute types specify the following information:
IM-T-AUTO-FORWARD-COMMENT
Is information supplied by the originator of the nonreceipt notification when the
originator requests messages to be auto-forwarded. This attribute is present only if the
value of the IM-T-NON-RECEIPT-REASON attribute is IM-IPM-AUTOFORWARDED.
IM-T-CONVERSION-EITS
Are the EITs of the IPM at the time of its delivery to the originator of the interpersonal
notification (IPN). This attribute is present only if the subject IPM was converted for
delivery to that recipient.
IM-T-DISCARD-REASON
Indicates why the IPM was discarded (after its delivery to the NRN’s originator and
before its receipt). DDL names for the enumerated values describe the reasons: for
example, IM-IPM-EXPIRED. See the Value Characteristics column in Table 3-79.
Values other than IM-NO-DISCARD are present only if the value of
IM-T-NON-RECEIPT-REASON is IM-IPM-DISCARDED.
IM-T-IPM-INTENDED-RECIPIENT
Is the O/R descriptor for the intended recipient. This attribute is present only if the
subject IPM is delivered to an alternate recipient.
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).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -123
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. This attribute is
present only if the value of the IM-T-IPM-RETURN-REQUESTED attribute of the
subject recipient specifier is OM-TRUE, and the subject IPM was not converted for
delivery to the originator of the nonreceipt notification.
IM-T-SUBJECT-IPM
Is the IPM identifier of the IPM to which the notification applies.
IM-C-OR-DESCRIPTOR
This class of object identifies a user, who can be an originator or recipient or both.
Table 3-80 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-80. IM-C-OR-DESCRIPTOR Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-FORMAL-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
IM-T-FREE-FORM-NAME
OM-S-TELETEX-STRING
0-128
0-1
IM-T-TELEPHONE-NUMBER
OM-S-PRINTABLE-STRING
0-32
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-81.
Table 3-81. IM-C-OR-DESCRIPTOR Attributes—Additional Characteristics
Attribute Type
Value Characteristics
IM-T-FREE-FORM-NAME
Max. Value Length:
IM-VL-FREE-FORM-NAME
IM-T-TELEPHONE-NUMBER
Max. Value Length:
IM-VL-TELEPHONE-NUMBER
Meanings of Attributes
The attribute types specify the following information:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -124
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. Specifically, the conditions are those set by the
IM-T-RETURN-REQUESTED, IM-T-NOTIFICATION-REQUEST, and
IM-T-REPLY-REQUESTED attributes.
IM-T-FREE-FORM-NAME
Is an informal name for the user. This attribute is always present if (but not only if) the
IM-T-FORMAL-NAME attribute is absent. The value length is expressed in octets (not
in teletex characters).
IM-T-TELEPHONE-NUMBER
Is the user’s telephone number. Use of a value length of 0 is discouraged.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -125
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-OTHER-RECIP-DESIGNATOR Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ORD-DESIGNATOR
OM-S-PRINTABLESTRING
1-69
1
IM-T-ORD-TYPE
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-83.
Table 3-83. IM-C-OTHER-RECIP-DESIGNATOR Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ORD-DESIGNATOR
Max Value Length:
IM-VL-ORD-DESIGNATOR
IM-T-ORD-TYPE
Integer Value:
IM-ORD-PRIMARY
IM-ORD-COPY
Meanings of Attributes
The attribute types specify the following information:
IM-T-ORD-DESIGNATOR
Specifies the names of the recipients.
IM-T-ORD-TYPE
Specifies the category (Primary or Copy) in which the recipients are placed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -126
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. IM-C-PILOT-INFORMATION Attributes— General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-PILOT-HANDLING
OM-S-PRINTABLESTRING
1-69
0-more
IM-T-PILOT-PRECEDENCE
OM-S-INTEGER
--
0-1
IM-T-PILOT-RECIPIENT
OM-S-OBJECT
(IM-C-ORDESCRIPTOR)
--
0-more
IM-T-PILOT-SECURITY
OM-S-OBJECT
(MH-C-SECURITYLABEL)
--
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-85.
Table 3-85. IM-C-PILOT-INFORMATION Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-PILOT-HANDLING
Max. Value Length:
IM-VL-PILOT-HANDLING
IM-T-PILOT-PRECEDENCE
Integer Values:
IM-DEFERRED-PRECEDENCE
IM-ROUTINE-PRECEDENCE
IM-PRIORITY-PRECEDENCE
IM-IMMEDIATE-PRECEDENCE
IM-FLASH-PRECEDENCE
IM-OVERRIDE-PRECEDENCE
Meanings of Attributes
The attribute types specify the following information:
IM-T-PILOT-HANDLING
Specifies the local handling instructions.
IM-T-PILOT-PRECEDENCE
Conveys the military precedence level of pilot message.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -127
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -128
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. IM-C-RECEIPT-NOTIFICATION Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ACKNOWLEDGMENTMODE
OM-S-ENUMERATION
--
1
IM-T-CONVERSION-EITS
OM-S-OBJECT
(MH-C-EITS)
--
0-1
IM-T-IPM-INTENDEDRECIPIENT
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-1
IM-T-IPN-ORIGINATOR
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
0-1
IM-T-RECEIPT-TIME
OM-S-UTC-TIME-STRING
0-17
1
IM-T-SUBJECT-IPM
OM-S-OBJECT
(IM-C-IPM-IDENTIFIER)
--
1
IM-T-SUPPL-RECEIPT-INFO
OM-S-PRINTABLE-STRING
1-256
0-1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-87.
Table 3-87. IM-C-RECEIPT-NOTIFICATION Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ACKNOWLEDGMENTMODE
Initial Value:
IM-MANUAL
Enumerated Values:
IM-MANUAL
IM-AUTOMATIC
IM-T-RECEIPT-TIME
Max. Value Length:
IM-VL-TIME
IM-T-SUPPL-RECEIPT-INFO
Max. Value Length:
IM-VL-SUPPL-RECEIPT-INFO
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -129
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). This attribute is present only if the subject IPM was converted for
delivery to the IPN’s originator or that recipient.
IM-T-IPM-INTENDED-RECIPIENT
Is the O/R descriptor for the intended recipient. This attribute is present only if the
subject IPM was delivered to an alternate recipient.
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-RECEIPT-TIME
Indicates the date and time at which the originator of the receipt notification received the
subject IPM.
IM-T-SUBJECT-IPM
Is the IPM identifier of the IPM to which the notification applies.
IM-T-SUPPL-RECEIPT-INFO
Provides supplementary information about receipt of the subject IPM by the receipt
notification’s originator.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -130
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. IM-C-RECIPIENT-SPECIFIER Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-ACP-NOTIFICATION-TYPE
OM-S-ENUMERATION
--
0-1
IM-T-IPM-RETURN-REQUESTED
OM-S-BOOLEAN
--
1
IM-T-NOTIFICATION-REQUEST
OM-S-ENUMERATION
--
1
IM-T-RECIPIENT
OM-S-OBJECT
(IM-C-OR-DESCRIPTOR)
--
1
IM-T-REPLY-REQUESTED
OM-S-BOOLEAN
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-89.
Table 3-89. IM-C-RECIPIENT-SPECIFIER Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
IM-T-ACP127-NOTIFICATIONTYPE
Enumerate
Values:
IM-ACP127-NEVER
IM-ACP127-NN
IM-ACP127-PN
IM-ACP127-TN
IM-ACP127-NN-PN
IM-ACP127-NN-TN
IM-ACP127-PN-TN
IM-ACP127-ALWAYS
IM-T-IPM-RETURN-REQUESTED
Initial Value:
OM-FALSE
IM-T-NOTIFICATION-REQUEST
Initial Value:
IM-NEVER
Enumerated
Values:
IM-NEVER
IM-NON-RECEIPT
IM-ALWAYS
Initial Value:
OM-FALSE
IM-T-REPLY-REQUESTED
Meanings of Attributes
The attribute types specify the following information:
IM-T-ACP127-NOTIFICATION-TYPE
Enables the originator to request notifications from ACP 127 gateways.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -131
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-NON-RECEIPT
A nonreceipt notification is requested when appropriate.
IM-ALWAYS
A receipt or nonreceipt notification is requested as appropriate.
IM-T-RECIPIENT
Is an O/R descriptor for the recipient. If the attributes IM-T-NOTIFICATIONREQUEST or IM-T-REPLY-REQUESTED make a request of the preferred recipient, the
IM-T-FORMAL-NAME attribute must be present in this O/R descriptor (IM-C-ORDESCRIPTOR).
IM-T-REPLY-REQUESTED
Indicates whether a reply is requested of the recipient. A reply is one IPM sent in
response to another. A user may reply to an IPM even though no reply is requested and
the user is not a specified recipient but obtains the message some other way. A user from
whom a reply is requested does not have to reply.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -132
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. IM-C-TELETEX-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-TELETEX-DOCUMENT
OM-S-TELETEX-STRING
--
0-more
or
OM-S-ONFILE-STRING
IM-T-TELETEX-NBPS
OM-S-OBJECT
(MH-C-TELETEX-NBPS)
--
0-1
IM-T-TELEX-COMPATIBLE
OM-S-BOOLEAN
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-91.
Table 3-91. IM-C-TELETEX-BODY-PART Attributes—Additional Characteristics
Attribute Type
Value Characteristics
IM-T-TELEX-COMPATIBLE
Initial Value:
OM-FALSE
Meanings of Attributes
The attribute types specify the following information:
IM-T-TELETEX-DOCUMENT
Is the teletex document, one page per attribute value.
IM-T-TELETEX-NBPS
Provides the nonbasic parameters of the document. This attribute is always present if the
IPM contains two or more teletex body parts. If only a single body part is present in the
IPM, the nonbasic parameters might be conveyed instead by means of the
MH-T-ORIGINAL-EITS attribute of the message (or report) containing the IPM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -133
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.
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. 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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -134
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-UNIDENTIFIED-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-UNIDENTIFIED-DATA
OM-S-OCTET-STRING
2-n
1
or
OM-S-ONFILE-STRING
IM-T-UNIDENTIFIED-TAG
OM-S-INTEGER
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-UNIDENTIFIED-DATA
Is the Basic Encoding Rules encoded data that is the whole body part including its
ASN.1 tag.
IM-T-UNIDENTIFIED-TAG
Is the ASN.1 tag number that differentiates this body part. This value is extracted from
the first few octets of IM-T-UNIDENTIFIED-DATA.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-UNIDENTIFIED-DATA, this value syntax is an alternative to
OM-S-OCTET-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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -135
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.
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-VIDEOTEX-BODY-PART
This class of object consists of videotex data.
Table 3-93 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-93. IM-C-VIDEOTEX-BODY-PART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
IM-T-VIDEOTEX-DATA
OM-S-VIDEOTEX-STRING
--
1
or
OM-S-ONLINE-STRING
IM-T-VIDEOTEX-SYNTAX
OM-S-ENUMERATION
--
1
OM-T-CLASS
OM-S-INTEGER
--
1
Some attribute types have additional value characteristics, as shown in Table 3-94.
Table 3-94. IM-C-VIDEOTEX-BODY-PART Attributes—Additional Characteristics
Attribute Type
Value Characteristics
IM-T-VIDEOTEX-SYNTAX
Initial Value:
IM-UNSPECIFIED
Enumerated Values:
IM-UNSPECIFIED
IM-IDS
IM-DATA-SYNTAX-1
IM-DATA-SYNTAX-2
IM-DATA-SYNTAX-3
Meanings of Attributes
The attribute types specify the following information:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -136
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.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-VIDEOTEX-DATA, this value syntax is an alternative to OMS-VIDEOTEX-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.
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.
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.
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.
Electronic Data Interchange Messaging Classes
This subsection describes objects and attributes of the electronic data interchange
package. For an overview of how each class relates to the other classes, refer to
Appendix D, Class Hierarchies.
EDI-C-AUTHORIZATION-INFO
This class of object contains information about who authorized an EDI message
(EDIM). The object is contained in the heading for an EDIM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -137
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-AUTHORIZATION-INFO Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-AUTHORIZATION-INFO
OM-S-TELETEX-STRING
1-20
1
EDI-T-AUTHORIZATION-INFO-Q
OM-S-TELETEX-STRING
1-4
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-96.
Table 3-96. EDI-C-AUTHORIZATION-INFO Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-AUTHORIZATION-INFO
Max. Value
Length:
EDI-VL-AUTHORIZATION-INFO
EDI-T-AUTHORIZATION-INFO-Q
Max. Value
Length:
EDI-VL-AUTHORIZATION-INFO-Q
OM-T-CLASS
Max. Value
Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
EDI-T-AUTHORIZATION-INFO
Indicates who authorized the EDIM.
EDI-T-AUTHORIZATION-INFO-Q
Qualifies the information provided by the EDI-T-AUTHORIZATION-INFO attribute.
EDI-C-CROSS-REF-INFO
This class of object contains information that allows an application to reference body
parts in the same EDIM or within other EDIMs. The use of the cross reference
information is determined by the application.
Table 3-97 describes the attribute types for this class and the syntax, length, and number
of values for each type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -138
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-CROSS-REF-INFO Attributes—Additional Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
EDI-T-APP-CROSS-REFERENCE
Contains application-specific information about the referenced body part.
EDI-T-BODYPART-REFERENCE
Indicates the referenced body part.
EDI-T-MSG-REFERENCE
Indicates the EDIM containing the referenced body part. If this attribute is absent, the
cross reference information refers to this EDIM.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute EDI-T-APP-CROSS-REFERENCE, this value syntax is an
alternative to OM-S-OCTET-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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -139
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.
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.
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-APP-SECUR-ELTS
This class of object identifies a set of security elements. This class is used to allow an
application to exchange security elements that have significance to the originator and
recipients. This class is contained in both EDIMs and EDINs.
Table 3-99 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Table 3-99. EDI-C-EDI-APP-SECUR-ELTS Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDI-APP-SECUR-ELEMENT
OM-S-BIT-STRING
0-1025
0-1 1
or
OM-S-ONFILE-STRING
EDI-T-EDI-APP-SECUR-EXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-EDI-ENCRYPTED-PRIMARY-BP
OM-S-BOOLEAN
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
1
The value length of an attribute of syntax OM-S-BIT-STRING is specified in units of octets. The first octet
of the value specifies the number of unused bits in the last octet. The first octet must contain a value in the
range of 0 through 7. The maximum number of bits allowed for EDI-T-EDI-APP-SECUR-ELEMENTS is
8191, not including bits of the first octet. This implies a maximum length of 1025 octets; one octet to indicate the number of unused bits, followed by 1024 octets for the data string (1023 octets that are filled completely, and a last octet that has one unused bit).
Some attribute types have additional value characteristics, as shown in Table 3-100.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -140
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-T-EDI-APP-SECUR-EXTENSIONS
Contains requests for extended security processing as part of the submission, transfer, or
delivery of the object (EDIM or EDIN).
EDI-T-EDI-ENCRYPTED-PRIMARY-BP
Indicates whether the associated primary body part is encrypted (applies to EDIMs
only).
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute EDI-T-APP-SECURE-ELEMENT, this value syntax is an
alternative to OM-S-BIT-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.
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.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -141
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-BODYPART
This class of object contains a single EDI interchange.
Table 3-101 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-101. EDI-C-EDI-BODYPART Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BODY
OM-S-OCTET-STRING
--
1
7
1
or
OM-S-ONFILE-STRING
OM-T-CLASS
OM-S-OBJECT-ID-STRING
Some attribute types have additional value characteristics, as shown in Table 3-102.
Table 3-102. EDI-C-EDI-BODYPART Attributes—Additional Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The first attribute type specifies the following information:
EDI-T-BODY
Contains the EDI interchange in whatever EDI format the receiving application can
understand. GPI expects it in octet string format and will encode it in ASN.1 octet string
for you.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute EDI-T-BODY, this value syntax is an alternative to OM-S-OCTETSTRING.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -142
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.
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.
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
This class of object is provided for future extensions to the EDI messaging defined in
this document.
Table 3-103 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-103. EDI-C-EDI-EXTENSION Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-CRITICALITY
OM-S-BOOLEAN
--
1
EDI-T-EXTENSION-TYPE
OM-S-OBJECT-ID-STRING
2-n
1
EDI-T-EXTENSION-VALUE
OM-S-ENCODING-STRING
2-n
0-1
7
1
or
OM-S-ONFILE-STRING
OM-T-CLASS
OM-S-OBJECT-ID-STRING
Some attribute types have additional value characteristics, as shown in Table 3-104.
Table 3-104. EDI-C-EDI-EXTENSION Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-CRITICALITY
Initial Value:
OM-FALSE
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -143
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-T-EXTENSION-VALUE
Indicates the value of the extension. The value must be of the type indicated by the value
of the extension type attribute.
Implementation and Usage Note
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute EDI-T-EXTENSION-VALUE, this value syntax is an alternative to
OM-S-ENCODING-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.
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.
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.
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-HEADING
This class of object contains information that describes an EDIM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -144
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 Attributes—General
Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-APP-REFERENCE
OM-S-TELETEX-STRING
1-28
0-1
EDI-T-DATE-AND-TIMEOF-PREP
OM-S-UTC-TIME-STRING
0-17
0-1
EDI-T-CROSS-REFERENCING-INFO
OM-S-OBJECT
(EDI-C-CROSS-REF-INFO)
--
0-more
EDI-T-EDI-APP-SECURELEMENTS
OM-S-OBJECT
(EDI-C-EDI-APP-SECUR-ELTS)
--
0-1
EDI-T-EDI-BODYPARTTYPE
OM-S-OBJECT-ID-STRING
2-n
1
EDI-T-EDI-MSG-TYPE
OM-S-TELETEX-STRING
1-12
0-more
EDI-T-EDIN-RECEIVER
OM-S-OBJECT
(EDI-C-EDIN-RECEIVER)
--
0-1
EDI-T-EXPIRY-TIME
OM-S-UTC-TIME-STRING
0-17
0-1
EDI-T-HEADING-EXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-INC-COPY
OM-S-BOOLEAN
--
1
EDI-T-INTER-SENDER
OM-S-OBJECT
(EDI-C-INTER-SENDER-RECIP)
--
0-1
EDI-T-OBSOLETED-EDIMS
OM-S-OBJECT
(EDI-C-EDIM-ID)
--
0-more
EDI-T-ORIG
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
EDI-T-THIS-EDIM
OM-S-OBJECT
(EDI-C-EDIM-ID)
--
1
EDI-T-RECIPS
OM-S-OBJECT
(EDI-C-RECIPS)
--
0-more
EDI-T-RESPONS-FORWARD
OM-S-BOOLEAN
--
1
EDI-T-RELATED-EDI-MSGS
OM-S-OBJECT
(EDI-C-EDIM-ID)
--
0-more
EDI-T-RELATED-NON-EDIMSGS
OM-S-OBJECT
(OM-C-EXTERNAL)
--
0-more
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -145
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. EDI-C-EDI-HEADING Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-APP-REFERENCE
Max. Value Length:
EDI-VL-APP-REFERENCE
EDI-T-EDI-BODYPART-TYPE
Initial Value:
Object Identifier Values:
EDI-BPO-EDIFACT-ISO646
EDI-BPO-EDIFACT-ISO646
EDI-BPO-EDIFACT-T61
EDI-BPO-EDIFACT-OCTET
EDI-BPO-ANSIX12-ISO646
EDI-BPO-ANSIX12-T61
EDI-BPO-ANSIX12-OCTET
EDI-BPO-ANSIX12-EBCDIC
EDI-BPO-UNTDI-ISO646
EDI-BPO-UNTDI-T61
EDI-BPO-UNTDI-OCTET
EDI-BPO-PRIVATE-OCTET
EDI-BPO-UNDEFINED-OCTET
EDI-T-EDI-MSG-TYPE
Max.Value Length:
EDI-VL-EDI-MSG-TYPE
EDI-T-EXPIRY-TIME
Max.Value Length:
EDI-VL-TIME
EDI-T-INC-COPY
Initial Value:
OM-FALSE
EDI-T-RESPONS-FORWARD
Initial Value:
OM-FALSE
OM-T-CLASS
Max.Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -146
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-T-EDI-APP-SECUR-ELEMENTS
Allows an EDI application to exchange security elements having an end-to-end
significance (elements that are understood at both ends of the exchange).
EDI-T-EDI-BODYPART-TYPE
Indicates the EDI standard and EDI character sets used in the primary body part. It is
represented by a single object identifier. The following standard values have object
identifiers defined in the EDI message standards. The first column of the table lists the
symbolic values. The second column specifies, in ASN.1, the object identifiers denoted
by the values.
Value
Object Identifier (ASN.1)
edifact-ISO646
{joint-isi-ccitt mhs-motis(6) edims(7) 11 0}
edifact-T61
{joint-isi-ccitt mhs-motis(6) edims(7) 11 1}
edifact-octet
{joint-isi-ccitt mhs-motis(6) edims(7) 11 2}
ansiX12-ISO646
{joint-isi-ccitt mhs-motis(6) edims(7) 11 3}
ansiX12-T61
{joint-isi-ccitt mhs-motis(6) edims(7) 11 4}
ansiX12-octet
{joint-isi-ccitt mhs-motis(6) edims(7) 11 5}
ansiX12-ebcdic
{joint-isi-ccitt mhs-motis(6) edims(7) 11 6}
untdi-ISO646
{joint-isi-ccitt mhs-motis(6) edims(7) 11 7}
untdi-T61
{joint-isi-ccitt mhs-motis(6) edims(7) 11 8}
untdi-octet
{joint-isi-ccitt mhs-motis(6) edims(7) 11 9}
private-octet
{joint-isi-ccitt mhs-motis(6) edims(7) 11 10}
undefined-octet
{joint-isi-ccitt mhs-motis(6) edims(7) 11 11}
The value of the EDI-T-BODYPART-TYPE attribute can be copied to the
MH-T-EXTERNAL-EITS attribute of the MH-C-EITS class. This value enables an
EDI-UA to signal to the MTS the EDI standard to which the EDIM’s primary body part
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -147
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. The three message types used
most widely are:
EDIFACT
ANSIX12
UNTDI
EDI-T-EDIN-RECEIVER
Identifies the recipient to whom EDINs are to be sent. The value of this attribute is
supplied by the originator of the EDIM when the recipient of a requested notification is
different from the originator of the message. It consists of a sequence of recipient name,
EDIM identifier, and first recipient. This attribute is not present if EDI notification
requests are not specified. (You specify EDI notification requests with the EDI-TRECIPS attribute.)
EDI-T-EXPIRY-TIME
The date and time when the originator considers this EDIM to be no longer valid.
EDI-T-HEADING-EXTENSIONS
Contains extensions to the EDI-C-EDI-HEADING class.
EDI-T-INC-COPY
Indicates that the forwarded EDIM is an incomplete copy of an EDIM. This attribute
shall have the value OM-TRUE if body parts are removed when an EDIM is forwarded.
The default value is OM-FALSE.
EDI-T-INTER-SENDER
Indicates the sender of this EDIM.
EDI-T-OBSOLETED-EDIMS
Identifies one or more EDIMs that the present EDIM obsoletes. Each obsoleted EDIM is
identified by an EDIM identifier.
EDI-T-ORIG
The O/R name that identifies the EDIM’s originator. If the originator attribute is not in
the EDIM heading on reception, then MH-T-ORIGINATOR-NAME of the
MH-C-MESSAGE is used to determine the originator of the EDIM. The originatingname is contained in the MH-T-ORIGINATOR-NAME attribute of MH-C-MESSAGE,
defined in the MH package.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -148
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. If this attribute has the value
OM-TRUE, it indicates to a receiving EDI-UA that responsibility was forwarded. If this
attribute has the value OM-FALSE, it indicates to a receiving EDI-UA that the security
fields of the delivery envelope have been checked. The fields are contained in the MHT-EXTENSIONS attribute of MH-C-DELIVERY-ENVELOPE. Subject to the security
policy in force, the security elements might have been checked when the message was
forwarded. However, when responsibility is accepted by the client application, the
security elements shall be checked again.
EDI-T-RELATED-EDI-MSGS
Identifies EDIMs that the originator of this EDIM considers related to it. If the related
message identifies messages from other services, the user component of the message
identifier (EDI-C-EDIM-ID) must be present. Message identifier values of the
referenced message of service types other than EDI messaging (EDIMG) are carried in
this attribute.
EDI-T-RELATED-NON-EDI-MSGS
Identifies messages (other than EDIMs) that the originator of this EDIM considers
related to it. A related message may be an EDIM or any other type of message (for
example, an IPM).
EDI-T-SERVICE-STRING-ADVICE
Provides details about how to interpret the EDI interchange within this EDIM.
EDI-T-SYNTAX-ID
Provides details about the syntax used in this EDIM.
EDI-C-EDI-NOTIF-REQUESTS
This class of object specifies the type of notifications and the security required for the
notifications which are requested of a preferred recipient. The originator of an EDIM
(originating EDI-UA) can request notifications so that the originator is informed of the
disposition of the EDIM by the recipient.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -149
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. EDI-C-EDI-NOTIF-REQUESTS Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-FORWARD-NOTIF
OM-S-BOOLEAN
--
1 1
EDI-T-NEGATIVE-NOTIF
OM-S-BOOLEAN
--
1 1
EDI-T-POSITIVE-NOTIF
OM-S-BOOLEAN
--
1 1
EDI-T-NON-REPUD-OFRECEPTION
OM-S-BOOLEAN
--
1 2
EDI-T-NON-REPUD-OF-NOTIF
OM-S-BOOLEAN
--
1 2
EDI-T-PROOF-OF-NOTIFICATION
OM-S-BOOLEAN
--
1 2
EDI-T-PROOF-OF-RECEPTION
OM-S-BOOLEAN
--
1 2
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
1
The notification values (marked (1)) collectively determine whether any repudiation or proof values (marked
(2)) can be OM-TRUE. If none of the values marked (1) is OM-TRUE, then the values of the values marked
(2) must be OM-FALSE.
2
The values must be OM-FALSE if none of the values marked (1) is OM-TRUE.
Some attribute types have additional value characteristics, as shown in Table 3-108.
Table 3-108. EDI-C-EDI-NOTIF-REQUESTS Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-FORWARD-NOTIF
Initial Value:
OM-FALSE
EDI-T-NEGATIVE-NOTIF
Initial Value:
OM-FALSE
EDI-T-POSITIVE-NOTIF
Initial Value:
OM-FALSE
EDI-T-NON-REPUD-OF-NOTIF
Initial Value:
OM-FALSE
EDI-T-NON-REPUD-OF-RECEPTION
Initial Value:
OM-FALSE
EDI-T-PROOF-OF-NOTIFICATION
Initial Value:
OM-FALSE
EDI-T-PROOF-OF-RECEPTION
Initial Value:
OM-FALSE
OM-T-CLASS
Max. Value
Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -150
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-T-POSITIVE-NOTIF
Requests a positive notification (PN), that reports an entity has accepted responsibility
of an EDIM.
EDI-T-NON-REPUD-OF-NOTIF
Indicates whether a content-integrity check is requested with a non-repudiablecertificate when submitting the EDIN to the MTS. For more information about these and
other security options, refer to CCITT Recommendation X.411|ISO/IEC 10021-4.
EDI-T-NON-REPUD-OF-RECEPTION
Indicates whether, when submitting the EDIN to the MTS, a non-repudiable-contentintegrity-check (possibly in the message token) or a message-origin-authenticationcheck (depending on the security policy in force) is requested (refer to CCITT
Recommendation X.411|ISO/IEC 10021-4).
EDI-T-PROOF-OF-NOTIFICATION
Indicates whether a content-integrity-check is requested when submitting the EDIN to
the MTS (refer to CCITT Recommendation X.411|ISO/IEC 10021-4).
EDI-T-PROOF-OF-RECEPTION
Indicates whether, when submitting the EDIN to the MTS, a content-integrity-check
(possibly in the message token) or the message-origin-authentication (depending on the
security policy in force) is requested. A notification is to contain the security elements
and must be signed on submission to the MTS, using content-integrity-check or
message-origin-authentication-check (refer to CCITT Recommendation X.411|ISO/IEC
10021-4).
EDI-C-EDIM
This class of object contains an EDIM. An EDIM is the mechanism used to transmit an
EDI interchange within the EDI messaging system (EDIMS). An EDIM consists of a
heading and body. The EDI heading contains information that describes the EDIM. The
body consists of one primary body part, and optionally, one or more additional body
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -151
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 Attributes—General Characteristics
Value
Length
Number of
Values
Attribute Type
Value Syntax
EDI-T-ADD-BODYPARTS
OM-S-OBJECT
(EDI-C-EDIM-EX-DF-BODYPART)
--
0-more
EDI-T-HEADING
OM-S-OBJECT
(EDI-C-EDI-HEADING)
--
1
EDI-T-PRIMARY-BODYPART
OM-S-OBJECT
(EDI-C-EDI-BODYPART)
(EDI-C-EDIM-BODYPART)
--
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-110.
Table 3-110. EDI-C-EDIM Attributes—Additional Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
EDI-T-ADD-BODYPARTS
Additional body parts related to the primary body part but of different types. Examples
of related body parts include textual information, voice annotation or graphics to be used
in conjunction with the EDI interchange.
EDI-T-HEADING
A set of heading attributes, each an information item that gives a characteristic of the
EDIM.
EDI-T-PRIMARY-BODYPART
Contains an EDI interchange that may be original (EDI-C-EDI-BODYPART) or may be
contained in a forwarded EDIM (EDI-C-EDIM-BODYPART).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -152
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. EDI-C-EDIM-BODYPART Attributes—General Characteristics
Value
Length
Number of
Values
Attribute Type
Value Syntax
EDI-T-ADD-BODYPARTS
OM-S-OBJECT
(EDI-C-EDIM-EX-DF-BODYPART)
--
0-more
EDI-T-DELIV-ENVELOPE
OM-S-OBJECT
(MH-C-DELIVERY-ENVELOPE)
--
0-1
EDI-T-EDI-SUPPLEMENTARY-INFO
OM-S-TELETEX-STRING
1-512
0-1
EDI-T-HEADING
OM-S-OBJECT
(EDI-C-EDI-HEADING)
--
1
EDI-T-PRIMARY-BODYPART
OM-S-OBJECT
(EDI-C-EDI-BODYPART)
(EDI-C-EDIM-BODYPART)
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-112.
Table 3-112. EDI-C-EDIM-BODYPART Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-EDI-SUPPLEMENTARY-INFO
Max. Value
Length:
EDI-VL-SUPPLEMENTARY-INFO
OM-T-CLASS
Max. Value
Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
The attribute types specify the following information:
EDI-T-ADD-BODYPARTS
Additional body parts of the EDIM. This attribute may contain complete body parts, or
body parts from which the data portion has been removed. The latter, incomplete values,
are used as place holders for removed body parts. They might consist of only the EDI-TBODYPART-REFERENCE or a modified IM-C-EXTERN-DEFINED-BODY-PART. In
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -153
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. That is, in the OM-C-EXTERNAL object, the encoding attribute
which is present shall be of zero length (that is, have no content). Refer to the definition
of the OM-C-EXTERNAL class in the OM package.
EDI-T-DELIV-ENVELOPE
The delivery envelope of the EDIM. The delivery envelope class is part of the MH
package. A value of the EDI-T-DELIV-ENVELOPE attribute is an object of the
MH-C-DELIVERY-ENVELOPE class as specified in the MH package with the
exception that the MH-T-CONTENT-IDENTIFIER attribute shall not be present and the
MH-T-DELIVERY-TIME attribute is optional (that is, it might not be present).
EDI-T-EDI-SUPPLEMENTARY-INFO
Additional parameters specific to EDI.
EDI-T-HEADING
Heading of the EDIM.
EDI-T-PRIMARY-BODYPART
The primary body part of the EDIM. This attribute may be absent if the primary body
part has been removed from the EDIM.
EDI-C-EDIM-EX-DF-BODYPART
This class of object contains a body part that may accompany a primary body part within
the body of an EDIM. This additional body part does not contain an EDI interchange
(either original or forwarded in an EDIM). It is externally defined and represents
information that supplements the EDI interchange (such as a drawing or explanatory
text). The semantics and abstract syntax of this body part are denoted by an object
identifier that the body part carries. These parameters and data components, and
optionally a body part reference, may be cross-referenced to another body part.
Table 3-113 describes the attribute types for this class and the syntax, length, and
number of values for each type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -154
EDI-C-EDIM-EX-DF-BODYPART
Object Classes and Attribute Types
Table 3-113. EDI-C-EDIM-EX-DF-BODYPART Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BODYPART-PLACEHOLDER
OM-S-BOOLEAN
--
1 1
EDI-T-BODYPART-REFERENCE
OM-S-INTEGER
--
0-1 2
EDI-T-EX-BODYPART
OM-S-OBJECT
(IM-C-EXTERN-DEFINEDBODY-PART)
--
1 2
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
1
When an object of this class is a subobject of class EDI-C-EDIM, the value of EDI-T-BODYPART-PLACEHOLDER must be set to OM-FALSE. In all other cases, the value can be either OM-TRUE or OM-FALSE.
2
If the EDI-T-BODYPART-PLACE-HOLDER is set to OM-TRUE, then attributes EDI-T-BODYPART-REFERENCE and EDI-T-EX-BODYPART are optional, but one of these attributes must be present. If the
attribute EDI-T-BODYPART-PLACE-HOLDER is set to OM-FALSE, then the attribute EDI-T-EX-BODYPART must be present.
Some attribute types have additional value characteristics, as shown in Table 3-114.
Table 3-114. EDI-C-EDIM-EX-DF-BODYPART Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-BODYPART-PLACEHOLDER
Initial Value:
OM-FALSE
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-BODYPART-PLACE-HOLDER
This attribute is used to indicate a body part which is identified as a place holder; that is,
a body part from which the data portion has been removed.
EDI-T-BODYPART-REFERENCE
A reference to this body part. The reference may be used for cross referencing body
parts. The references assigned to body parts shall be unique within an EDIM. They are
assigned when a body part is created, and they are not modified subsequently. A
reference shall be present if the originator wishes to cross reference the body part at
creation or in the future.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -155
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.
Table 3-115 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-115. EDI-C-EDIM-ID Attributes—General Characteristics
Value
Length
Number of
Values
Attribute Type
Value Syntax
EDI-T-USER
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-USER-RELATIVE-ID
OM-S-PRINTABLE-STRING
0-64
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-116.
Table 3-116. EDI-C-EDIM-ID Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-USER-RELATIVE-ID
Max. Value Length:
EDI-VL-USER-RELATIVE-ID
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-USER
Identifies the user who originated the EDIM. The MH-C-OR-NAME class is defined in
the MH package.
EDI-T-USER-RELATIVE-ID
Unambiguously identifies the EDIM, distinguishing it from all other EDIMs that the
user has originated.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -156
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-EDIN-RECEIVER Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDIN-RECEIVER-NAME
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-FIRST-RECIP
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
EDI-T-ORIGINAL-EDIM-ID
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-118.
Table 3-118. EDI-C-EDIN-RECEIVER Attributes—Additional Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-EDIN-RECEIVER-NAME
Identifies the recipient of a requested notification. The MH-C-OR-NAME class is
defined in the MH package.
EDI-T-FIRST-RECIP
Identifies the first recipient in a forwarding chain. This attribute (together with
information from instances of other classes), is used by the recipient of the notification
to correlate the notification and the original message. The EDI-T-FIRST-RECIP
attribute must not be present if the corresponding EDIM contains more than one
recipient with associated EDI notification requests. The MH-C-OR-NAME class is
defined in the MH package.
EDI-T-ORIGINAL-EDIM-ID
Identifies the original EDIM for which the notification is sent.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -157
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-PDAU-REASON-CODE
This class of object indicates why the subject EDIM could not be passed to the user by
the PDAU originating the forwarded notification (FN). An object of this class contains
reasons indicated by the PDAU for issuing the forwarded notification.
Table 3-119 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-119. EDI-C-FN-PDAU-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-120.
Table 3-120. EDI-C-FN-PDAU-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-FPB-UNSPECIFIED
EDI-FPB-FORWARD-FOR-PD-AND-RND
EDI-T-DIAGNOSTIC
Integer Value:
1-32767 1
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
1
This attribute is user-defined; value must be an integer in the range 1 through 32767.
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. 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -158
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-UAMS-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
EDI-T-FN-SECUR-CHECK
OM-S-BOOLEAN
--
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-122.
Table 3-122. EDI-C-FN-UAMS-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-FUMB-UNSPECIFIED
EDI-FUMB-ONWARD-ROUTING
EDI-FUMB-RECIP-UNKNOWN
EDI-FUMB-ORIG-UNKNOWN
EDI-FUMB-FORWARD-BY-EDI-MS
EDI-T-DIAGNOSTIC
Integer Values:
EDI-FUMD-RECIP-NAME-CHANGED
EDI-FUMD-RECIP-NAME-DELETED
EDI-T-FN-SECURCHECK
Initial Value:
OM-FALSE
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-BASIC-CODE
Provides the basic reason the EDI-UA or EDI-MS could not process the EDIM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -159
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). An object
of this class contains reasons indicated by the user for issuing the forwarded notification.
Table 3-123 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-123. EDI-C-FN-USER-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-124.
Table 3-124. EDI-C-FN-USER-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-FUB-UNSPECIFIED
EDI-FUB-FORWARD-FOR-ARCHIVING
EDI-FUB-FORWARD-FOR-INFO
EDI-FUB-FORWARD-FOR-ADD-INFO
EDI-FUB-SUB-CHANGED
EDI-FUB-HEADING-FIELD-NOT-SUPP
EDI-FUB-BODYPART-TYPE-NOT-SUPP
EDI-FUB-MSG-TYPE-NOT-SUPP
EDI-FUB-SYNTAX-ID-NOT-SUPP
EDI-FUB-INTER-SENDER-UNKNOWN
EDI-FUB-USER-DEFINED-REASON
EDI-T-DIAGNOSTIC
Integer Values:
1-32767 1
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
1
This attribute is user-defined; value must be an integer in the range 1 through 32767.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -160
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
This class of object reports that responsibility for an EDIM has been forwarded together
with the subject EDIM. A forwarded notification is originated by a receiving EDI-UA,
EDI-MS, or PDAU when EDIM responsibility can not be given to the associated user.
In this case, the EDI-UA, EDI-MS, or PDAU forwards the EDIM, and EDI notification
requests contained in the EDIM, to another user. Note that a forwarded notification is
sent only if the originator of the EDIM has requested forwarded notification.
Table 3-125 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-125. EDI-C-FORWARD-NOTIF Attributes—General
Characteristics (page 1 of 2)
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDIN-INITIATOR
OM-S-ENUMERATION
--
1
EDI-T-EDIN-ORIG
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-FIRST-RECIP
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
EDI-T-FN-REASONCODE
OM-S-OBJECT
(EDI-C-FN-PDAU-REASON-CODE)
(EDI-C-FN-UAMS-REASON-CODE)
(EDI-C-FN-USER-REASON-CODE)
--
1
EDI-T-FN-NOTIFEXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-FORWARD-TO
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-NOTIFEXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-NOTIF-TIME
OM-S-UTC-TIME-STRING
0-17
1
EDI-T-SECURELEMENTS
OM-S-OBJECT
(EDI-C-SECUR-ELEMENTS)
--
0-1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -161
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. EDI-C-FORWARD-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. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
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). Only an EDI-UA, EDI-MS, or PDAU can originate (send) a
notification; however, a notification can be initiated (caused) by a condition at each of
these entities or at the users associated with them.
EDI-T-EDIN-ORIG
Indicates the O/R name of the entity that originated the notification.
EDI-T-FIRST-RECIP
Indicates the O/R name of the first recipient in a chain of recipients of the notification.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -162
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-T-NOTIF-TIME
Contains the UTC formatted date and time that the notification was generated.
EDI-T-SECUR-ELEMENTS
Indicates whether proof or non-repudiation of content received are required for the
notification. Also indicates whether EDI application security services are required. For
more information about these and other security options, refer to CCITT
Recommendation X.411|ISO/IEC 10021-4.
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-INTER-SENDER-RECIP
This class of object indicates the sender or recipient of an EDI interchange.
Table 3-127 describes the attribute types for this class and the syntax, length, and
number of values for each type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -163
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-INTER-SENDER-RECIP Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-IDENTIFICATIONCODE
Max Value Length:
EDI-VL-IDENTIFICATION-CODE
EDI-T-IDENTIFICATIONCODE-Q
Max Value Length:
EDI-VL-IDENTIFICATIONCODE-Q
EDI-T-ROUTING-ADDRESS
Max Value Length:
EDI-VL-ROUTING-ADDRESS
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-IDENTIFICATION-CODE
Identifies the sender or recipient of an interchange.
EDI-T-IDENTIFICATION-CODE-Q
Qualifies the EDI-T-IDENTIFICATION-CODE of a sender or recipient.
EDI-T-ROUTING-ADDRESS
Contains an address for routing to the sender or recipient specified in
EDI-T-IDENTIFICATION-CODE.
EDI-C-NEGATIVE-NOTIF
This class of object reports that responsibility for an EDIM has been refused. A
negative notification is originated by a receiving EDI-UA, EDI-MS, or PDAU when
EDIM responsibility can not be given to the associated user, and the EDIM can not be
forwarded. Note that a negative notification is sent only if the originator of the EDIM
has requested negative notification.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -164
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. EDI-C-NEGATIVE-NOTIF Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDIN-INITIATOR
OM-S-ENUMERATION
--
1
EDI-T-EDIN-ORIG
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-FIRST-RECIP
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
EDI-T-NN-NOTIFEXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-NN-REASONCODE
OM-S-OBJECT
(EDI-C-NN-PDAU-REASON-CODE)
(EDI-C-NN-UAMS-REASON-CODE)
(EDI-C-NN-USER-REASON-CODE)
--
1
EDI-T-NOTIFEXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-NOTIF-TIME
OM-S-UTC-TIME-STRING
0-17
1
EDI-T-SECURELEMENTS
OM-S-OBJECT
(EDI-C-SECUR-ELEMENTS)
--
0-1
EDI-T-SUBJECT-EDIM
OM-S-OBJECT
(EDI-C-EDIM-ID)
--
1
EDI-TSUPPLEMENTARY-INFO
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-130.
Table 3-130. EDI-C-NEGATIVE-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. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -165
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). Only an EDI-UA, EDI-MS, or PDAU can originate (send) a
notification; however, a notification can be initiated (caused) by a condition at each of
these entities or at the users associated with them.
EDI-T-EDIN-ORIG
Indicates the O/R name of the entity that originated the notification.
EDI-T-FIRST-RECIP
Indicates the O/R name of the first recipient in a chain of recipients of the notification.
EDI-T-NN-NOTIF-EXTENSIONS
Reserves space for future extensions to the notification.
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-NOTIF-EXTENSIONS
Reserves space for future extensions to the notification.
EDI-T-NOTIF-TIME
Contains the UTC formatted date and time that the notification was generated.
EDI-T-SECUR-ELEMENTS
Indicates whether proof or non-repudiation of content received are required for the
notification. Also indicates whether EDI application security services are required. For
more information about these and other security options, refer to CCITT
Recommendation X.411|ISO/IEC 10021-4.
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -166
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-PDAU-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-132.
Table 3-132. EDI-C-NN-PDAU-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-NPB-UNSPECIFIED
EDI-NPB-UNDELIV-MAIL
EDI-NPB-P-REND-NOT-PERFORMED
EDI-T-DIAGNOSTIC
Integer Values:
EDI-NPD-P-REND-ATTS-NOT-SUPP
EDI-NPD-PD-ADDRESS-INCORRECT
EDI-NPD-PD-OFFICE-I-OR-INVALID
EDI-NPD-PD-ADDRESS-INC
EDI-NPD-RECIP-UNKNOWN
EDI-NPD-RECIP-DECEASED
EDI-NPD-ORGANIZATION-EXPIRED
EDI-NPD-RECIP-REFUSED-TO-ACCPT
EDI-NPD-RECIP-DID-NOT-CLAIM
EDI-NPD-RECIP-CHANGED-ADDR-P
EDI-NPD-RECIP-CHANGED-ADD-T
EDI-NPD-RECIP-CHANGED-T-ADDR
EDI-NPD-NEW-ADDRESS-UNKNOWN
EDI-NPD-RECIP-NOT-WANT-FORWARD
EDI-NPD-ORIG-PROHIBITED-FORWRD
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -167
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). An
object of this class contains reasons indicated by the EDI-UA or EDI-MS for issuing the
negative notification.
Table 3-133 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-133. EDI-C-NN-UAMS-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -168
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-UAMS-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-NUMB-UNSPECIFIED
EDI-NUMB-CANNOT-DELIV-TO-USER
EDI-NUMB-DELIV-TIMEOUT
EDI-NUMB-MSG-DISCARDED
EDI-NUMB-SUB-TERMINATED
EDI-NUMB-FORWARDING-ERROR
EDI-NUMB-SECUR-ERROR
EDI-T-DIAGNOSTIC
Integer Values:
EDI-NUMD-PROTOCOL-VIOLATION
EDI-NUMD-EDIM-ORIG-UNKNOWN
EDI-NUMD-EDIM-RECIP-UNKNOWN
EDI-NUMD-EDIM-RECIPI-AMBIGUOUS
EDI-NUMD-ACT-REQUEST-NOT-SUPP
EDI-NUMD-EDIM-EXPIRED
EDI-NUMD-EDIM-OBSOLETED
EDI-NUMD-DUPLICATE-EDIM
EDI-NUMD-UNSUPP-EXTENSION
EDI-NUMD-INC-COPY-REJECTED
EDI-NUMD-EDIM-TOO-LARGE-FOR-AP
EDI-NUMD-FORWARD-EDIM-NOT-DLIV
EDI-NUMD-FORWARD-EDIM-D-TIME
EDI-NUMD-FORWARD-LOOP-DETECTED
EDI-NUMD-UNABLE-TO-ACCEPT-RESP
EDI-NUMD-INTER-SENDER-UNKNOWN
EDI-NUMD-INTERC-RECIP-UNKNOWN
EDI-NUMD-INVALID-HEADING-FIELD
EDI-NUMD-INVALID-BODYPART-TYPE
EDI-NUMD-INVALID-MSG-TYPE
EDI-NUMD-INVALID-SYNTAX-ID
EDI-NUMD-MSG-INTEG-FL
EDI-NUMD-FORWARD-MSG-INTEG-FL
EDI-NUMD-UNSUPP-ALGORITHM
EDI-NUMD-DECRYPTION-FAILED
EDI-NUMD-TOKEN-ERROR
EDI-NUMD-UNABLE-TO-SIGN-NOTIF
EDI-NUMD-UNABLE-TO-SIGN-MSG-R
EDI-NUMD-AUTHENTICATION-FAIL
EDI-NUMD-SECUR-CONTEXT-FAIL
EDI-NUMD-MSG-SEQUENCE-FAIL
EDI-NUMD-MSG-SECUR-LABEL-FAIL
EDI-NUMD-REPUDIATION-FAIL
EDI-NUMD-PROOF-OF-FAIL
OM-T-CLASS
Max. Value
Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -169
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).
An object of this class contains reasons indicated by the user for issuing the negative
notification.
Table 3-135 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-135. EDI-C-NN-USER-REASON-CODE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-BASIC-CODE
OM-S-INTEGER
--
1
EDI-T-DIAGNOSTIC
OM-S-INTEGER
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-136.
Table 3-136. EDI-C-NN-USER-REASON-CODE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
EDI-T-BASIC-CODE
Integer Values:
EDI-NUB-UNSPECIFIED
EDI-NUB-SYNTAX-ERROR
EDI-NUB-INTER-SENDER-UNKNOWN
EDI-NUB-INTER-RECIP-UNKNOWN
EDI-NUB-NVALID-HEADING-FIELD
EDI-NUB-INVALID-BODYPART-TYPE
EDI-NUB-INVALID-MSG-TYPE
EDI-NUB-FUNCT-GROUP-NOT-SUPP
EDI-NUB-SUB-TERMINATED
EDI-NUB-NO-BILATERAL-AGREEMENT
EDI-NUB-USER-DEFINED-REASON
EDI-T-DIAGNOSTIC
Integer Values:
1-32767 1
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
1
This attribute is user-defined; value must be an integer in the range 1 through 32767.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -170
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. A
positive notification is originated by a receiving EDI-UA, EDI-MS, or PDAU when
EDIM responsibility can be given to the associated user. Note that a positive
notification is sent only if the originator of the EDIM has requested positive notification.
Table 3-137 describes the attribute types for this class and the syntax, length, and
number of values for each type.
Table 3-137. EDI-C-POSITIVE-NOTIF Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDIN-INITIATOR
OM-S-ENUMERATION
--
1
EDI-T-EDIN-ORIG
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-FIRST-RECIP
OM-S-OBJECT
(MH-C-OR-NAME)
--
0-1
EDI-T-NOTIF-EXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-NOTIF-TIME
OM-S-UTC-TIME-STRING
0-17
1
EDI-T-PN-NOTIF-EXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-SECUR-ELEMENTS
OM-S-OBJECT
(EDI-C-SECUR-ELEMENTS)
--
0-1
EDI-T-SUBJECT-EDIM
OM-S-OBJECT
(EDI-C-EDIM-ID)
--
1
EDI-T-SUPPLEMENTARY-INFO
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-138.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -171
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. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
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). Only an EDI-UA, EDI-MS, or PDAU can originate (send) a
notification; however, a notification can be initiated (caused) by a condition at each of
these entities or at the users associated with them.
EDI-T-EDIN-ORIG
Indicates the O/R name of the entity that originated the notification.
EDI-T-FIRST-RECIP
Indicates the O/R name of the first recipient in a chain of recipients of the notification.
EDI-T-NOTIF-EXTENSIONS
Reserves space for future extensions to the notification.
EDI-T-NOTIF-TIME
Contains the UTC formatted date and time that the notification was generated.
EDI-T-FN-NOTIF-EXTENSIONS
Reserves space for future extensions to the notification.
EDI-T-SECUR-ELEMENTS
Indicates whether proof or non-repudiation of content received are required for the
notification. Also indicates whether EDI application security services are required. For
more information about these and other security options, refer to CCITT
Recommendation X.411|ISO/IEC 10021-4.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -172
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-RECIP-REFERENCE Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-RECIP-REFERENCE
OM-S-TELETEX-STRING
1-28
1
EDI-T-RECIP-REFERENCE-Q
OM-S-TELETEX-STRING
1-4
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-140.
Table 3-140. EDI-C-RECIP-REFERENCE Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-RECIP-REFERENCE
Max. Value Length:
EDI-VL-RECIP-REFERENCE
EDI-T-RECIP-REFERENCE-Q
Max. Value Length:
EDI-VL-RECIP-REFERENCE-Q
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-RECIP-REFERENCE
Contains a reference to the recipient’s EDI application.
EDI-T-RECIP-REFERENCE-Q
Qualifies EDI-T-RECIP-REFERENCE.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -173
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 Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-TACKNOWLEDGEMENTREQUEST
OM-S-BOOLEAN
--
1
EDI-T-ACT-REQUEST
OM-S-OBJECT-ID-STRING
2-n
1
EDI-T-COMMSAGREEMENT-ID
OM-S-TELETEX-STRING
1-70
0-1
EDI-T-EDI-NOTIFREQUESTS
OM-S-OBJECT
(EDI-C-EDI-NOTIF-REQUESTS)
--
0-1
EDI-T-INTER-RECIP
OM-S-OBJECT
(EDI-C-INTER-SENDER-RECIP)
--
0-1
EDI-T-INTER-CONTROLREFERENCE
OM-S-TELETEX-STRING
1-28
0-1
EDI-T-PROCESSINGPRIORITY-CODE
OM-S-TELETEX-STRING
1-2
0-1
EDI-T-RECIP
OM-S-OBJECT
(MH-C-OR-NAME)
--
1
EDI-T-RECIPEXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-RESPONS-PASSINGALLOWED
OM-S-BOOLEAN
--
1
EDI-T-RSF-RECIPREFERENCE
OM-S-OBJECT
(EDI-C-RECIP-REFERENCE)
--
0-1
EDI-T-RSFAUTHORIZATION-INFO
OM-S-OBJECT
(EDI-C-AUTHORIZATION-INFO)
--
0-1
EDI-T-TEST-INDICATOR
OM-S-BOOLEAN
--
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-142.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -174
EDI-C-RECIPS
Object Classes and Attribute Types
Table 3-142. EDI-C-RECIPS Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-ACKNOWLEDGEMENTREQUEST
Initial Value:
OM-FALSE
EDI-T-ACT-REQUEST
Initial Value:
EDI-ARO-FOR-ACTION
Object
Identifier
Values:
EDI-ARO-FOR-ACTION
EDI-ARO-COPY
EDI-T-COMMS-AGREEMENT-ID
Max Value
Length:
EDI-VL-COMMS-AGREEMENT-ID
EDI-T-INTER-CONTROLREFERENCE
Max Value
Length:
EDI-VL-INTER-CONTROL-REF
EDI-T-PROCESSING-PRIORITYCODE
Max Value
Length:
EDI-VL-PROC-PRIORITY-CODE
EDI-T-RESPONS-PASSINGALLOWED
Initial Value:
OM-FALSE
EDI-T-TEST-INDICATOR
Initial Value:
OM-FALSE
OM-T-CLASS
Max. Value
Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-ACKNOWLEDGEMENT-REQUEST
Indicates the request for EDI acknowledgment as indicated by the EDI interchange
originator. Its value is Boolean, where the value OM-TRUE indicates a request for
acknowledgment. Absence of this attribute is interpreted as the value OM-FALSE.
EDI-T-ACT-REQUEST
Indicates what action the originator requests from the recipient. It is represented by a
single object identifier. The following standard values have object identifiers defined in
the EDI messaging standards. Additional values can be defined. The first column of the
table lists the symbolic values. The second column specifies, in ASN.1, the object
identifiers denoted by the values.
Value
Object Identifier (ASN.1)
for-action
(joint-iso-ccitt mhs-motis(6) edims(7) 13 0)
copy
(joint-iso-ccitt mhs-motis(6) edims(7) 13 1)
The DDL name for the default value of this attribute is EDI-ARO-FOR-ACTION.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -175
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-T-INTER-CONTROL-REFERENCE
Indicates the EDI interchange control reference as assigned by the EDI interchange
sender.
EDI-T-PROCESSING-PRIORITY-CODE
Indicates the EDI application processing priority code.
EDI-T-RECIP
Identifies a preferred recipient. The MC-OR-NAME class is defined in the MH
package.
EDI-T-RECIP-EXTENSIONS
Contains extensions to the EDI-C-RECIPS class.
EDI-T-RESPONS-PASSING-ALLOWED
Indicates whether forwarding of responsibility is allowed. A recipient of a message with
the EDI-RESPONS-PASSING-ALLOWED attribute set to OM-FALSE must originate
EDIN’s as requested and cannot forward responsibility. If this attribute is set to
OM-TRUE, responsibility may be forwarded to at most one recipient.
EDI-T-RSF-RECIP-REFERENCE
Identifies a reference meaningful to the recipient’s EDI application.
EDI-T-RSF-AUTHORIZATION-INFO
Indicates who authorized the EDI interchange.
EDI-T-TEST-INDICATOR
Indicates that the EDI interchange is a test. The value OM-TRUE indicates that the EDI
interchange is a test. Absence of this attribute is interpreted as the value OM-FALSE.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -176
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-SECUR-ELEMENTS Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-EDI-APP-SECURELEMENTS
OM-S-OBJECT
(EDI-C-EDI-APP-SECUR-ELTS)
--
0-1
EDI-T-EDI-APP-SECUREXTENSIONS
OM-S-OBJECT
(EDI-C-EDI-EXTENSION)
--
0-more
EDI-T-ORIGINAL-CONTENT
OM-S-OBJECT
(EDI-C-EDIM)
(EDI-C-FORWARD-NOTIF)
(EDI-C-NEGATIVE-NOTIF)
(EDI-C-POSITIVE-NOTIF)
--
0-1
EDI-T-ORIGINALCONTENT-INTEG-C
OM-S-OBJECT
(MH-C-ALGORITHM-ANDRESULT)
--
0-1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Meanings of Attributes
EDI-T-EDI-APP-SECUR-ELEMENTS
Identifies a set of security elements. This attribute is used to allow an EDI application
to exchange security elements having an end-to-end significance (of meaning to both
originator and recipient).
EDI-T-EDI-APP-SECUR-EXTENSIONS
Reserves space for future extensions to the application security elements.
EDI-T-ORIGINAL-CONTENT
Content of the subject EDIM. The content class is part of the MH package.
EDI-T-ORIGINAL-CONTENT-INTEG-C
Provides the notification recipient with a means of validating that the message content
of the EDIM has not been modified.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -177
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-SERV-STRING-ADVICE Attributes—General
Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-COMPONENT-DATAELEMENT-S
OM-S-OCTET-STRING
1
1
EDI-T-DATA-ELEMENTSEPARATOR
OM-S-OCTET-STRING
1
1
EDI-T-DECIMAL-NOTATION
OM-S-OCTET-STRING
1
1
EDI-T-RELEASE-INDICATOR
OM-S-OCTET-STRING
1
0-1
EDI-T-RESERVED
OM-S-OCTET-STRING
1
0-1
EDI-T-SEGMENT-TERMINATOR
OM-S-OCTET-STRING
1
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-145.
Table 3-145. EDI-C-SERV-STRING-ADVICE Attributes—Additional
Characteristics
Attribute Type
Value Characteristics
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-COMPONENT-DATA-ELEMENT-S
Indicates the character used to separate subfields within data elements.
EDI-T-DATA-ELEMENT-SEPARATOR
Indicates the character used to separate data elements.
EDI-T-DECIMAL-NOTATION
Indicates the decimal notation used (if any) within data elements.
EDI-T-RELEASE-INDICATOR
Indicates the version of the EDI format.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -178
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. EDI-C-SYNTAX-ID Attributes—General Characteristics
Attribute Type
Value Syntax
Value
Length
Number of
Values
EDI-T-SYNTAX-ID-STRING
OM-S-TELETEX-STRING
1-8
1
EDI-T-SYNTAX-VERSION
OM-S-PRINTABLE-STRING
1-5
1
OM-T-CLASS
OM-S-OBJECT-ID-STRING
7
1
Some attribute types have additional value characteristics, as shown in Table 3-147.
Table 3-147. EDI-C-SYNTAX-ID Attributes—Additional Characteristics
Attribute Type
Value Characteristics
EDI-T-SYNTAX-ID-STRING
Max. Value Length:
EDI-VL-SYNTAX-ID-STRING
EDI-T-SYNTAX-VERSION
Max. Value Length:
EDI-VL-SYNTAX-VERSION
OM-T-CLASS
Max. Value Length:
ZGPI-EDI-CLASS-OBJ-ID-LEN
Meanings of Attributes
EDI-T-SYNTAX-ID-STRING
Contains an identifier that specifies the syntax used.
EDI-T-SYNTAX-VERSION
Identifies the version of the syntax used.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3 -179
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. For many procedure calls, you will also need to refer to the DDL
structure and value definitions in Appendix A, DDL Definitions.
Files Provided by Compaq
The external declarations for the current version of the GPI procedures are provided in
the following files:
•
GPIEXT (TAL declarations)
For applications coded in TAL, you must use the ?SOURCE directive to include the
content of the GPIEXT declarations at the beginning of the external procedures
section of your program.
•
GPIEXTH (C declarations)
For applications coded in C, you must use the #include directive to include the
GPIEXTH declarations in your program before making any calls to the procedures.
For more information about the location of these files, which reside in a user library, see
the OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide.
The distribution subvolume for the Compaq OSI/MHS GPI product supplies two files
containing data declarations:
•
•
GPIDEFS contains TAL declarations for data structures used in parameters to the
procedure calls; you can use the ?SOURCE directive to include these declarations in
your TAL application programs.
GPIDEFSH contains the corresponding C declarations; you can use the #include
directive to include them in C programs.
Procedure Names and Categories
The names of all GPI procedures start with the prefix GPI_.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -1
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_.
GPI message transfer procedures enable you to transfer objects from the GPI
service’s input queue and to the GPI service’s output queue. The names of these
procedures have the prefix GPI_MT_.
Table 4-1 summarizes the set of environment management procedures.
Table 4-1. GPI Environment Management Procedures
Procedure Name
Purpose
GPI_CLOSE_
Ends a GPI session between a client and the GPI service.
GPI_INITIALIZE_
Sets up an environment in which other GPI procedures can operate.
GPI_OPEN_
Establishes a GPI session between a client and the GPI service.
GPI_STATUS_
Provides additional status and error information about the most recent
GPI failure.
Table 4-2 summarizes the set of object management procedures.
Table 4-2. GPI Object Management Procedures
Procedure Name
Purpose
GPI_OM_COPY_
Creates an exact but independent copy of an object and its
subobjects.
GPI_OM_CREATE_
Creates a new object of a specified class.
GPI_OM_DELETE_
Deletes an object and invalidates its identifier.
GPI_OM_EXAMINE_
Identifies the types of attributes present in an object and,
optionally, gives the syntax and values of single-valued attributes.
GPI_OM_FETCH_
Indicates whether specific types of attributes are present in an
object and, optionally, gives the syntax and values of singlevalued attributes.
GPI_OM_INSERT_
Adds attribute values to an object.
GPI_OM_LIST_
Retrieves values of multivalued attributes of an object.
GPI_OM_READ_
Reads a segment of a string value of a specified type of attribute.
GPI_OM_REMOVE_
Removes and discards attribute values of an object.
GPI_OM_WRITE_
Writes a segment of a string value of a specified type of attribute.
Table 4-3 summarizes the set of message transfer procedures.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -2
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.
GPI_MT_START_TRANSFER_IN_
Reserves an object in the input queue of the GPI
service and makes it available to your program for
examining and copying.
GPI_MT_TRANSFER_OUT_
Adds a message, probe, report, or P1-encoded
object to the output queue of the GPI service.
GPI_MT_WAIT_
Monitors the input queue of the GPI service for a
specified time, checking for available unreserved
objects.
Procedure Call Descriptions
Figure 4-1 shows the notation used to describe procedure calls in this manual. The
syntax of the call is enclosed in a box. Below the box, a description of each parameter is
given.
This notation gives the syntax for calling the procedures from TAL programs. For
information about using the TAL language, refer to the Transaction Application
Language (TAL) Reference Manual. You can also call these procedures from
C programs; for a summary of the GPI procedure calls for the C language, refer to
Appendix C, GPI Procedure Calls for the C Language. For additional information on
using the C language, refer to the C Reference Manual.
Following Figure 4-1, the remainder of this section provides the syntax and semantics of
all the GPI procedures, in alphabetic order.
When you provide values by referring to DDL names such as OM-TRUE, substitute an
underscore for each hyphen: for example, OM_TRUE.
Note. The condition code, a hardware register that can be set by software, is not meaningful
after a call to a GPI procedure.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -3
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. For the GPI
procedures, the variable name is always
status . The status values returned are
from the list of MH-RC-, OM-RC-, and ZGPI-RC- status codes given in Appendix
B, “Return Codes.”
This is the name of the procedure. It must appear in the program exactly as
shown, including the underline characters. In a C program, all letters in the name
must be in uppercase.
You must enclose the list of parameters in parentheses. Use commas to
separat e multiple parameters. In the notation, optional parameters are enclosed in
square brackets ( [ and ] ); these brackets must not appear in the program. If you
omit optional parameters, a placeholder comma (,) must be present for each
omitted parameter, except for parameters omitted from the end of the list.
Some parameters are optional only if certain conditions are met. You should read
the parameter descriptions before omitting an optional parameter.
4
The exclamation point indicates that a comment follows. The comment is either an
I or an O (or both), indicating that the parameter is an input (I) or an output (O)
parameter, or both. Input parameters are those passing data to the called
procedure; output parameters are those that return data to the calling program.
VST 401 .vsd
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -4
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.
For all parameters except returned values, the parameter type (and .EXT, if present) is
followed by a colon. Additional information after the colon includes:
value
ref:1
ref:8
ref:32
ref:*
7
means that the actual value or contents of a parameter is passed.
means this is a reference parameter; that is, the address of the parameter is
passed. (The statements within the program body must access the actual
parameter contents indirectly through the parameter location.) “1” indicates
that the parameter contains one element.
indicates that the reference parameter contains 8 elements.
indicates that the reference parameter contains 32 elements.
indicates that the number of elements returned varies according to the
number of elements requested for the reference parameter.
This line describes the information passed or returned in the parameter. When the
description includes a DDL name such as OM-TRUE, substitute an underscore for the
hyphen when you use the name in your program.
VST 401B .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -5
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.
Considerations
•
•
All objects that are reserved by a specific session are made unreserved when you
call GPI_CLOSE_ to end that session or if the session terminates abnormally.
The session identifier becomes invalid after a call to GPI_CLOSE_, even if errors
occur while the procedure is executing.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -6
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. For additional values of status, see Appendix B, Return Codes.
swap-volume
input
STRING .EXT:ref:8
specifies a disk volume to be used as the swap volume for the GPI extended data
segment used by your application. The length of swap-volume is 8 octets. The
first octet must be a dollar sign ($), and the value must include trailing spaces if the
number of characters is less than 8 octets. For example, the value $USER should
contain three trailing spaces.
If you omit this parameter, the swap volume for the GPI extended data segment is
the same as the swap volume used for the data stack of your program.
max-table-entries
input
INT(32):value
specifies the maximum number of entries that the GPI is to use for each of its object
trees. An object tree is the internal form of an X.400 message maintained by the
GPI.
The minimum value allowed is ZGPI-MIN-OT-TBL-ENTRIES (50). The maximum
value allowed is ZGPI-MAX-OT-TBL-ENTRIES (1,048,576). The default value of
ZGPI-DEFAULT-OT-TBL-ENTRIES (10,000) is used, if you omit this parameter.
max-table-data
input
INT(32):value
specifies the maximum length (in octets) that the GPI is to use for string data space
in memory in each of its object trees. If you omit this parameter, the default value of
ZGPI-DEFAULT-OT-DATA-LEN (2,097,152) is used. The minimum value allowed
is ZGPI-MIN-OT-DATA-LEN (2,048). The maximum value allowed is ZGPIMAX-OT-DATA-LEN (10,485,760). The value must be greater than or equal to the
value you specify for the max-string-length parameter.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -7
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. For values of max-table-data that are greater than the default (2,097,152)
through the maximum allowed (10,485,760), messages with size greater than that
value will be transferred through use of a temporary file.
For example,
If max-table-data equals 1,048,304:
•
•
Messages with size less than 2 MB are transferred directly.
Messages with size greater than 2 MB are transferred through use of a
temporary file.
If max-table-data equals 4,194,304:
•
•
Messages with size less than 4 MB are transferred directly.
Messages with size greater than 4 MB will be transferred through use of a
temporary file.
max-string-length
input
INT(32):value
specifies the maximum length (in octets) of a string that the GPI is to allow to be
passed in an attribute descriptor. Strings that are longer than the length specified are
known as long strings. Long strings can only be accessed by using
GPI_OM_READ_ or GPI_OM_WRITE_.
The minimum value for this parameter is ZGPI-MIN-LONG-STRING-LEN (1024)
octets. The default value of ZGPI-DEFAULT-LONG-STRING-LEN (32,767) is
used, if you omit this parameter.
Considerations
•
•
•
If a client has open sessions with the GPI service when the program calls
GPI_INITIALIZE_, the sessions are closed, session-related data is discarded, and
any objects reserved by the client are made unreserved. Normally, you should end
all sessions by calling GPI_CLOSE_ before calling GPI_INITIALIZE_ again.
The practical limit on the total length of a communication’s string data is less than
ZGPI-MAX-OT-DATA-LEN even though this amount of string data can be
supplied. If an encoded communication exceeds the maximum message limit
specified by max-table-data, OSI/MHS generates a nondelivery report.
The GPI allows a client program to process at most 15 root objects at a time,
regardless of the number of open sessions. The root objects can be a combination of
reserved root objects and newly created root objects. The number of root objects is
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -8
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4 -9
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.
With all four options you have the ability to retain the object and its object identifier in
client memory and process it as you would a newly created object. The retained object is
the responsibility of your client program. If you leave the object in the input queue, you
can call the GPI_MT_START_TRANSFER_IN_ procedure to process it again.
status := GPI_MT_FINISH_TRANSFER_IN_ (
session
,
object
, [ retain ]
, [ all ]
, [ remove ] ) ;
!
!
!
!
!
I
I
I
I
I
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.
input
session
INT:value
specifies the session identifier of the established GPI session for which the object is
reserved.
input
object
INT(32):value
specifies the object identifier of the reserved object. If you specify OM-TRUE as the
value of the all parameter, the object parameter is ignored.
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 you want to retain the object. All client program
resources associated with the retained object remain allocated.
The object is the responsibility of the client program, which can
examine and modify the object.
OM-FALSE
specifies that you do not want to retain the object. The effect of
OM-FALSE is the same as specifying OM-TRUE and then calling
the GPI_OM_DELETE_ procedure.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 10
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.
remove
input
INT(32):value
specifies what you want to do with the object. You can remove the object
permanently from the input queue, move the object from the input queue to the
archive queue, leave the object in the input queue as an unreserved object, or
remove the object from the input queue and resubmit it to the MTA. Leaving the
object on the unreserved input queue has the effect of cancelling the object’s transfer
in, returning to the situation before you called GPI_MT_START_TRANSFER_IN_
to reserve the object.
The value can be:
MH-CANCEL
specifies leaving the unreserved object on the input queue.
MH-REMOVE
specifies removing the object from the input queue.
MH-ARCHIVE
specifies moving the object from the input queue to the
archive queue.
MH-TRANSFER
specifies removing the object from the input queue and
resubmitting that object to the MTA. This value can only be
used by a P1-EXIT type gateway.
If you omit this parameter, the default value is MH-REMOVE.
Considerations
•
You should call this procedure after your application successfully processes an
object, as follows:
•
•
If the object is a message or report, the client application delivers or internally
transfers the object to the indicated users of the messaging system to which your
client application is a gateway.
If the object is a probe, the client application establishes the deliverability to
prescribed users of a message having prescribed characteristics.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 11
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.
If the all parameter is OM-TRUE, the GPI does not indicate which objects have
been removed. To recover from this situation, continue to call the
GPI_MT_FINISH_TRANSFER_IN_ procedure until the status parameter is
MH-RC-SESSION-NOT-BUSY, which indicates that you have processed all
reserved objects.
•
•
After calling the GPI_MT_START_TRANSFER_IN procedure, you can determine
whether to archive a communication by calling the GPI_STATUS_ procedure.
Check the primary code returned for GPI_MT_START_TRANSFER_IN_. If the
value of the primary code is ZGPI-RC-UNDECODABLE-MESSAGE or
ZGPI-RC-UNDECODABLE-CONTENT, it is useful to archive the communication.
You cannot analyze or delete an archived communication by using the GPI
procedures.
The MH-TRANSFER value of the remove parameter is only allowed if the
gateway is configured as a P1-EXIT gateway. This option removes the reserved
message from the input message queue and adds it to the output message queue. The
resubmission of this message will give the MTA the responsibility to further process
the message. This option is recommended if the client wants to relay the message, or
if any kind of undecodable error is returned from the
GPI_MT_START_TRANSFER_IN_ call. If the client modifies and then transfers
out a copy of the reserved message, it is recommended that you delete the original
reserved message by specifying the MH-REMOVE value for the remove
parameter in the GPI_MT_FINISH_TRANSFER_IN_ call.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 12
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. A value of OM-RC-SUCCESS indicates a
successful call. For additional values of status, see Appendix B, Return Codes.
input
session
INT:value
specifies the session identifier of an established session in which the request for
access to an object is made.
output
object
INT(32) .EXT:ref:1
is an object identifier assigned to the object reserved by this procedure. If no object
is available to be reserved, the value of this parameter is ZGPI-NULL-OBJ-ID (0).
encoded
input
INT(32)
is a value that specifies whether an encoded or decoded object is returned. If the
parameter is not present, a value of OM-FALSE is assumed. (See below for the
definition of OM-FALSE.) The values for encoded can be as follows:
OM-TRUE
specifies that the object is to be to be passed to the client application as an encoded PDU.
OM-FALSE
specifies that the PDU is to be passed to the client application in
the normal decoded object-tree form of a message.
If you omit this parameter, the default value is OM-FALSE.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 13
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.
Considerations
•
•
•
If the input queue contains several unreserved objects, the GPI service decides
which one to reserve on the basis of its priority and, within a priority, on its arrival
time. Higher-priority items received at the earliest time are reserved first. If all
objects in the input queue are reserved, or there are no objects in the queue, an error
is returned.
While you have an object reserved, the GPI service continues to be responsible for
it. By reserving an object for a session, you prevent the object from being reserved
again, either by the same or another session.
The GPI allows a client program to process at most 15 root objects at a time,
regardless of the number of open sessions. The root objects can be a combination of
reserved root objects and newly created root objects. The limit is also affected by the
size of the objects. For more information, see GPI_INITIALIZE_ on page 4-7
When your program reaches this limit, you cannot make another call to
GPI_MT_START_TRANSFER_IN_ until you remove a reserved object by calling
GPI_MT_FINISH_TRANSFER_IN_ , you transfer a root object out to the GPI
service output queue, or you delete a root object.
•
When an error occurs, the GPI attempts to return as much information as possible.
For example, a partial communication is returned, if a mapping problem occurs
during processing of an inbound message. No communication is returned if an error
is detected before an inbound communication is processed.
If a full communication is returned, the status value is OM-RC-SUCCESS or
OM-RC-TEMPORARY-ERROR. If a partial communication, or no communication,
is returned, the status value is OM-RC-PERMANENT-ERROR.
A full or partial communication is assigned a valid object identifier. If no
communication is returned, the object identifier is ZGPI-NULL-OBJ-ID.
•
The Gateway Interface Process (GIP)does not write strings exceeding the maximum
value for max-in-memory-string-len into the in-memory string table.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 14
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_. If the attempt fails and theGIP could not
successfully complete the object tree for the message, the GIP returns a ZGPI-RCNO-STRING-MEMORY error message. The client application can then adjust the
max-in-memory-string-len specification to a lower value and retry the procedure
call.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 15
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.
status := GPI_MT_TRANSFER_OUT_
(
session
,
object
,
local-identifier
,
local-identifier-length
, [ retain ] ) ;
status
!
!
!
!
!
I
I
O
O
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 session from which the object is
transferred out.
object
input
INT(32):value
specifies the object identifier of the object that is to be transferred out. The class of
the object must be a message, probe, report, or P1-encoded object.
local-identifier
output
STRING .EXT:ref:*
is a local identifier that uniquely identifies the object being transferred out. If this
procedure is successful, the GPI returns the local identifier, which is a string of up to
32 alphanumeric characters. You can concatenate the local identifier with the
attributes of the environment object (class MH-C-ENVIRONMENT) returned by
the GPI_OPEN_ procedure to form an MTS identifier for the object that is being
transferred out. This parameter remains unchanged if the object being transferred is
an instantiation of class MH-C-P1-ENCODED-PDU.
local-identifier-length
output
INT.EXT:ref:1
is the length (in octets) of the local identifier.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 16
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.
OM-FALSE
specifies that the object is not to be retained.
If you omit this parameter, the default value is OM-FALSE.
Considerations
•
•
•
•
•
•
The procedure verifies the integrity of the object before placing it in the output
queue. If the object does not include all required attributes, an error occurs as
indicated in the return code.
Although you can insert a local identifier attribute in an MTS identifier object, you
should allow the GPI to insert it to guarantee the uniqueness of each MTS identifier.
If you copy an inbound object with the intention of transferring it out to an X.400
MTA, you can retain the local identifier of the inbound object. If the GPI detects a
local identifier in an outbound object, GPI_MT_TRANSFER_OUT_ does not
generate a new local identifier for the object.
If you are transferring out an object that is a copy of an inbound object, you should
first remove the MTS identifier attribute value (unless you want it to be reused).
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 (through the root-object parameter) must be inserted by a call to
GPI_OM_INSERT_.
If you specify that you want to retain an object after it is transferred out, the retained
object does not contain the local identifier generated by the GPI service. If you
inserted the local identifier attribute before calling the
GPI_MT_TRANSFER_OUT_ procedure, the attribute will be present.
It is possible, but unlikely, that the GPI will encounter an error after committing an
outbound object to the PDU store. In this case, the GPI retains the object in memory
and returns an error in the status parameter. You can send the communication
again or take some other action. If you send the communication again without
specifying a local identifier, the GPI generates a new identifier for the duplicate
communication.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 17
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.
input
session
INT:value
specifies the session identifier of the session that is monitoring the input queue.
input
interval
INT(32):value
specifies the maximum interval of time (in 0.01-second units) that this procedure is
to wait for an unreserved object to be located in the input queue. The value can be as
follows:
= -1
Wait indefinitely for an available unreserved object.
= 0
Return immediately even if an unreserved object is not available currently.
> 0
Wait for a maximum of the specified number of 0.01-second units for an
available unreserved object.
output
available
INT(32) .EXT:ref:1
is an indicator denoting whether an available unreserved object has been detected on
the input queue.
The value can be:
OM-TRUE
indicates that an unreserved object is available.
OM-FALSE
indicates that no unreserved objects are available.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 18
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.
However, only one GPI_MT_START_TRANSFER_IN_ call will be successful in
reserving the communication, because a communication can be reserved by only one
caller.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 19
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.
original
input
INT(32):value
specifies the object identifier of the object to be copied.
output
copy
INT(32) .EXT:ref:1
is the object identifier of the newly copied object. If the procedure is not successful,
this parameter is unchanged.
copy-root-object
input
INT(32):value
specifies the object identifier of the root object with which the copied object is to be
associated. The specified root object must already exist. You must specify this
parameter if the object you are copying is not a root object. If the object you are
copying is a root object, this parameter is ignored.
copy-session
input
INT:value
specifies the session identifier of the session with which the copied root object is to
be associated. The session must already be established. If the original object to be
copied is a root object, you must specify a value for this parameter. If the object you
are copying is not a root object, this parameter is ignored.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 20
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 21
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.
status := GPI_OM_CREATE_ (
,
,
,
,
,
,
[
[
[
[
class
initialize
object
root-object ]
session ] ) ;
class-obj-id ]
class-obj-id-len ] ) ;
!
!
!
!
!
!
!
I
I
O
I
I
I
I
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.
input
class
INT:value
is an integer that identifies the class of object to be created. For a description of the
object classes, see Section 3, Object Classes and Attribute Types. For the DDL
definitions of object classes, see Appendix A, DDL Definitions.
Object classes of the EDI package and two object classes of the MH package
(MH-C-ALGORITHM and MH-C-ALGORITHM-AND-RESULT) are identified by
an ASN.1 object identifier rather than an integer. To create an object of these
classes, set the class parameter to ZGPI-CLASS-UNSPECIFIED and specify the
ASN.1 object identifier using the class-obj-id and class-obj-id-len
parameters.
input
initialize
INT(32):value
specifies whether to initialize the new object as defined by its class.
The value can be:
OM-TRUE
specifies creating the object with initial values.
OM-FALSE
specifies creating the object with the OM-T-CLASS attribute only.
object
output
INT(32) .EXT:ref:1
is the object identifier of the newly created object. If the procedure is not successful,
this parameter is unchanged.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 22
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. If
the object you are creating is a root object, you must specify a value for this
parameter. If you are creating an object that is not a root object, this parameter is
ignored.
class-obj-id
input (optional)
STRING .EXT:ref:*
is the ASN.1 object identifier that identifies the class of the object to be created.
This parameter is ignored if the value of the class parameter is not ZGPI-CLASSUNSPECIFIED.
class-obj-id-len
input (optional)
INT:value
specifies the length in octets of the object identifier specified by class-obj-id.
Considerations
•
•
•
You refer to the object by its object identifier in all other procedure calls that operate
on the object.
You can examine, modify, transfer out, and copy the new object. Until you transfer
the object to the output queue of the GPI service, your client application is
responsible for the object.
The attributes of the new object and their initial values are specified for each class
of object in its definition. For a description of object classes, see Section 3, Object
Classes and Attribute Types. For the DDL definitions of objects and their attributes,
see Appendix A, DDL Definitions.
Some required attributes do not have initial values defined. You must insert values
for these attributes before transferring the object out to the GPI service output
queue.
If you specify that you want to initialize the new object, all optional attributes that
have initial values defined will be inserted in the object.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 23
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 24
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.
object
input
INT(32):value
specifies the object identifier of the object to be deleted.
Considerations
•
•
If GPI_OM_DELETE_ returns successfully, your client application can no longer
access the object by using its object identifier. Further references to the object
identifier result in an error.
Normally, you use the GPI_OM_DELETE_ procedure to delete objects you have
created or copied and the GPI_MT_FINISH_TRANSFER_IN_ procedure to delete
an object from the input queue. If you use the GPI_OM_DELETE_ procedure to
delete a reserved root object from the input queue, the result is the same as calling
GPI_MT_FINISH_TRANSFER_IN_ with remove specified as MH-CANCEL.
The object becomes unreserved, and its object identifier becomes invalid. However,
the object remains in the input queue of the GPI service, which assumes
responsibility for the object.
The object remains at the beginning of the input queue. You cannot reserve the next
object on the queue until you have reserved the first one again by calling
GPI_MT_START_TRANSFER_IN_. In this case, the GPI assigns a new object
identifier to the newly reserved object. To remove the object permanently from the
queue, you can call GPI_MT_FINISH_TRANSFER_IN_ and specify a remove
value of MH-REMOVE or MH-ARCHIVE.
•
If you delete a subobject, the object is no longer an attribute of its superobject. An
attempt to delete a reserved subobject results in an error.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 25
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.
status := GPI_OM_EXAMINE_ (
,
,
,
,
,
,
,
,
,
,
[
[
[
[
[
object
values
attribute-position
maximum-number
descriptor-list
total-number
actual-number ]
string-buffer ]
string-buffer-length ]
actual-string-length ]
total-string-length ] ) ;
!
!
!
!
!
!
!
!
!
!
!
I
I
I
I
O
O
O
O
I
O
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.
input
object
INT(32):value
specifies the object identifier of the object being examined.
input
values
INT(32):value
specifies whether the value and syntax of any single-valued attributes should be
returned.
The value of this parameter can be:
OM-TRUE
requests return of the syntax and value.
OM-FALSE
requests return of the attribute type only.
attribute-position
input
INT(32):value
specifies the position within the object of the first attribute you want to examine.
The first attribute in the object is at position ZGPI-POSITION-AT-BEGIN, which
is 0. The value of this parameter must be less than the number of attributes in the
object; that is, the specified position must be within the range of attribute positions
for the object.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 26
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. The total number of
attributes in the object is returned through 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. The area must be large enough to contain the number of
attribute descriptors specified by the maximum-number parameter.
The attribute descriptors are returned in the order in which they appear in the object.
Each descriptor includes an attribute type. If the attribute is single-valued and you
specify OM-TRUE for the values parameter, a syntax and value are returned. If
the procedure call is unsuccessful or the value of the maximum-number parameter
is 0, the buffer is unchanged.
For more information about descriptor lists, see Section 2, Information Architecture
and Data Structures.
total-number
output
INT(32) .EXT:ref:1
is the total number of attributes present in the object (including the OM-T-CLASS
attribute). This number is not affected by the attribute-position or
maximum-number value. If the procedure call is unsuccessful, the parameter is
unchanged.
actual-number
output
INT(32) .EXT:ref:1
is the actual number of attribute descriptors returned. If the procedure call is
unsuccessful, the parameter is unchanged.
string-buffer
output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which elements of any string values
of the attributes are returned. This buffer can be in your program’s stack segment or
in any extended data segment. For a description of string buffers, see Section 2,
Information Architecture and Data Structures.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 27
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. 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 attribute-position or
maximum-number parameters.
Considerations
•
•
•
•
For multivalued attributes, GPI_OM_EXAMINE_ returns the attribute type, syntax
OM-S-UNSPECIFIED, and element OM-S-ELEMENTS-UNSPECIFIED. No
values are returned. You can retrieve the values by using the GPI_OM_LIST_
procedure.
Attributes that are defined as multivalued attributes but appear in the object with
only a single value are treated as single-valued attributes by this procedure.
The elements of an attribute value that has a syntax of OM-S-xxx-STRING are
returned in the string buffer you specify. The starting address of each value is
returned in the OM-string elements field of the descriptor value field for that
attribute.
If a string is a long string (the total length of the string is greater than the maxstring-length value you specified for the GPI_INITIALIZE_ procedure), or if a
regular string does not fit in the buffer, GPI_OM_EXAMINE_ does the following:
•
•
Returns the length of the value in the string-length field of the descriptor value
field for the attribute
Returns OM-ELEMENTS-UNSPECIFIED in the string elements field
If you detect either of these situations, you can retrieve the string by making another
procedure call. To retrieve a long string, call the GPI_OM_READ_ procedure. To
retrieve other strings, call GPI_OM_EXAMINE_ again and specify a larger buffer
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 28
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.
•
If you specify OM-FALSE for the values parameter, you cannot determine
whether an attribute is single-valued or multivalued by checking its syntax and
value.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 29
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.
status := GPI_OM_FETCH_ (
,
,
,
,
,
,
,
,
[
[
[
[
object
values
descriptor-list-in
descriptor-count
descriptor-list-out
string-buffer ]
string-buffer-length ]
actual-string-length ]
total-string-length ] ) ;
!
!
!
!
!
!
!
!
!
I
I
I
I
O
O
I
O
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.
input
object
INT(32):value
specifies the object identifier of the object about which you want information.
input
values
INT(32):value
specifies whether the value and syntax of any single-valued attributes should be
returned.
The value of this parameter can be:
OM-TRUE
requests return of the syntax and value.
OM-FALSE
requests return of the attribute type only
descriptor-list-in
input
STRING .EXT:ref:*
is a list of attribute descriptors specifying the types of attributes you want to fetch.
Each descriptor must specify an attribute type; the syntax and value fields are
ignored. For more information about descriptor lists, see Section 2, Information
Architecture and Data Structures.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 30
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. The area must be large enough to contain the number of
attribute descriptors specified by the descriptor-count parameter.
The attribute descriptors appear in the order that you specify the types in
descriptor-list-in. Each descriptor includes a type if an attribute of that
type is present in the object; otherwise, the type returned is OM-T-UNSPECIFIED.
If the attribute is single-valued and you specify OM-TRUE for the values
parameter, a syntax and value are returned. If the procedure call is unsuccessful, the
buffer is unchanged.
string-buffer
output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which any string values of the
attributes are returned. This buffer can be in your program’s stack segment or in any
extended data segment. 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. 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 31
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).
•
For single-valued attributes that are present, the values are returned only if you
specify OM-TRUE for the values parameter. If you specify OM-FALSE, the
procedure returns a syntax of OM-S-UNSPECIFIED and a value of
OM-ELEMENTS-UNSPECIFIED.
For multivalued attributes that are present, the values are not returned. The
procedure returns a syntax of OM-S-UNSPECIFIED and a value of
OM-ELEMENTS-UNSPECIFIED. You can retrieve the values by using the
GPI_OM_LIST_ procedure.
If you specify OM-FALSE for the values parameter, you cannot determine
whether an attribute is single-valued or multivalued by checking its syntax and
value.
•
•
•
Attributes that are defined as multivalued attributes but appear in the object with
only a single value are treated as single-valued attributes by this procedure.
The elements of an attribute value that has a syntax of OM-S-xxx-STRING are
returned in the string buffer you specify. The starting address of each value is
returned in the OM-S-string elements field of the descriptor value field for that
attribute.
If a string is a long string (the total length of the string is greater than the maxstring-length value specified for the GPI_INITIALIZE_ procedure), or if a regular
string does not fit in the buffer, GPI_OM_FETCH_ does the following:
•
•
Returns the length of the value in the string-length field of the descriptor value
field for the attribute
Returns OM-ELEMENTS-UNSPECIFIED in the string-elements field
If you detect either of these situations, you can retrieve the string by making another
procedure call. To retrieve a long string, call the GPI_OM_READ_ procedure. To
retrieve other strings, call GPI_OM_FETCH_ again and specify a larger buffer
(string-buffer-length).
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 32
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. A value of OM-RC-SUCCESS indicates a
successful call. For additional values of status, see Appendix B, Return Codes.
object
input
INT(32):value
specifies the object identifier of the object to which attribute values are being added.
value-position
input
INT(32):value
specifies the position within the attribute at which the first new value is to be
inserted. If you specify OM-POSITION-AT-END, or you specify a position that is
not within the range of current positions for the attribute, the first new value is
added immediately after any existing values. For single-valued attributes, this
parameter is ignored.
descriptor-list
input
STRING .EXT:ref:*
is the list of attribute descriptors to be processed. For more information about
descriptor lists, see Section 2, Information Architecture and Data Structures.
descriptor-count
input
INT(32):value
specifies the number of attribute descriptors to be processed. 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).
Considerations
•
GPI_OM_INSERT_ verifies the integrity and validity of attribute types, syntaxes,
and values before adding them. The type specified in each attribute descriptor must
be one of the types defined for the object’s class. The syntax must be valid for the
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 33
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.
•
•
•
•
If the syntax of a value is OM-S-OBJECT, the value is the object identifier of the
subobject you are inserting as an attribute.
If the attribute is new and contains no existing values, the new values are inserted
starting at position ZGPI-POSITION-AT-BEGIN, the first value position in an
attribute, which is 0.
If you specify an attribute type that refers to a single-valued attribute and that
attribute is already present in the object when you call this procedure, an error is
returned. For example, this can occur if an attribute was inserted previously or was
initialized when the object was created. If you want to change the value, you can
call GPI_OM_REMOVE_ to remove it and then call GPI_OM_INSERT_ again.
GPI_OM_INSERT_ uses the value-position parameter to determine where to
place the first new value of a particular attribute type. The same position is used for
all attributes for which you are inserting values. GPI_OM_INSERT_ inserts values
in multivalued attributes, as follows:
•
•
If you supply contiguous values for a multivalued attribute, the procedure inserts
the additional values sequentially after the first new value.
If you supply noncontiguous values for the same multivalued attribute, valueposition is used to determine where to place the first new value of each
portion of the noncontiguous list of values. In other words, each portion of the
list is inserted at the same position and causes the positions of values already in
the attribute to be moved to higher-numbered positions.
You should not try to insert values for different types of multivalued attributes,
unless the value-position is appropriate for processing each attribute.
•
•
•
If you specify value-position 0 for a multivalued attribute, new values are
inserted before any initial value inserted in the object when GPI_OM_CREATE_
created it.
You cannot insert an attribute value that is a long string by using this procedure.
You must use the GPI_OM_WRITE_ procedure to add the value.
No subobject can be identified by the same object identifier as another subobject of
its superobject. If you try to insert an object that is already a subobject, an error is
returned.
You can insert a subobject that does not have all its attributes and insert more
attributes in the subobject later. You can insert attributes in an object, superobject,
or subobject at any time before it is transferred out, as long as none of the objects
are reserved.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 34
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.
status := GPI_OM_LIST_ (
,
,
,
,
,
,
,
,
,
,
status
[
[
[
[
[
object
attribute-type
value-position
maximum-number
descriptor-list
total-number
actual-number ]
string-buffer ]
string-buffer-length ]
actual-string-length ]
total-string-length ] ) ;
!
!
!
!
!
!
!
!
!
!
!
I
I
I
I
O
O
O
O
I
O
O
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.
object
input
INT(32):value
specifies the object identifier of the object you want information about.
attribute-type
input
INT(32):value
specifies the type of the attribute whose values you are retrieving.
value-position
input
INT(32):value
specifies the position within the attribute of the first value you want to retrieve. The
value of this parameter must be less than or equal to the value position of the last
value in the attribute.
maximum-number
input
INT(32):value
specifies the maximum number of attribute descriptors to be returned. If the value of
this parameter exceeds the number of values available, the number available is used.
The maximum value for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT
(10,240).
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 35
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. The area must be large enough to contain the number of
attribute descriptors specified by the maximum-number parameter.
The attribute descriptors are returned in the order in which the values appear in the
attribute. Each descriptor includes an attribute type, a syntax, and a value. If the
procedure call is unsuccessful or the value of the maximum-number parameter is
0, the buffer is unchanged.
For more information about descriptor lists, see Attribute Descriptors on page 2-2.
total-number
output
INT(32) .EXT:ref:1
is the total number of values in the attribute. This number is not affected by the
maximum-number or value-position parameter value. If the procedure call
is unsuccessful, the parameter is unchanged.
actual-number
output
INT(32) .EXT:ref:1
is the actual number of attribute descriptors returned. If the procedure call is
unsuccessful, the parameter is unchanged.
string-buffer
output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which elements of any string values
are returned. This buffer can be in your program’s stack segment or in any extended
data segment. 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 36
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.
Considerations
•
•
•
The procedure fills in a list of attribute descriptors with the information you request.
Each descriptor corresponds to one attribute value of the type you specify and
contains the attribute type, syntax, and value.
The elements of an attribute value that has a syntax of OM-S-xxx-STRING are
returned in the string buffer you specify. The starting address of each value is
returned in the OM-S-string elements field of the descriptor value field for that
attribute.
If a string is a long string (the total length of the string is greater than the
max-string-length value specified for the GPI_INITIALIZE_ procedure), or
if a short string does not fit in the buffer, GPI_OM_LIST_ does the following:
•
•
Returns the length of the value in the string-length field of the descriptor value
field for the attribute
Returns OM-ELEMENTS-UNSPECIFIED in the string-elements field
If you detect either of these situations, you can retrieve the string by making another
procedure call. To retrieve a long string, call the GPI_OM_READ_ procedure. To
retrieve other strings, call GPI_OM_LIST_ again and specify a larger buffer
(string-buffer-length).
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.
•
•
You can use this procedure to retrieve the value of a single-valued attribute by
specifying value-position 0.
If a multivalued attribute appears in the object with only one value,
GPI_OM_LIST_ retrieves that value.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 37
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.
status := GPI_OM_READ_ (
status
object
,
attribute-type
,
value-position
,
string-offset
,
maximum-number
, [ data-string ]
, [ actual-number ]
,
approx-total-number ) ;
! I
! I
! I
! I/O
! I
! O
! O
! O
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.
object
input
INT(32):value
specifies the object identifier of the object whose attribute value you want to read.
attribute-type
input
INT:value
specifies the type of the attribute whose value you want to read.
value-position
input
INT(32):value
specifies the position within the attribute of the value you want to read. The value of
this parameter must not be greater than that of the last value in the attribute.
string-offset
input, output
INT(32) .EXT:ref:1
on input, specifies the offset (in octets) of the start of the string element to be read.
The offset of the first octet in a string is 0. The value of this parameter must be less
than the actual number of octets in the attribute’s value. This parameter is not
checked if maximum-number is zero.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 38
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. If the value of this parameter
exceeds the number of octets available, the number available is used.
To determine the total number of octets in the value without retrieving any octets,
specify 0 as the value of this parameter. The total number of octets in the value is
returned in the approx-total-number parameter.
data-string
output
STRING .EXT:ref:*
specifies a buffer in your program’s memory space to which you want the segment
returned. The buffer must be long enough to contain the number of octets specified
by the maximum-number parameter.
If the procedure call is unsuccessful or the value of the maximum-number
parameter is 0, the buffer is unchanged.
actual-number
output
INT(32) .EXT:ref:1
is the actual number of octets read. If the procedure call is unsuccessful, the
parameter is unchanged.
approx-total-number
output
INT(32) .EXT:ref:1
is the total number of octets in the value. If the procedure call is unsuccessful, the
parameter is unchanged.
Consideration
•
You can also use this procedure to retrieve string values that are not long strings.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 39
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. You can use this procedure to remove either of
the following from an object:
•
•
One attribute value of a single-valued attribute
One or more attribute values of a multivalued attribute of the same attribute type
status := GPI_OM_REMOVE_ (
status
object
, attribute-type
, value-position
, maximum-number
, total-number
!
!
!
!
!
I
I
I
I
O
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.
object
input
INT(32):value
specifies the object identifier of the object whose attribute values you want to
remove.
attribute-type
input
INT:value
specifies the type of the attribute whose values you want to remove.
value-position
input
INT(32):value
specifies the position within the attribute of the first value you want to remove. The
value of this parameter must not be greater than that of the last value in the attribute
before you call the procedure.
maximum-number
input
INT(32):value
specifies the maximum number of attribute values to be removed. If the maximum
number you specify exceeds the number of values in the attribute starting at
value-position, the value at value-position and all successive values are
removed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 40
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.
Considerations
•
•
You can also remove an attribute that is an object (in other words, a subobject) by
using the GPI_OM_DELETE_ procedure.
All objects have an attribute of type OM-T-CLASS that cannot be modified or
removed. The OM-T-CLASS attributes exists until its object is deleted or transferred
out to the GPI service output queue. You can remove all other attributes of an object
and their values, but the object remains accessible.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 41
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. You can use
this procedure to write a new string value, append a string segment to an existing value,
or replace all or part of a string value.
You should call this procedure as many times as needed to add all segments of the value.
Each call returns a next position, which you can use as the starting position (string
offset) for the next call.
You cannot write segments to a reserved object.
status := GPI_OM_WRITE_ (
status
object
,
attribute-type
,
value-position
,
string-offset
,
data-string
,
element-number
, [ syntax ] ) ;
! I
! I
! I
! I/O
! I
! 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.
object
input
INT(32):value
specifies the object identifier of the object containing the attribute to which you
want to write.
attribute-type
input
INT:value
specifies the type of the attribute whose value you want to write.
value-position
input
INT(32):value
specifies the position within the attribute of the value you want to write. For an
explanation of how to specify value-position, see the considerations that
follow the parameter descriptions.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 42
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. The segment is appended as specified by the value-position
parameter.
The minimum string offset allowed is ZGPI-NEW-VALUE. The string offset
cannot exceed the current length of the existing string value. The string offset
plus the length of the string segment you are adding cannot exceed the
maximum length string allowed for a value of the specified attribute.
For an explanation of how to specify string-offset, see the considerations that
follow the parameter descriptions.
On output, string-offset is the offset (in octets) after the last string segment
written. You can use the returned string-offset as the starting position in the
next GPI_OM_WRITE_ call.
If the procedure call is unsuccessful, the parameter value is unchanged.
data-string
input
STRING .EXT:ref:*
specifies a buffer in your program’s memory space that contains the string segment
to be written. This segment will be copied to the string value starting at the offset
specified by string-offset. The number of octets written will be equal to the
value of the element-number parameter.
element-number
input
INT(32):value
specifies the number of octets to be written; the minimum value is 0. The maximum
value is the smaller of the attribute’s value length or the value specified for the
GPI_INITIALIZE_ max-table-data parameter.
syntax
input
INT:value
specifies the syntax to be used for a value of an attribute that is not already present
in the object. You must specify a valid string syntax of the form OM-S-xxxSTRING. This parameter is ignored if the value already exists. For information on
the value syntax OM-S-ONFILE-STRING, see “Considerations” at the end of this
section.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 43
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. Writing String Segments
Write Operation
String Offset
Value Position
Add new value to end of value
list starting at string offset 0.
ZGPI-NEW-VALUE
OM-POSITION-AT-END or
(last value position + 1)
Insert new value preceding an
existing value and shift
subsequent values one position.
ZGPI-NEW-VALUE
Existing value position
Append string segment to an
existing value.
OM-POSITION-AT-END
Existing value position
Replace entire value with string
segment.
0
Existing value position
Replace and overwrite existing
value with string segment
beginning at specified string
offset. (You can shorten or
lengthen value.)
String offset greater than
0 but less than maximum
length allowed for value.
Existing value position
By replacing all or part of a value, you can lengthen or shorten the value. The new
string segment overwrites any existing segments beyond the string offset you
specify. For more information about string offsets, see String Buffers on page 2-9.
•
•
•
If the attribute to which segments are being added does not already exist,
GPI_OM_WRITE_ adds the attribute to the object.
If the string offset is greater than or equal to 0, the maximum value position allowed
is the last existing value position.
If the string offset is ZGPI-NEW-VALUE, the maximum value position allowed is
OM-POSITION-AT-END (or last existing value position + 1), unless no value exists
for the attribute. If no value exists, the value is added in the first value position
(position 0).
You cannot add a value when the maximum number of values for the attribute
already exist. For example, you cannot add a ninth attribute to a multivalued
attribute that can have at most eight values, or add a value to a single-valued
attribute when a value already exists.
•
When generating large messages, applications can specify the syntax OM-SONFILE-STRING. Specifying this syntax reduces memory requirements and avoids
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 44
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 45
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.
status := GPI_OPEN_ (
status
gateway-name
,
gateway-instance-name
,
session
,
environment
,
MHS-mgr-name
,
MHS-mgr-name-length
, [ gateway-password ]
, [ gateway-password-length ] ) ;
!
!
!
!
!
!
!
!
I
I
O
O
I
I
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.
gateway-name
input
STRING .EXT:ref:32
specifies the name used to configure the GATEWAY object through DSM; that is,
the name by which the GATEWAY object is added to a specific OSI/MHS object
hierarchy.
The name can contain up to 32 alphanumeric characters; shorter names must be
padded with trailing blanks.
gateway-instance-name
input
STRING .EXT:ref:32
specifies a name that uniquely identifies a specific session’s use of a gateway. The
name serves as a textual tag for the session identifier. gateway-instancename can contain up to 32 alphanumeric characters; shorter names must be padded
with trailing blanks.
Each session should have its own gateway instance name. All gateway instances of
the same GATEWAY object share the same input and output queues. Although the
GPI service maintains the gateway instance name, the name has no significance to
the GPI. You can use the name as a logging or tracing mechanism or for archiving
or auditing gateway activity.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 46
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. If the call
does not succeed, this parameter is unchanged. You cannot modify any of the
attributes of the environment object or gain access to the object after the session
ends.
An object of the environment class consists of an ADMD name, a country name,
and an optional PRMD identifier. For a complete definition of the environment
class, see MH-C-ENVIRONMENT on page 3-19.
MHS-mgr-name
input
STRING .EXT:ref:*
specifies the fully qualified name of the OSI/MHS manager process that controls the
MTA (OSI/MHS subsystem) with which the client application is to communicate.
The manager process you specify must be the one that is used to configure the
GATEWAY object specified by gateway-name. The form of the name is:
[system.]$process-name
For example, a typical MHS manager process name is \SYS1.$ZMHS.
MHS-mgr-name-length
input
INT:value
specifies the length (in octets) of the MHS-mgr-name string. The maximum length
is 256.
gateway-password
input
STRING .EXT:ref:*
specifies the gateway password as configured by DSM. The GPI service does not
transfer objects between the client and the X.400 MTA unless the gateway password
is provided to validate the authenticity of the client.
The maximum length of the gateway password is 62 IA5-string characters. You
must specify this parameter if the length of the gateway password is greater than 0.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 47
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.400 MTA.
The time required to complete this procedure might be significantly longer than that
required for the other procedures.
See the OSI/MHS Configuration and Management Manual for more information
about GATEWAY objects, the MHS manager process, and gateway passwords.
A client application may open up to 15 sessions. Sessions can be connected to the
same gateway, or to different gateways which are configured in the same or different
subsystem(s).
The GPI components in the current release are not compatible with components in
the previous release. Attempts to use incompatible releases of the GPI result in the
return of the ZGPI-RC-INCOMPATIBLE-GIP error in response to GPI_OPEN_.
If an entry manager is configured with a “terminal” as output, and if the entry
manager is trying to output an error to that impaired terminal, then the open may
hang as the GIP tries to open the entry manager.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 48
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.
status := GPI_STATUS_ (
,
,
,
,
,
,
,
,
,
,
,
,
status
[
[
[
[
[
[
[
[
[
[
[
[
[
status-context ]
session ]
request-type ]
old-status ]
error-class ]
primary-code ]
secondary-code ]
error-qualifier ]
error-source ]
info-buffer ]
info-buffer-length ]
actual-info-length ]
total-info-length ] ) ;
!
!
!
!
!
!
!
!
!
!
!
!
!
I
O
O
O
O
O
O
O
O
O
I
O
O
returned value
INT:value
indicates the outcome of the GPI_STATUS_ call. A value of OM-RC-SUCCESS
indicates a successful call. For additional values of status, see Appendix B,
Return Codes.
status-context
input
INT:value
specifies the context in which you want error information. You can specify one of
the following:
•
•
•
The session identifier of an established session to obtain information about the
last error that occurred in that session.
The value ZGPI-ANY to obtain information about the last GPI call that occurred
in any session (successfully or unsuccessfully).
The value ZGPI-NON-SESSION to obtain information about the last error that
occurred outside a session context.
If you omit this parameter, the default value is ZGPI-ANY.
session
output
INT.EXT:ref:1
is the session identifier of the session to which the status information applies.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 49
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.
The values of request type and the procedures they identify are as follows:
Request Type Value
Procedure Name
ZGPI-RT-NULL
No request in progress
ZGPI-RT-EM-INITIALIZE
GPI_INITIALIZE_
ZGPI-RT-EM-OPEN
GPI_OPEN_
ZGPI-RT-EM-CLOSE
GPI_CLOSE_
ZGPI-RT-EM-STATUS
GPI_STATUS_
ZGPI-RT-MT-WAIT
GPI_MT_WAIT_
ZGPI-RT-MT-START-XFER-IN
GPI_MT_START_TRANSFER_IN_
ZGPI-RT-MT-FINISH-XFER-IN
GPI_MT_FINISH_TRANSFER_IN_
ZGPI-RT-MT-XFER-OUT
GPI_MT_TRANSFER_OUT_
ZGPI-RT-OM-COPY
GPI_OM_COPY_
ZGPI-RT-OM-CREATE
GPI_OM_CREATE_
ZGPI-RT-OM-DELETE
GPI_OM_DELETE_
ZGPI-RT-OM-EXAMINE
GPI_OM_EXAMINE_
ZGPI-RT-OM-FETCH
GPI_OM_FETCH_
ZGPI-RT-OM-INSERT
GPI_OM_INSERT_
ZGPI-RT-OM-LIST
GPI_OM_LIST_
ZGPI-RT-OM-READ
GPI_OM_READ_
ZGPI-RT-OM-REMOVE
GPI_OM_REMOVE
ZGPI-RT-OM-WRITE
GPI_OM_WRITE_
old-status
output
INT .EXT:ref:1
contains the original status returned for the most recent GPI error in the specified
context. Typically, this is the status that caused you to call GPI_STATUS_ for more
information. For values of status, see Appendix B, Return Codes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 50
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. If the value of old-status is
OM-RC-PERMANENT-ERROR or OM-RC-TEMPORARY-ERROR, the primary
code is a Compaq proprietary code described in Compaq Proprietary Codes on
page B-14. Otherwise, the primary code has the same value as old-status.
secondary-code
output
INT .EXT:ref:1
contains one of the secondary codes identified by a DDL name or contains a value
that is specific to the error context: for example, the class of an object to which the
error pertains. For explanations of the secondary codes identified by DDL names,
see Secondary Codes on page B-49. The other values returned in this parameter are
described with the recovery recommendation for the OM-RC-, MH-RC-, or ZGPIRC- code to which they relate.
Include this value when reporting problems to your Compaq service representative.
error-qualifier
output
INT .EXT:ref:1
contains qualifying information about the most recent GPI error in the specified
context. Include this value when reporting problems to your Compaq service
representative.
error-source
output
INT .EXT:ref:1
contains the source for the most recent GPI error in the specified context. Typically,
the error source is a GPI procedure or function. Include this value when reporting
problems to your Compaq service representative.
info-buffer
output
STRING .EXT:ref:*
is the name of the buffer to which you want the error information returned. You
must include this parameter if you specify a value greater than 0 for
info-buffer-length. If you specify 0 for info-buffer-length, the
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 51
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. This parameter is required if
you specify info-buffer.
actual-info-length
output
INT .EXT:ref:1
is the number of octets of information returned to info-buffer. If no
information is returned, the value is 0.
total-info-length
output
INT .EXT:ref:1
is the total number of octets of information available. You can call the
GPI_STATUS_ procedure again to get the information in info-buffer. If the
buffer is not large enough to hold the information, it is truncated to fit. You cannot
call the procedure again to get the additional information. If you want all the
information, you must increase the length of the buffer by revising
info-buffer-length (and possibly declare a different area for infobuffer).
Considerations
•
•
The recommended value for info-buffer-length is also the maximum value,
which is ZGPI-MAX-STATUS-BUF-LEN (512) octets. This length accommodates
the optimum amount of error information.
For detailed information about examining the information buffer and the other
values returned by the GPI_STATUS_ procedure, see Appendix B, Return Codes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4- 52
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.
The equivalent of C code (in the file GPIDEFSH) is provided for you to include in
your C program by using the #include directive.
This appendix describes two major types of DDL definitions:
•
•
Basic data types are building blocks on which the parameter structures are based.
Named values identify specific values or sets of values (constants) that can be
assigned to parameters or parameter fields.
In the headings in this section, the abbreviation xxx is used to indicate the remainder of
a DDL name that follows a prefix.
Note. When the DDL compiler translates these definitions into TAL and C, the compiler
changes hyphens ( - ) in the names to underscores ( _ ). You should use underscores in DDL
names included in your programs. Because the C language distinguishes uppercase and
lowercase letters, you must use the DDL names exactly as they are declared in the
GPIDEFSH file or create your own declarations file.
DDL definitions used to return status and error information from the GPI procedures are
described in Appendix B, Return Codes.
Basic Data Types
Some DDL data types are built upon other data types. Intermediate data types are used
in the definitions of other data types. The precise definitions of intermediate data types
in C are system-defined. First-level (primary) data types are the lowest-level building
blocks. Second-level (secondary) data types are made from one or more first-level data
types. Third-level (tertiary) data types are made from one or more second-level data
types.
Intermediate Data Types
The GPI defines intermediate data types for binary numbers.
OM-SINT
This data type defines a signed 16-bit integer.
DEFINITION
OM-SINT
TYPE BINARY 16.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 1
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.
OM-UINT32
This data type defines an unsigned 32-bit integer.
DEFINITION
OM-UINT32
TYPE BINARY 32 UNSIGNED.
First-Level Data Types
The GPI defines first-level data types for specific syntaxes, classes, objects, padded
objects, and string values. First-level (primary) data types are the lowest-level building
blocks.
OM-BOOLEAN
This data type defines a field used for Boolean values of an attribute.
DEFINITION
OM-BOOLEAN
TYPE OM-UINT32.
The valid values are:
CONSTANT
CONSTANT
OM-FALSE
OM-TRUE
VALUE 0.
VALUE 1.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 2
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.
DEFINITION
OM-OBJECT
TYPE OM-UINT32.
OM-PADDED-OBJECT
This data type defines a field used for attribute values that are object identifiers.
DEFINITION OM-PADDED-OBJECT.
02 PADDING
02 OBJECT
END
TYPE OM-UINT32.
TYPE OM-OBJECT.
OM-STRING-LENGTH
This data type defines a field used for the length of a string.
DEFINITION
OM-STRING-LENGTH
TYPE OM-UINT32.
OM-STRING
This data type defines a field used for string values of an attribute.
DEFINITION OM-STRING
02 LENGTH
02 ELEMENTS
END
TYPE OM-STRING-LENGTH.
TYPE OM-UINT32.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 3
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.
OM-TYPE
This data type defines a field for the type of an attribute value in an attribute descriptor.
DEFINITION
OM-TYPE
TYPE OM-UINT16.
OM-VALUE
This data type defines a field for the attribute value in an attribute descriptor.
DEFINITION OM-VALUE.
02 Z-STRING
TYPE OM-STRING.
02 BOOLEAN
REDEFINES Z-STRING
02 ENUMERATION REDEFINES Z-STRING
02 INTEGER
REDEFINES Z-STRING
02 OBJECT
REDEFINES Z-STRING
02 VALUE
REDEFINES Z-STRING
END
TYPE
TYPE
TYPE
TYPE
TYPE
OM-BOOLEAN.
OM-ENUMERATION.
OM-INTEGER.
OM-PADDED-OBJECT.
BINARY 64.
Third-Level Data Types
The GPI defines third-level data types for attribute descriptors. Third-level (tertiary)
data types are made from one or more second-level data types, described in SecondLevel Data Types on page A-4.
OM-DESCRIPTOR
This data type defines a field for an attribute descriptor. Use this structure to insert
attribute values in and examine attribute values from a descriptor list.
DEFINITION OM-DESCRIPTOR.
02 TYPE
02 SYNTAX
02 VALUE
END
TYPE OM-TYPE.
TYPE OM-SYNTAX.
TYPE OM-VALUE.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 4
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.
OM-FALSE and OM-TRUE
These symbolic constants are used as Boolean values.
CONSTANT
CONSTANT
OM-FALSE
OM-TRUE
TYPE BINARY 32 UNSIGNED
TYPE BINARY 32 UNSIGNED
VALUE IS 0.
VALUE IS 1.
MH-xxx for GPI_MT_FINISH_TRANSFER_IN_
These symbolic constants define values for the remove parameter of the
GPI_MT_FINISH_TRANSFER_IN procedure.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-CANCEL
MH-REMOVE
MH-ARCHIVE
MH-TRANSFER
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
32
32
32
32
UNSIGNED
UNSIGNED
UNSIGNED
UNSIGNED
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
0.
1.
2.
3.
For descriptions of these values, see GPI_MT_FINISH_TRANSFER_IN_ on page 4-10.
OM-ELEMENTS-UNSPECIFIED
This symbolic constant defines a value used in the LENGTH and ELEMENTS fields of
an attribute string value to indicate various conditions, as specified in the GPI procedure
descriptions in Section 4, Procedure Calls.
CONSTANT
OM-ELEMENTS-UNSPECIFIED TYPE BINARY 32 UNSIGNED
VALUE IS 0.
OM-POSITION-AT-END
This symbolic constant defines a value used to specify the position of an attribute value
in a descriptor list.
CONSTANT
OM-POSITION-AT-END
TYPE BINARY 32
VALUE IS -1.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 5
Object Management Classes and Types
DDL Definitions
OM-S-xxx
These syntax constants are used to specify the syntax in an attribute descriptor.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
OM-S-UNSPECIFIED
OM-S-BIT-STRING
OM-S-BOOLEAN
OM-S-ENCODING-STRING
OM-S-ENUMERATION
OM-S-IA5-STRING
OM-S-INTEGER
OM-S-NUMERIC-STRING
OM-S-OBJECT
OM-S-OBJECT-DESCRIPTOR-STRING
OM-S-OBJECT-ID-STRING
OM-S-OBJECT-IDENTIFIER-STRING
OM-S-OCTET-STRING
OM-S-ONFILE-STRING
OM-S-PRINTABLE-STRING
OM-S-TELETEX-STRING
OM-S-UTC-TIME-STRING
OM-S-VIDEOTEX-STRING
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
0.
3.
1.
8.
10.
22.
2.
18.
127.
7.
6.
6.
4.
24.
19.
20.
23.
21.
OM-S-UNSPECIFIED
is used in the syntax field of an attribute descriptor to indicate various conditions, as
specified in the GPI procedure descriptions in Section 4, Procedure Calls.
For descriptions of the other constants, see Syntax and Values on page 2-4.
Object Management Classes and Types
The object management constants are used to specify the objects of the object
management package. For descriptions of the object classes and attribute types, see
Object Management Classes on page 3-3.
OM-C-xxx
This constant defines the object classes of the object management package.
CONSTANT OM-C-EXTERNAL
VALUE IS 2.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 6
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.
Message Handling Classes and Types
The message handling constants are used to specify the objects of the message handling
package. For descriptions of the object classes and attribute types, see Message
Handling Classes on page 3-5.
MH-C-xxx
These constants define object classes of the message handling package. The first two
constants are in the form of ASN.1 object identifiers. The remaining constants are in the
form of integers.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 7
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.
CONSTANT MH-C-ENVIRONMENT
VALUE IS 250.
CONSTANT MH-C-EXPANSION-RECORD
VALUE IS 214.
CONSTANT MH-C-EXTENSION
VALUE IS 216.
CONSTANT MH-C-EXTERNAL-TRACE-ENTRY
VALUE IS 217.
CONSTANT MH-C-G3-FAX-NBPS
VALUE IS 218.
CONSTANT MH-C-GENERAL-CONTENT
VALUE IS 219.
CONSTANT MH-C-INTERNAL-TRACE-ENTRY
VALUE IS 220.
CONSTANT MH-C-MESSAGE
VALUE IS 225.
CONSTANT MH-C-MESSAGE-RD
VALUE IS 226.
CONSTANT MH-C-MTS-IDENTIFIER
VALUE IS 227.
CONSTANT MH-C-OR-NAME
VALUE IS 229.
CONSTANT MH-C-P1-ENCODED-DATA
VALUE IS 251.
CONSTANT MH-C-PER-RECIPIENT-DR
VALUE IS 230.
CONSTANT MH-C-PER-RECIPIENT-NDR
VALUE IS 231.
CONSTANT MH-C-PROBE
VALUE IS 233.
CONSTANT MH-C-PROBE-RD
VALUE IS 234.
CONSTANT MH-C-REPORT
VALUE IS 237.
CONSTANT MH-C-SECURITY-LABEL
VALUE IS 252.
CONSTANT MH-C-TELETEX-NBPS
VALUE IS 246.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 8
Message Handling Classes and Types
DDL Definitions
MH-T-xxx
These constants define attribute types of the message handling package.
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
MH-T-A3-WIDTH
MH-T-ACTION
MH-T-ACTUAL-RECIPIENT-NAME
MH-T-ADMD-NAME
MH-T-ALGORITHM-DATUM
MH-T-ALGORITHM-ID
MH-T-ALGORITHM-RESULT
MH-T-ALGORITHM
MH-T-ALTERNATE-RECIP-ALLOWED
MH-T-ARRIVAL-TIME
MH-T-ASNI-ENCODED-DATA
MH-T-ATTEMPTED-ADMD-NAME
MH-T-ATTEMPTED-COUNTRY-NAME
MH-T-ATTEMPTED-MTA-NAME
MH-T-ATTEMPTED-PRMD-IDENTIFIER
MH-T-B4-LENGTH
MH-T-B4-WIDTH
MH-T-BILATERAL-INFORMATION
MH-T-BINARY-CONTENT
MH-T-BUILTIN-EITS
MH-T-COMMON-NAME
MH-T-CONTENT
MH-T-CONTENT-EXTENSIONS
MH-T-CONTENT-IDENTIFIER
MH-T-CONTENT-LENGTH
MH-T-CONTENT-RETURN-REQUESTED
MH-T-CONTENT-TYPE
MH-T-CONTROL-CHARACTER-SETS
MH-T-CONVERSION-PROHIBITED
MH-T-CONVERTED-EITS
MH-T-COUNTRY-NAME
MH-T-CRITICAL-FOR-DELIVERY
MH-T-CRITICAL-FOR-SUBMISSION
MH-T-CRITICAL-FOR-TRANSFER
MH-T-DEFERRED-DELIVERY-TIME
MH-T-DEFERRED-TIME
MH-T-DELIVERY-POINT
MH-T-DELIVERY-TIME
MH-T-DIRECTORY-NAME
MH-T-DISCLOSURE-ALLOWED
MH-T-DOMAIN-TYPE-1
MH-T-DOMAIN-TYPE-2
MH-T-DOMAIN-TYPE-3
MH-T-DOMAIN-TYPE-4
MH-T-DOMAIN-VALUE-1
MH-T-DOMAIN-VALUE-2
MH-T-DOMAIN-VALUE-3
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A- 9
200.
201.
202.
203.
204.
205.
206.
396.
207.
209.
373.
210.
211.
212.
213.
214.
215.
216.
217.
218.
220.
222.
219.
224.
225.
226.
227.
228.
230.
231.
232.
233.
234.
235.
236.
237.
239.
240.
374.
242.
244.
245.
246.
247.
248.
249.
250.
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
CONSTANT
CONSTANT
MH-T-DOMAIN-VALUE-4
MH-T-EXPANSION-HISTORY
MH-T-EXPANSION-PROHIBITED
MH-T-EXPLICIT-CONVERSION
MH-T-EXTENSION-TYPE
MH-T-EXTENSION-VALUE
MH-T-EXTENSIONS
MH-T-EXTERNAL-EITS
MH-T-EXTERNAL-TRACE-INFO
MH-T-EXT-CRIT-FOR-DELIVERY
MH-T-EXT-CRIT-FOR-SUBMISSION
MH-T-EXT-CRIT-FOR-TRANSFER
MH-T-FINE-RESOLUTION
MH-T-G3-FAX-NBPS
MH-T-G4-FAX-NBPS
MH-T-GENERATION
MH-T-GIVEN-NAME
MH-T-GRAPHIC-CHARACTER-SETS
MH-T-INFORMATION
MH-T-INITIALS
MH-T-INTENDED-RECIPIENT-NAME
MH-T-INTENDED-RECIPIENT-NUMBER
MH-T-INTERNAL-TRACE-INFO
MH-T-LOCAL-IDENTIFIER
MH-T-MISC-CAPABILITIES
MH-T-MTA-NAME
MH-T-MTA-REPORT-REQUEST
MH-T-MTA-RESPONSIBLITY
MH-T-MTS-IDENTIFIER
MH-T-NAME
MH-T-NON-DELIVERY-DIAGNOSTIC
MH-T-NON-DELIVERY-REASON
MH-T-NUMERIC-USER-IDENTIFIER
MH-T-ORGANIZATION-NAME
MH-T-ORGANIZATIONAL-UNIT-NME-1
MH-T-ORGANIZATIONAL-UNIT-NME-2
MH-T-ORGANIZATIONAL-UNIT-NME-3
MH-T-ORGANIZATIONAL-UNIT-NME-4
MH-T-ORIGINAL-EITS
MH-T-ORIGINATOR-NAME
MH-T-ORIGINATOR-REPORT-REQUES
MH-T-OTHER-RECIPIENT-NAMES
MH-T-PAGE-FORMATS
MH-T-PER-RECIPIENT-REPORTS
MH-T-PREFERRED-DELIVERY-MODES
MH-T-PRIORITY
MH-T-PRIVACY-MARK
MH-T-PRIVATE-USE
MH-T-PRMD-IDENTIFIER
MH-T-PRMD-NAME
MH-T-RECIPIENT-DESCRIPTORS
MH-T-RECIPIENT-NAME
MH-T-RECIPIENT-NUMBER
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -10
251.
254.
255.
256.
257.
258.
259.
260.
261.
397.
398.
399.
262.
266.
267.
268.
269.
270.
271.
272.
274.
275.
276.
280.
281.
283.
284.
285.
286.
287.
288.
289.
290.
291.
292.
293.
294.
295.
297.
299.
300.
302.
303.
304.
322.
324.
403.
326.
327.
328.
338.
339.
340.
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-INFO
MH-T-SURNAME
MH-T-TELETEX-NBPS
MH-T-TERMINAL-IDENTIFIER
MH-T-TERMINAL-TYPE
MH-T-TIME
MH-T-TWO-DIMENSIONAL
MH-T-UNCOMPRESSED
MH-T-UNLIMITED-LENGTH
MH-T-X121-ADDRESS
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
345.
346.
347.
348.
349.
353.
404.
402.
401.
359.
360.
361.
362.
364.
365.
366.
368.
369.
370.
372.
Message Handling Value Limits
Message handling constants are also used to specify maximum value lengths and the
maximum number of values for multivalued attributes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -11
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.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-VL-ADMD-NAME
MH-VL-ATTEMPTED-ADMD-NAME
MH-VL-ATTEMPTED-COUNTRY-NAME
MH-VL-ATTEMPTED-MTA-NAME
MH-VL-ATTEMPTED-PRMD-IDENTIFIER
MH-VL-COMMON-NAME
MH-VL-CONTENT-IDENTIFIER
MH-VL-COUNTRY-NAME
MH-VL-DOMAIN-TYPE
MH-VL-DOMAIN-VALUE
MH-VL-GENERATION
MH-VL-GIVEN-NAME
MH-VL-INFORMATION
MH-VL-INITIALS
MH-VL-LOCAL-IDENTIFIER
MH-VL-MTA-NAME
MH-VL-NUMERIC-USER-IDENTIFIER
MH-VL-ORGANIZATION-NAME
MH-VL-ORGANIZATION-UNIT-NAMES
MH-VL-PRIVACY-MARK
MH-VL-PRIVATE-USE
MH-VL-PRMD-IDENTIFIER
MH-VL-PRMD-NAME
MH-VL-REPORT-ADDITIONAL-INFO
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
16.
16.
3.
32.
16.
64.
16.
3.
8.
128.
3.
16.
1024.
5.
32.
32.
32.
64.
32.
128.
128.
16.
16.
1024.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-VL-SUPPLEMENTARY-INFO
MH-VL-SURNAME
MH-VL-TERMINAL-IDENTIFIER
MH-VL-TIME
MH-VL-X121-ADDRESS
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
256
40.
24.
17.
15.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -12
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
This subsection provides definitions of constants for enumerated values of the message
handling package. For descriptions of the enumerated values, see the description of the
associated attribute in Message Handling Classes on page 3-5.
MH-xxx for MH-T-SECURITY-POLICY-ID
This contstant defines the enumerated value for the MH-T-SECURITY-POLICY-ID
attribute.
CONSTANT MH-SECURITY-POLICY-ID
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x05".
MH-AC-xxx
These constants define the enumerated values for the MH-T-ACTION attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-AC-EXPANDED
MH-AC-REDIRECTED
MH-AC-RELAYED
MH-AC-REROUTED
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
32
32
32
32
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -13
IS
IS
IS
IS
-2.
-1.
0.
1.
Message Handling Enumerated Values
DDL Definitions
MH-BE-xxx
These constants define the enumerated values for the MH-T-BUILTIN-EITS attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-BE-UNDEFINED
MH-BE-TELEX
MH-BE-IA5-TEXT
MH-BE-G3-FAX
MH-BE-G4-CLASS1
MH-BE-TELETEX
MH-BE-VIDEOTEX
MH-BE-MIXED-MODE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
32
32
32
32
32
32
32
32
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
9.
MH-EE-xxx
These constants define the enumerated values for the MH-T-EXTERNAL-EITS
attribute. The values are encoded ASN.1 object identifiers. Note that a different
notation is used to encode ASN.1 object identifiers in TAL; for example, in TAL , the
value for CONSTANT MH-EE-G3-FAX is:
%h56,%h03,%h04,%h03
CONSTANT MH-EE-ACP127-DATA
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x07\x0C".
CONSTANT MH-EE-ADATP3
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x07\x00".
CONSTANT MH-EE-CORRECTIONS
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x07\x01".
CONSTANT MH-EE-FOR-ENC
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x07\x06".
CONSTANT MH-EE-G3-FAX
VALUE IS "\x56\x03\x04\x03".
CONSTANT MH-EE-G4-CLASS1
VALUE IS "\x56\x03\x04\x04".
CONSTANT MH-EE-IA5-TEXT
VALUE IS "\x56\x03\x04\x02".
CONSTANT MH-EE-MIXED-MODE
VALUE IS "\x56\x03\x04\x09".
CONSTANT MH-EE-MM-MESSAGE
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x07\x09".
CONSTANT MH-EE-TELETEX
VALUE IS "\x56\x03\x04\x05".
CONSTANT MH-EE-TELEX
VALUE IS "\x56\x03\x04\x01".
CONSTANT MH-EE-UNDEFINED
VALUE IS "\x56\x03\x04\x00".
CONSTANT MH-EE-VIDEOTEX
VALUE IS "\x56\x03\x04\x06".
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -14
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.
MH-CTO-xxx
These constants define the enumerated values of syntax OM-S-OBJECT-ID-STRING
for the MH-T-CONTENT-TYPE attribute. The values are encoded 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,%h03,%h03,%h01
CONSTANT MH-CTO-INNER-MESSAGE
VALUE IS "\x56\x03\x03\x01".
CONSTANT MH-CTO-P772
VALUE IS "\x2B\x1A\x00\xA2\x36\x00\x04\x01".
CONSTANT MH-CTO-UNIDENTIFIED
VALUE IS "\x56\x03\x03\x00".
MH-DP-xxx
These constants define the enumerated values for the MH-T-DELIVERY-POINT
attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
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
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
32
32
32
32
32
32
32
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
MH-EC-xxx
These constants define the enumerated values for the MH-T-EXPLICIT-CONVERSION
attribute. The first line shows the complete definition for each constant, which is
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -15
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.
MH-EC-NO-CONVERSION
MH-EC-IA5-TEXT-TO-TELETEX
MH-EC-TELETEX-TO-TELEX
MH-EC-TELEX-TO-IA5-TEXT
MH-EC-TELEX-TO-TELETEX
MH-EC-TELEX-TO-G4-CLASS1
MH-EC-TELEX-TO-VIDEOTEX
MH-EC-IA5-TEXT-TO-TELEX
MH-EC-TELEX-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G3-FAX
MH-EC-IA5-TEXT-TO-G4-CLASS1
MH-EC-IA5-TEXT-TO-VIDEOTEX
MH-EC-TELETEX-TO-IA5-TEXT
MH-EC-TELETEX-TO-G3-FAX
MH-EC-TELETEX-TO-G4-CLASS1
MH-EC-TELETEX-TO-VIDEOTEX
MH-EC-VIDEOTEX-TO-TELEX
MH-EC-VIDEOTEX-TO-IA5-TEXT
MH-EC-VIDEOTEX-TO-TELETEX
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
-1.
0.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
MH-RQ-xxx
These constants define the enumerated values for the MH-T-MTA-REPORT-REQUEST
and MH-T-ORIGINATOR-REPORT-REQUEST attributes.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-RQ-NEVER
MH-RQ-NON-DELIVERY
MH-RQ-ALWAYS
MH-RQ-ALWAYS-AUDITED
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
32
32
32
32
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
0.
1.
2.
3.
MH-DG-xxx
These constants define the enumerated values for the MH-T-NON-DELIVERYDIAGNOSTIC attribute. The first line shows the complete definition for each constant,
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -16
Message Handling Enumerated Values
DDL Definitions
which is followed by an abbreviated definition that substitutes ... for the TYPE portion
of the definition.
CONSTANT MH-DG-xxx
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
TYPE BINARY 32 VALUE IS x.
MH-DG-NO-DIAGNOSTIC
MH-DG-OR-NAME-UNRECOGNIZED
MH-DG-OR-NAME-AMBIGUOUS
MH-DG-MTS-CONGESTED
MH-DG-LOOP-DETECTED
MH-DG-RECIPIENT-UNAVAILABLE
MH-DG-MAXIMUM-TIME-EXPIRED
MH-DG-EITS-UNSUPPORTED
MH-DG-CONTENT-TOO-LONG
MH-DG-IMPRACTICAL-TO-CONVERT
MH-DG-PROHIBITED-TO-CONVERT
MH-DG-CONVERSION-UNSUBSCRIBED
MH-DG-PARAMETERS-INVALID
MH-DG-CONTENT-SYNTAX-IN-ERROR
MH-DG-LENGTH-CONSTRAINT-VIOLTD
MH-DG-NUMBER-CONSTRAINT-VIOLTD
MH-DG-CONTENT-TYPE-UNSUPPORTED
MH-DG-TOO-MANY-RECIPIENTS
MH-DG-NO-BILATERAL-AGREEMENT
MH-DG-CRITICAL-FUNC-UNSUPPORTD
MH-DG-CONVERSION-LOSS-PROHIB
MH-DG-LINE-TOO-LONG
MH-DG-PAGE-TOO-LONG
MH-DG-PICTORIAL-SYMBOL-LOST
MH-DG-PUNCTUATION-SYMBOL-LOST
MH-DG-ALPHABETIC-CHAR-LOST
MH-DG-MULTIPLE-INFO-LOSSES
MH-DG-REASSIGNMENT-PROHIBITED
MH-DG-REDIRECTION-LOOP-DETECTD
MH-DG-EXPANSION-PROHIBITED
MH-DG-SUBMISSION-PROHIBITED
MH-DG-EXPANSION-FAILED
MH-DG-RENDITION-UNSUPPORTED
MH-DG-MAIL-ADDRESS-INCORRECT
MH-DG-MAIL-OFFICE-INCOR-OR-INV
MH-DG-MAIL-ADDRESS-INCOMPLETE
MH-DG-MAIL-RECIPIENT-UNKNOWN
MH-DG-MAIL-RECIPIENT-DECEASED
MH-DG-MAIL-ORGANIZATION-EXPIRD
MH-DG-MAIL-REFUSED
MH-DG-MAIL-UNCLAIMED
MH-DG-MAIL-RECIPIENT-MOVED
MH-DG-MAIL-RECIPIENT-TRAVELING
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -17
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
-1.
0.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
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. 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-RE-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32 VALUE IS x.
MH-RE-TRANSFER-FAILED
MH-RE-TRANSFER-IMPOSSIBLE
MH-RE-CONVERSION-NOT-PERFORMED
MH-RE-PHYSICAL-RENDTN-NOT-DONE
MH-RE-PHYSICAL-DELIV-NOT-DONE
MH-RE-RESTRICTED-DELIVERY
MH-RE-DIRECTORY-OPERATN-FAILED
...
...
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
MH-DM-xxx
These constants define the enumerated values for the MH-T-PREFERRED-DELIVERYMODES attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
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
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
32
32
32
32
32
32
32
32
32
32
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -18
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
7.
8.
9.
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.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
MH-TT-TELEX
MH-TT-TELETEX
MH-TT-G3-FAX
MH-TT-G4-FAX
MH-TT-IA5-TERMINAL
MH-TT-VIDEOTEX
TYPE
TYPE
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
BINARY
BINARY
32
32
32
32
32
32
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -19
IS
IS
IS
IS
IS
IS
3.
4.
5.
6.
7.
8.
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.
IM-C-ACP127-DATA-BODY-PART
IM-C-ACP127-NOTIFICATION
IM-C-ACP127-NOTIFICATION-RSP
IM-C-ADATP3-BODY-PART
IM-C-ADDRESS-LIST-DESIGNATOR
IM-C-BILAT-DEFINED-BODY-PART
IM-C-CORRECTIONS-BODY-PART
IM-C-DISTRIBUTION-CODES
IM-C-EXTERN-DEFINED-BODY-PART
IM-C-FORWARDED-ENC-BODY-PART
IM-C-G3-FAX-BODY-PART
IM-C-G4-CLASS-1-BODY-PART
IM-C-IA5-TEXT-BODY-PART
IM-C-INTERPERSONAL-MESSAGE
IM-C-IPM-IDENTIFIER
IM-C-ISO-6937-TEXT-BODY-PART
IM-C-MESSAGE-BODY-PART
IM-C-MESSAGE-TYPE
IM-C-MIXED-MODE-BODY-PART
IM-C-MM-MESSAGE-BODY-PART
IM-C-NAT-DEFINED-BODY-PART
IM-C-NON-RECEIPT-NOTIFICATION
IM-C-OR-DESCRIPTOR
IM-C-OTHER-RECIP-DESIGNATOR
IM-C-PILOT-INFORMATION
IM-C-RECEIPT-NOTIFICATION
IM-C-RECIPIENT-SPECIFIER
IM-C-TELETEX-BODY-PART
IM-C-UNIDENTIFIED-BODY-PART
IM-C-VIDEOTEX-BODY-PART
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -20
140.
141.
142.
136.
132.
100.
137.
133.
102.
138.
103.
104.
105.
106.
108.
109.
110.
131.
111.
139.
112.
113.
114.
134.
135.
115.
116.
117.
121.
118.
DDL Definitions
Interpersonal Messaging Classes and Types
IM-T-xxx
These constants define attribute types of the interpersonal messaging package.
IM-T-ACKNOWLEDGMENT-MODE
IM-T-ACP127-DATA-DATA
IM-T-ACP127-DATA-PARAMETERS
IM-T-ACP127-MESSAGE-IDENTIFIER
IM-T-ACP127-NOTIFICATION-TYPE
IM-T-ACP127-NOTIFICATION-RSP
IM-T-ACP127-RECIPIENT
IM-T-ACP127-SUPP-INFO
IM-T-ADATP3-PARAMETERS
IM-T-ADDRESS-LIST-INDICATOR
IM-T-ALD-LIST-NAME
IM-T-ALD-NOTIFICATION-REQUEST
IM-T-ALD-REPLY-REQUEST
IM-T-ALD-TYPE
IM-T-AUTHORIZING-USERS
IM-T-AUTO-FORWARDED-COMMENT
IM-T-AUTO-FORWARDED
IM-T-BILATERAL-DATA
IM-T-BLIND-COPY-RECIPIENTS
IM-T-BODY
IM-T-CODRESS-MESSAGE
IM-T-CONVERSION-EITS
IM-T-COPY-PRECEDENCE
IM-T-COPY-RECIPIENTS
IM-T-CORRECTIONS-DATA
IM-T-CORRECTIONS-PARAMETERS
IM-T-DISCARD-REASON
IM-T-DIST-EXTENSIONS
IM-T-DISTRIBUTION-CODES
IM-T-ENVELOPE
IM-T-EXEMPTED-ADDRESS
IM-T-EXTENDED-AUTH-INFO
IM-T-EXPIRY-TIME
IM-T-EXTENSIONS
IM-T-EXTERNAL-DATA
IM-T-EXTERNAL-PARAMETERS
IM-T-FORMAL-NAME
IM-T-FORWARDED-ENC-DATA
IM-T-FORWARDED-ENVELOPE
IM-T-FREE-FORM-NAME
IM-T-G3-FAX-NBPS
IM-T-G4-CLASS-1-DOCUMENT
IM-T-HANDLING-INSTRUCTIONS
IM-T-IMAGES
IM-T-IMPORTANCE
IM-T-IPM
IM-T-IPM-INTENDED-RECIPIENT
IM-T-IPM-RETURN-REQUESTED
VALUE IS 100.
VALUE IS 514.
VALUE IS 513.
VALUE IS 169.
VALUE IS 185.
VALUE IS 186.
VALUE IS 187.
VALUE IS 188.
VALUE IS 502.
VALUE IS 159.
VALUE IS 174.
VALUE IS 175.
VALUE IS 176.
VALUE IS 173.
VALUE IS 101.
VALUE IS 102.
VALUE IS 103.
VALUE IS 104.
VALUE IS 105.
VALUE IS 106.
VALUE IS 165.
VALUE IS 107.
VALUE IS 157.
VALUE IS 108.
VALUE IS 505.
VALUE IS 503.
VALUE IS 109.
VALUE IS 178.
VALUE IS 162.
VALUE IS 110.
VALUE IS 160.
VALUE IS 161.
VALUE IS 111.
VALUE IS 197.
VALUE IS 112.
VALUE IS 113.
VALUE IS 114.
VALUE IS 508.
VALUE IS 507
VALUE IS 115.
VALUE IS 116.
VALUE IS 117.
VALUE IS 163.
VALUE IS 118.
VALUE IS 119.
VALUE IS 121.
VALUE IS 122.
VALUE IS 123.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -21
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-PILOT-PRECEDENCE
IM-T-PILOT-RECIPIENT
IM-T-PILOT-SECURITY
IM-T-PRIMARY-PRECEDENCE
IM-T-PRIMARY-RECIPIENTS
IM-T-RECEIPT-TIME
IM-T-RECIPIENT
IM-T-RELATED-IPMS
IM-T-REPERTOIRE
IM-T-REPLIED-TO-IPM
IM-T-REPLY-RECIPIENTS
IM-T-REPLY-REQUESTED
IM-T-REPLY-TIME
IM-T-RETURNED-IPM
IM-T-SENSITIVITY
IM-T-SET-ORIENTED-DATA
IM-T-SIC
IM-T-SUBJECT
IM-T-SUBJECT-IPM
IM-T-SUPPL-RECEIPT-INFO
IM-T-TELEPHONE-NUMBER
IM-T-TELETEX-DOCUMENT
IM-T-TELETEX-NBPS
IM-T-TELEX-COMPATIBLE
IM-T-TEXT
Interpersonal Messaging Classes and Types
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -22
124.
198.
199.
515.
172.
164.
158.
126.
511.
510.
127.
128.
129.
130.
180.
179.
131.
166.
170.
167.
168.
184.
181.
182.
183.
156.
132.
133.
134.
135.
136.
137.
138.
139.
140.
141.
142.
516.
177.
143.
144.
145.
146.
147.
148.
149.
150.
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 ... for the TYPE portion of the definition
CONSTANT IM-VL-xxx
TYPE BINARY 32 UNSIGNED VALUE IS x.
CONSTANT IM-LB-SIC
CONSTANT IM-NUM-SICS
CONSTANT IM-UB-SIC
...
...
...
VALUE IS 3.
VALUE IS 8.
VALUE IS 8.
IM-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 IM-VL-xxx
TYPE BINARY 32 UNSIGNED VALUE IS x.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
IM-VL-ACP127-DATA-DATA
IM-VL-ACP127-MESG-IDENTIFIER
IM-VL-ACP127-RECIPIENT
IM-VL-AUTO-FORWARD-COMMENT
IM-VL-FREE-FORM-NAME
IM-VL-HANDLING-INSTRUCTIONS
...
...
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
IM-VL-MESSAGE-IDENTIFIER
IM-VL-MESSAGE-INSTRUCTIONS
IM-VL-ORD-DESIGNATOR
IM-VL-ORIGINATOR-IDENTIFIER
IM-VL-ORIGINATOR-PLAD
IM-VL-PILOT-HANDLING
IM-VL-SUBJECT
IM-VL-SUPP-INFO
IM-VL-SUPPL-RECEIPT-INFO
IM-VL-TELEPHONE-NUMBER
IM-VL-TIME
IM-VL-USER-RELATIVE-IDENTIFIER
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE IS 65535.
VALUE IS 69
VALUE IS 128.
VALUE IS 256.
VALUE IS 128.
VALUE IS 69.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
69.
69.
69.
69.
69.
69.
256.
128.
256.
32.
17.
64.
Interpersonal Messaging Enumerated Values
This subsection provides definitions of constants for enumerated values of the
interpersonal messaging package. For descriptions of the enumerated values, see the
description of the associated attribute in Interpersonal Messaging Classes in Section 3.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -24
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.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
IM-NO-DISCARD
IM-IPM-EXPIRED
IM-IPM-OBSOLETED
IM-USER-TERMINATED
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
32
32
32
32
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
-1.
0.
1.
2.
IM-xxx (IM-T-REPERTOIRE)
These constants define the enumerated values for the IM-T-REPERTOIRE attribute.
CONSTANT IM-ITA2
CONSTANT IM-IA5
TYPE BINARY 32
TYPE BINARY 32
VALUE IS 2.
VALUE IS 5.
IM-xxx (IM-T-ISO-6937-REPERTOIRE)
These constants define the enumerated values for the IM-T-ISO-6937-REPERTOIRE
attribute.
CONSTANT IM-GRAPHIC
CONSTANT IM-PART1-AND-PART2
CONSTANT IM-TELETEX
TYPE BINARY 32
TYPE BINARY 32
TYPE BINARY 32
VALUE IS 1.
VALUE IS 2.
VALUE IS 3.
IM-xxx (IM-T-IMPORTANCE)
These constants define the enumerated values for the IM-T-IMPORTANCE attribute.
CONSTANT IM-LOW
CONSTANT IM-ROUTINE
CONSTANT IM-HIGH
TYPE BINARY 32
TYPE BINARY 32
TYPE BINARY 32
VALUE IS 0.
VALUE IS 1.
VALUE IS 2.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -25
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.
CONSTANT IM-NEVER
CONSTANT IM-NON-RECEIPT
CONSTANT IM-ALWAYS
TYPE BINARY 32
TYPE BINARY 32
TYPE BINARY 32
VALUE IS 0.
VALUE IS 1.
VALUE IS 2.
IM-xxx (IM-T-SENSITIVITY)
These constants define the enumerated values for the IM-T-SENSITIVITY attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
IM-NOT-SENSITIVE
IM-PERSONAL
IM-PRIVATE
IM-COMPANY-CONFIDENTIAL
TYPE
TYPE
TYPE
TYPE
BINARY
BINARY
BINARY
BINARY
32
32
32
32
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
0.
1.
2.
3.
IM-xxx (IM-T-VIDEOTEX-SYNTAX)
These constants define the enumerated values for the IM-T-VIDEOTEX-SYNTAX
attribute.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
IM-UNSPECIFIED
IM-IDS
IM-DATA-SYNTAX-1
IM-DATA-SYNTAX-2
IM-DATA-SYNTAX-3
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
-1.
0.
1.
2.
3.
Electronic Data Interchange (EDI) Classes and Types
The electronic data interchange constants are used to specify the objects of the electronic
data interchange package. For descriptions of the object classes and attribute types, see
Electronic Data Interchange Messaging Classes on page 3-137.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -26
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".
CONSTANT EDI-C-EDI-APP-SECUR-ELTS
VALUE IS "\x56\x06\x01\x02\x07\x01\x02".
CONSTANT EDI-C-EDI-BODYPART
VALUE IS "\x56\x06\x01\x02\x07\x01\x03".
CONSTANT EDI-C-EDI-EXTENSION
VALUE IS "\x56\x06\x01\x02\x07\x01\x04".
CONSTANT EDI-C-EDI-HEADING
VALUE IS "\x56\x06\x01\x02\x07\x01\x05".
CONSTANT EDI-C-EDI-NOTIF-REQUESTS
VALUE IS "\x56\x06\x01\x02\x07\x01\x07".
CONSTANT EDI-C-EDIM
VALUE IS "\x56\x06\x01\x02\x07\x01\x08".
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -27
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".
CONSTANT EDI-C-FN-USER-REASON-CODE
VALUE IS "\x56\x06\x01\x02\x07\x01\x10".
CONSTANT EDI-C-FORWARD-NOTIF
VALUE IS "\x56\x06\x01\x02\x07\x01\x11".
CONSTANT EDI-C-INTER-SENDER-RECIP
VALUE IS "\x56\x06\x01\x02\x07\x01\x12".
CONSTANT EDI-C-NEGATIVE-NOTIF
VALUE IS "\x56\x06\x01\x02\x07\x01\x13".
CONSTANT EDI-C-NN-PDAU-REASON-CODE
VALUE IS "\x56\x06\x01\x02\x07\x01\x14".
CONSTANT EDI-C-NN-UAMS-REASON-CODE
VALUE IS "\x56\x06\x01\x02\x07\x01\x16".
CONSTANT EDI-C-NN-USER-REASON-CODE
VALUE IS "\x56\x06\x01\x02\x07\x01\x17".
CONSTANT EDI-C-POSITIVE-NOTIF
VALUE IS "\x56\x06\x01\x02\x07\x01\x18".
CONSTANT EDI-C-RECIP-REFERENCE
VALUE IS "\x56\x06\x01\x02\x07\x01\x1B".
CONSTANT EDI-C-RECIPS
VALUE IS "\x56\x06\x01\x02\x07\x01\x1C".
CONSTANT EDI-C-SECUR-ELEMENTS
VALUE IS "\x56\x06\x01\x02\x07\x01\x1D".
CONSTANT EDI-C-SERV-STRING-ADVICE
VALUE IS "\x56\x06\x01\x02\x07\x01\x1E".
CONSTANT EDI-C-SYNTAX-ID
VALUE IS "\x56\x06\x01\x02\x07\x01\x1F".
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -28
DDL Definitions
Electronic Data Interchange (EDI) Classes and
Types
EDI-T-xxx
These constants define attribute types of the electronic data interchange package.
EDI-T-ACKNOWLEDGEMENT-REQUEST
EDI-T-ACT-REQUEST
EDI-T-ADD-BODYPARTS
EDI-T-APP-CROSS-REFERENCE
EDI-T-APP-REFERENCE
EDI-T-AUTHORIZATION-INFO
EDI-T-AUTHORIZATION-INFO-Q
EDI-T-BASIC-CODE
EDI-T-BODY
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -29
1000.
1001.
1002.
1003.
1004.
1007.
1008.
1009.
1010.
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-EDIN-INITIATOR
EDI-T-EDIN-ORIG
EDI-T-EDIN-RECEIVER
EDI-T-EDIN-RECEIVER-NAME
EDI-T-EXPIRY-TIME
EDI-T-EXTENSION-TYPE
EDI-T-EXTENSION-VALUE
EDI-T-EX-BODYPART
EDI-T-FIRST-RECIP
EDI-T-FN-NOTIF-EXTENSIONS
EDI-T-FN-REASON-CODE
EDI-T-FN-SECUR-CHECK
EDI-T-FORWARD-NOTIF
EDI-T-FORWARD-TO
EDI-T-HEADING
EDI-T-HEADING-EXTENSIONS
EDI-T-IDENTIFICATION-CODE
EDI-T-IDENTIFICATION-CODE-Q
EDI-T-INC-COPY
EDI-T-INTER-CONTROL-REFERENCE
EDI-T-INTER-RECIP
EDI-T-INTER-SENDER
EDI-T-MSG-REFERENCE
EDI-T-NEGATIVE-NOTIF
EDI-T-NN-NOTIF-EXTENSIONS
EDI-T-NN-REASON-CODE
EDI-T-NON-REPUD-OF-RECEPTION
EDI-T-NON-REPUD-OF-NOTIF
EDI-T-NOTIF-EXTENSIONS
EDI-T-NOTIF-TIME
EDI-T-OBSOLETED-EDIMS
EDI-T-ORIG
EDI-T-ORIGINAL-CONTENT
EDI-T-ORIGINAL-CONTENT-INTEG-C
Electronic Data Interchange (EDI) Classes and
Types
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -30
1199.
1011.
1012.
1013.
1014.
1015.
1016.
1017.
1018.
1019.
1020.
1005.
1021.
1006.
1022.
1030.
1023.
1024.
1025.
1026.
1027.
1028.
1029.
1031.
1032.
1033.
1034.
1035.
1194.
1036.
1037.
1038.
1039.
1040.
1041.
1042.
1043.
1044.
1045.
1046.
1047.
1048.
1049.
1195.
1050.
1051.
1052.
1053.
1054.
1055.
1056.
1057.
1058.
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-RSF-AUTHORIZATION-INFO
EDI-T-RSF-RECIP-REFERENCE
EDI-T-SECUR-ELEMENTS
EDI-T-SEGMENT-TERMINATOR
EDI-T-SERVICE-STRING-ADVICE
EDI-T-SUBJECT-EDIM
EDI-T-SUPPLEMENTARY-INFO
EDI-T-SYNTAX-ID
EDI-T-SYNTAX-ID-STRING
EDI-T-SYNTAX-VERSION
EDI-T-TEST-INDICATOR
EDI-T-THIS-EDIM
EDI-T-USER
EDI-T-USER-RELATIVE-ID
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
1059.
1196.
1060.
1061.
1062.
1063.
1064.
1065.
1066.
1067.
1068.
1069.
1070.
1071.
1072.
1073.
1074.
1075.
1076.
1197.
1198.
1077.
1078.
1079.
1080.
1081.
1082.
1083.
1084.
1085.
1086.
1087.
1088.
EDI-BPO-xxx
These constants define body-part type attributes 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, %h07, %h0B, %h00
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
EDI-BPO-EDIFACT-ISO646
EDI-BPO-EDIFACT-T61
EDI-BPO-EDIFACT-OCTET
EDI-BPO-ANSIX12-ISO646
EDI-BPO-ANSIX12-T61
EDI-BPO-ANSIX12-OCTET
EDI-BPO-ANSIX12-EBCDIC
EDI-BPO-UNTDI-ISO646
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
"\x56\x07\x0B\x00".
"\x56\x07\x0B\x01".
"\x56\x07\x0B\x02".
"\x56\x07\x0B\x03".
"\x56\x07\x0B\x04".
"\x56\x07\x0B\x05".
"\x56\x07\x0B\x06".
"\x56\x07\x0B\x07".
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -31
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.1 object identifiers in TAL; for example, in TAL, the first value is:
%h56, %h07, %h0D, %h00
CONSTANT EDI-ARO-FOR-ACTION
CONSTANT EDI-ARO-COPY
VALUE IS "\x56\x07\x0D\x00".
VALUE IS "\x56\x07\x0D\x01".
EDI Forwarded Notification Codes
A forwarded notification reports that responsibility of an EDIM has been forwarded
together with the subject EDIM. The forwarded notification codes indicate why EDIM
responsibility has been forwarded. The notification code constants are contained within
the EDI-T-FN-REASON-CODE attribute of the EDI-C-FORWARD-NOTIF class.
EDI-FPB-xxx
These constants specify basic codes related to a physical delivery access unit (PDAU).
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.
CONSTANT EDI-FPB-xxx
TYPE BINARY 32
CONSTANT EDI-FPB-UNSPECIFIED
CONSTANT EDI-FPB-FORWARD-FOR-PD-AND-RND
...
...
VALUE IS x.
VALUE IS 0.
VALUE IS 1.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -32
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.
CONSTANT EDI-FUMB-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32
EDI-FUMB-UNSPECIFIED
EDI-FUMB-ONWARD-ROUTING
EDI-FUMB-RECIP-UNKNOWN
EDI-FUMB-ORIG-UNKNOWN
EDI-FUMB-FORWARD-BY-EDI-MS
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
EDI-FUMD-xxx
These constants specify diagnostic 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.
CONSTANT EDI-FUMD-xxx
TYPE BINARY 32
CONSTANT EDI-FUMD-RECIP-NAME-CHANGED
CONSTANT EDI-FUMD-RECIP-NAME-DELETED
...
...
VALUE IS x.
VALUE IS 1.
VALUE IS 2.
EDI-FUB-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.
CONSTANT EDI-FUB-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32
EDI-FUB-UNSPECIFIED
EDI-FUB-FORWARD-FOR-ARCHIVING
EDI-FUB-FORWARD-FOR-INFO
EDI-FUB-FORWARD-FOR-ADD-INFO
EDI-FUB-SUB-UNCHANGED
EDI-FUB-HEADING-FIELD-NOT-SUPP
EDI-FUB-BODYPART-TYPE-NOT-SUPP
EDI-FUB-MSG-TYPE-NOT-SUPP
EDI-FUB-SYNTAX-ID-NOT-SUPP
EDI-FUB-INTER-SENDER-UNKNOWN
EDI-FUB-USER-DEFINED-REASON
...
...
...
...
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -33
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
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).
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.
CONSTANT EDI-NPB-xxx
TYPE BINARY 32
CONSTANT EDI-NPB-UNSPECIFIED
CONSTANT EDI-NPB-UNDELIV-MAIL
CONSTANT EDI-NPB-P-REND-NOT-PERFORMED
...
...
...
VALUE IS x.
VALUE IS 0.
VALUE IS 1.
VALUE IS 2.
EDI-NPD-xxx
These constants specify diagnostic codes related to a physical delivery access unit
(PDAU). 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.
CONSTANT EDI-NPD-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32
EDI-NPD-P-REND-ATTS-NOT-SUPP
EDI-NPD-PD-ADDRESS-INCORRECT
EDI-NPD-PD-OFFICE-I-OR-INVALID
EDI-NPD-PD-ADDRESS-INC
EDI-NPD-RECIP-UNKNOWN
EDI-NPD-RECIP-DECEASED
EDI-NPD-ORGANIZATION-EXPIRED
EDI-NPD-RECIP-REFUSED-TO-ACCPT
EDI-NPD-RECIP-DID-NOT-CLAIM
EDI-NPD-RECIP-CHANGED-ADDR-P
EDI-NPD-RECIP-CHANGED-ADDR-T
EDI-NPD-RECIP-CHANGED-T-ADDR
EDI-NPD-NEW-ADDRESS-UNKNOWN
EDI-NPD-RECIP-NOT-WANT-FORWARD
EDI-NPD-ORIG-PROHIBITED-FORWRD
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -34
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
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.
CONSTANT EDI-NUMB-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32
EDI-NUMB-UNSPECIFIED
EDI-NUMB-CANNOT-DELIV-TO-USER
EDI-NUMB-DELIV-TIMEOUT
EDI-NUMB-MSG-DISCARDED
EDI-NUMB-SUB-TERMINATED
EDI-NUMB-FORWARDING-ERROR
EDI-NUMB-SECUR-ERROR
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
EDI-NUMD-xxx
These constants specify diagnostic codes related to a user agent or message store
(UAMS). The first line shows the complete definition for each constant. This line is
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -35
EDI Negative Notification Codes
DDL Definitions
followed by an abbreviated definition that substitutes ... for the TYPE portion of the
definition.
CONSTANT EDI-NUMD-xxx
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
TYPE BINARY 32
EDI-NUMD-PROTOCOL-VIOLATION
EDI-NUMD-EDIM-ORIG-UNKNOWN
EDI-NUMD-EDIM-RECIP-UNKNOWN
EDI-NUMD-EDIM-RECIP-AMBIGUOUS
EDI-NUMD-ACT-REQUEST-NOT-SUPP
EDI-NUMD-EDIM-EXPIRED
EDI-NUMD-EDIM-OBSOLETED
EDI-NUMD-DUPLICATE-EDIM
EDI-NUMD-UNSUPP-EXTENSION
EDI-NUMD-INC-COPY-REJECTED
EDI-NUMD-EDIM-TOO-LARGE-FOR-AP
EDI-NUMD-FORWARD-EDIM-NOT-DLIV
EDI-NUMD-FORWARD-EDIM-D-TIME
EDI-NUMD-FORWARD-LOOP-DETECTED
EDI-NUMD-UNABLE-TO-ACCEPT-RESP
EDI-NUMD-INTER-SENDER-UNKNOWN
EDI-NUMD-INTER-RECIP-UNKNOWN
EDI-NUMD-INVALID-HEADING-FIELD
EDI-NUMD-INVALID-BODYPART-TYPE
EDI-NUMD-INVALID-MSG-TYPE
EDI-NUMD-INVALID-SYNTAX-ID
EDI-NUMD-MSG-INTEG-FAIL
EDI-NUMD-FORWARD-MSG-INTEG-FL
EDI-NUMD-UNSUPP-ALGORITHM
EDI-NUMD-DECRYPTION-FAILED
EDI-NUMD-TOKEN-ERROR
EDI-NUMD-UNABLE-TO-SIGN-NOTIF
EDI-NUMD-UNABLE-TO-SIGN-MSG-R
EDI-NUMD-AUTHENTICATION-FAIL
EDI-NUMD-SECUR-CONTEXT-FAIL
EDI-NUMD-MSG-SEQUENCE-FAIL
EDI-NUMD-MSG-SECUR-LABEL-FAIL
EDI-NUMD-REPUDIATION-FAIL
EDI-NUMD-PROOF-OF-FAIL
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -36
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
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.
CONSTANT EDI-NUB-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32
EDI-NUB-UNSPECIFIED
EDI-NUB-SYNTAX-ERROR
EDI-NUB-INTER-SENDER-UNKNOWN
EDI-NUB-INTER-RECIP-UNKNOWN
EDI-NUB-INVALID-HEADING-FIELD
EDI-NUB-INVALID-BODYPART-TYPE
EDI-NUB-INVALID-MSG-TYPE
EDI-NUB-FUNCT-GROUP-NOT-SUPP
EDI-NUB-SUB-TERMINATED
EDI-NUB-NO-BILATERAL-AGREEMENT
EDI-NUB-USER-DEFINED-REASON
...
...
...
...
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
0.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
EDI Notification Initiator Enumerated Values
These constants define the enumerated values for the EDI-T-EDIN-INITIATOR
attribute. The attribute is present in the object classes for forwarded, positive, and
negative notifications. For descriptions of the enumerated values, see the description of
the EDI-T-EDIN-INITIATOR attribute in Electronic Data Interchange Messaging
Classes on page 3-137.
EDI-EI-xxx
CONSTANT EDI-EI-INTERNAL-UA
CONSTANT EDI-EI-EX-UA
CONSTANT EDI-EI-INTERNAL-MS
TYPE BINARY 32
TYPE BINARY 32
TYPE BINARY 32
VALUE IS 0.
VALUE IS 1.
VALUE IS 2.
EDI Value Limits
Electronic data interchange messaging constants are also used to specify maximum
value lengths. 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -37
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-RECIP-REFERENCE
EDI-VL-RECIP-REFERENCE-Q
EDI-VL-ROUTING-ADDRESS
EDI-VL-SUPPLEMENTARY-INFO
EDI-VL-SYNTAX-ID-STRING
EDI-VL-SYNTAX-VERSION
EDI-VL-TIME
EDI-VL-USER-RELATIVE-ID
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE IS x.
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
IS
28.
1025.
4.
70.
12.
70.
8.
28.
2.
28.
4.
28.
512.
8.
5.
17.
64.
GPI External Constants
The GPI external constants are defined for various uses, such as specifying minimum,
maximum, and default values.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -38
GPI External Constants
DDL Definitions
ZGPI-xxx
These names define the GPI external constants. Descriptions of the constants follow the
definitions.
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
ZGPI-WAIT-MODE
ZGPI-MIN-STATUS-BUF-LEN
ZGPI-MAX-STATUS-BUF-LEN
ZGPI-MIN-DANGLING-OBJ
ZGPI-MAX-DANGLING-OBJ
ZGPI-MIN-OT-COUNT
ZGPI-MAX-OT-COUNT
ZGPI-MIN-SESSION-ID
ZGPI-MAX-SESSION-ID
ZGPI-NULL-SESSION-ID
ZGPI-NON-SESSION
ZGPI-ANY
ZGPI-DEFAULT-OT-TBL-COUNT
ZGPI-GWY-NAME-LEN
ZGPI-GWY-INSTANCE-NAME-LEN
ZGPI-MAX-GWY-PASSWORD-LEN
ZGPI-MIN-GWY-PASSWORD-LEN
ZGPI-MAX-LOCAL-ID-LEN
ZGPI-CLASS-UNSPECIFIED
ZGPI-MAX-ERR-ATTR-STRING-LEN
ZGPI-EDI-CLASS-OBJ-ID-LEN
ZGPI-MIN-CLASS-OBJ-ID-LEN
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
0.
1.
512.
1.
80.
1.
15.
1.
15.
-1.
-1.
-2.
2.
32.
32.
62.
0.
32.
0.
16.
7.
1.
For the following GPI external constants, the first line shows the complete definition for
each constant and is followed by an abbreviated definition of each one.
CONSTANT ZGPI-xxx
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
TYPE BINARY 32 VALUE is x.
ZGPI-MIN-OT-TBL-ENTRIES
ZGPI-MAX-OT-TBL-ENTRIES
ZGPI-DEFAULT-OT-TBL-ENTRIE
ZGPI-MIN-OT-DATA-LEN
ZGPI-MAX-OT-DATA-LEN
ZGPI-DEFAULT-OT-DATA-LEN
ZGPI-MIN-LONG-STRING-LEN
ZGPI-DEFAULT-LONG-STRING-LEN
ZGPI-MIN-DESCRIPTOR-COUNT
ZGPI-MAX-DESCRIPTOR-COUNT
ZGPI-POSITION-AT-BEGIN
ZGPI-NEW-VALUE
ZGPI-NULL-OBJ-ID
ZGPI-MAX-RECIPIENTS
ZGPI-MIN-RECIPIENTS
ZGPI-MAX-CONTENT-LEN
ZGPI-MIN-CONTENT-LEN
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
VALUE
50.
1048576.
10000.
2048.
10485760
2097152.
1024.
32767.
1.
10240.
0.
-1.
0.
32767.
1.
2147483647.
0.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -39
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.
ZGPI-MAX-DANGLING-OBJ
is the maximum number of dangling objects checked and returned to your program
during a message transfer.
ZGPI-MIN-OT-COUNT
is the minimum number of root objects processed at one time for each client
process.
ZGPI-MAX-OT-COUNT
is the maximum number of root objects processed at one time for each client
process.
ZGPI-MIN-SESSION-ID
is the minimum number of sessions per client process.
ZGPI-MAX-SESSION-ID
is the maximum number of sessions per client process.
ZGPI-NULL-SESSION-ID
is a session identifier indicating that a session has not been established.
ZGPI-NON-SESSION-ID
is an identifier used in GPI_STATUS_ procedure calls to indicate that you want the
most recent status information that is not related to a known session identifier.
ZGPI-ANY
is an identifier used in GPI_STATUS_ procedure calls to indicate that you want the
most recent status information related to the last GPI procedure call that occurred in
an active session, closed session, or unknown session.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -40
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.
ZGPI-MAX-LOCAL-ID-LEN
is the maximum length (in octets) of the local identifier.
ZGPI-CLASS-UNSPECIFIED
is the initial value of the Z-OBJ-CLASS field in the ZGPI-ERROR-ATTR-DATA
definition and is used to indicate that the class information is not available when the
ZGPI-INFO-1 structure is returned in the information buffer from a GPI_STATUS_
procedure call.
ZGPI-MAX-ERR-ATTR-STRING-LEN
is the maximum number of octets of the string value to be returned in the
ZGPI-INFO-1 structure when the syntax of the offending attribute is
OM-S-xxx-STRING. For more information about this structure, see Information
Buffer on page B-62.
ZGPI-MIN-OT-TBL-ENTRIES
is the minimum number of entries used for each object tree.
ZGPI-MAX-OT-TBL-ENTRIES
is the maximum number of entries used for each object tree.
ZGPI-DEFAULT-OT-TBL-ENTRIES
is the default number of entries used for each object tree.
ZGPI-MIN-OT-DATA-LEN
is the minimum length (in octets) of string data space for each object tree.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -41
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.
ZGPI-DEFAULT-LONG-STRING-LEN
is the maximum length (in octets) for strings that the GPI allows to be passed in an
attribute descriptor. Strings that are longer (long strings) must be accessed using
GPI_OM_READ_ or GPI_OM_WRITE_.
ZGPI-MIN-DESCRIPTOR-COUNT
is the minimum number of attribute descriptors required in a descriptor list.
ZGPI-MAX-DESCRIPTOR-COUNT
is the maximum number of attribute descriptors allowed in a descriptor list.
ZGPI-POSITION-AT-BEGIN
is used to indicate the first attribute position in an object or the first value of an
attribute.
ZGPI-NEW-VALUE
is an indicator to the GPI_OM_WRITE_ procedure that a string segment is to be
inserted as a new value.
ZGPI-NULL-OBJ-ID
is an indicator used to identify an invalid object.
ZGPI-MAX-RECIPIENTS
is the maximum number of recipients that can be specified for the
MH-T-RECIPIENT-NUMBER and MH-T-INTENDED-RECIPIENT-NUMBER
attributes.
ZGPI-MIN-RECIPIENTS
is the minimum number of recipients that can be specified for the
MH-T-RECIPIENT-NUMBER and MH-T-INTENDED-RECIPIENT-NUMBER
attributes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -42
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.
ZGPI-EDI-CLASS-OBJ-ID-LEN
is the number of octets of the EDI class object identifier string that is specified in the
GPI_OM_CREATE_ procedure.
ZGPI-MIN-CLASS-OBJ-ID-LEN
is the minimum number of octets of the class object identifier string that is specified
in the GPI_OM_CREATE_ procedure.
GPI Parameter Positions
The GPI defines the following constants for identifying positions of parameters passed
in calls to the GPI procedures.
CONSTANT ZGPI-PARAM-1
CONSTANT ZGPI-PARAM-2
.
.
.
.
.
.
CONSTANT ZGPI-PARAM-20
VALUE
VALUE
.
.
.
VALUE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
A -43
1.
2.
.
.
.
20.
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. The following information is provided:
•
•
•
•
A method for checking the status of a procedure call
The values of return codes passed in the status parameter of each procedure (as
well as in the old-status and primary-code parameters of the
GPI_STATUS_ procedure)
Descriptions of the various types of information returned by the GPI_STATUS_
procedure: request types, error classes, primary codes, and secondary codes.
Descriptions of the five versions of information returned in the GPI_STATUS_
information buffer
Status Checking
Each GPI procedure returns a code in the status parameter that indicates the success
or failure of the procedure call. You can use the DDL constants that represent return
codes to check the value returned. The types of codes returned are identified by the
following prefixes:
OM-RC-
Object-management return codes that conform to the XAPIA-1988
specification
MH-RC-
Message-handling return codes that conform to the XAPIA-1988
specification
ZGPI-RC-
Compaq proprietary return codes
In most cases, ZGPI-RC- codes are returned by the GPI_STATUS_ procedure as
primary codes. However, the following codes can be returned in the status parameter
of any procedure:
ZGPI-RC-USESEGMENT-ERROR
ZGPI-RC-MISSING-REQUIRED-PARAMETER
ZGPI-RC-MISSING-OPTIONAL-PARAMETER
ZGPI-RC-PARAMETER-OUT-OF-BOUND
ZGPI-RC-PARAMETER-OUT-OF-RANGE
For descriptions of these codes, see Compaq Proprietary Codes on page B-14on
page B-14.
A value of OM-RC-SUCCESS (zero) indicates that the procedure was successful. If the
value is greater than OM-RC-SUCCESS, you can do either of the following:
•
Take immediate action based on the status. For example, the return code
MH-RC-NOT-RESERVED indicates you tried to perform an operation on an object,
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 1
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.
The GPI_STATUS_ procedure returns a primary code, secondary code, and error
class, along with other useful information. For example, if the return code is
OM-RC-NO-SUCH-OBJECT, you can call GPI_STATUS_ to get the secondary
code value. In this case, the secondary code indicates the specific cause of the error;
for example, the secondary code ZGPI-NSOC-ELMT-ALREADY-DELETED
indicates the object you specified has already been deleted.
When you call the GPI_STATUS_ procedure, first check the status parameter to
make sure your request for more information was successful. Next, consider the other
information returned to determine what action to take. For more information about
recovering from errors, see GPI_STATUS_ Information on page B-10.
Standard X.400 API Return Codes
This subsection describes the standard return codes that can be values of the status,
old-status, and primary-code parameters.
Object-Management Return Codes
Table B-1 summarizes the OM-RC- return codes you can receive from an object
management procedure and explains what they mean. A more detailed description of
each value follows the table. (The OM-RC-SUCCESS code is also returned to message
handling procedures that succeed.)
Table B-1. Return Code Values for Object Management (page 1 of 2)
Constant (OM-RC-)
Value
Meaning
SUCCESS
0
Operation succeeded.
FUNCTION-DECLINED
2
Function does not apply to object or cannot be
performed.
FUNCTION-INTERRUPTED
3
Function aborted because of action taken by client
program unrelated to GPI procedure calls.
MEMORY-INSUFFICIENT
4
More main memory needed.
NETWORK-ERROR
5
Service could not employ required network.
NO-SUCH-CLASS
6
Specified class is undefined.
NO-SUCH-OBJECT
9
Specified object is undefined.
NO-SUCH-SYNTAX
12
Specified syntax is undefined.
NO-SUCH-TYPE
13
Specified type is undefined.
NOT-PRESENT
17
Attribute value is not present.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 2
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).
TOO-MANY-VALUES
24
Limit to number of values in object exceeded.
VALUES-NOT-ADJACENT
25
Descriptors for values of an attribute are not
adjacent.
WRONG-VALUE-LENGTH
26
Attribute value exceeds length limit.
WRONG-VALUE-MAKEUP
27
Attribute value violates valid syntax constraint.
WRONG-VALUE-NUMBER
28
Specified number does not refer to an existing
value.
WRONG-VALUE-SYNTAX
29
Specified syntax not valid for attribute.
WRONG-VALUE-TYPE
30
Specified attribute type not valid for object.
Note. Three ZGPI-RC- codes defined in the DDL file are equivalent to OM-RC- codes.
Specifically, ZGPI-RC-SUCCESS is equivalent to OM-RC-SUCCESS,
ZGPI-RC-OTHER-ERROR is equivalent to OM-RC-PERMANENT-ERROR,
ZGPI-RC-WARNING is equivalent to OM-RC-TEMPORARY-ERROR. Use the DDL name that
follows the conventions for application development in your organization and makes your
program most readable.
0 OM-RC-SUCCESS
Cause. The operation was successfully completed.
Effect. The application can proceed with the next step.
Recovery. None is required.
2 OM-RC-FUNCTION-DECLINED
Cause. The procedure you called performs a function that does not apply to the object
you specified. For example, you tried to transfer out an object that is not a root object.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-FDC-). Take the recovery action recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 3
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. For example, you have exceeded the string buffer space while creating an
object.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-MIC-). Take the recovery action recommended for the error class.
5 OM-RC-NETWORK-ERROR
Cause. The GPI service could not access or use the network.
Effect. The function is not performed.
Recovery. Try the operation again.
6 OM-RC-NO-SUCH-CLASS
Cause. You specified a class that is not defined. For example, you tried to create an
object of an undefined class.
Effect. The function is not performed.
Recovery. Call GPI_OM_CREATE_ again with a valid DDL name for the class of
object you are creating. See Section 3, Object Classes and Attribute Types. You can
call GPI_STATUS_ , which returns the invalid class as the secondary code.
9 OM-RC-NO-SUCH-OBJECT
Cause. You specified a nonexistent object identifier. For example, you tried to specify
the object identifier of an object that has been deleted or transferred out.
The object identifier must be one returned by GPI_OM_CREATE_ ,
GPI_OM_COPY_ , GPI_MT_START_TRANSFER_IN_ , or GPI_OPEN_.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-NSOC-). Take the recovery action recommended for the error class. If the
secondary code is less than 1000, it indicates the type of attribute that could not be
found.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 4
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. Specify one of the attribute types described in Section 3, Object Classes and
Attribute Types. You can call GPI_STATUS_ , which returns the invalid type as the
secondary code.
17 OM-RC-NOT-PRESENT
Cause. A required attribute value is missing. For example, you tried to examine or list
a third attribute value when only two values exist.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-NPC-). Take the recovery action recommended for the error class. If the
secondary code is less than 1000, it indicates the type of attribute that is missing.
20 OM-RC-PERMANENT-ERROR
Cause. An error has occurred that requires further checking.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the primary code to determine the specific
problem and the error class to determine the severity of the error. In this case, the
primary code value begins with ZGPI-RC-. For most primary codes, the secondary code
provides additional information. In some cases, the information buffer is also useful.
21 OM-RC-POINTER-INVALID
Cause. You specified an invalid pointer as the value of a parameter. For example, a
string pointer in the descriptor list is not a valid address.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-PIC-). Take the recovery action recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 5
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. A warning condition has occurred.
Effect. The function completed its task but some other condition occurred about which
you should be aware.
Recovery. Continue processing or call GPI_STATUS_ for more information before
continuing. In this case, the primary code value begins with ZGPI-RC-. For most
primary codes, the secondary code provides additional information. In some cases, the
information buffer is also useful.
24 OM-RC-TOO-MANY-VALUES
Cause. You cannot add another attribute value to an object. For example, you tried to
insert more than one value for a single-valued attribute.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-TMVC-). Take the recovery action recommended for the error class.
25 OM-RC-VALUES-NOT-ADJACENT
Cause. The descriptor list contains values for a multivalued attribute, but the values are
not contiguous.
Effect. The function is not performed.
Recovery. Revise the descriptor list.
26 OM-RC-WRONG-VALUE-LENGTH
Cause. You tried to insert a value that exceeds the length allowed. To determine the
maximum length allowed for the value, see the attribute description in Section 3, Object
Classes and Attribute Types.
Effect. The value is not inserted.
Recovery. Specify a shorter value. You can call GPI_STATUS_ , which returns the
type value as the secondary code.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 6
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. If the
secondary code is less than 1000, it indicates the type of attribute that is in error.
28 OM-RC-WRONG-VALUE-NUMBER
Cause. You tried to insert too many values for a multivalued attribute, or you tried to
insert an enumerated value that is invalid for the attribute. To determine the maximum
number of values allowed or the valid enumerated values, see the attribute description in
Section 3, Object Classes and Attribute Types.
Effect. The value is not inserted.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-WVNC-). Take the recovery action recommended for the error class.
29 OM-RC-WRONG-VALUE-SYNTAX
Cause. You specified a syntax that is not valid for the specified type of attribute. To
determine the valid syntax for the attribute type, see the attribute description in
Section 3, Object Classes and Attribute Types.
Effect. No change is made.
Recovery. Call the procedure again, specifying the correct syntax. You can call
GPI_STATUS_ , which returns the invalid syntax as the secondary code.
30 OM-RC-WRONG-VALUE-TYPE
Cause. You specified an attribute type that is not valid for the specified object. To
determine the valid attribute types for the object, see the attribute description in
Section 3, Object Classes and Attribute Types.
Effect. No change is made.
Recovery. Call the procedure again, specifying the correct attribute type. You can call
GPI_STATUS_ , which returns the invalid type as the secondary code.
Message-Handling Return Codes
Table B-2 summarizes the MH-RC- return code values you can receive from a message
handling procedure. A more detailed description of each value follows the table. The
OM-RC-SUCCESS code is also returned from successful message transfer procedures.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 7
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.
TOO-MANY-SESSIONS
113
Maximum of 15 sessions already in progress.
NO-SUCH-SESSION
115
Specified session does not exist.
100 MH-RC-FEATURE-CONFLICTS
Cause. The requested feature conflicts with an existing feature of the session. For
example, when finishing a transfer-in operation, you specified that you want to retain an
object without specifying that you want to remove it from the input queue.
Effect. The function is not performed.
Recovery. Reconsider the requested feature within the context of the procedure you
called. You can call GPI_STATUS_ , which returns in the secondary code the position
of the parameter that is causing the conflict.
106 MH-RC-NOT-RESERVED
Cause. You tried to perform an operation in which an object must be reserved, but the
specified object is not reserved. For example, an object you specify in a
GPI_MT_FINISH_TRANSFER_IN procedure must be reserved.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
107 MH-RC-NOT-UNRESERVED
Cause. You tried to perform an operation in which an object must not be reserved, but
the specified object is reserved. For example, you cannot transfer a reserved object out
to the GPI service output queue.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 8
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. The root objects can be a combination of newly created
objects and reserved objects.
Effect. No action is taken.
Recovery. Call the procedure again after a root object is transferred out, deleted, or
finished transferring in.
111 MH-RC-SESSION-NOT-BUSY
Cause. A transfer in is not in progress in the session; there is no object to finish
transferring in (change to an unreserved state).
Effect. No action is taken.
Recovery. None is required.
113 MH-RC-TOO-MANY-SESSIONS
Cause. The current number of sessions is ZGPI-MAX-SESSION-ID (15). You cannot
establish another session until one of those sessions is ended.
Effect. No action is taken.
Recovery. Try opening the session again later. You can call GPI_STATUS_ , which
returns the internal session identifier in the secondary code.
115 MH-RC-NO-SUCH-SESSION
Cause. The session identifier you specified does not refer to a currently opened session.
Your program might be malfunctioning, for example, specifying an invalid session
identifier. The error might also be caused by the session being closed when the GIP
aborted, and another client using the GIP after it is restarted but before your program
continues its session.
Effect. No action is taken. Depending on the error class, the session might be unusable.
Recovery. Call GPI_STATUS_ to check the error class. GPI_STATUS_ also returns
the invalid session identifier as the secondary code. Depending on the error class, either
call the procedure again, using a valid session identifier that has been returned by a call
to GPI_OPEN_ , or close the invalid session in your application environment.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B- 9
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). If returned from GPI_INITIALIZE_ or GPI_STATUS_ ,
the value can be a Compaq proprietary code (ZGPI-RC- code).
Primary code
Indicates a more specific cause of the error. If old status is a
standard code other than OM-RC-PERMANENT-ERROR or
OM-RC-TEMPORARY-ERROR, the primary code is the same
as old status. Otherwise, the primary code is a ZGPI-RC- code.
Secondary code
Provides another level of detail about the error. Secondary codes
identified by a DDL name are described in “Secondary Codes,”
later in this section. Values returned in this parameter that are
not identified by a DDL name are described with the recovery
recommendation for the X.400 API or Compaq proprietary
codes to which they apply.
Information buffer
Provides detailed information about one or more of the
following errors:
•
•
•
An incorrect attribute
One or more dangling objects (objects that have been created
but not inserted in the current root object)
Internal GPI error codes in one of three structures described
in “Information Buffer,” later in this section
To check the information buffer, refer to the OSI/MHS Gateway
Programmatic Interface (GPI) Programming Guide.
Request Types
Request types are returned by GPI_STATUS_ to indicate the GPI procedure in which the
most recently returned error occurred. Table B-3 summarizes the request types.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -10
Error Classes
Return Codes
Table B-3. Request Types
Constant (ZGPI-RT)
Value
Procedure Name
NULL
0
No request in progress
EM-INITIALIZE
1
GPI_INITIALIZE_
EM-OPEN
2
GPI_OPEN_
EM-CLOSE
3
GPI_CLOSE_
EM-STATUS
4
GPI_STATUS_
MT-WAIT
21
GPI_MT_WAIT_
MT-START-XFER-IN
23
GPI_MT_START_TRANSFER_IN_
MT-FINISH-XFER-IN
25
GPI_MT_FINISH_TRANSFER_IN_
MT-XFER-OUT
26
GPI_MT_TRANSFER_OUT_
OM-COPY
41
GPI_OM_COPY_
OM-CREATE
42
GPI_OM_CREATE_
OM-DELETE
43
GPI_OM_DELETE_
OM-EXAMINE
44
GPI_OM_EXAMINE_
OM-FETCH
45
GPI_OM_FETCH_
OM-INSERT
46
GPI_OM_INSERT_
OM-LIST
47
GPI_OM_LIST_
OM-READ
48
GPI_OM_READ_
OM-REMOVE
49
GPI_OM_REMOVE
OM-WRITE
50
GPI_OM_WRITE_
Error Classes
Error classes indicate the severity of an error.
Table B-4 summarizes the error class values you can receive from a GPI_STATUS_ call
and explains what they indicate about the procedure that caused you to call
GPI_STATUS_. A more detailed description of each value follows the table.
Table B-4. Error Class Values (page 1 of 2)
Constant (ZGPI-RC-CLASS-)
Value
Meaning
SUCCESS
0
No error occurred.
WARNING
10
Procedure was successful but another condition
should be noted.
IMMINENT
20
Failure is likely to occur soon.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -11
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.
BLOCKED
60
Session is unusable because of operator action
or other external operation.
FATAL
70
Fatal error occurred requiring call to
GPI_INITIALIZE_ to reset environment.
INTERNAL
80
Library is unusable because of internal
exception.
0 ZGPI-RC-CLASS-SUCCESS
Cause. The procedure completed successfully.
Effect. Processing can continue.
Recovery. None is required.
10 ZGPI-RC-CLASS-WARNING
Cause. An exception occurred, the function was only partially successful, or the
function succeeded but something else happened that should be noted. For example, the
Guardian 90 CLOSE procedure failed during a call to GPI_CLOSE_.
Effect. Processing can continue.
Recovery. Keep a record of the warning and continue processing.
20 ZGPI-RC-CLASS-IMMINENT
Cause. An exceptional condition occurred that might lead to a failure; for example,
system resources were not returned.
Effect. Performance of operations requested by subsequent GPI procedure calls might
be degraded.
Recovery. Shut down the client program through an orderly process, which includes
keeping a detailed record of the error condition and ending all sessions by calls to
GPI_CLOSE_. If the condition continues to occur, notify your Compaq representative
about the condition that occurred.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -12
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. Use the other information returned by GPI_STATUS_ (for example, primary
and secondary codes) to diagnose the problem. If the problem continues to occur, check
the operational environment and make sure all of the installed software is from the same
release and that all processes are in a STARTED state and running.
If you started a transfer in from the input queue, check the object identifier to determine
whether a complete object was transferred. For more information, see the description of
GPI_MT_START_TRANSFER_IN_ on page 4-13.
40 ZGPI-RC-CLASS-CLIENT
Cause. Your program supplied invalid data, such as parameter values.
Effect. The function is not performed.
Recovery. Use the other information returned by GPI_STATUS_ (for example, primary
and secondary codes) to diagnose the problem.
50 ZGPI-RC-CLASS-BLOCKED-INT
Cause. The session for which the procedure was called is unusable because of an
internal problem. For example, the GIP encountered a problem with TMF or the
OSI/MHS subsystem interface. The problem might or might not affect the next
procedure call.
Effect. Session is unusable.
Recovery. Close the session and open a new one. If the problem continues to occur,
check the operational environment and make sure all of the installed software is from
the same release and that all processes are in a STARTED state and running. Keep a full
record of the other GPI_STATUS_ information and report the problem to your Compaq
representative.
60 ZGPI-RC-CLASS-BLOCKED
Cause. The session for which the procedure was called is unusable. For example, an
operator has stopped the GIP process associated with the session, or the GIP might be
reset because of an internal problem.
Effect. The session is closed automatically. Any reserved objects are returned to the
input queue.
Recovery. Use the other information returned by GPI_STATUS_ (for example, primary
and secondary codes) to diagnose the problem. Check the operational environment,
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -13
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. Although the call might not succeed, try calling GPI_STATUS_ to get more
information. Then call the GPI_INITIALIZE_ procedure. Keep a full record of the
other GPI_STATUS_ information. If the problem continues to occur, report it to your
Compaq representative.
80 ZGPI-RC-CLASS-INTERNAL
Cause. An internal error has occurred.
Effect. The GPI library might be unusable and total capability of the GPI lost.
Recovery. Although the call might not succeed, try calling GPI_STATUS_ to get more
information. Then try calling the GPI_INITIALIZE_ procedure. If the initialization
fails, report the problem to your Compaq representative.
Note. For error classes 30 through 80, you can call GPI_STATUS_ to get more information.
You can also retry the operation. If the problem continues to occur, you can try to reinitialize
the GPI. You should also check the operational environment and make sure your software is
correctly installed with all elements from the same release.
Compaq Proprietary Codes
ZGPI-RC- codes are Compaq proprietary codes instead of X.400 API standard codes.
These codes are returned in the primary-code parameter of GPI_STATUS_ . (In the
following descriptions, codes that can also be returned in the status parameter of the
GPI_INITIALIZE_ and GPI_STATUS_ procedures are identified in the descriptions.)
Table B-5 summarizes the ZGPI-RC- codes you can receive when parameters are
invalid and explains what they mean. A more detailed description of each code follows
the table.
Table B-5. ZGPI-RC- Codes for Parameter-Validation Errors
Constant (ZGPI-RC-)
Value
Meaning
MISSING-REQUIRED-PARAM
2000
Procedure call omitted a required parameter.
PARAMETER-OUT-OF-BOUND
2001
Parameter length or address is incorrect.
MISSING-OPTIONAL-PARAM
2002
Optional parameter (required because of
presence of another parameter) is missing.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -14
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.
MISSING-INT-REQ-PARAM
2007
Required internal parameter is missing.
2000 ZGPI-RC-MISSING-REQUIRED-PARAM
Cause. Your program did not pass a required parameter in a procedure call.
Effect. The function is not performed.
Recovery. Revise the call to include the required parameter. You can call
GPI_STATUS_ and check the secondary code, which indicates the position of the
parameter that is missing.
2001 ZGPI-RC-PARAMETER-OUT-OF-BOUND
Cause. Your program passed a parameter that is not the correct length or its address is
invalid. The parameter might be the wrong type or might need to be initialized. (This
code can be returned as the status of GPI_INITIALIZE_ and GPI_STATUS_ .)
Effect. The function is not performed.
Recovery. Correct the procedure call using a valid parameter. You can call
GPI_STATUS_ and check the secondary code, which indicates the position of the
incorrect parameter.
2002 ZGPI-RC-MISSING-OPTIONAL-PARAM
Cause. You did not specify an optional parameter that is required because of the value
specified for another parameter. For example, if you are copying a root object, you must
include the copy-session parameter in the GPI_OM_COPY_ call. (This code can
be returned as the status of GPI_STATUS_ .)
Effect. The function is not performed.
Recovery. Revise the procedure call to include the optional parameter. You can call
GPI_STATUS_ and check the secondary code, which indicates the position of the
parameter that is missing.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -15
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. You
should also check the error class and take the recover action recommended for that class.
2004 ZGPI-RC-INT-PARAM-OUT-OF-RANGE
Cause. A parameter of a internal GPI procedure is not within the range of values
allowed.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
2005 ZGPI-RC-INT-PARAM-OUT-OF-BOUND
Cause. A parameter of a internal GPI procedure is not the correct length or its address
is invalid.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
2006 ZGPI-RC-MISSING-INT-OPT-PARAM
Cause. An optional parameter of an internal GPI procedure, which is required because
of the value specified for another parameter, is missing.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
2007 ZGPI-RC-MISSING-INT-REQ-PARAM
Cause. A required parameter of an internal GPI procedure is missing.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
Table B-6 summarizes the ZGPI-RC- codes you can receive due to GPI internal
problems and explains what they mean. A more detailed description of each code
follows the table. The GPI internal protocol elements referred to in these errors are
meaningful only to a Compaq representative.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -16
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.
BAD-REQUEST-TYPE
2202
Request type of GPI internal protocol element
returned by GIP is not one expected for
procedure called by client program.
BAD-GRP-HDR-TYPE
2203
GPI internal protocol element returned by GIP
is not one expected for procedure called by
client program.
BAD-GRP-HDR-LEN
2204
Length of GPI internal protocol element
returned by GIP does not match total length
expected by GPI library.
BAD-ELMT-HDR-TYPE
2205
GPI internal protocol element returned by GIP
is not one expected by GPI library.
BAD-ELMT-SUBTYPE
2206
GPI internal protocol element returned by GIP
is not one expected by GPI library.
BAD-ELMT-HDR-LEN
2207
Length of GPI internal protocol element
returned by GIP does not match total length
expected by GPI library.
BAD-ELMT-LEN
2208
Length of GPI internal protocol element
returned by GIP does not match total length
expected by GPI library.
BAD-SESSION-ID
2209
Session identifier is not one expected for
session.
INVALID-MGR-NAME
2210
Invalid MHS manager process name was
specified.
2008 ZPGI-RC-CLASS-ERROR
Cause. Either of the following conditions exists:
•
•
You attempted to insert a value exceeding 10 megabytes into a string for
which the value syntax OM-S-ONFILE-STRING. is not supported.
Not enough disk space exists for the string to be placed into the temporary
file.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -17
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.
2101 ZGPI-RC-FOUND-DANGLING-OBJECT
Cause. The root object (message, probe, report, or P1-encoded object) to be transferredin or transferred-out contains an object that has been created but not inserted as an
attribute of the root object.
Effect. The transfer-in or transfer-out operations does not succeed.
Recovery. Call GPI_STATUS_ and check the secondary code, which indicates the
number of dangling objects, and the information buffer, which provides additional
information.
2200 ZGPI-RC-BUF-ELMT-NOT-FOUND
Cause. GPI internal protocol elements cannot be found in the interprocess
communication (IPC) buffer.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2201 ZGPI-RC-BAD-IPC-BUF
Cause. The IPC buffer contains invalid information in GPI internal protocol elements.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2202 ZGPI-RC-BAD-REQUEST-TYPE
Cause. The request type of a GPI internal protocol element returned by the GIP is not
the request type expected 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -18
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.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2205 ZGPI-RC-BAD-ELMT-HDR-TYPE
Cause. The GPI internal protocol element returned by the GIP is not the one expected
by the GPI library.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2206 ZGPI-RC-BAD-ELMT-SUBTYPE
Cause. The GPI internal protocol element returned by the GIP is not the one expected
by the GPI library.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2207 ZGPI-RC-BAD-ELMT-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.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
2208 ZGPI-RC-BAD-ELMT-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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -19
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. The form of the MHS manager process name passed to the GPI is invalid.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class. Check the operational environment.
Table B-7 summarizes the ZGPI-RC- codes you can receive when an error occurs during
execution of a Guardian 90 procedure and explains what they mean. A more detailed
description of each code follows the table. Unless otherwise noted, the secondary code
contains the Guardian 90 error code.
Table B-7. ZGPI-RC- Codes for Guardian 90 Procedure Errors (page 1 of 2)
Constant (ZGPI-RC-)
Value
Meaning
WRITEREADX-ERROR
2501
Guardian 90 WRITEREADX procedure error
occurred.
REPLYX-ERROR
2502
Guardian 90 REPLYX procedure error
occurred.
ALLOCATESEGMENT-ERROR
2503
Guardian 90 ALLOCATESEGMENT
procedure error occurred.
USESEGMENT-ERROR
2504
Guardian 90 USESEGMENT procedure error
occurred.
DEFINEPOOL-ERROR
2505
Guardian 90 DEFINEPOOL procedure error
occurred.
GETPOOL-ERROR
2506
Guardian 90 GETPOOL procedure error
occurred.
PUTPOOL-ERROR
2507
Guardian 90 PUTPOOL procedure error
occurred.
MOVEX-ERROR
2508
Guardian 90 MOVEX procedure error
occurred.
READUPDATEX-ERROR
2509
Guardian 90 READUPDATE procedure error
occurred.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -20
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.
SSGETTKN-ERROR
2514
Guardian 90 SSGETTKN procedure error
occurred.
SSINIT-ERROR
2515
Guardian 90 SSINIT procedure error
occurred.
SSPUTTKN-ERROR
2516
Guardian 90 SSPUTTKN procedure error
occurred.
SETMODE-ERROR
2517
Guardian 90 SETMODE procedure error
occurred.
SIGNALTIMEOUT-ERROR
2518
Guardian 90 SIGNALTIMEOUT procedure
error occurred.
BEGINTRANSACTION-ERROR
2519
Guardian 90 BEGINTRANSACTION
procedure error occurred.
GETTMPNAME-ERROR
2520
Guardian 90 GETTMPNAME procedure error
occurred.
OPEN-ERROR
2521
Guardian 90 OPEN procedure error occurred.
AWAITIOX-ERROR
2522
Guardian 90 AWAITIOX procedure error
occurred.
2501 ZGPI-RC-WRITEREADX-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 WRITEREADX
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. (See “Error Classes,” earlier in this appendix.)
The secondary code returns either the Guardian 90 error, an application-defined
Guardian 90 error (300 - 305), or an internal code.
2502 ZGPI-RC-REPLYX-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 REPLYX procedure.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -21
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.
2504 ZGPI-RC-USESEGMENT-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 USESEGMENT
procedure. For example, the GPI cannot access the GPI segment or return to the client’s
segment. Or, the GIP cannot access its own reserved segment.
Effect. The function is not performed.
Recovery. If the GPI segment cannot be accessed, this code is returned in the status
parameter of the procedure you called. If the GPI cannot return control to your
application’s segment, the GPI abends, and you should restart your application. If the
GIP cannot access its own reserved segment, you can try calling GPI_STATUS_ for
more information.
2505 ZGPI-RC-DEFINEPOOL-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 DEFINEPOOL
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.
2506 ZGPI-RC-GETPOOL-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 GETPOOL 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. The secondary code contains the GPI internal
pool ID.
2507 ZGPI-RC-PUTPOOL-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 PUTPOOL procedure.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -22
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. An error occurred during a GPI call to the Guardian 90 READUPDATEX
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.
2510 ZGPI-RC-FNAME32COLLAPSE-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 FNAME32COLLAPSE
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. There is no secondary code.
2511 ZGPI-RC-FNAMEEXPAND-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 FNAMEEXPAND
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. There is no secondary code.
2512 ZGPI-RC-RESIZESEGMENT-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 RESIZESEGMENT
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -23
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. Follow the recommended
recovery procedure for the error class.
2515 ZGPI-RC-SSINIT-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 SSINIT 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.
2516 ZGPI-RC-SSPUTTKN-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 SSPUTTKN 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.
2517 ZGPI-RC-SETMODE-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 SETMODE 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.
2518 ZGPI-RC-SIGNALTIMEOUT-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 SIGNALTIMEOUT
procedure.
Effect. This is a warning condition.
Recovery. No action is required.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -24
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. Call GPI_STATUS_ and check the error class. Follow the recommended
recovery procedure for the error class.
2521 ZGPI-RC-OPEN-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 OPEN procedure. The
error can occur when the GIP tries to open the entry manager, wait manager, or TFILE.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ , check the error class, and follow the recommended
recovery procedure for that class. The secondary code contains the FILEINFO code.
2522 ZGPI-RC-AWAITIOX-ERROR
Cause. An error occurred during a GPI call to the Guardian 90 AWAITIOX procedure.
This can occur if the wait manager process fails during a GPI_MT_WAIT_ command.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ to check the error class. The secondary code contains
the FILEINFO code.
Table B-8 summarizes the ZGPI-RC- codes you can receive when an error occurs in one
of the GPI-library procedures and explains what they mean. A more detailed description
of each code follows the table.
Table B-8. ZGPI-RC- Codes for GPI-Library Errors (page 1 of 2)
Constant (ZGPI-RC-)
Value
Meaning
SEGMENT-ALREADY-IN-USE
4000
Required segment was in use.
OPEN-WAIT-GIP-ERROR
4001
GPI cannot open GIP process.
CLOSE-WAIT-GIP-ERROR
4003
GPI cannot close GIP process.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -25
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.
CLOSE-SCP-ERROR
4009
Problem occurred while closing SCP process.
OPEN-SCP-ERROR
4010
Problem occurred while opening SCP process.
SPI-CMD-ERROR
4011
SPI command error occurred.
NO-GIPS
4012
No GIPs are available.
SESSION-ABORTED
4013
GPI aborted session because GIP was stopped
and restarted for another session.
4000 ZGPI-RC-SEGMENT-ALREADY-IN-USE
Cause. A requested segment is already in use. This condition occurs when the GPI is
reinitialized after it has already been initialized successfully.
Effect. All sessions are closed and the GPI is completely reinitialized.
Recovery. This is a warning condition. You can continue processing but should check
the logic of your program to determine why the problem occurs. If you call
GPI_STATUS_ when this condition occurs, the secondary code contains the segment
identifier.
4001 ZGPI-RC-OPEN-WAIT-GIP-ERROR
Cause. The GPI is not able to open the GIP with waited I/O.
Effect. The session is closed automatically.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
Guardian 90 file system error. Try again to open a session.
4003 ZGPI-RC-CLOSE-WAIT-GIP-ERROR
Cause. The GPI is not able to close the GIP with waited I/O.
Effect. Processing continues.
Recovery. This is a warning condition. You can call GPI_STATUS_ and check the
secondary code, which contains the Guardian 90 file system error.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -26
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_. A long string cannot be included in a descriptor list; it must be
processed by the GPI_OM_READ_ or GPI_OM_WRITE_ procedure.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
attribute type, and the information buffer. Either specify a shorter string or use a
different procedure.
4007 ZGPI-RC-OT-COUNT-MISMATCH-TBL
Cause. The object tree count maintained by the GPI library does not match the count of
the object-tree tables in memory. This is an internal logic error.
Effect. The session is unusable.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action for
the error class. Reinitialize the GPI and try the operation again.
4008 ZGPI-RC-EXCEEDED-RESERVED-OTS
Cause. If a new communication is transferred in, the maximum number of TMF
transactions allowed by the GIP will be exceeded.
Effect. The communication is not transferred in.
Recovery. Finish transferring in another object and then retry the operation.
4009 ZGPI-RC-CLOSE-SCP-ERROR
Cause. An error occurred while attempting to close the local SCP process.
Effect. None. Processing can continue.
Recovery. This is a warning condition. You can call GPI_STATUS_ and check the
secondary code, which contains the Guardian 90 file-system error code.
4010 ZGPI-RC-OPEN-SCP-ERROR
Cause. An error occurred while attempting to open the local SCP process.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -27
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.
4012 ZGPI-RC-NO-GIPS
Cause. There are no GIPs available currently.
Effect. A session could not be established.
Recovery. Try to open a session again later. Check the operational environment,
particularly the GIP groups.
4013 ZGPI-RC-SESSION-ABORTED
Cause. The GPI aborted the session because the GIP was stopped and restarted for
another session.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ to get additional information. The secondary code
contains the session identifier of the aborted session. Open another session.
Table B-9 summarizes the ZGPI-RC- codes you can receive due to problems in
managing an object tree and explains what they mean. A more detailed description of
each code follows the table.
Table B-9. ZGPI-RC- Codes for Object Tree Management Errors
Constant (ZGPI-RC-)
Value
Meaning
OBJ-ALREADY-ATTACHED
5000
Subobject cannot be inserted as attribute of more
than one super object.
ILLEGAL-NON-ROOT-COPY
5001
Object cannot be copied as root object unless it
is a root object.
ILLEGAL-ROOT-COPY
5002
Root object cannot be copied as a nonroot
object.
PROTOCOL-ERROR
5003
Error occurred in GPI internal protocol.
NO-SUCH-POSITION
5004
Specified value position is beyond existing
values or exceeds value limit defined for
attribute type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -28
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.
5000 ZGPI-RC-OBJ-ALREADY-ATTACHED
Cause. An object cannot be inserted as the subobject of more than one superobject.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the type
value.
5001 ZGPI-RC-ILLEGAL-NON-ROOT-COPY
Cause. You attempted to copy a non-root object as a root object.
Effect. The function is not performed.
Recovery. Make sure you are specifying the correct object identifier.
5002 ZGPI-RC-ILLEGAL-ROOT-COPY
Cause. You attempted to copy a root object as a non-root object.
Effect. The function is not performed.
Recovery. Make sure you are specifying the correct object identifier.
5003 ZGPI-RC-PROTOCOL-ERROR
Cause. An error occurred in the internal protocol used by the GPI.
Effect. The session is unusable.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-PEC-). Take the recovery action recommended for the error class.
5004 ZGPI-RC-NO-SUCH-POSITION
Cause. The specified value position is beyond existing values or exceeds the number of
values allowed for the attribute type.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -29
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. Call GPI_STATUS_ and check the secondary code, which contains either
zero, the enumerated action value, or the type of the MH-T-ATTEMPTED- attribute.
5006 ZGPI-RC-MD-NAME-ERROR
Cause. The values of an MH-C-INTERNAL-TRACE-ENTRY object or an
MH-T-EXTERNAL-TRACE-ENTRY object are inconsistent with the
MH-T-ATTEMPTED- attributes or MH-T-ACTION attribute, or both.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains either
zero, the enumerated action value, or the type of the MH-T-ATTEMPTED- attribute.
5007 ZGPI-RC-BAD-STRING-OFFSET
Cause. In a GPI_OM_WRITE_ call, the specified offset is greater than the number of
octets in the existing string value.
Effect. The write operation is not performed.
Recovery. Revise the procedure call, specifying the correct offset. You can call
GPI_STATUS_ and check the secondary code, which contains the type of the attribute
affected.
Table B-10 summarizes the ZGPI-RC- codes you can receive due to GIP processing
errors and explains what they mean. A more detailed description of each code follows
the table. These descriptions include terms that relate to the configuration and
management of OSI/MHS. For more information, see the OSI/MHS Configuration and
Management Manual.
Table B-10. ZGPI-RC- Codes for GIP Errors (page 1 of 3)
Constant (ZGPI-RC-)
Value
Meaning
NOT-STARTED-STATE
6000
GIP is not in the STARTED state.
ILLEGAL-GPI-OPEN
6001
Second open request made during existing
session.
GIP-BUSY
6002
GIP received open request when already in
session with another process.
NO-PREVIOUS-GPI-OPEN
6003
GIP received GPI request but session not
established yet.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -30
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.
UNEXPECTED-OTT-REQ
6007
Object-tree-transport module made request
while GIP in the wrong state.
IPC-PROTOCOL-ERROR
6008
GPI request to GIP violates sequence of
events expected in interface protocol.
TMF-ERROR
6009
Attempt to begin, end, abort, or resume
transaction failed.
GIP-SEND-FAILURE
6010
GIP could not transfer communication to
MRP during transfer-out.
WAIT-CANCELLED
6011
GIP cancelled a wait request.
GIP-INTERNAL-ERROR
6012
Fatal internal error occurred in GIP.
GW-AUX-P-UNEXP-REPLY
6013
Gateway auxiliary process received
unexpected reply from WRITEREADX.
GW-AUX-PNAME-ERROR
6014
Gateway auxiliary process returned
unrecoverable error.
GW-PNAME-ERROR
6015
Gateway process returned unrecoverable error
in unit-of-work response.
PDU-FILE-INACCESSIBLE
6016
GIP was unable to access the PDU store
during a start-transfer-in operation.
PREVIOUS-OT-DELETED
6017
GIP deleted an object tree from memory.
ILLEGAL-WAIT-INTERVAL
6018
Interval specified for GPI_MT_WAIT_
procedure is invalid.
PDU-SUBSYS-INIT-ERROR
6019
Unrecoverable error occurred during
initialization of PDU store subsystem.
GW-DATABASE-OPEN-ERROR
6020
GIP cannot open gateway database file.
GW-DATABASE-READ-ERROR
6023
GIP cannot read gateway database file.
INVALID-GATEWAY-INFO
6024
Gateway database contains invalid data.
UNUSABLE-ADMIN-QUEUE
6025
All ADMIN queue entries contain MHS
manager name that is different from MHS
manager that started GIP.
MRP-NOT-COMPATIBLE
6026
Version of MHS-interface module not
compatible with MRP.
VERSION-CHECK-ERROR
6027
GIP could not check version of MHSinterface module.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -31
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.
OT-INIT-FAILURE
6032
GIP could not initialize the object tree in
memory.
INCOMPATIBLE-GIP
6033
Levels of the GIP and GPI are incompatible.
INVALID-REMOVE-FLAG
6034
GPI_MT_FINISH_TRANSFER_IN_
procedure call has invalid remove parameter
value.
PDU-STORES-TOO-FULL
6035
Size of outbound message is larger than
available space in each attempted PDU store.
GW-NAME-NOT-CONFIGURED
6036
No gateway name configuration record was
found.
NO-PDU-MEMORY-BUFFER
6037
No memory buffers have been allocated for
the PDU manipulation.
ENCODED-MSG-TOO-LONG
6038
The inbound message exceeds the maximum
length specification.
QUEUE-ENTRY-ARCHIVED
6039
The queue entry found on the input queue has
been archived.
ARCHIVE-WRITE-FAILED
6040
Bad PDU archived; archive log record not
written.
6000 ZGPI-RC-NOT-STARTED-STATE
Cause. The GIP received a GPI request but was not in the STARTED state.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
6001 ZGPI-RC-ILLEGAL-GPI-OPEN
Cause. The GIP received a request to open a session from a client program that is
already in session with the GIP.
Effect. The session is not opened.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -32
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. The GIP received a GPI request but has not successfully opened a session. For
example, the error might occur after the GIP abends and is restarted by the MHS
manager.
Effect. The request is rejected. The GPI closes the session automatically.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the type
of the rejected request.
6004 ZGPI-RC-INVALID-PID
Cause. The GIP received a GPI request from a process other than the one that opened
the session.
Effect. The request is rejected.
Recovery. Call GPI_STATUS_ and check the error class. Take the recovery action
recommended for the error class.
6005 ZGPI-RC-UNKNOWN-GPI-REQUEST
Cause. The GIP received a GPI request that it does not recognize.
Effect. The request is rejected.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the type
of the rejected request.
6006 ZGPI-RC-OTT-FAILURE
Cause. A failure occurred in the object-tree-transport module during a transfer-out or
start-transfer-in request.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -33
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. The GIP received a GPI request that violated the expected sequence of events
within the interface protocol.
Effect. The request is rejected.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
6009 ZGPI-RC-TMF-ERROR
Cause. An error occurred during an attempt to begin, end, abort, or resume a TMF
transaction.
Effect. The function is not performed. If this error occurs during a finish-transfer-in
operation, the object is put back in the input queue.
Recovery. Call GPI_STATUS_ and examine the information buffer. The secondary
code is either null or contains the Guardian 90 error. Take the recovery action
recommended for the error class.
6010 ZGPI-RC-GIP-SEND-FAILURE
Cause. The GIP was unable to transfer a communication to the MRP during a transferout operation.
Effect. The transfer-out is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
6011 ZGPI-RC-WAIT-CANCELLED
Cause. The GIP cancelled a wait request.
Effect. The GPI_MT_WAIT_ procedure is finished processing.
Recovery. This is a warning condition. No action is required.
6012 ZGPI-RC-GIP-INTERNAL-ERROR
Cause. An internal error has occurred in the GIP.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -34
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. You should also check to see if the gateway auxiliary process has failed.
6014 ZGPI-RC-GW-AUX-PNAME-ERROR
Cause. The gateway auxiliary process returned an unrecoverable error.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the error
that was returned. Take the recovery action recommended for the error class.
6015 ZGPI-RC-GW-PNAME-ERROR
Cause. The gateway process returned an unrecoverable error.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the error
that was returned. Take the recovery action recommended for the error class.
6016 ZGPI-RC-PDU-FILE-INACCESSIBLE
Cause. The GIP cannot access the PDU store while processing a start-transfer-in
request.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code (prefix ZGPI-PFIC-) and
the information buffer. Take the recovery action recommended for the error class.
6017 ZGPI-RC-PREVIOUS-OT-DELETED
Cause. In order to process a start-transfer-in request, the GIP must discard an object
tree from memory.
Effect. The request is processed successfully.
Recovery. This is a warning condition and does not affect processing.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -35
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. Take the recovery
action recommended for the error class.
6020 ZGPI-RC-GW-DATABASE-OPEN-ERROR
Cause. The GIP cannot open the gateway database file.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
6023 ZGPI-RC-GW-DATABASE-READ-ERROR
Cause. The GIP cannot read the gateway database file.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
6024 ZGPI-RC-INVALID-GATEWAY-INFO
Cause. The gateway database contains corrupt or invalid data.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
6025 ZGPI-RC-UNUSABLE-ADMIN-QUEUE
Cause. MHS manager names supplied found in the ADMIN queue are not the same as
the name of the MHS manager that started the GIP.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class. Check the operational environment.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -36
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).
6027 ZGPI-RC-VERSION-CHECK-ERROR
Cause. The GIP could not check the version of the MHS-interface module.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
version code of the MRP, and the information buffer. Take the recovery action
recommended for the error class.
6028 ZGPI-RC-MRP-UNAVAILABLE
Cause. The MRP was not available when the GIP attempted a connection.
Effect. The function is not performed.
Recovery. Try the request again. The GIP will try another MRP. If the problem
continues to occur, call GPI_STATUS_ and examine the information buffer. Take the
recovery action recommended for the error class.
6029 ZGPI-RC-INVALID-GW-PASSWORD
Cause. The password supplied when the GIP attempted a connection with the MRP was
rejected.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class. Check the operational environment.
6030 ZGPI-RC-NO-GATEWAY
Cause. The GATEWAY object could not be found 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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -37
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. Call GPI_STATUS_ and take the recovery action recommended for the error
class. Check the operational environment.
6033 ZGPI-RC-INCOMPATIBLE-GIP
Cause. The GIP and GPI library compatibility levels do not match.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
compatibility level of the GIP. Take the recovery action recommended for the error
class. Check that the versions of the GPI library and GIP software installed on your
system are from the same release.
6034 ZGPI-RC-INVALID-REMOVE-FLAG
Cause. The value of the remove parameter of the
GPI_MT_FINISH_TRANSFER_IN_ procedure is not valid.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and take the recovery action recommended for the error
class.
6035 ZGPI-RC-PDU-STORES-TOO-FULL
Cause. The GIP could not write the outbound communication to any of the PDUs
configured for the system, because the size of the communication was larger than the
space available in each PDU to which the GIP tried to write.
Effect. The function is not performed.
Recovery. Try the transfer out again, finish the transfer in of another object, or change
the timing configuration of the store cleaner (SC) process to clear the deleted PDUs
from the PDU stores. (For information about the SC process, see the OSI/MHS
Configuration and Management Manual.)
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -38
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. Memory is not available for PDU manipulation.
Effect. The function is not performed.
Recovery. Check memory availability on the system and swap file allocations.
6038 ZGPI-RC-ENCODED-MSG-TOO-LONG
Cause. The inbound message received from the MTA has exceeded the limit specified
by the client application. A maximum message limit of 2 MB through 10 MB is set with
the max-table-data parameter of the GPI-INITIALIZE_ procedure. For additional
information about setting message size, refer to the description of GPI_INITIALIZE_ on
page 4-7.
Effect. An empty root object is returned from the call to
GPI_MT_START_TRANSFER_IN_.
Recovery. Call GPI_FINISH_TRANSFER_IN_ with the appropriate option to remove
the message from the input queue. If the message is on a P1-EXIT input queue,
Compaq recommends the MH-TRANSFER option, which resubmits the message to the
MTA and causes the MTA to generate a non-delivery report (if the APPL recipient is not
configured to receive a message of this length). If the message is on a NORMAL input
queue, Compaq recommends the MH-ARCHIVE option, which removes the message
from the input queue but saves the message in the PDU store for later analysis. The
message originator can be determined using diagnostic tools and can be notified of the
non-delivery of the message by the client.
6039 ZGPI-RC-QUEUE-ENTRY-ARCHIVED
Cause. The queue entry found on the input queue is bad and has been archived.
Effect. The bad PDU is removed from the input queue, an event message with the PDU
ID is generated, a log record 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. If desired, you can use diagnostic tools to
investigate the bad PDU in the PDU store. To identify the PDU, check the log record.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -39
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. If desired, you can use diagnostic tools to
investigate the bad PDU in the PDU store. Note that, because the archive log record is
not written, the PDU STATE display for that PDU is DELIV-GW rather than
ARCHIVED. To distinguish the bad PDU from currently active PDUs, use the PDU ID
contained in the event message.
Table B-11 summarizes the ZGPI-RC- codes you can receive during the mapping of
outbound communications and explains what they mean. A more detailed description of
each code follows the table.
Table B-11. ZGPI-RC- Codes for Outbound-Mapping Errors (page 1 of 2)
Constant (ZGPI-RC-)
Value
Meaning
OTM-OUTBOUND-ERROR
8001
Request from outbound-mapping module to
object-management module failed.
GW-OUTBOUND-ERROR
8002
Request from outbound-mapping module to
MHS-interface module failed.
BAD-CN-CHAR
8003
Outbound-mapping module cannot match
2-character country name.
BAD-CN-DIGIT
8004
Outbound-mapping module cannot match 3digit country name.
BAD-SYNTAX
8005
Outbound-mapping module cannot match an
object’s syntax value.
BAD-TYPE
8006
Outbound-mapping module cannot match an
object’s type value.
BAD-ACTION-SELECTOR
8007
Outbound-mapping module cannot match a GPI
internal indicator.
BAD-SPECIAL-SELECTOR
8008
Outbound-mapping module cannot match a GPI
internal indicator.
BAD-ENUMERATION-CASE
8009
Outbound-mapping module cannot match an
enumerated value with values allowed for the
MH-T-BUILTIN-EITS attribute.
BAD-ROOT-CHECK
8010
Outbound-mapping module cannot translate an
input class.
MAX-ARCS-EXCEEDED
8011
Outbound-mapping module cannot find end of
string of syntax OM-S-OBJECT-ID-STRING.
CONTENT-ERROR
8012
Outbound-mapping module cannot find
required class for content.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -40
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.
BAD-KIND
8016
Outbound-mapping module cannot match a GPI
internal indicator.
DEFAULT-CLASS
8017
Outbound-mapping module cannot match
object’s class value.
BAD-PDU-OPERATION
8018
Outbound-mapping module tried to create
another PDU in the PDU store.
PDU-ID-UNAVAILABLE
8019
Outbound-mapping module cannot obtain an
PDU ID for a P2 encode.
BAD-EDI-PLACEHOLDER
8020
Outbound-mapping module encountered an
incorrectly set EDI placeholder.
ADD-BODYPART-ERROR
8021
Outbound-mapping module cannot obtain
information about an EDI body part.
8001 ZGPI-RC-OTM-OUTBOUND-ERROR
Cause. A request from the outbound-mapping module to the object-management
module failed.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
8002 ZGPI-RC-GW-OUTBOUND-ERROR
Cause. A request from the outbound-mapping module to the MHS-interface module
failed.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and examine the information buffer. Take the recovery
action recommended for the error class.
8003 ZGPI-RC-BAD-CN-CHAR
Cause. The outbound-mapping module found a lowercase letter in the two-character
country name.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -41
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. Take the recovery action recommended for
the error class.
8005 ZGPI-RC-BAD-SYNTAX
Cause. The outbound-mapping module cannot match an object’s syntax value.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
unmatched syntax value, and the information buffer. Take the recovery action
recommended for the error class.
8006 ZGPI-RC-BAD-TYPE
Cause. The outbound-mapping module cannot match an object’s type value.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
unmatched type value, and the information buffer. Take the recovery action
recommended for the error class.
8007 ZGPI-RC-BAD-ACTION-SELECTOR
Cause. The outbound-mapping module cannot match a GPI-internal indicator.
Effect. The function is not performed.
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.
8008 ZGPI-RC-BAD-SPECIAL-SELECTOR
Cause. The outbound-mapping module cannot match a GPI-internal indicator.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -42
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. Call GPI_STATUS_ and check the secondary code, which contains the
unmatched enumerated value, and the information buffer. Take the recovery action
recommended for the error class.
8010 ZGPI-RC-BAD-ROOT-CHECK
Cause. The outbound-mapping module cannot match an input class, because it is not
one of the expected classes for a communication.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
unmatched class value, and the information buffer. Take the recovery action
recommended for the error class.
8011 ZGPI-RC-MAX-ARCS-EXCEEDED
Cause. The outbound-mapping module cannot find the end of a string of syntax
OM-S--OBJECT-ID-STRING.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the information buffer. Take the recovery
action recommended for the error class.
8012 ZGPI-RC-CONTENT-ERROR
Cause. The outbound-mapping module cannot find the required content class.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
invalid class value, and the information buffer. Take the recovery action recommended
for the error class.
8013 ZGPI-RC-BAD-ATTR-TYPE
Cause. The outbound-mapping module cannot find the required attribute for criticality
or an extension.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -43
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. Take the recovery action recommended for the error
class.
8015 ZGPI-RC-BAD-TABLE-OPERATION
Cause. The outbound-mapping module was not able to add or delete an entry from the
PDUID table, because the entry was invalid or the table was too full.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
current number of PDUID table entries, and the information buffer. Take the recovery
action recommended for the error class.
8016 ZGPI-RC-BAD-KIND
Cause. The outbound-mapping module cannot match a GPI-internal indicator.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
GPI-internal indicator, and the information buffer. Take the recovery action
recommended for the error class.
8017 ZGPI-RC-DEFAULT-CLASS
Cause. The outbound-mapping module cannot match an object’s class value.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the secondary code, which contains the
unmatched class value, and the information buffer. Take the recovery action
recommended for the error class.
8018 ZGPI-RC-BAD-PDU-OPERATION
Cause. The internal outbound-mapping module made an unsuccessful attempt to create
another PDU in the PDU store.
Effect. The function is not performed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -44
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. Call GPI_STATUS_ and check the information buffer (which contains either
the ZGPI-INFO-3 or the ZGPI-INFO-4 structure data that is returned as error data from
the outbound-mapping module). Take the recovery action recommended for the error
class.
8020 ZGPI-RC-BAD-EDI-PLACEHOLDER
Cause. The outbound-mapping module encountered an incorrectly set
EDI-T-BODYPART-PLACEHOLDER.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the information buffer (which contains the
ZGPI-ST-ERROR-ATTR structure data. Take the recovery action recommended for the
error class.
8021 ZGPI-RC-ADD-BODYPART-ERROR
Cause. The outbound-mapping module cannot obtain information about an EDIM
externally defined body part (no attribute) after receiving an attribute
EDI-T-BODYPART-PLACEHOLDER.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the information buffer (which contains the
ZGPI-ST-ERROR-ATTR structure data. Take the recovery action recommended for the
error class.
Table B-12 summarizes the ZGPI-RC- codes you can receive during the processing of
inbound communications and explains what they mean. A more detailed description of
each code follows the table.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -45
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.
GW-INBOUND-ERROR
8504
Inbound-mapping module could not create
internal structure in PDU.
EXT-TYPE-MISMATCH
8505
Values of two GPI-internal indicators should
match but do not.
CLASS-NOT-FOUND
8506
Inbound-mapping module could not find object
class for GPI-internal indicator.
UNDECODABLE-MESSAGE
8507
Communication on input queue could not be
decoded.
UNDECODABLE-CONTENT
8508
Content of message on input queue could not
be decoded.
ILLEGAL-NOTIF-REQ
8509
IM-T-NOTIFICATION-REQUEST attribute
contains invalid value.
INIT-MEMORY-FAILURE
8510
Inbound-mapping module could not initialize
its internal tables because of memory problems.
UNREADABLE-PDU
8511
Inbound-mapping module could not read the
inbound PDU from the PDU store.
UNSUPPORTED-BODY-PART
8512
A body part has been encountered that is not
supported by the GPI.
UNSUPPORTED-ATTR-TYPE
8503
Inbound-mapping module encountered attribute
type not supported by XAPIA-1988
specification.
Note. If the effect of an inbound-mapping error is that the function is partially performed, a
partial communication is returned. For information about using the object identifier to analyze
this situation, see the description of the GPI_MT_FINISH_TRANSFER_IN_ on page 4-10.
8500 ZGPI-RC-ILLEGAL-RECIPIENT-DR
Cause. The inbound-mapping module received an invalid PDU.
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 (prefix ZGPI-IRDC-).
Take the recovery action recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -46
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. An object contains an extension that is not supported by the GPI
implementation of the XAPIA-1988 specification.
Effect. The extension is ignored. A full X.400 communication is returned.
Recovery. This is a warning and requires no recovery action. The secondary code
returned by GPI_STATUS_ contains the unsupported extension.
8503 ZGPI-RC-UNSUPPORTED-ATTR-TYPE
Cause. An object contains an attribute type that is not supported by the GPI
implementation of the XAPIA-1988 specification.
Effect. The attribute type is ignored. A full X.400 communication is returned.
Recovery. This is a warning and requires no recovery action. The secondary code
returned by GPI_STATUS_ contains the kind code of the unsupported attribute.
8504 ZGPI-RC-GW-INBOUND-ERROR
Cause. The inbound-mapping module could not finish processing the request due to an
internal error.
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 take the recovery action recommended for the error
class.
8505 ZGPI-RC-EXT-TYPE-MISMATCH
Cause. The values of two GPI-internal indicators should match but do not.
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 take the recovery action recommended for the error
class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -47
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. A communication on the input queue cannot be decoded successfully.
Effect. If the error class is ZGPI-RC-CLASS-FAILED, the function is partially
completed, and a partial communication is returned.
Recovery. You can examine the communication. To be able to continue with the next
message, you must remove the communication from the input queue or archive it by
calling GPI_MT_FINISH_TRANSFER_IN_.
8508 ZGPI-RC-UNDECODABLE-CONTENT
Cause. The content of a message on the input queue cannot be decoded.
Effect. If the error class is ZGPI-RC-CLASS-FAILED, the function is partially
completed, and a partial communication is returned.
Recovery. You can examine the communication. To be able to continue with the next
message, you must remove the communication from the input queue or archive it by
calling GPI_MT_FINISH_TRANSFER_IN_.
8509 ZGPI-RC-ILLEGAL-NOTIF-REQ
Cause. The IM-T-NOTIFICATION-REQUEST attribute of a message from the input
queue contains a value that is not allowed.
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 take the recovery action recommended for the error
class.
8510 ZGPI-RC-INIT-MEMORY-FAILURE
Cause. Because of memory problems, the inbound-mapping module could not initialize
its internal tables.
Effect. The function is not performed. No X.400 communication is returned.
Recovery. Call GPI_STATUS_ and check the information buffer. Take the recovery
action recommended for the error class.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -48
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. The GPI decodes the entire message except the body part that is unsupported.
Recovery. You can process the message without the body part decoded, or you can
archive the message and analyze it using diagnostic tools.
Secondary Codes
Secondary codes provide detailed information about the conditions reported by codes
returned in the status and primary-code parameters.
Table B-13 through Table B-24 summarize the secondary code values you can receive
from a GPI procedure and explains what they mean. The second segment of the
secondary code prefix (following ZGPI-) indicates the return code that caused the
secondary codes, as follows:
FDC-
OM-RC-FUNCTION-DECLINED
MIC-
OM-RC-MEMORY-INSUFFICIENT
NSOC-
OM-RC-NO-SUCH-OBJECT
PIC-
OM-RC-POINTER-INVALID
SEC-
OM-RC-SYSTEM-ERROR
TMVC-
OM-RC-TOO-MANY-VALUES
WVNC-
OM-RC-WRONG-VALUE-NUMBER
PEC-
ZGPI-RC-PROTOCOL-ERROR
IRDC-
ZGPI-RC-ILLEGAL-RECIPIENT-DR
WVMC-
OM-RC-WRONG-VALUE-MAKEUP
NPC-
OM-RC-NOT-PRESENT
IGIC-
ZGPI-RC-INVALID-GATEWAY-INFO
PFIC-
ZGPI-RC-PDU-FILE-INACCESSIBLE
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -49
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.
FDC-ENVIRONMENT-OBJ
1008
Environment object cannot be modified.
FDC-NOT-A-ROOT-OBJ
1009
Specified object is not a root object.
FDC-WRONG-ROOT-OBJ
1010
Object can be inserted only in root object
specified when object was created.
FDC-REMOTE-MGR-NAME
1011
MHS manager process, which is on remote
system, must be on local system.
FDC-NOWAIT-NOT-SUPPORTED
1012
Currently, GPI does not support nowait
operations.
1004 ZGPI-FDC-XFER-OUT-IN-PROGRESS
Cause. The specified object cannot be modified, because it is being transferred out.
1007 ZGPI-FDC-NOT-MODIFIABLE
Cause. A reserved object, or an attribute of a reserved object, cannot be modified.
1008 ZGPI-FDC-ENVIRONMENT-OBJ
Cause. An environment object cannot be modified.
1009 ZGPI-FDC-NOT-A-ROOT-OBJ
Cause. The specified object is not a root object (message, probe, report, or P1-encoded
object).
1010 ZGPI-FDC-WRONG-ROOT-OBJ
Cause. An object can be inserted only in the object you specified in the rootobject parameter of the GPI_OM_CREATE_ procedure when you created the object.
1011 ZGPI-FDC-REMOTE-MGR-NAME
Cause. The MHS manager process must be running on your local system, not on a
remote system.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -50
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.
MIC-NO-MORE-PDUS
1053
The GIP cannot obtain the memory for any more
PDUs.
1050 ZGPI-MIC-NO-MORE-OT-ENTRIES
Cause. There are no more entries available in the object-tree table being used to process
an object. The initialized and allocated space is already in use.
1051 ZGPI-MIC-NO-MORE-OT-DATA
Cause. No more string space is available in the object-tree table.
1052 ZGPI-MIC-NO-MORE-OTS
Cause. The GIP cannot allocate the memory required for the object tree. For additional
information, check the information buffer.
1053 ZGPI-MIC-NO-MORE-PDUS
Cause. The GIP cannot obtain the memory for any more PDUs.
Table B-15. ZGPI-NSOC- Secondary Codes
Constant (ZGPI-)
Value
Meaning
NSOC-NULL-OBJ-ID
1100
Object identifier is zero, which is invalid.
NSOC-ELMT-ALREADY-DELETED
1101
Deleted object or attribute cannot be
specified.
NSOC-BAD-OBJ-ID-OT-OR-REV
1102
Object identifier contains invalid objecttree number or revision.
NSOC-BAD-OBJ-ID-INDEX
1103
Object identifier contains invalid index to
object entries.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -51
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).
1101 ZGPI-NSOC-ELMT-ALREADY-DELETED
Cause. You specified an object or attribute that has been deleted.
1102 ZGPI-NSOC-BAD-OBJ-ID-OT-OR-REV
Cause. The specified object identifier contains an invalid object-tree number or
revision.
1103 ZGPI-NSOC-BAD-OBJ-ID-INDEX
Cause. The specified object identifier contains an invalid index to object entries.
1104 ZGPI-NSOC-ELMT-IS-AN-ATTR
Cause. The object pointer points to an attribute instead of an object.
1105 ZGPI-NSOC-BAD-DSCR-OBJ-PTR
Cause. A pointer in an internal descriptor consists of an invalid address or does not
point to an object.
1106 ZGPI-NSOC-OBJ-NOT-IN-SESSION
Cause. The specified root object was not reserved or created in the current session.
Table B-16. ZGPI-PIC- Secondary Codes
Constant (ZGPI-RC-)
Value
Meaning
PIC-OBJ-ID-PTR
1150
Object-identifier pointer is invalid.
PIC-OTD-PTR
1151
GPI internal pointer (to object-tree dictionary) is
invalid.
PIC-ATTR-PTR
1152
Attribute pointer is invalid.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -52
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. The attribute pointer is invalid.
1153 ZGPI-PIC-OBJ-PTR
Cause. Either the object identifier or the object pointer is invalid.
1154 ZGPI-PIC-SESSION-PTR
Cause. The session pointer is invalid.
1155 ZGPI-PIC-DSCR-STR-PTR
Cause. The string pointer of the attribute descriptor is invalid.
Table B-17. ZGPI-SEC- Secondary Codes (page 1 of 2)
Constant (ZGPI-RC-)
Value
Meaning
SEC-NOT-AN-ATTR-PTR
1200
Specified pointer does not refer to attribute.
SEC-MISSING-PTR
1201
Expected pointer not specified.
SEC-BAD-PTR
1202
Specified pointer does not match expected
value.
SEC-BAD-OT-SIZE
1203
Sizes of object-tree table in GPI library
definition and GIP definition are
inconsistent.
SEC-BAD-MV-HDR
1204
GPI internal protocol element for
multivalued attribute is incorrect.
SEC-BAD-MV-TYPE
1205
Type of multivalued attribute not consistent.
SEC-ILLEGAL-MV-HDR-OPEN
1206
Attempt to replace GPI internal protocol
element failed.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -53
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.
SEC-BAD-OT-TBL-ENTRIES
1211
GPI_INITIALIZE_ max-tableentries parameter not in valid range.
SEC-BAD-OT-TBL-DATA
1212
GPI_INITIALIZE_ max-table-data
parameter not in valid range.
SEC-BAD-INIT-OT-TBL-NUM
1213
Number of object-tree tables to be
generated during GPI initialization not in
valid range.
SEC-BAD-MAX-OT-TBL-NUM
1214
Number of object-tree tables that can be
used by GPI application not in valid range.
SEC-BAD-IPC-HDR-LEN
1215
Total length of GPI internal protocol
element not expected value.
SEC-BAD-IPC-ELMT-LEN
1216
Total length of GPI internal protocol
element not expected value.
1200 ZGPI-SEC-NOT-AN-ATTR-PTR
Cause. The specified pointer does not refer to an attribute.
1201 ZGPI-SEC-MISSING-PTR
Cause. An expected pointer has not been specified.
1202 ZGPI-SEC-BAD-PTR
Cause. The specified pointer does not match the expected value.
1203 ZGPI-SEC-BAD-OT-SIZE
Cause. The size of the object-tree table defined in the GPI library is inconsistent with
the size of the GIP object-tree table.
1204 ZGPI-SEC-BAD-MV-HDR
Cause. A GPI internal protocol element for a multivalued attribute contains incorrect
values or has an invalid format.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -54
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. An attempt to allocate an object-tree table failed due to an internal inconsistency
relating to the object tree.
1208 ZGPI-SEC-NUM-EXCEEDED-MAX-OTS
Cause. During GPI initialization, an attempt was made to allocate more object trees
than the maximum number allowed for the GPI library.
1209 ZGPI-SEC-BAD-SESSION-ID
Cause. The session identifier used by the GPI internally does not match the expected
value.
1210 ZGPI-SEC-VALUE-N-CNT-NOT-MATCH
Cause. The count of the total number of values for a specified attribute maintained by
the object-management module does not equal the actual number of values.
1211 ZGPI-SEC-BAD-OT-TBL-ENTRIES
Cause. The maximum number of attribute entries for each object tree (specified by the
GPI_INITIALIZE_ max-table-entries parameter) is not within the range of
ZGPI-MIN-TBL-ENTRIES and ZGPI-MAX-TBL-ENTRIES. (This is an internal error
probably caused by running with GPI software from more than one release installed at
the same time.)
1212 ZGPI-SEC-BAD-OT-TBL-DATA
Cause. The maximum length in octets for each object tree (specified by the
GPI_INITIALIZE_ max-table-data parameter) is not within the range of
ZGPI-MIN-TBL-DATA and ZGPI-MAX-TBL-DATA. (This is an internal error
probably caused by running with GPI software from more than one release installed at
the same time.)
1213 ZGPI-SEC-BAD-INIT-OT-TBL-NUM
Cause. The number of object-tree tables to be generated during GPI initialization is less
than one or greater than ZGPI-MAX-OT-COUNT. (This is an internal error probably
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -55
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. The total length of the GPI internal protocol element used for the GPI-to-GIP
interface is not the expected value.
Table B-18. ZGPI-TMVC- and ZGPI-WVNC- Secondary Codes
Constant (ZGPI-RC-)
Value
Meaning
TMVC-MULTI-VALUED-ATTR
1250
Multivalued attribute already contains
maximum number of values.
TMVC-SINGLE-VALUED-ATTR
1251
Value for single-valued attribute already
present.
WVNC-ENUMERATED-VALUE
1300
Enumerated value invalid for specified
attribute type.
1250 ZGPI-TMVC-MULTI-VALUED-ATTR
Cause. A multivalued attribute already contains the maximum number of values
allowed.
1251 ZGPI-TMVC-SINBLE-VALUED-ATTR
Cause. A value already exists for the specified single-valued attribute.
1300 ZGPI-WVNC-ENUMERATED-VALUE
Cause. The specified value is not one of the enumerated values allowed for the
specified type of attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -56
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.
PEC-OTT-SIZE-ERROR
1354
Size of object-tree table from object-tree-transport
module is not the expected one.
1350 ZGPI-PEC-OTT-RSP-ERROR
Cause. The object-tree-transport module has returned an error.
1351 ZGPI-PEC-OTT-TYPE-ERROR
Cause. The object-tree-transport module has returned a type that is not expected.
1352 ZGPI-PEC-OTT-OFFSET-ERROR
Cause. The object-tree-transport module has returned a GPI internal protocol element
that is not expected.
1353 ZGPI-PEC-OTT-INDEX-ERROR
Cause. The object-tree-transport module has returned an internal index that is not
expected.
1354 ZGPI-PEC-SIZE-ERROR
Cause. The object-tree-transport module has returned a size for the object-tree table
that is not expected.
Table B-20. ZGPI-IRDC- Secondary Codes
Constant (ZGPI-RC-)
Value
Meaning
IRDC-BOTH-BITS-SET
1400
Incorrect bit string (both bits set) encountered.
IRDC-NEITHER-BIT-SET
1401
Incorrect bit string (neither bit set) encountered.
1400 ZGPI-IRDC-BOTH-BITS-SET
Cause. The inbound-mapping module found an incorrect bit string (both bits set) for
the node being translated.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -57
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.
WVMC-BAD-CRITICALITY
1502
Attribute type specified for CRITICALFOR- value is not one that can have this
criticality.
WVMC-BAD-OR-NAME
1503
Incorrect O/R name specified for attribute.
WVMC-BAD-ACTION
1504
MH-T-ACTION attribute violates protocol
rules.
WVMC-BAD-COUNTRY-NAME
1505
MH-T-COUNTRY-NAME attribute violates
protocol rules.
WVMC-BAD-SYNTAX-TYPE
1506
An invalid syntax type is specified for the
object.
WVMC-EXTRA-ENCODING
1507
Two or more forms of encoding are
specified.
WVMC-RPT-REQS-CONFLICT
1508
Invalid report request value combination is
present.
WVMC-BAD-CONTENT-LEN
1509
The specified length of the content is
invalid.
WVMC-BAD-OBJECT-ID-STRING
1510
The specified id string is invalid because it
does not follow the encoding rules.
1500 ZGPI-WVMC-BAD-BIT-STRING
Cause. The object-management module found an incorrect bit string in an attribute
value.
1501 ZGPI-WVMC-BAD-CONTENT-TYPE
Cause. The value of an MH-T-CONTENT-TYPE attribute violates the protocol rules
specified for the attribute.
1502 ZGPI-WVMC-BAD-CRITICALITY
Cause. The value of an MH-T-CRITICAL-FOR- attribute does not specify a valid
attribute type.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -58
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. The specified syntax type is invalid for the attribute.
1507 ZGPI-WVMC-EXTRA-ENCODING
Cause. In the OM-C-EXTERNAL object, the OM-T-ARBITRARY-ENCODING,
OM-T-OCTET-ALIGNED-ENCODING, and OM-T-ANSI-ENCODING attributes are
mutually exclusive. This error is generated if an attempt is made to specify more than
one of the above attributes in the same object.
1508 ZGPI-WVMC-RPT-REQS-CONFLICT
Cause. The combination of MH-T-MTA-REPORT-REQUEST and
MH-T-ORIGINATOR-REPORT-REQUEST is invalid. If both are present, the value of
MH-T-MTA-REPORT-REQUEST must be greater than or equal to the value of the
MH-T-ORIGINATOR-REPORT-REQUEST.
1509 ZGPI-WVMC-BAD-CONTENT-LEN
Cause. The specified length of the content is invalid.
1510 ZGPI-WVMC-BAD-OBJECT-ID-STRING
Cause. The specified object identifier string is invalid; it violates encoding rules.
Table B-22. ZGPI-NPC- Secondary Codes
Constant (ZGPI-RC-)
Value
Meaning
NPC-TYPE-NOT-FOUND
1550
Attribute type is valid but does not exist in
object.
NPC-POSITION-NOT-FOUND
1551
Specified value position does not exist in
multivalued attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -59
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.
IGIC-BAD-PNAME-LEN
1601
Gateway process name too long.
IGIC-BAD-AUX-PNAME-LEN
1602
Gateway auxiliary process name too long.
IGIC-BAD-AUX-PNAME
1603
Gateway auxiliary process not configured or not
in valid state.
IGIC-BAD-GATEWAY-TYPE
1604
An invalid gateway type was specified.
1600 ZGPI-IGIC-TOO-MANY-PNAMES
Cause. Too many gateway processes are configured.
1601 ZGPI-IGIC-BAD-PNAME-LEN
Cause. The gateway process name is too long.
1602 ZGPI-IGIC-BAD-AUX-PNAME-LEN
Cause. The gateway auxiliary process name is too long.
1603 ZGPI-IGIC-BAD-AUX-PANME
Cause. The gateway auxiliary process name is not configured or is in an invalid form.
1604 ZGPI-IGIC-BAD-GATEWAY-TYPE
Cause. The specified gateway type is not valid.
Table B-24. ZGPI-PFIC- Secondary Codes
Constant (ZGPI-RC-)
Value
Meaning
PFIC-INFO-NOT-INIT
1650
PDU store not correctly initialized by GIP.
PFIC-INFO-NO-PDU
1651
PDU identifier is null, PDU does not exist, or
record locked in PDU store.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -60
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. The PDU identifier is null, the PDU does not exist in the PDU store, or an
attempt to read the PDU store failed, because a record was locked.
1652 ZGPI-PFIC-INFO--NO-STORE
Cause. The PDU store is not available for reading or does not exist.
1653 ZGPI-PFIC-INFO--NO-TMF
Cause. TMF has not been started.
1654 ZGPI-PFIC-UNEXPECTED-ERROR
Cause. The GIP received an unexpected error while trying to access the PDU store.
Table B-25. ZGPI-UAQC- Secondary Codes
Constant (ZGPI-UAQC-)
Value
Meaning
INVALID-MGR-NAME
1700
The MRP’s MHS manager does not match the GIP’s
MHS manager.
INVALID-GATEWAY-ID
1701
The MRP gateway does not match the GIP gateway.
1700 ZGPI-UAQC-INVALID-MGR-NAME
Cause. The MHS manager of the MRP which registered is not the same as the MHS
manager of the GIP. They must be the same.
1701 ZGPI-UAQC-INVALID-GATEWAY-NAME
Cause. The gateway ID (an internal value which maps to the gateway name) of the
MRP which registered is not the same gateway ID of the GIP. They must be the same.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -61
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. The PDU identifier is null, or the PDU cannot be found in the PDU store.
1751 ZGPI-QEAC-INVALID-GW-PDU
Cause. The PDU is known, but has not been delivered to a gateway.
1752 ZGPI-QEAC-INVALID-GW-ID
Cause. The PDU has been delivered to the wrong gateway. The gateway identifier
associated with the PDU is put into the error code field in the information buffer.
Information Buffer
The GPI_STATUS_ procedure returns additional information in the information buffer
to which you provide a pointer in the info-buffer parameter. Based on the returned
buffer length and type of structure, the information buffer can contain no information or
information formatted in these five structures:
ZGPI-ST-ERROR-ATTR
ZGPI-ST-DANGLING-OBJ
ZGPI-ST-INFO-3
ZGPI-ST-INFO-4
ZGPI-ST-INFO-5
Depending on the error, different combinations of the five structures are returned. For a
detailed explanation of how to examine the information buffer, see the OSI/MHS
Gateway Programmatic Interface (GPI) Programming Guide.
The structure type (Z-STRUCT-TYPE) is provided at the beginning of each structure
contained in the information buffer.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -62
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.
If the actual buffer length returned from the GPI is greater than zero, the information
buffer contains error information. The five structure types for which information is
returned are described in the following DDL definitions and field descriptions. For
attributes in error and dangling objects, a figure also shows the data structure of the
information buffer.
ZGPI-ST-ERROR-ATTR (Value 10)
This structure returns the content of an attribute descriptor that has caused an error.
DEFINITION ZGPI-INFO-1.
02 Z-STRUCT-TYPE
02 Z-DATA
END
TYPE BINARY 32.
TYPE ZGPI-ERROR-ATTR-DATA.
DEFINITION ZGPI-ERROR-ATTR-DATA.
02 Z-OBJ-ID
TYPE
02 Z-OBJ-CLASS
TYPE
02 Z-OBJ-TYPE
TYPE
02 Z-ATTR-DSCR
TYPE
02 Z-ATTR-STRING-VALUE
TYPE
END
OM-OBJECT.
OM-CLASS.
OM-TYPE.
OM-DESCRIPTOR.
CHARACTER 16.
Z-OBJ-ID
is the object identifier of the object associated with the error. The value
OM-ELEMENTS-UNSPECIFIED indicates that the object identifier is unknown.
Z-OBJ-CLASS
is the class of the object, if known; otherwise, the value is
ZGPI-CLASS-UNSPECIFIED.
Z-OBJ-TYPE
is the attribute type of the object, if known and if the object is a subobject;
otherwise, the value is OM-T-UNSPECIFIED.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -63
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -64
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.)
Z-ATTR-STRING-VALUE
•••
First 16 Octets of String
Value of Attribute
VST 601.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -65
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.
02 Z-OBJ-ID
TYPE OM-OBJECT.
02 Z-OBJ-CLASS
TYPE OM-CLASS.
END
Z-OBJ-ID
is the object identifier of the dangling object (the object has been created but not
inserted as an attribute).
Z-OBJ-CLASS
is the class of the dangling object.
Z-ROOT-OBJ-ID
is the object identifier specified as the root object when the dangling object was
created.
Z-OBJ-COUNT
is the total number of dangling objects that have been created for the root object.
This value indicates the number of entries in Z-OBJ-LST.
Z-OBJ-LST
is an array of dangling objects. For each dangling object, the array contains
Z-OBJ-ID and Z-OBJ-CLASS.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -66
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.)
Z-ATTR-STRING-VALUE
•••
First 16 Octets of String
Value of Attribute
VST 601.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -67
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.
Z-CODE-3
is an error source.
Z-CODE-4
is an error class.
Z-CODE-5
contains an error qualifier.
ZGPI-ST-INFO-4 (Value 40)
This structure provides extended error information in format 4 to be reported to your
Compaq representative.
DEFINITION ZGPI-INFO-4.
02 Z-CODE-1
02 Z-CODE-2
02 Z-CODE-3
END
TYPE BINARY 16.
TYPE BINARY 32.
TYPE BINARY 16.
All Z-CODE-n values contain internal GPI information defined by Compaq.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -68
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.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B -69
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.
status
GPI_CLOSE_ (
short
) ;
status
GPI_INITIALIZE_ (
extptr char
unsigned long
unsigned long
unsigned long
) ;
session
*swap_volume,
max_table_entries,
max_table_data,
max_string_length
status
GPI_MT_FINISH_TRANSFER_IN_ (
short
unsigned long
unsigned long
unsigned long
unsigned long
) ;
session,
object,
retain,
all,
remove
status
GPI_MT_START_TRANSFER_IN_ (
short
extptr unsigned long
unsigned long
) ;
session,
*object
encoded
status
GPI_MT_TRANSFER_OUT_ (
short
unsigned long
extptr char
extptr unsigned short
unsigned long
) ;
session,
object,
*local_identifier,
*local_identifier_length,
retain
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
C- 1
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
) ;
object
status
GPI_OM_EXAMINE_ (
unsigned long
unsigned long
unsigned long
unsigned long
extptr char
extptr unsigned
extptr unsigned
extptr char
unsigned long
extptr unsigned
extptr unsigned
) ;
object,
values,
attribute_position,
maximum_number,
*descriptor_list,
*total_number,
*actual_number,
*string_buffer,
string_buffer_length,
*actual_string_length,
*total_string_length
long
long
long
long
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
C- 2
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_LIST_ (
unsigned long
unsigned short
long
unsigned long
extptr char
extptr unsigned
extptr unsigned
extptr char
unsigned long
extptr unsigned
extptr unsigned
) ;
object,
attribute_type,
value_position,
maximum_number,
*descriptor_list,
*total_number,
*actual_number,
*string_buffer,
string_buffer_length,
*actual_string_length,
*total_string_length
long
long
long
long
status
GPI_OM_READ_ (
unsigned long
unsigned short
long
extptr unsigned long
unsigned long
extptr char
extptr unsigned long
extptr unsigned long
) ;
object,
attribute_type,
value_position,
*string_offset,
maximum_number,
*data_string,
*actual_number,
*approx_total_number
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
C- 3
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
unsigned short
extptr char
unsigned short
) ;
*gateway_name,
*gateway_instance_name,
*session,
*environment,
*MHS_mgr_name,
MHS_mgr-name_length,
*gateway_password,
gateway_password_length
status
GPI_STATUS_ (
short
extptr short
extptr unsigned
extptr unsigned
extptr unsigned
extptr unsigned
extptr unsigned
extptr unsigned
extptr unsigned
extptr char
unsigned short
extptr unsigned
extptr unsigned
) ;
status_context,
*session,
*request_type,
*old_status,
*error_class,
*primary_code,
*secondary_code,
*error_qualifier,
*error_source,
*info_buffer,
info_buffer_length,
*actual_info_length,
*total_info_length
short
short
short
short
short
short
short
short
short
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
C- 4
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. For example, MH-T-CONTENT-TYPE is replaced with
Content type.
The names of multivalued attributes are italicized: for example, Recipient
descriptors.
If the syntax of an attribute is OM-S-OBJECT, indicating that its value is an object,
the attribute type appears in plain (or italic) type and the object name appears in
bold type enclosed in parentheses: for example, Expansion history ( Expansion
record ).
The symbol o (a lowercase letter O) preceding an attribute indicates that the
attribute is optional.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 1
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.)
or EDI forwarded notification (See Figure D-9.)
or EDI negative notification (See Figure D-10.)
or EDI positive notification (See Figure D-10.)
Content identifier
Content return requested
Content type
Conversion prohibited
Critical-for-delivery
Critical-for-submission
Critical-for-transfer
Deferred delivery time
Disclosure allowed
Expansion history ( Expansion record )
Name ( OR name (See Figure D-8.) )
(
2 attributes )
Expansion prohibited
Extensions ( Extension ( 6 attributes ) )
External trace info ( External trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 10 attributes )
Internal trace info ( Internal trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 12 attributes )
MTS identifier ( MTS identifier ( 5 attributes ) )
Original EITS ( EITS (See Figure D-8.) )
Originator name ( OR name (See Figure D-8.) )
Priority
Recipient descriptors ( Message RD )
o
Extensions ( Extension ( 6 attributes ) )
Recipient name ( OR name (See Figure D-8.) )
( 10 attributes )
OM class
o Indicates optional attribute
VST 801.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 2
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.) )
( 2 attributes )
o
Expansion prohibited
o
Extensions ( Extension ( 6 attributes ) )
o
External trace info ( External trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 10 attributes )
Internal trace info ( Internal trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 12 attributes )
MTS identifier ( MTS identifier ( 5 attributes ) )
o
Original EITS ( EITS (See Figure D-8.) )
Originator name ( OR name (See Figure D-8.) )
Recipient descriptors ( Probe RD )
o
Extensions ( Extension ( 6 attributes ) )
Recipient name ( OR name (See Figure D-8.) )
( 10 attributes )
OM class
o
Indicates optional attribute
VST
802.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 3
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.)
o
o
o
o
o
o
o
Content extensions ( Extension ( 6 attributes ) )
Content identifier
Content type
Critical-for-delivery
Critical-for-submission
Critical-for-transfer
Expansion history ( Expansion record )
Name ( OR name (See Figure D-8.) )
( 2 attributes )
o
o
Extensions ( Extension ( 6 attributes ) )
External trace info ( External trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 10 attributes )
o
o
o
MTS identifier ( MTS identifier ( 5 attributes ) )
Original EITS ( EITS (See Figure D-8.) )
Per-recipient reports ( Per-recipient DR or Per-recipient NDR (See Figure D-7.) )
Report additional info
Report destination ( OR name (See Figure D-8.) )
Report external trace info ( External trace entry (same as above) )
Report internal trace info ( Internal trace entry )
o
Converted EITS ( EITS (See Figure D-8.) )
( 12 attributes )
Report MTS identifier ( MTS identifier ( 5 attributes ) )
Reporting DL name ( OR name (See Figure D-8.) )
OM class
o Indicates optional attribute
VST 803.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 4
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.) )
Auto-forwarded
( 3 attributes )
Blind copy recipients( Recipient specifier)
Body can be
Recipient ( OR descriptor (same as above) )
( 4 attributes )
Bilat-defined body part( 2 attributes )
or Externally defined body part
o
External data ( OM external( 7 attributes ) )
External parms ( OM external( 7 attributes ) )
( 1 attribute )
G3-fax NBPS( 8 attributes )
or G3-fax body part
or G4-class 1 body part ( 2 attributes )
( 2 attributes )
or IA5-text body part ( 3 attributes )
or ISO 6937 text body part ( 3 attributes )
or Message body part(See Figure D-5.)
or Mixed-mode body part( 2 attributes )
or NAT-defined body part( 2 attributes )
or Teletex body part
Teletex NBPS( 6 attributes )
or Unidentified body part( 3 attributes)
( 3 attributes )
or Videotex body part ( 3 attributes )
Copy recipients( Recipient specifier(same as above ) )
Expiry time
Extensions ( Extension ( 6 attributes ) )
Importance
Obsoleted IPM( IPM identifier )
User ( OR name(See Figure D-8.) )
Originator ( OR descriptor (same as above) )
( 2 attributes )
Primary recipients( Recipient specifier(same as above) )
Related IPMs( IPM identifier (same as above) )
Replied to IPM ( IPM identifier (same as above) )
Reply recipients( OR descriptor(same as above) )
Reply time
Sensitivity
Subject
This IPM ( IPM identifier (same as above) )
OM class
Indicates optional attribute
VST 804.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 5
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.) )
Critical-for-delivery
Critical-for-submission
o
o
Critical-for-transfer
Delivery time
o
Expansion history ( Expansion record )
Name ( OR name (See Figure D-8.) )
( 2 attributes )
Extensions ( Extension ( 6 attributes ) )
o
o
o
o
o
o
o
o
Intended recipient name ( OR name (See Figure D-8.) )
Original EITS ( EITS (See Figure D-8.) )
Originator name ( OR name (See Figure D-8.) )
Other recipient names ( OR name (See Figure D-8.) )
Preferred delivery modes
Priority
Submission time
OM class
IPM ( Interpersonal message (See Figure D-4. ) )
OM class
o
Indicates optional attribute
VST 805.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 6
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.) )
Receipt time
( 3 attributes )
Subject IPM ( IPM identifier )
o
Name ( OR name (See Figure D-8.) )
( 2 attributes )
Supplementary receipt information
OM class
NON-RECEIPT NOTIFICATION
o
Auto-forward comment
o
Conversion EITS ( EITS (See Figure D-8.) )
Discard reason
o
IPM intended recipient ( OR descriptor )
o
Formal name ( OR name (See Figure D-8.) )
o
o
( 3 attributes )
IPN originator ( OR descriptor )
o
Formal name ( OR name (See Figure D-8.) )
( 3 attributes )
Nonreceipt reason
Returned IPM ( Interpersonal message (See Figure D-4. ) )
Subject IPM ( IPM identifier )
OM class
o
Name ( OR name (See Figure D-8.) )
( 2 attributes )
Indicates optional attribute
VST 806.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 7
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.) )
Intended recipient number
MTA report request
MTA responsibility
o
Originator report request
Supplementary info
OM class
PER-RECIPIENT NDR
Actual recipient name ( OR name (See Figure D-8.) )
Arrival time
o
o
o
Converted EITS ( EITS (See Figure D-8.) )
Extensions ( Extension ( 6 attributes ) )
Intended recipient name ( OR name (See Figure D-8.) )
Intended recipient number
MTA report request
MTA responsibility
Nondelivery diagnostic
Nondelivery reason
Originator report request
o
Supplementary info
OM class
o
Indicates optional attribute
VST 807.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
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. OR Name and EITS Object Classes
OR NAME
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
ADMD name
Common name
Country name
Domain type 1
Domain type 2
Domain type 3
Domain type 4
Domain value 1
Domain value 2
Domain value 3
Domain value 4
Extensions ( Extension ( 6 attributes ) )
Generation
Given name
Initials
Numeric user identifier
Organization name
Organizational unit name 1
Organizational unit name 2
Organizational unit name 3
Organizational unit name 4
PRMD name
Surname
Terminal identifier
Terminal type
X121 address
OM class
EITS
o
o
o
o
o
Builtin EITS
External EITS
G3-fax NBPS ( G3-fax NBPS ( 8 attributes ) )
G4-fax NBPS
Teletex NBPS ( Teletex NBPS ( 6 attributes ) )
OM class
o Indicates optional attribute
VST 808 .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D- 9
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.) )
Primary body part can be
EDI body part ( 2 attributes )
or EDIM body part (See Figure D-12.) )
OM class
FORWARDED NOTIFICATION
o
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.) )
Forwarded notification reason code can be
Forwarded notification PDAU reason code( 3 attributes ) )
or Forwarded notification UAMS reason code( 4 attributes )
or Forwarded notification user reason code (3 attributes)
Fowarded notification extensions ( EDI extension ( 4 attributes ) )
Forward to ( OR name (See Figure D-8.) )
Notification extensions ( EDI extension ( 4 attributes ) )
Notification time
Security elements ( Security elements (See Figure D-13. ) )
Subject EDIM ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Supplementary information
OM class
Indicates optional attribute
VST 809 .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D -10
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.) )
Negative notification extensions ( EDI extension ( 4 attributes ) )
Negative notification reason code can be
Negative notification PDAU reason code ( 3 attributes ) )
or Negative notification UAMS reason code ( 3 attributes )
or Negative notification user reason code ( 3 attributes )
Notification extensions ( EDI extension ( 4 attributes ) )
Notification time
Security elements ( Security elements (See Figure D-13.) )
Subject EDIM ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Supplementary information
OM class
POSITIVE NOTIFICATION
o
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.) )
Notification extensions ( EDI extension ( 4 attributes ) )
Notification time
Positive notification extensions ( EDI extension ( 4 attributes ) )
Security elements ( Security elements (See Figure D-13.) )
Subject EDIM ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Supplementary information
OM class
Indicates optional attribute
VST 810 .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D -11
Class Hierarchies
Figure D-11 shows the structure of the EDI-C-EDI-HEADING class.
Figure D-11. EDI Heading Object Class
EDI HEADING
o
o
Application reference
Application security elements ( Application security elements )
o
Application security extensions ( EDI extension (4 attributes) )
( 3 attributes )
Bodypart type
o
Cross referencing information ( Cross referencing information )
o
Message reference ( EDIM ID )
o
o
Date and time of preference
( 3 attributes )
EDIN receiver ( EDIN receiver )
o
o
o
o
o
o
o
o
o
o
o
o
o
User ( OR name (See Figure D-8.) )
( 2 attributes )
First recipient ( OR name (See Figure D-8.) )
Receiver name ( OR name (See Figure D-8.) )
Originator EDIM ID ( EDIM ID )
( 1 attribute )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Expiry time
Heading extensions ( EDI extension ( 4 attributes ) )
Incomplete copy
Interchange sender ( Interchange sender recipient ( 4 attributes ) )
Message type
Obsoleted EDIMs ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Originator ( OR name (See Figure D-8.) )
Recipients ( Recipients )
o
Authorization Information ( Authorization information ( 3 attributes ) )
o
Interchange recipient ( I nterchange sender recipient ( 4 attributes ) )
o
Notification requests ( Notification requests ( 8 attributes ) )
Recipient ( OR name (See Figure D-8.) )
o
Recipient reference ( Recipient reference ( 3 attributes ) )
o
Recipient extensions ( EDI extension ( 4 attributes ) )
( 8 attributes )
Related EDIMs ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
Related non-EDIMs ( OM external ( 7 attributes ) )
Responsibility forwarded
Service string advice ( Service string advice ( 7 attributes ) )
Syntax ID ( Syntax ID ( 3 attributes ) )
This EDIM ( EDIM ID )
User ( OR name (See Figure D-8.) )
( 2 attributes )
OM class
o Indicates optional attribute
VST 811 .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D -12
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.) )
Critical-for-delivery
Critical-for-submission
Critical-for-transfer
Delivery time
Expansion history ( Expansion record )
Name ( OR name (See Figure D-8.) )
( 2 attributes )
Extensions ( Extension ( 6 attributes ) )
Intended recipient name ( OR name (See Figure D-8.) )
Original EITS ( EITS (See Figure D-8.) )
Originator name ( OR name (See Figure D-8. ) )
Other recipient names ( OR name (See Figure D-8.) )
Preferred delivery modes
Priority
Submission time
OM class
Additional body parts ( EDIM Externally defined body part )
OM object ( Externally defined body part )
( 3 attributes )
External data ( OM external ( 7 attributes ) )
o
External parms ( OM external ( 7 attributes ) )
OM class
Heading ( EDI heading (See Figure D-11.) )
o
o
Primary body part ( EDI body part ( 2 attributes ) or EDIM body part (See Figure D-12.) )
Supplementary information
OM class
o
Indicates optional attribute
VST 812 .VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D -13
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.)
or EDI negative notification (See Figure D-10.)
or EDI positive
(See Figure D-10.)
o
Original content integrity check ( Algorithm and result)
OM class
Algorithm ( Algorithm ) )
( 2 attributes )
o Indicates optional attribute
VST 813.VSD
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
D -14
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.
This appendix does not give detailed information about the event messages or present
messages generated by processes other than the GPI. For complete information about
all OSI/MHS event messages refer to the OSI/MHS Management Programming Manual.
Note. When the GIP cannot communicate with the collector process, the GIP writes a text
message to the output file of the MHS manager.
Table E-1 summarizes the event messages that are generated by GIP processes.
Table E-1. GPI Event Messages
Event
Number
Symbolic Name
(ZMHS-EVT-)
Description
1
INTL-ERR
Unrecoverable internal error
2
INTL-WARN
Internal warning
6
BAD-PROT-ELEM
Undecodable communication
12
IO-ERR
File system error from I/O operation
26
BAD-MSG
Unexpected communication
29
FTL-IO-ERR
Unrecoverable file system error
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
E- 1
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. It defines a set of primitive elements whose range of
values is fully defined—for example, integers, characters, and Boolean values—and
ways of combining these elements.
adjacent MTA. An MTA that has a direct path to your OSI/MHS subsystem.
ACSE (Association Control Service Element). An application service element (ASE) in the
Application Layer. It exists within an application entity and provides for other ASEs to
work together by establishing and releasing associations.
ADMD (Administration Management Domain). An X.400 domain managed by an
administration, such as a government or a public service. ADMDs can send, receive,
and provide intermediate routing for messages. See domain.
Administration Management Domain. See ADMD.
alternate collector. A process to which subsystems can send event messages, rather than to
the primary collector ($0). An alternate collector maintains its own log files.
APDU (application protocol data unit). See PDU.
API (application programmatic interface, application programming interface,
application program interface). A mechanism by which an application program
interacts with another piece of software, usually software that provides services to the
application.
APIA (Application Program Interface Association). See XAPIA.
APPL object. An object type, used in OSI/MHS management interfaces, that defines
information about users of OSI/MHS message stores—that is, about user agents—and
users of gateways. See also UA and GATEWAY object.
Application Layer. Layer 7 of the OSI Reference Model. This layer provides the interface
between user programs (application processes) and the OSI network. Layer 7 includes
the standards for services such as file transfer, electronic mail, and terminal access.
archive queue. A queue to which you can move an object from the input queue during a
finish-transfer-in operation requested of the GPI. Typically, undecodable
communications are placed on the archive queue for future examination using diagnostic
procedures. See also communication.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -1
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.
In the P7 API, the relationship established between a local user agent and OSI/MHS
when an MS bind request is accepted.
association database. A database, within the OSI/MHS subsystem, that contains information
about MTAs, including information about active associations. Each MTA object
represents an adjacent MTA.
attach. An operation performed by an application using OSI/AS or OSI/TS, in the
Application Layer, Presentation Layer, or Session Layer, to indicate that the application
is willing to receive an incoming connect request or association request from a remote
application.
attribute. In general, a characteristic of some entity.
In X.400, an information item that describes an X.400 user and can also identify a
location for that user. An O/R name consists of a list of attributes. See also O/R name.
In the GPI, a fundamental unit of information. It has a type (name), a syntax, and one or
more values. Attributes are grouped to form objects; for example, a message object
includes originator, priority, and country-name attributes See also object.
In DSM, a characteristic of an entity. For example, two attributes of a communications
line might be its baud rate and its retry count. In a token-oriented interface based on
SPI, an attribute of an object is usually expressed as either a simple token or a field
within an extensible structured token.
attribute descriptor. The data structure used to represent attributes in the GPI.
attribute position. In the GPI, the position of an attribute in an object.
attribute syntax. The form of an attribute value. It may be string, Boolean, enumeration,
integer, or object.
attribute type. In general, an element defining the form or range of a value.
In the GPI, a name suggesting the kind of information a value represents: for instance,
MH-T-COUNTRY-NAME. See also attribute syntax.
attribute value. The data for specific instance of an attribute. For example, “US” is a
possible value of an MH-T-COUNTRY-NAME attribute.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -2
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. The substance of an interpersonal message (IPM) or EDI message (EDIM). An
IPM user message can contain one or more body parts. Each IPM body part can have
one of a variety of encoded information types, such as text, facsimile, graphics, or voice.
An EDI interchange consists of one primary body part and one or more additional body
parts. The primary body part contains an EDI interchange (original or forwarded). The
interchange is encoded in a format appropriate for EDI messaging (for example,
EDIFACT). Additional body parts contain information associated with the EDI
interchange, such as drawings or explanatory text. Additional body parts can be
encoded with any of the same information types allowed for IPMs.
CCITT (International Telegraph and Telephone Consultative Committee). A division of
the United Nations International Telecommunications Union that coordinates standardssetting activities.
character string. A set of characters treated as a unit and interpreted by a computer as text
rather than a numeric value.
class. A grouping or category of objects, based on their shared purpose and internal structure.
In the GPI, messages, probes, and reports are the fundamental object classes.
In OSI/MHS, groups of processes fall into classes, depending on the functions the
groups perform; for instance, the MS (message store) class consists of all the MS
processes and associated data in an OSI/MHS subsystem.
CLASS object. An object type, used in OSI/MHS management interfaces, representing all
groups that have the same basic function: for instance, all message relay groups or all
message store groups. You use a CLASS object to configure and control a set of groups
as a unit. The OSI/MHS subsystem recognizes five CLASS object names: #GI, #LO,
#MR, #MS, and #RS. See also group.
client. An application or program that uses another software component, typically called a
“service” or a “server.” For instance, a GPI client uses the GPI service. The XAPIA
specifications use the term “client application.”
closed user group. See CUG.
collector. An EMS process that accepts event messages from subsystems and logs them in
the event log. See also distributor.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -3
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. In DSM programmatic interfaces, a definition (data declaration) used in
several commands, responses, or event messages in an SPI interface to a subsystem.
communication. The transfer of information between or among different entities, or the
information transmitted. In GPI manuals, this term is used to designate a message, a
probe, or a report in statements that apply to all three of these types of X.400 messages.
compatibility distributor. An EMS distributor process that filters event messages according
to fixed (rather than user-specified) criteria, obtains text for these messages that is
compatible with the operator console of Guardian 90 operating system versions earlier
than C00, and writes the text to the standard Guardian 90 console-message destinations.
conditional token. In DSM event management, a token that is sometimes, but not always,
present in a particular event message. See also unconditional token.
configuration and control components. The OSI/MHS components (such as the MHS
manager and configuration databases) and related products (such as SCF) that
specifically support management of the OSI/MHS subsystem.
configuration database. An OSI/MHS database that consists of the following databases:
subsystem, class, group, process, local MTA and MTA identity, entry, OSI address, MS
configuration, and RTS configuration.
configuration database subvolume. The subvolume that contains the OSI/MHS
configuration database. The default location is the same subvolume as the executable
object file for the MHS manager process This subvolume contains a set of Enscribe
files. The files are protected by TMF auditing. The file names are prefixed with the
first four characters of the process name of the MHS manager.
configuration file. An SCF command file that contains all the configuration information
about one subsystem. See also OSI/MHS subsystem.
configured object. An object whose characteristics have been defined to OSI/MHS through
SCF or a management application. See also nonconfigured object.
confirm primitive. In OSI, a primitive issued when a service user is to be informed about its
request. This is one of four types of service primitives. See also service primitive.
connection. In OSI, a relationship between a service access point on one protocol stack and a
corresponding point on a different protocol stack in the desired system (this could be the
same system, or another local or remote system). See also association.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -4
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. In DSM, those operations that affect or request information about the
state or configuration of an object. See also event management.
correspondent. A sender or receiver of information within the Transfer subsystem.
Examples of possible types of correspondents are a person, an interest group, a process,
or a device.
critical event. A DSM event that is crucial to the operation of the system or network. Each
subsystem determines which of its events are critical, designating them as such by
setting the value of the emphasis token to TRUE. See also noncritical event.
CUG (closed user group). A set of users who may communicate with one another. Closed
user groups are an optional feature of OSI/MHS and are not part of the X.400
recommendations; when CUGs are established, users may communicate with one
another only if both are part of the same CUG.
CUG object. An object type, used in OSI/MHS management interfaces, that identifies a
closed user group to the Compaq OSI/MHS subsystem.
CUGMEMBER object. An object type, used in OSI/MHS management interfaces, that
identifies an individual member of a closed user group.
data communications standard definitions. In DSM, the set of declarations provided by
Compaq for use in all management applications that manage or retrieve event messages
from Compaq data communications subsystems. The names of these definitions start
with either ZCOM or ZCMK. See also definition files, SPI standard definitions, or EMS
standard definitions.
Data Link Layer. Layer 2 in the OSI Reference Model. This layer packages data for
transmission across the physical link and ensures that the data arrives at the next layer
without any errors.
data list. In DSM programmatic interfaces, a group of tokens used to separate response
records within an SPI message for a response, or to enclose a single response record, if
the program so requests. A data list consists of a list token that denotes a data list
(different from the token that starts an error list or a generic list), followed by a response
record and an end-list token.
decoding. The process of changing ASN.1 encoded (BER) data into a local representation.
See also encoding and BER.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -5
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.
In the case of the Subsystem Programmatic Interface (SPI), there is a standard definition
file in Data Definition Language (DDL) and a definition file for each of the
programming languages supporting SPI; the latter files are derived from the DDL
definition file. Likewise, each subsystem that has a token-oriented programmatic
interface has one definition file for DDL and one for each programming language.
Some subsystems—for instance, data communications subsystems—have additional,
shared definition files. See also SPI standard definitions, data communications standard
definitions, or EMS standard definitions.
delivery envelope. An “inner” X.400 envelope that relates to the P3 protocol. A delivery
envelope may be included in the message body part for an IPM or the primary body part
for an EDI interchange. A delivery envelope is not the same as and should not be
confused with an “outer” X.400 envelope, which is attached to messages, probes, and
reports and relates to the P1 protocol.
delivery report. A notification to the originator of a message that indicates the message was
successfully delivered to each of the intended recipients. See also nondelivery report.
diagnostic code. A value indicating why a message was not delivered (called a non-deliverydiagnostic code in the X.411 standard).
Distributed Systems Management. See DSM.
distribution list. A list of users to whom it is possible to address messages collectively. The
distribution list name logically represents the names of all members of the list.
OSI/MHS and Transfer both support distribution lists.
distributor. An EMS process that distributes event messages from event logs to requesting
management applications, to Guardian 90 console message destinations, or to a collector
on another node. See also compatibility distributor, printing distributor, or collector.
DLIST object. An object type, used in OSI/MHS management interfaces, that identifies a
local distribution list within the Compaq OSI/MHS subsystem.
DLISTMEMBER object. An object type, used in OSI/MHS management interfaces, that
identifies an individual member of a local distribution list.
domain. A collection of nodes on an X.400 network; these are connected through MTAs.
There are two types of domains: ADMDs and PRMDs.
DSM (Distributed Systems Management). A set of tools used to manage Compaq
NonStop™ systems and Expand networks. These tools include the ViewPoint console
application and various other applications, the Subsystem Control Facility (SCF) for
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -6
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. The onward transfer of a received EDIM to one or more recipients
determined by a forwarding EDI-UA, EDI-MS, or PDAU. The EDIM is forwarded
along with EDI notification requests contained within it. Any of the body parts within
the EDIM can be removed (wholly, not partially) when forwarding, except a forwarded
body part, which cannot be removed. Body parts that are removed when forwarding are
replaced with placeholders to indicate which type of body part was removed. Note that
the heading of an EDIM cannot be removed when forwarding.
EDI interchange. A trade document (such as a purchase order or invoice) in interchange
format. Currently, three formats are used widely: EDIFACT, ANSI12, and UNTDI. Of
these formats, EDIFACT is generally accepted worldwide as the defacto standard.
EDI messaging system (EDIMS). The means by which EDI messaging users communicate
with one another. The EDIMS can be viewed as consisting of functional objects which
interact. The central object, or core of the EDIMS, is the X.400 message transfer system
(MTS). The EDIMS uses MTS as an infrastructure for exchange of EDIMs. Each
EDIM is transferred as X.400 message content accompanied by an envelope (which
conforms to P1 protocol). The format of message content is similar to, but not the same
as, a P2 message. In addition to the MTS, the EDIMS also consists of numerous
peripheral objects of three kinds: EDI user agents (EDI-UAs), EDI message stores
(EDI-MSs), and EDI access units (EDI-AUs). These peripheral objects can be viewed
as access points for EDI users.
EDI messaging (EDIMG). The exchange of EDI messages (EDIMs) and EDI notifications
(EDINs). Both are information objects specified in CCITT Recommendation X.435.
EDI-MS (EDI message store). An X.400 MS that is tailored to better assist a single EDI-UA
to engage in EDI messaging.
EDI-UA (EDI user agent). An X.400 UA that is tailored to assist an EDIMS user to engage
in EDI messaging.
EDIFACT (Electronic Data Interchange for Administration, Commerce, Transport).
Trade document format developed in 1988 by the United Nations Economic
Commission of Europe (UNECE). EDIFACT is generally accepted worldwide as the
defacto standard for an EDI interchange.
EDIM (EDI message). Mechanism used to transfer an EDI interchange between originator
and recipient(s). An EDIM consists of a heading and body. The heading contains
information that describes the EDI interchange. The body consists of one primary body
part, and optionally, one or more additional body parts. The primary body part contains
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -7
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). When a user accepts responsibility,
the body parts of that message are made available to the user by the associated EDI-UA,
EDI-MS, or PDAU (which received the EDIM on behalf of the user).
EDIMS user. An X.400 user that engages in EDI messaging. An EDIMS user originates,
receives, or both originates and receives EDIMs. An EDIMS user may be a person or a
computer process. An EDIMS user may access the EDI messaging system directly
through an EDI user agent or access unit, or indirectly through an EDI message store.
Note that each EDIM contains only one EDI interchange (which may or may not have
been forwarded).
EDIN (EDI notification). A notification indicating the disposition of an EDIM received.
An EDIN can be requested by the originator of an EDIM when the EDIM is sent. The
EDIN is generated by the EDI-UA, EDI-MS, or PDAU associated with the recipient.
There are three possible conditions that can be requested and reported on: forwarded
notification (FN), negative notification (NN), and positive notification. Each type of
notification relates to acceptance or refusal of responsibility for the EDIM by the
recipient. See also forwarded notification, negative notification, and positive
notification.
Electronic data interchange (EDI). The automated exchange of structured business data,
such as invoices and purchase orders.
element. See string element.
element of service. In OSI, a feature or function defined as part of a service.
empty response record. In DSM programmatic interfaces, a response record containing only
a return token with a value that means “no more response records.”
EMS (Event Management Service). A part of DSM used to provide event collection, event
logging, and event distribution facilities. It provides for different event descriptions for
interactive and programmatic interfaces, lets an operator or application select specific
event-message data, and allows flexible distribution of event messages within a system
or network. EMS has SPI-based programmatic interfaces for reporting events and
retrieving event messages.
EMS collector. See collector.
EMS standard definitions. The set of declarations provided by EMS for use in event
management, regardless of the subsystem. Any application that retrieves tokens from
event messages needs the EMS standard definitions. See also definition files, data
communications standard definitions, or SPI standard definitions.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -8
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. The envelope takes different forms from the time
the message is submitted to the time it is delivered or retrieved, and depending on
whether it is submitted or retrieved directly through an MTA or through a message store.
See also content.
error. A condition that causes a command or other operation to fail. See also warning.
error list. In DSM programmatic interfaces, a group of tokens used within a response record
to provide error and warning information. An error list consists of a list token that
denotes an error list (different from the token that starts a data list or a generic list),
followed by an error token, other tokens explaining the error (optional), and an end-list
token. Error lists can be nested within other error lists. The return token cannot be
included in an error list.
error number. In DSM programmatic interfaces, a value that can be assigned to a return
token, or to the last field of an error token, to identify an error that occurred. Some error
numbers are defined in the data communications (ZCOM) definitions; others are defined
by individual subsystems.
error token. In DSM programmatic interfaces, a token in a response message that indicates
the reason an error occurred in performing a programmatic command. Compaq
subsystems enclose each error token in an error list, which can also contain additional
information about the error. A response record must contain a return token and can also
contain error lists to explain the error further.
event. In DSM, a significant change in some condition in the system or network. Events can
be operational errors, notifications of limits exceeded, requests for action needed, and so
on.
event log. A file or set of files maintained by EMS to store event messages generated by
subsystems.
event management. The reporting and logging of events, the distribution and retrieval of
information concerning those events, and the actions taken by operations personnel or
software in response to the events. See also control and inquiry.
Event Management Service. See EMS.
event message. A special kind of SPI message that describes an event occurring in the
system or network. See also command message or response message.
event-message template. A structured form in which to display event messages.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -9
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. In some
cases, no recovery action is needed; in others, some recovery action is required; and in
other cases, no programmatic recovery is possible. On receipt of an exception report
indication, either the local or the remote application must initiate an action to clear the
error before either application can initiate any other services.
exporter. In the Transfer X400 gateway, the server that moves messages from the Transfer
environment into the X.400 environment. See also importer.
extended processing. In the GPI, the type of operation requested of an MTA or MTS user by
means of an extension. See also extension.
extensible structure. In DSM programmatic interfaces, a structure declared for the value of
an extensible structured token. See also fixed structure.
extension. In X.400, an element of service that was defined in the 1988 recommendations but
was not present in the 1984 recommendations. Some 1988 extensions are explicitly
supported by the GPI, whereas others are not. Those that are supported are represented
by explicit attributes in the GPI. The extensions that are not explicitly supported by the
GPI are made available as BER-encoded data; GPI objects that include unsupported
extensions contain one or more instances of the MH-C-EXTENSIONS class. See also
BER.
external tracing. The recording of actions taken by a management domain with respect to a
message, probe, or report. See also internal tracing.
extensible structured token. In DSM programmatic interfaces, a token consisting of a token
code and a value that is an extensible structure. Extensible structures can be extended
by adding new fields at the end. Such structures are typically used to indicate the
attributes of an object being operated on and to return status and statistics information in
responses; they can also be used for other purposes. The token is referenced by a token
map that describes the structure to SPI so that SPI can provide compatibility between
different versions of the structure. See also simple token.
file number. An integer that represents a particular instance of an open of a file. A file
number is returned by an OPEN procedure and is used in subsequent I/O procedures to
access the file.
filter. In EMS, a file containing a list of criteria against which incoming event messages can
be evaluated to see if they can pass (all criteria met) or not pass (one or more criteria
failed) through the filter.
fixed structure. In DSM programmatic interfaces, a multifield structure declared for the
value of a simple token. Fields cannot be added to fixed structures. See also extensible
structure.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -10
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. A forwarded
notification is generated only if it had been requested by the originator of the EDIM.
See also EDIM responsibility.
forwarding IPM. An interpersonal message that encloses another interpersonal message,
which is being forwarded.
fully qualified file name. A file specification that includes the volume, subvolume, and file
name ($vol.subvol.filename), possibly preceded by a system name (\system).
gateway. In general, a device or program that connects dissimilar networks at any layer
above the Network Layer, compensating for protocol differences between the networks.
In X.400, a program that integrates a proprietary messaging system with an X.400
network. For example, the GPI and its client together form a gateway.
GATEWAY object. An object type, used in OSI/MHS management interfaces, that defines
and controls the Transfer X400 gateway or a gateway application based on the Gateway
Programmatic Interface (GPI).
GI (gateway interface) class. The OSI/MHS CLASS object that identifies the set of all GI
groups in an OSI/MHS subsystem.
GIP (Gateway Interface Process). The server that moves messages between a proprietary
message system and OSI/MHS. An application, or “client,” uses the GPI library for
access to the GIP.
GPI (Gateway Programmatic Interface ). A service that provides X.400 access to
proprietary messaging systems through Compaq OSI/MHS.
GPI library. The GPI procedural interface.
GPI service. The combined function of the GPI library and the GIP.
group. A collection of one or more processes and databases that provide a defined set of
services.
GROUP object. An object type, used in OSI/MHS management interfaces, that identifies a
set of related processes and databases: for instance, a message relay process (MRP), a
reliable transfer service (RTS) process, a PDU store, and a store cleaner (SC) process.
You use a GROUP object to configure, stop, and start the set of processes as a unit.
Guardian 90 operating system. The operating system for Compaq NonStop™ systems.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -11
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. Command and response
messages contain a specified set of header tokens; event messages, a different set with
some overlap. See also SPI message.
importer. In the Transfer X400 gateway, the server that moves messages from the X.400
network into the Transfer environment. See also exporter.
inbound communication. A communication received from the X.400 network and available
to a client. See also outbound communication.
indication primitive. In OSI, a primitive issued when a service user is to be informed about
an event. This is one of four types of service primitives. See also service primitive.
input queue. A queue on which the GPI service places messages, probes, and reports
received from the X.400 network to be accessed by a client gateway application.
Install program. The Compaq program that installs new or updated software on the system
from SUT tapes and creates the ISVs.
installation file. The file created through the OSI/MHS installation procedure that contains
the volume and subvolume locations for objects, the security classifications, and the
installation steps.
installation procedure. The OSI/MHS procedure that creates a default edit file and prompts
you to modify that file to fit your configuration requirements.
installation subvolume. See ISV.
interactive command. In DSM, a command given by a human operator rather than by a
program. See also programmatic command.
interface. In general, a set of rules by which a person, a program, or a device interacts with a
hardware or software product.
In OSI, a set of rules by which a given layer passes information to the adjoining layer
below or above.
internal tracing. The recording of actions taken by an MTA with respect to a message,
probe, or report. See also external tracing.
International Telegraph and Telephone Consultative Committee. See CCITT.
interpersonal message (IPM). See IPM.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -12
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). A type of message comparable to an acknowledgment of
receipt of a business memo.
ISO (International Organization for Standardization). A United Nations organization,
established to promote the development of standards to facilitate the international
exchange of goods and services and to develop mutual cooperation in areas of
intellectual, scientific, technological, and economic activity.
ISO Reference Model for Open Systems Interconnection. See OSI Reference Model.
ISV (installation subvolume). A subvolume produced from the SUT during the Install
process. The Install process creates many ISVs. The ISV named ZOSIMHS contains
all of the OSI/MHS object files (MTA, RTS, SC, MS, RS, GI, LO, and MHSMGR),
softdocs, and installation macros.
LAN. A local area network. See also TLAM.
layer. A grouping of related functions in the OSI Reference Model. See Application Layer,
Data Link Layer, Network Layer, Physical Layer, Presentation Layer, Session Layer, or
Transport Layer.
link. A physical and logical path between two adjacent computers or other devices.
In OSI/MHS, a pair of OSI addresses that are configured for each MTA. A pair of OSI
addresses is a set of local and remote address definitions in the MTA object representing
an adjacent MTA.
link retry. The action taken when a line to an adjacent MTA fails or is unavailable. All other
links to that MTA are tried. You set the time available to establish the association
through the CLASS attribute LINK-RETRY-TIME. You set the time to wait before an
MR group can retry the previously failed association through the CLASS attribute
LINK-RETRY-DELAY.
LO (local operations) class. The OSI/MHS CLASS object that identifies the set of all LO
groups in a Compaq OSI/MHS subsystem.
LO (local operations) group. The OSI/MHS group that implements the local operations
function, giving local user agents access to an X.400 network through a message store.
The LO group consists of a single LO process and a PDU store. There can be zero, one,
or more LO groups in a single OSI/MHS subsystem. There must be at least one LO
group for the P7 API to connect with OSI/MHS.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -13
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. A unique identifier that distinguishes an object from all other
communications ever originated by the originating management domain; an attribute of
the MTS identifier object. A local identifier is generated by the GPI when a client
program transfers a communication out to the GPI service.
local user agent. See LUA.
logical MTA. All of the MR groups in an OSI/MHS subsystem.
long string. In the GPI, a string that cannot be passed in an attribute descriptor but must be
manipulated a segment at a time by using the GPI_OM_READ_ and GPI_OM_WRITE_
procedures. At GPI initialization, a client program specifies the maximum length string
that can be passed in a descriptor. All strings longer than the specified maximum are
long strings.
LUA (local user agent). A process that submits and retrieves messages on behalf of a user,
through a message store on the same system as the user agent.
mailbox. A location in an MS SQL database that stores messages for one user. Each MS
group can have up to 1000 mailboxes to support up to 1000 users.
management application. In DSM, an application process that opens a management or
subsystem process to control a subsystem. This process can issue SPI commands to
subsystems and retrieve EMS event messages to assist in managing a computer system
or a network of systems. A management application is a requester with respect to the
subsystems to which it sends commands; the subsystems are servers with respect to the
management application.
management domain. See MD.
management process. In DSM, a Compaq process through which an application issues
commands to a subsystem. A management process can be part of a subsystem, or it can
be associated with more than one subsystem; in the latter case, the management process
is logically part of each of the subsystems. SCP is the management process for all
Compaq data communications subsystems that support DSM. See also subsystem.
manager process. In DSM, a Compaq subsystem process with which the SCP management
process communicates to control a particular data communications subsystem.
master password server. A process that permits a user access to the message stores of one or
more other users, normally for administrative purposes.
MD (management domain). The collection of message handling systems operated by one
organization, which encompasses one or more MTAs and zero or more UAs.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -14
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). A set of components providing for exchange of various
types of information, such as interoffice memoranda, among correspondents in a
network. An MHS consists of MTAs for message transfer, message stores for message
storage, and user agents to represent X.400 users.
MHS manager. The OSI/MHS manager process. The MHS manager runs as a NonStop™
process pair. The process name is made up of a dollar sign ($) followed by one
alphabetic and up to three alphanumeric characters: for example, $ZMHS. See also
manager process.
MIB (management information base). A database used by the OSI manager process to
store and retrieve configuration information and information about applications.
mnemonic O/R address. An O/R address that identifies a user by terms that are easily
remembered. See also numeric O/R address.
MON object. An object type, used in OSI/MHS management interfaces, that enables you to
address commands to the OSI/MHS manager process. The MON object name identifies
the MHS manager process.
MOTIS (Message-Oriented Text Interchange System). The ISO standard for message
handling systems, which is nearly the same as the CCITT X.400 standard.
MPDU (message protocol data unit). A user message, a probe, or a delivery report. An
MPDU can contain other, subordinate PDUs.
MR (message relay) class. The OSI/MHS CLASS object that identifies the set of all MR
groups in an OSI/MHS subsystem.
MR group. The OSI/MHS group that implements the message transfer function. The MR
group consists of three processes: MRP, RTS, and SC. There is one PDU store in each
MR group. Each OSI/MHS subsystem must contain at least one MR group.
MRP (message relay process). A process in the MR group that encodes and decodes
message headers, routes messages, schedules messages for delivery, and performs other
related functions.
MS (message store) class. The OSI/MHS CLASS object that identifies the set of all MS
groups in an OSI/MHS subsystem.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -15
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. An SQL catalog in which the MS, SAVEMBOX, and RESTMBOX
programs may be registered.
MS SQL database. The message store SQL database. Each MS group has one MS SQL
database.
MTA (Message Transfer Agent). The functional component that routes X.400 messages
through an X.400 network. MTAs work together to transfer messages and deliver them
to the intended recipient; there can be multiple MTAs on the path between any two
users. In OSI/MHS, multiple MR groups operate in parallel as a single logical MTA.
MTA object. An object type, used in OSI/MHS management interfaces, that defines adjacent
MTAs and their attributes to the OSI/MHS subsystem.
MTA process. See MRP process.
MTS (Message Transfer System). The part of a message handling system that contains the
MTAs and that permits communication between user agents.
MTS identifier. A unique identifier that distinguishes a communication from all other
communications ever conveyed by the MTS within the MHS.
multithreaded process. A process that handles multiple requests simultaneously.
multivalued attribute. An attribute that can have more than one value.
negative notification (NN). An EDIN that reports responsibility for an EDIM has been
refused. A negative 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
can not be forwarded to another recipient. A negative notification is generated only if it
had been requested by the originator of the EDIM. See also EDIM responsibility.
network address. See NSAP and NSAP address.
Network Layer. Layer 3 in the OSI Reference Model. This layer routes data by establishing,
maintaining, and terminating communications between nodes. It sets up the most
economical path, both physical and logical, between communicating nodes; routes
messages through intervening nodes to their destinations; and controls the flow of
messages between nodes.
network service access point. See NSAP or NSAP address.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -16
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.400 network that has no direct path to your OSI/MHS
subsystem. See also adjacent MTA or remote MTA.
noncritical event. A DSM event that is not crucial to system or network operations. Each
subsystem determines which of its events are noncritical by setting the value of the
emphasis token to FALSE. See also critical event.
nonconfigured object. An object whose characteristics have not been specified to OSI/MHS
through SCF or through a management application that issues programmatic commands.
See also configured object.
nondelivery report. A report generated by the MRP when it cannot deliver a message to the
recipients, or when it cannot deliver a report to the originator of the message or probe.
nonreceipt notification. An indication to the sender of a communication that the
communication was not received by the intended recipients.
nonsensitive command. A DSM command that can be issued by any user or program having
access to the target subsystem—that is, a command on which the subsystem imposes no
further security restrictions. For Compaq data communications subsystems, the
nonsensitive commands are usually information commands (commands that cannot
change the state or configuration of objects). See also sensitive command.
NonStop™ SQL. A relational database management system that combines the ease of use of
the Structured Query Language (SQL) with the application performance provided by the
Guardian 90 operating system.
NSAP (network service access point). The logical point at which Network Layer services
are provided by the Network Layer entity to the Transport Layer entity.
NSAP address. The global, network-unique address of an end system’s network service
access point, through which Network Layer services are provided to local users, and
through which Transport Layer services are provided to remote systems.
null object. An object type, used in management interfaces, that occurs when a subsystem
supports exactly one object of a given type and the type of that object can be deduced
from the name. In OSI/MHS, the object type need not be specified in the VERSION or
NAMES command: the object is understood to be the MHS manager. The null object
has no inherent hierarchical relationship to any other object.
null value. A value indicating that a program has made no explicit assignment to a variable
or field. In DSM programmatic interfaces, a field in a structure has a null value if the
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -17
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.
In DSM, an entity subject to independent reference and control by a subsystem: for
example, the disk volume $DATA or the data communications line $X2502. An object
typically has a name and a type known to the controlling subsystem.
In GPI, a collection of elements (called “attributes”) used for constructing messages.
See also root object, subobject, and superobject.
object identifier. In ASN.1, a set of values identifying an object in an ASN.1 abstract syntax
notation defined by the CCITT.
In the GPI, a unique identifier of a particular object generated by the GPI service when
the client program creates a new object, copies an object, or reserves an object. The
client program passes the object identifier to any GPI procedure operating on the object.
A GPI object identifier is not related to an ASN.1 object identifier.
object management. A means to operate on messages and their elements as objects.
object-name template. In DSM, a name that stands for more than one object. Such a name
includes one or more wild-card characters, such as * and ?. See also wild-card
character.
object tree. The internal form of an X.400 communication maintained by the GPI.
object type. In DSM, the category of objects to which a specific object belongs: for
example, a specific disk file might have the object type FILE, and a specific terminal
might have the object type SU (subdevice). A subsystem identifies a set of object types
for the objects it manages. The SCF interfaces to Compaq data communications
subsystems use standard keywords to identify the types. The corresponding
programmatic interfaces have object-type numbers (represented by symbolic names such
as ZCOM-OBJ-SU) suitable for passing to the SPI SSINIT procedure.
In the GPI, a category of objects having a common purpose and structure is called a
“class.”
octet. A sequence of eight bits. Also called a “byte” or “character.”
octet string. A string comprising octets.
open system. Any computer system that adheres to the OSI standards.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -18
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. A list of attributes that identifies a user as an originator or
potential recipient of a message or probe. An O/R name contains an O/R address.
OSI (Open Systems Interconnection). A set of standards used for the interconnection of
heterogeneous computer systems, thus providing universal connectivity.
OSI manager process. A process in the OSI/AS subsystem that performs subsystem
management functions. The OSI manager is the focal point for all OSI management
activities. It maintains a management information base (MIB) that contains the
configuration information about the OSI environment. There is one OSI manager
process per OSI/AS subsystem.
OSI/MHS (Open Systems Interconnection/Message Handling System). The Compaq
implementation of an X.400 message handling system for Compaq NonStop™ systems.
OSI/MHS database. The database that consists of the registration database and OSI/MHS
configuration database.
OSI/MHS ISV. The installation subvolume for the OSI/MHS release. The Install process
creates this subvolume as ZOSIMHS.
OSI/MHS subsystem. The set of all processes and files defined through the installation
procedure, and through SCF or management applications, to be part of an OSI/MHS
environment, under control of a specified MHS manager. There can be more than one
OSI/MHS subsystem on a Compaq NonStop™ system.
OSI/MHS subvolume. The subvolume that contains all files required by an OSI/MHS
subsystem, such as executable object and configuration files. The MHS manager must
always reside in this subvolume, but some of the other executable files can reside
elsewhere, as defined by the MHS manager.
OSI Reference Model. A communications architecture, adopted by the ISO in 1984, that
includes seven layers that define the functions involved in communications between two
systems, the services required to perform these functions, and the protocols associated
with these services. See also layer.
OSI services. The Compaq implementation of the OSI Reference Model. OSI services
consist of an OSI manager process and a number of subordinate protocol processes. The
protocol processes handle OSI protocols and provide layer services. The network
service provider, NSP, handles layers 1 through 3 and is provided by access methods
such as X25AM and TLAM. The transport service provider, TSP, handles Layer 4 and
is provided by OSI/TS. The TSP process also provides Layer 3 for LANs. The session,
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -19
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.400 message transfer protocol, which defines the transfer of messages
between two message transfer agents (MTAs).
P1 message. An X.400 message that consists of an envelope and its content. The envelope
contains delivery information; the content is the actual information that is to be
delivered to the recipient.
P2 protocol. The X.400 interpersonal message (IPM) user agent protocol, which defines the
format by which one user agent (UA) sends an interpersonal message (IPM) to one or
more other UAs.
P2 message. An X.400 message that consists of a heading followed by a series of data
blocks, called body parts. The heading contains the message originator, recipients, and
other service information. Each body part can contain a different form of data, and
messages can be nested within body parts.
P3 protocol. The X.400 message submission and delivery protocol, which defines a standard
for the submission and delivery of messages and the interaction of UAs and MTAs.
P7 protocol. The X.400 protocol defining access to the message store by remote or local user
agents.
package. A set of GPI object classes that are grouped together because they are functionally
related and defined in the same specification. For example, the MH 88 package consists
of the message handling classes defined in the XAPIA specification.
packet switching. A technique in which messages are broken into smaller units, called
“packets,” which can be individually addressed and routed through the network. The
receiving-end node ascertains that all the packets are received and in the proper
sequence before forwarding the complete message to the addressee.
PAM. See Port Access Method.
password server. An application process that provides security services at the MTA-MTA or
UA-MS boundary. Such an application uses either the MTA-bind or the MS-bind
password server interface of OSI/MHS. The master password server provided with
OSI/MHS is an example of a password server.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -20
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). An information unit that contains control and address information
and possibly data, and is exchanged between peer entities. Two types of PDUs relevant
to X.400 are:
MPDU (message PDU)
Information exchanged between message handling
systems (used by OSI/MHS)
APDU (application PDU)
Information exchanged between OSI Application Layer
entities (used by OSI/AS)
PDU ID. An identifier generated by OSI/MHS for internal use. A PDU ID is not the same as
the MPDU ID defined by X.400.
PDU store. The database that stores messages in an X.400 system. A PDU store consists of a
data file and a log file. Each MR, MS, RS, and LO group has its own PDU store.
Physical Layer. Layer 1 in the OSI Reference Model. This layer establishes the actual
physical connection between the network and the computer equipment. Protocols at the
Physical Layer include rules for the transmission of bits across the physical medium and
rules for connectors and wiring.
Port Access Method (PAM). A Compaq communications subsystem that provides an
independent interface to allow applications access to token-ring or Ethernet local area
networks (LANs) on Himalaya S-series servers. The PAM subsystem provides a port
interface that applications can use by making file-system procedure calls. The PAM
subsystem implements, for LANs, the services of the Data Link Layer and layers below.
PAM replaces the Tandem LAN Access Method (TLAM) for G06 and later releases.
port address. For X25AM lines, the logical port number used to specify the address of the
connection to the X.25 network. For TLAM lines, the address used by TLAM to specify
the address of the connection to a LAN controller.
positive notification (PN). An EDIN that reports responsibility for an EDIM has been
accepted. A positive notification is generated by a receiving EDI-UA, EDI-MS, or
PDAU when EDIM responsibility can be given to the associated user. A positive
notification is generated only if it had been requested by the originator of the EDIM.
See also EDIM responsibility.
Presentation Layer. Layer 6 in the OSI Reference Model. This layer resolves the
differences of varying data formats between systems of different vendors. It transfers
data in a system-independent manner, performing appropriate conversions at each
system as necessary.
presentation selector. See PSEL.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -21
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.400 domain managed by a private
organization, such as a corporation. See also domain.
probe. An X.400 communication sent by an originator into the MTS to test the likelihood of
delivery of a message or report. It consists of an envelope and the description of the
actual content of the message or report. The envelope is similar to, but not the same as,
an envelope that would be used for an actual message or report.
process. A running entity that is managed by the operating system, as opposed to a program,
which is a collection of code and data. A process is a unique execution of a program.
PROCESS object. An object type, used in OSI/MHS management interfaces, that defines a
process to the OSI/MHS subsystem. You use the PROCESS object to trace and monitor
OSI/MHS processes.
programmatic command. In DSM, a command issued by a program rather than by a human
operator. See also interactive command.
programmatic interface. A mechanism by which a program can interact with other software.
programmed operator. In DSM, a management application that performs functions that
might otherwise be performed by a human operator.
protocol. The set of rules governing the format and meaning of the frames, packets, or
messages that are exchanged by the peer entities within a layer. See also service.
PSAP (presentation service access point). A logical location between the Presentation and
Application Layers, through which presentation services are made available to local
users and through which application services are made available to remote systems.
PSEL (presentation selector). An address at the boundary between the Presentation and
Application Layers, through which connections are established and maintained. A
single PSEL can service one or more connections simultaneously and can refer to one or
more presentation service access points (PSAPs).
P-selector. See PSEL.
PTrace. A program that enables you to display trace files. Trace criteria are specified with
SCF.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -22
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. The queue manager can be used independently of
Transfer; it is automatically installed when you configure the Transfer X400 gateway
and is also required for gateways using the Gateway Programmatic Interface (GPI).
reason code. A value indicating why a message could not be delivered (called a “nondelivery-reason-code,” in the X.411 standard).
receipt notification. Indicates to the sender of a message that the message was received and
read by the intended recipient.
$RECEIVE. The name of a special file through which a process receives and optionally
replies to messages from other processes.
recipient. A person or application that receives a message from a message handling system.
registration database. An OSI/MHS database that consists of three files: APPL, route, and
adjacent MTA.
reliable transfer service. See RTSE.
remote MTA. An adjacent or nonadjacent MTA. Any MTA other than your local OSI/MHS
subsystem.
Remote Operations Service. See ROSE.
remote system. In Compaq terms, any system within an Expand network that is not the local
system.
remote user agent. See RUA.
report. A notification generated by the OSI/MHS subsystem that tells the user whether the
message has been sent.
request primitive. In OSI, a primitive issued when a service user wants the service to do
some work. This is one of four types of service primitives. See also service primitive.
reserved object. An object on the input queue that the client program has started transferring
in and to which the GPI has assigned an object identifier. A client program can examine
or copy a reserved object (and its attributes) but not modify it.
response. In OSI, see response primitive.
In DSM, the information or confirmation supplied (as part of a response message) to an
application by a subsystem in reaction to a DSM command.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -23
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. In DSM programmatic interfaces, a set of response tokens, usually
describing the results of performing a command on one object. Every response record in
a response from a Compaq subsystem contains a return token; a response record can also
contain error lists that include error tokens. A response can consist of multiple response
records, spread across one or more response messages.
result file. In the P7 API, a file used for retrieving results from the OSI/MHS subsystem. The
file number is returned by a call to the LOS_OPEN_ procedure. See also send file.
return token. In DSM programmatic interfaces, the token that indicates whether a command
was successful and, if not, why it failed. The token code for the return token is
ZSPI-TKN-RETCODE. Its value consists of a single integer field. See also error token.
root object. In the GPI, a message, probe, report, or P1-encoded object.
ROSE (Remote Operations Service Element). An Application Layer service definition and
protocol supporting interactive applications, implemented by the RS process in
OSI/MHS. Examples of ROSE PDUs are:
ROIV-APDU
Invoke application protocol data unit
RORJ-PDU
Reject application protocol data unit
ROER-APDU
Error application protocol data unit
RORS-APDU
Response application protocol data unit
route. A path through an X.400 system from an originator to a recipient.
ROUTE object. An object type, used in OSI/MHS management interfaces, that defines
routing information to the OSI/MHS subsystem. You use the ROUTE object to define
and inquire about O/R names for addressing adjacent MTAs.
route retry. The action taken when an attempt to deliver a message to an adjacent MTA fails
after all links have been tried and exhausted. Route retry occurs when the subsystem
attempts to deliver the message by an alternate route.
route-selection criteria. The attributes that determine the route the message is to take.
routing. The selection of the adjacent MTA to which a message, probe, or report is
transferred.
routing database. A database in the OSI/MHS registration database that contains records of
ROUTE objects and APPL objects.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -24
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. The RS interfaces to the Compaq OSI/AS services, manages
associations from RUAs, encodes and decodes messages, and creates and deletes PDUs
in the MR or MS PDU stores as submit and retrieval operations are successfully
completed.
RS (remote operations service) group. The OSI/MHS group that implements the remote
operations service, giving remote user agents access to an X.400 network through a
message store. An RS group consists of a single RS process and a PDU store. There
can be zero, one, or more RS groups in a single OSI/MHS subsystem.
RTSE (reliable transfer service element). An Application Layer service definition and
protocol supporting the reliable exchange of application data, defining such services as
recovery from end-to-end failures and reporting delivery status to the sender. In
OSI/MHS, the RTS process implements the RTSE.
RTS (reliable transfer service) process. A process in the MR group that implements the
RTSE protocol and accesses the PDU store to read and write messages.
RUA (remote user agent). A user agent that submits and retrieves messages through a
message store and resides on a system or device other than the system that provides the
message store. See also LUA.
SAP (service access point). In OSI, a logical location between two layers, through which the
services of the lower layer are made available to local users, and those of the upper layer
are made available to remote systems. (The SAP is always named after the lower layer;
for instance, an SSAP is between the Session and Presentation Layers.) For the Network
Layer and below, local users and remote systems use the Network Service Access Point
(NSAP) address to establish and maintain connections. For the Transport Layer and
above, local users and remote systems do not use SAP addresses explicitly; rather, they
specify an address called the “(N)-address,” consisting of one or more selectors. See
also selector.
S-selector. See SSEL.
SC (store cleaner) process. A process that scans the MR group PDU store periodically and
removes messages that have been fully processed.
SCF (Subsystem Control Facility). A part of DSM, used to provide a common, interactive
management interface for configuring, controlling, and collecting information from
Compaq data communications products.
SCP (Subsystem Control Point). In DSM, the management process for all Compaq data
communications subsystems. There can be several instances of this process.
Applications using SPI send all commands for data communications subsystems to an
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -25
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. In OSI, an address component that refers to one or more service access points
(SAPs) of the Transport, Session, or Presentation Layer and is used to establish and
maintain connections. Remote systems and local users specify the selectors as part of an
address called the “n-address.” See also SAP.
send file. In the P7 API, a file used for sending data to the OSI/MHS subsystem. The file
number is returned by a call to the LOS_OPEN_ procedure. See also result file.
sensitive command. In DSM, a command that can be issued only by a restricted set of
Guardian 90 users, such as the owner of a subsystem process. For Compaq data
communications subsystems, the sensitive commands are those that can change the state
or configuration of objects, start or stop tracing, or change the values of statistics
counters. See also nonsensitive command.
service. A set of primitives (operations) that an OSI layer provides to the layer above it. The
service defines what operations the layer can perform on behalf of its users, but not how
these operations are implemented. A service relates to an interface between two layers,
with the lower layer being the service provider and the upper layer being the service
user. See also protocol.
The GPI and P7 API are examples of services available to applications. In both cases,
the service consists of a process and the library procedures that provide the application
interface to that process.
service access point. See SAP.
service element. In OSI, a feature or function defined as part of a service.
service primitive. In OSI, an abstract, implementation-independent interaction between a
service user and a service provider. Service primitives describe the sequences of events
between adjacent layers that occur through the service access point (SAP). There are
four types of service primitives; see confirm primitive, indication primitive, request
primitive, or response primitive.
session. A temporary logical connection between a user and a software product, or between
communicating processes.
In the GPI, an interaction between a client program and the GPI, established when a
client program successfully calls the GPI_OPEN_ procedure. Once a session is
established, the client program can request GPI services by calling other GPI
procedures. A session is ended by calling the GPI_CLOSE_ procedure.
In the P7 API, an interaction between a client program and an LO group, established
when a client program successfully calls the LOS_OPEN_ procedure. Once a session is
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -26
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. It allows the setup and termination of
sessions and controls communication sessions between nodes on the network.
session selector. See SSEL.
simple token. In DSM programmatic interfaces, a token consisting of a token code and a
value that is either a single elementary field, such as an integer or a character string, or a
fixed (nonextensible) structure. See also extensible structured token.
single-valued attribute. An attribute that has only one value.
Site Update Tape. See SUT.
SNPA (subnetwork point of attachment). A real, physical address, identifying the point of
attachment to a subnetwork.
softdoc. A text file in edit-file (code 101) format that is part of a software product version or
an interim product modification (IPM) in the same subvolume. A softdoc provides
information about new product features and sometimes contains information not
included in product manuals.
SPI (Subsystem Programmatic Interface). In DSM, a set of procedures and associated
definition files used to define common message-based programmatic interfaces for
communication between requesters and servers—for instance, in a management
application. SPI includes procedures to build and decode specially formatted messages;
definition files in Pascal, TAL, C, COBOL85, and TACL for inclusion in programs,
macros, and routines using the SPI procedures; and definition files in DDL for
programmers writing their own subsystems.
SPI buffer. The buffer that contains an SPI message. See also SPI message.
SPI message. In DSM programmatic interfaces, a message specially formatted by the SPI
procedures for communication between a management application and a subsystem or
between one subsystem and another. An SPI message consists of a collection of tokens.
Note that an SPI message is a single block of information sent at one time, as one
interprocess message. There are two types of SPI messages, distinguished by different
sets of tokens in the header: command and response messages, and event messages.
SPI procedures. In DSM, the set of Guardian 90 procedures used to build and decode buffers
for use in system and network management and in certain other applications. These
procedures are SSINIT, SSNULL, SSPUT, SSPUTTKN, SSGET, SSGETTKN,
SSMOVE, and SSMOVETKN.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -27
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. A logical location between the Session and Presentation Layers, through which
session services are made available to local users, and through which presentation
services are made available to remote systems.
SSEL (session selector). An address at the boundary between the Session and Presentation
Layers, through which connections are established and maintained. A single SSEL can
service one or more connections simultaneously and can refer to one or more SSAPs.
SSID (subsystem ID). In DSM programmatic interfaces, a data structure that uniquely
identifies a subsystem to SPI. It consists of the name of the owner of the subsystem
(such as Compaq), a subsystem number that identifies that particular subsystem, and a
subsystem version number. The subsystem ID is an argument to most of the SPI
procedures.
string element. The bits of a bit string or the octets of an octet string.
string segment. A portion of a string value consisting of zero or more contiguous octets of its
representation.
subject. In event management, a device, process, or other named entity about which a given
event message has information.
subnetwork. In general, a network that participates in a larger network, possibly through the
use of gateways or bridges.
In OSI, one or more intermediate systems that provide relaying and through which end
systems may establish network connections.
subobject. An object that is an attribute of another object.
SUBSYS object. An object type, used in OSI/MHS management interfaces, that identifies the
subsystem as a whole. You use the SUBSYS object to configure general aspects of the
subsystem and to inquire about the subsystem as a whole.
subsystem. The software and/or hardware facilities that provide users with access to a set of
communications services.
In DSM, a program or set of processes that manages a cohesive set of objects. Each
subsystem has a process through which applications can request services by issuing
commands defined by that subsystem; in some cases, this process is the entire
subsystem. Many subsystems also have interactive interfaces.
See also OSI/MHS subsystem.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -28
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. First, a summary state
pertains only to the management of an object, whereas a state may convey other kinds of
information about the object. Second, summary states are defined the same way for all
Compaq data communications subsystems, whereas the set of possible states differs
from subsystem to subsystem. The management programming interfaces to Compaq
data communications subsystems refer to summary states rather than to states.
Examples of summary states are STARTED, STOPPED, SUSPENDED, and
ABORTING.
superobject. An object that has other objects for one or more of its attributes.
SUT (site update tape). The tape on which Compaq ships its software for installation. The
product files on the SUT tape are grouped into distribution subvolumes (DSVs), the
names of which appear on the last part of the packing list. The SUT contains the DSVs
for OSI/MHS and other products.
symbolic name. In DSM programmatic interfaces, a name used in programs to refer to
commonly used values, token codes, token maps, extensible structures, and other related
variables for use in management programs.
syntax. See attribute syntax.
Sysgen. The Compaq system generation program, used to configure objects such as devices,
controllers, and I/O processes in a newly installed system, or to update the system when
new software is released. Objects to be configured are defined to Sysgen in a special
configuration file, which can then be cold loaded into the system. The Compaq OSI
products are not configured with Sysgen, but the underlying X25AM and TLAM I/O
processes are.
T-selector. See TSEL.
TAL. The Transaction Application Language, which is used to write systems software and
routines that support transaction-oriented applications. It is also used to write
application software.
TAPS (Tandem application, presentation, and session) process. A process in the OSI/AS
subsystem that performs service and protocol functions for ACSE (in the Application
Layer), the Presentation Layer, and the Session Layer. The TAPS process also performs
some management services in the DSM environment.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -29
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. Programs place tokens in an SPI
buffer using the SSPUT or SSINIT procedures and retrieve them from the buffer using
the SSGET procedure. A token has two parts: an identifying code, or token code, and
a token value. In command and response messages, a token normally represents a
parameter to a command, an item of information in a response, or control information
for the subsystem. In event messages, a token normally represents an item of
information about an event or about the event message itself. See also header token.
token code. In DSM programmatic interfaces, a 32-bit value that identifies a token. A token
code consists of a token type (16 bits) and a token number (16 bits). See also token
number, token type, and token map.
token map. In DSM programmatic interfaces, a structure that contains decoding information
for a DSM extensible structured token. Also, a variable name that refers to an extensible
structured token. The token map includes a token code and a description of the token
value: its fields, the null values of those fields, and the versions of the fields. A token
map defines a structure that might change in some later code version (by the addition of
new fields at the end), and the information in the map allows SPI to provide
compatibility between different structure versions.
token number. In DSM programmatic interfaces, the number used by a subsystem to identify
each DSM token that it defines. The token type and the token number together form the
token code.
token type. In DSM programmatic interfaces, the part of a DSM token code that identifies
the data type and length of the token value. The token type and the token number
together form the token code.
token value. In DSM programmatic interfaces, the value assigned to a DSM token.
Transaction Management Facility. See TMF.
Transfer. The Compaq proprietary messaging system, which supports communications
among people, input/output devices, and processes.
Transfer application. A set of processes that communicate with each other and with the
Transfer subsystem and work together to perform a common task.
Transfer X400 gateway. The application that allows Transfer correspondents to exchange
packages with users on other host systems that support the international X.400
message-system standards.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -30
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). A logical location between the Transport and
Session Layers, through which transport services are made available to local users, and
through which session services are made available to remote systems.
TSEL (transport selector). An address between the Transport and Session Layers, through
which connections are established and maintained. A single TSEL can service one or
more connections simultaneously and can refer to one or more TSAPs.
TSP process. The OSI transport services process.
type. See attribute type.
UA (user agent). The functional component that represents the user in an X.400 message
handling system. A UA interacts directly with the user, prepares messages, and submits
messages for routing to their destinations. UAs also reply, retrieve, and potentially
forward messages for the user. See also RUA and LUA.
unconditional token. A token that is always present in a particular event message. See also
conditional token.
unreserved object. In the GPI, an object on the input queue that is not reserved by a client
program. A client program must reserve the object to examine or copy it.
user agent. See UA.
user database. A database in the OSI/MHS database that contains records of APPL objects.
Each APPL object corresponds to a user agent or a gateway.
user message. An octet string, which can be of a standardized content type, such as IPM or
EDI. A user message can contain one of a variety of encoded information types, such as
text, facsimile, graphics, or voice.
value. See attribute value.
value position. The position of a value of a multivalued attribute.
ViewPoint console application. An extensible interactive application for operators, provided
as part of DSM. ViewPoint allows a system or a network to be controlled from a single
terminal. It includes several block-mode display screens for event messages, a blockmode display for system or network status, a conversational TACL screen, and a facility
called Define Process to maintain sessions with multiple subsystems at the same time.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -31
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. In DSM object-name templates, two wildcard characters can appear: ? for a single character and * for zero, one, or more
consecutive characters. See also object-name template.
working subvolume. A subvolume that contains temporary files used by the OSI/MHS
subsystem processes. There is a separate working subvolume for each process group.
X.25 access method. See X25AM.
X.25 network. Any network or subnetwork linked using X.25 standards. X.25 standards are
CCITT standards that define packet-switching carrier communication in the Network
Layer over wide area networks (WANs).
X25AM (X.25 access method). A Compaq product that implements the services of the
Network Layer and underlying layers for WANs.
X.400. The CCITT standards of architecture and protocols for message handling systems.
X.400 message. Generic term that may refer to either a message, probe, or report.
X.435. CCITT recommendation that describes how MHS is used to convey an EDI
document.
XAPIA (X.400 Application Program Interface Association). An organization active in
defining and promoting standard programming interfaces for use in X.400 networks.
$RECEIVE. The name of a special file through which a process receives and optionally
replies to messages from other processes.
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Glossary -32
Index
Numbers
1984 and 1988 standards 1-7
1984 X.400, extensions to 3-22
1988 X.400 extensions 3-22
A
A3-width images 3-29
Abbreviations xxxv
Acknowledgment mode, receipt
notification 3-130
ACP 127
message identifier 3-110
notification type 3-131
Acronyms xxxv
Action attribute
external trace 3-27
internal trace 3-36
Actual recipient name 3-13
per-recipient DR 3-60
per-recipient NDR 3-66
Additional body part, EDI 3-151, 3-154
ADMD name
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-34
MTS identifier 3-49
O/R name 3-53
See also Attempted ADMD name
See also Attempted country name
Alternate recipient allowed
message 3-40
probe 3-70
Application Program Interface (API)
conformance to 1-7
See X.400 Application Program
Interface (API)
Archive queue 1-5, 4-11
Archiving and auditing gateway activity 1-3
Arrival time
external trace 3-27
internal trace 3-36
per-recipient DR 3-61
per-recipient NDR 3-66
transfer-in based on 4-14
ASN.1 object identifier 2-1
ASN.1-encoded value
P1-encoded message, of 3-57
P1-encoded probe, of 3-57
P1-encoded report, of 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
Attribute 2-1
in object 4-30
introduced 1-4
position 2-7
removing 4-40
syntax
See Syntax
type
See Type
value
See Value
Attribute descriptor
checking validity of 4-34
data structure of 2-6, A-4
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 1
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-class 1 3-104
IA5-text 3-105
message 3-117
mixed-mode 3-119
nationally defined 3-120
primary 3-151
teletex 3-133
UNIDENTIFIED 3-135
videotex 3-136
Boolean syntax 2-4
Buffer information B-62
Built-in EITS 3-17
C
C language
DDL declarations A-1
external declaration file 4-1
procedure call summary C-1
CCITT xxviii, 1-7
Class
DDL constant values
EDI-C- A-26
IM-C- A-20
MH-C- A-7
OM-C- A-6
electronic data interchange 3-137
hierarchies 2-2
diagrams of D-1
interpersonal messaging 3-89
introduced 2-1
message handling 3-5
object management 3-3
Class Attribute 3-2
Client 1-1
Close
See GPI_CLOSE_
Common name 3-53
Communications 1-2
Condition code 4-3
Conformance to API 1-7
Content
general 3-31
message 3-40
report 3-80
return requested 3-40
versions of 1-2
Content identifier
delivery envelope 3-13
message 3-40
probe 3-70
report 3-81
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 2
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
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-35
MTS identifier 3-49
O/R name 3-53
Create
See GPI_OM_CREATE_
Criticality
delivery envelope 3-14
EDI extension 3-144
message 3-41
Criticality (continued)
message RD 3-46
probe 3-70
probe RD 3-75
report 3-81
Cross reference, EDI 3-138, 3-147
D
Dangling object error B-66
Data declarations 4-1, A-1
Data segment, extended 4-7
Data structures 2-5
Data types
basic DDL A-1
intermediate DDL A-1
primary (first-level) DDL A-2
secondary (second-level) DDL A-4
tertiary (third-level) DDL A-4
DDL
definitions A-1
files A-1
named values A-5
symbolic constants A-5
Deferred delivery time
external trace 3-28
internal trace 3-36
message 3-41
Delete
See GPI_OM_DELETE_ and
GPI_OM_REMOVE_
Delivery
envelope 3-11
forwarded EDIM 3-153
forwarded IPM 3-118
point, per-recipient DR 3-61
report, per-recipient 3-59
See also Nondelivery and Preferred
delivery
time
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 3
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 notification
See EDIN
EDIM
description of object class 3-151
forwarding of 3-151, 3-153
heading 3-144, 3-151
EDIN
forwarded 3-161
negative 3-164, 3-167, 3-168
positive 3-171
EDI-CAUTHORIZATION-INFO 3-137
CROSS-REF-INFO 3-138
EDIM 3-151
diagram of D-10
EDI-C- (continued)
EDIM-BODYPART 3-153
diagram of D-13
EDIM-EX-DF-BODYPART 3-154
EDIM-ID 3-156
EDIN-RECEIVER 3-157
EDI-APP-SECUR-ELTS 3-140
EDI-BODYPART 3-142
EDI-EXTENSION 3-143
EDI-HEADING 3-144
EDI-NOTIF-REQUESTS 3-149
FN-PDAU-REASON-CODE 3-158
FN-UAMS-REASON-CODE 3-159
FN-USER-REASON-CODE 3-160
FORWARD-NOTIF 3-161
diagram of D-10
HEADING
diagram of D-12
INTER-SENDER-RECIP 3-163
NEGATIVE-NOTIF 3-164
diagram of D-11
NN-PDAU-REASON-CODE 3-167
NN-UAMS-REASON-CODE 3-168
NN-USER-REASON-CODE 3-170
POSITIVE-NOTIF 3-171
diagram of D-11
RECIPS 3-174
RECIP-REFERENCE 3-173
SECUR-ELEMENTS 3-177
diagram of D-14
SERV-STRING-ADVICE 3-178
SYNTAX-ID 3-179
EDI-TACKNOWLEDGEMENTREQUEST 3-175
ACT-REQUEST 3-175
ADD-BODYPARTS
EDIM 3-152
EDIM body part 3-153
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 4
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-OF-PREP 3-147
DDL constant values for A-29
DECIMAL-NOTATION 3-178
DELIV-ENVELOPE 3-154
DIAGNOSTIC
FN PDAU reason code 3-158
FN UAMS reason code 3-160
FN user reason code 3-161
NN PDAU reason code 3-168
NN UAMS reason code 3-170
NN user reason code 3-171
EDIN-INITIATOR
forwarded notification 3-162
negative notification 3-166
positive notification 3-172
EDIN-ORIG
forwarded notification 3-162
negative notification 3-166
EDI-T- (continued)
positive notification 3-172
EDIN-RECEIVER 3-148
EDIN-RECEIVER-NAME 3-157
EDI-APP-SECUR-ELEMENT 3-141
EDI-APP-SECUR-ELEMENTS
EDI heading 3-147
security elements 3-177
EDI-APP-SECUR-EXTENSIONS
EDI application security
elements 3-141
security elements 3-177
EDI-BODYPART-TYPE 3-147
EDI-ENCRYPTED-PRIMARYBP 3-141
EDI-MSG-TYPE 3-148
EDI-NOTIF-REQUESTS 3-176
EDI-SUPPLEMENTARY-INFO 3-154
EXPIRY-TIME 3-148
EXTENSION-TYPE 3-144
EXTENSION-VALUE 3-144
EX-BODYPART 3-156
FIRST-RECIP 3-157, 3-166
forwarded notification 3-162
positive notification 3-172
FN-NOTIF-EXTENSIONS
forwarded notification 3-163
positive notification 3-172
FN-REASON-CODE 3-163
FN-SECUR-CHECK 3-160
FORWARD-NOTIF 3-151
FORWARD-TO 3-163
HEADING
EDIM 3-152
EDIM body part 3-154
HEADING-EXTENSIONS 3-148
IDENTIFICATION-CODE 3-164
IDENTIFICATION-CODE-Q 3-164
INC-COPY 3-148
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 5
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-INTEGC 3-177
ORIG-EDIM-ID 3-157
POSITIVE-NOTIF 3-151
PRIMARY-BODYPART
EDIM 3-152
EDIM body part 3-154
PROCESSING-PRIORITYCODE 3-176
PROOF-OF-NOTIFICATION 3-151
PROOF-OF-RECEPTION 3-151
RECIP 3-176
RECIPS 3-149
RECIP-EXTENSIONS 3-176
RECIP-REFERENCE 3-173
RECIP-REFERENCE-Q 3-173
RELATED-EDI-MSGS 3-149
RELATED-NON-EDI-MSGS 3-149
EDI-T- (continued)
RELEASE-INDICATOR 3-178
RESERVED 3-179
RESPONS-FORWARD 3-149
RESPONS-PASSINGALLOWED 3-176
ROUTING-ADDRESS 3-164
RSF-AUTHORIZATON-INFO 3-176
RSF-RCIP-REFERENCE 3-176
SECUR-ELEMENTS
forwarded notification 3-163
negative notification 3-166
positive notification 3-172
SEGMENT-TERMINATOR 3-179
SERVICE-STRING-ADVICE 3-149
STNTAX-ID-STRING 3-179
SUBJECT-EDIM
forwarded notification 3-163
negative notification 3-166
positive notification 3-173
SUPPLEMENTARY-INFO
forwarded notification 3-163
negative notification 3-166
positive notification 3-173
SYNTAX-ID 3-149
SYNTAX-VERSION 3-179
TEST-INDICATOR 3-176
THIS-EDIM 3-149
USER 3-156
USER-RELATIVE-ID 3-156
EITS (encoded information types)
built-in 3-17
converted
See Converted EITS
external 3-17
object class description 3-15
original
See Original EITS
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 6
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-66
internal format 3 B-68
internal format 4 B-68
internal format 5 B-69
introduced 1-5
overview of B-1
procedure 4-49
Error class
description of B-11
parameter 4-51
Event messages E-1
Examine
See GPI_OM_EXAMINE_
Expansion history
delivery envelope 3-14
message 3-42
probe 3-71
report 3-81
Expansion prohibited
message 3-42
Expansion record description 3-21
Expiry time 3-111
Explicit conversion of message RD 3-46
Extended data segment, GPI 4-7
Extension class 3-22
Extensions 3-14, 3-42, 3-111, 3-143
External attribute 3-3
External constants, GPI A-38
External data, IPM 3-100
External declaration files 4-1
External EITS 3-17
External trace
entry, description of class 3-25
message 3-42
probe 3-71
report 3-81, 3-82
F
Fatal errors B-11
Fetch
See GPI_OM_FETCH_
Files provided by Compaq 4-1
Final-form document
G4-class 1 3-104
mixed-mode 3-119
Fine resolution 3-30
First-level DDL data types A-2
Formal name attribute 3-125
Format 3 error B-68
Format 4 error B-68
Format 5 error B-69
Formats, teletex pages 3-88
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 7
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.400 1-1
Gateway Interface Process
See GIP
GATEWAY object 1-3
and manager process 4-47
Gateway Programmatic Interface
See GPI
General content 3-31
Generation 3-54
GIP
errors B-30
purpose of 1-4
Given name 3-54
GPI
environment 1-3
external constants A-38
initialization 1-3
GPI (continued)
internal errors B-16
library errors B-25
overview 1-1
GPIDEFS file 4-1, A-1
GPIDEFSH file 4-1, A-1
GPIEXT file 4-1
GPIEXTH file 4-1
GPI_CLOSE_ 4-6
GPI_INITIALIZE_ 4-7
GPI_MT_FINISH_TRANSFER_IN_ 4-10
GPI_MT_START_TRANSFER_IN_ 4-13
GPI_MT_TRANSFER_OUT_ 4-16
GPI_MT_WAIT_ 4-18
GPI_OM_COPY_ 4-20
GPI_OM_CREATE_ 4-22
GPI_OM_DELETE_ 4-25
GPI_OM_EXAMINE_ 4-26
descriptor list example 2-7
GPI_OM_FETCH_ 4-30
GPI_OM_INSERT_ 4-33
GPI_OM_LIST_ 4-35
descriptor list example 2-8
GPI_OM_READ_ 4-38
example of 2-11
GPI_OM_REMOVE_ 4-40
GPI_OM_WRITE_ 4-42
GPI_OPEN_ 4-46
GPI_STATUS_ 4-49
using B-2, B-10
Graphic character sets, teletex 3-87
Guardian 90 procedure errors B-20
H
Hardware register 4-3
Heading, EDIM 3-144, 3-151
Heading, IPM 1-2
Hierarchies of classes 2-2, D-1
Hyphen (-), in DDL names 4-3
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 8
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-103
G3-FAX-BODY-PART 3-101
G4-CLASS-1-BODY-PART 3-104
IA5-TEXT-BODY-PART 3-105
INTERPERSONAL-MESSAGE 3-107
diagram of D-5
IPM-IDENTIFIER 3-115
ISO-6937-TEXT-BODY-PART 3-116
MESSAGE-BODY-PART 3-117, 3-120
diagram of D-6
MESSAGE-TYPE 3-118
MIXED-MODE-BODY-PART 3-119
NAT-DEFINED-BODY-PART 3-120
NON-RECEIPTNOTIFICATION 3-122
diagram of D-7
IM-C- (continued)
OR-DESCRIPTOR 3-124
OTHER-RECIP-DESIGNATOR 3-126
PILOT-INFORMATION 3-127
RECEIPT-NOTIFICATION 3-129
diagram of D-7
RECIPIENT-SPECIFIER 3-131
TELETEX-BODY-PART 3-133
UNIDENTIFIED-BODY-PART 3-135
VIDEOTEX-BODY-PART 3-136
IM-TACKNOWLEDGMENT-MODE 3-130
enumerated values, DDL for A-25
ACP127-DATA-DATA 3-89
ACP127-DATA-PARAMETERS 3-89
ACP127-MESSAGEIDENTIFIER 3-110
ACP127-NOTIFICATION-RSP 3-90
ACP127-NOTIFICATION-TYPE 3-93,
3-131
ACP127-RECIPIENT 3-93
ACP127-SUPP-INFO 3-93
ADATP3-PARAMTERS 3-94
ADDRESS-LIST-INDICATOR 3-93,
3-110
ALD-LIST-NAME 3-95
ALD-NOTIFICATIONREQUEST 3-96
ALD-REPLY-REQUEST 3-96
ALD-TYPE 3-96
AUTHORIZING-USERS 3-110
AUTO-FORWARDED 3-110
AUTO-FORWARD-COMMENT 3-123
BILATERAL-DATA 3-97
BLIND-COPY-RECIPIENTS 3-110
BODY 3-111
CONVERSION-EITS 3-90
nonreceipt notification 3-123
receipt notification 3-130
COPY-RECIPIENTS 3-111
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index- 9
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
IAO-6937-REPERTOIRE
enumerated values, DDL for A-25
IMAGES 3-101
IMPORTANCE 3-112
enumerated values, DDL for A-25
IPM 3-118
IPM-INTENDED-RECIPIENT 3-90
nonreceipt notification 3-123
receipt notification 3-130
IPN-ORIGINATOR 3-91
nonreceipt notification 3-123
receipt notification 3-130
ISO-6937-REPERTOIRE 3-116
ISO-6937-TEXT 3-116
LINE-ORIENTED-DATA 3-94
MESSAGE-IDENTIFIER 3-118
MESSAGE-INSTRUCTIONS 3-112
IM-T- (continued)
MESSAGE-TYPE 3-112
MIXED-MODE-DOCUMENT 3-119
MM-MESSAGE-DATA 3-120
MM-MESSAGE-ENVELOPE 3-120
NATIONAL-DATA 3-121
NON-RECEIPT-REASON 3-124
enumerated values, DDL for A-26
NOTIFICATION-REQUEST 3-132
enumerated values, DDL for A-26
OBSOLETED-IPMS 3-112
ORD-DESIGNATOR 3-126
ORD-TYPE 3-126
ORIGINATOR 3-112
ORIGINATOR-IDENTIFIER 3-112
ORIGINATOR-PLAD 3-112
OTHER-RECIP-INDICATOR 3-112
PILOT-FORWARDING-INFO 3-113
PILOT-HANDLING 3-127
PILOT-PRECEDENCE 3-127
PILOT-RECIPIENT 3-128
PILOT-SECURITY 3-128
PRIMARY-PRECEDENCE 3-113
PRIMARY-RECIPIENTS 3-113
RECEIPT-TIME 3-93, 3-130
RECIPIENT 3-132
RELATED-IPMS 3-113
REPERTOIRE 3-105
enumerated values, DDL for A-25
REPLIED-TO-IPM 3-113
REPLY-RECIPIENTS 3-113
REPLY-REQUESTED 3-132
REPLY-TIME 3-113
RETURNED-IPM 3-124
RETURN-REQUESTED 3-132
SENSITIVITY 3-114
enumerated values, DDL for A-26
SET-ORIENTED-DATA 3-94
SIC 3-99
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -10
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
Inbound-mapping errors B-45
include directive
Information architecture 2-1
conformance to API 1-7
Information buffer
description of formats B-62
parameter 4-51
Initial values of attributes 2-8, 4-22
Initialization of GPI 1-3
See also GPI_INITIALIZE_
Initials of name 3-54
Input queue
available unreserved objects in 4-18
deleted objects in 4-25
removing object from 4-10
Input queue (continued)
reserving object in 4-13
Insert
See GPI_OM_INSERT_
Integer syntax 2-4
Integrity checking 4-34
Intended recipient
of IPM 3-123, 3-130
of message 3-43
of probe 3-73
Intended recipient name
delivery envelope 3-14
per-recipient DR 3-61
per-recipient NDR 3-66
Intended recipient number
per-recipient DR 3-61
per-recipient NDR 3-66
Intermediate DDL data types A-1
Internal errors B-11, B-16
Internal trace
entry, description of class 3-33
message 3-42
probe 3-71
report 3-82
Interpersonal message
See IPM
Interpersonal messaging
classes of objects 3-89
DDL constant values A-20
package 2-1
protocol (P2) 1-2
types of attributes 3-89
value limits A-24
Interpersonal notification
See IPN
IPM
body part 3-117
description of object class 3-107
forwarded 3-118
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -11
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 4-46
Login mechanism 1-3
Long string 2-10
retrieving value 4-38
specifying minimum 4-8
writing 4-42
M
Management domain
See MD
Management, object
See Object management
Maximum
entries in object tree 4-7
Maximum (continued)
lengths, DDL constants for A-12, A-24
number of root objects processed 4-14
number of values, DDL constants
for A-13
MD
local 1-4
trace of actions 3-25
Memo 3-107
Message
body part 3-117
description of object class 3-37
purpose 1-2
Message handling
classes of objects 3-5
DDL constant values A-7
package 2-1
return codes B-7
types of attributes 3-5
value limits A-12
Message transfer
overview of 1-5
procedures 4-2
protocol (P1) 1-2
Message transfer agent
See MTA
Message transfer system identifier
See MTS identifier
MHS manager process 1-3
specifying 4-47
MH-AC- enumerated values 3-27, 3-36
DDL for A-13
MH-BE- enumerated values 3-17
DDL for A-14
MH-CTI- integer values 3-40
DDL for A-15
MH-CTO- object identifier values 3-40
DDL for A-15
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -12
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
diagram of D-8
PER-RECIPIENT-NDR 3-63
diagram of D-8
PROBE 3-68
diagram of D-3
PROBE-RD 3-73
REPORT 3-78
diagram of D-4
SECURITY-LABEL 3-85
TELETEX-NBPS 3-87
MH-DG- enumerated values 3-66
DDL for A-16
MH-DM- enumerated values 3-15
DDL for A-18
message RD 3-47
probe RD 3-76
MH-DP- enumerated values 3-61
DDL for A-15
MH-EC- enumerated values
DDL for A-15
probe RD 3-75
MH-EE- enumerated values
DDL for A-14
MH-PTY- enumerated values 3-15
DDL for A-19
MH-RC- codes, summary of B-7
MH-RE- enumerated values 3-67
DDL for A-18
MH-RQ- enumerated values
DDL for A-16
message RD 3-47, 3-62, 3-66
per-recipient DR 3-62
per-recipient NDR 3-67
probe RD 3-76
MH-TT- enumerated values 3-55
DDL for A-19
MH-TA3-WIDTH 3-29
ACTION
enumerated values, DDL for A-13
external trace 3-27
internal trace 3-36
ACTUAL-RECIPIENT-NAME
delivery envelope 3-13
per-recipient DR 3-60
per-recipient NDR 3-66
ADMD-NAME
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-34
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -13
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-LENGTH 3-30
B4-WIDTH 3-30
BILATERAL-INFORMATION
message 3-40
probe 3-70
BINARY-CONTENT 3-31
BUILTIN-EITS 3-17
enumerated values, DDL for A-14
COMMON-NAME 3-53
CONTENT
message 3-40
report 3-80
CONTENT-EXTENSIONS
MH-T- (continued)
report 3-81
CONTENT-IDENTIFIER
delivery envelope 3-13
message 3-40
probe 3-70
report 3-81
CONTENT-LENGTH 3-70
CONTENT-RETURNREQUESTED 3-40
CONTENT-TYPE
delivery envelope 3-13
enumerated values, DDL for A-15
message 3-40
probe 3-70
report 3-81
CONTROL-CHARACTER-SETS 3-87
CONVERSION-PROHIBITED 3-13
message 3-41
probe 3-70
CONVERTED-EITS
delivery envelope 3-13
external trace 3-27
per-recipient DR 3-61
per-recipient NDR 3-66
COUNTRY-NAME
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-35
MTS identifier 3-49
O/R name 3-53
CRITICAL-FOR-DELIVERY
delivery envelope 3-14
message 3-41
message RD 3-46
probe 3-70
probe RD 3-75
report 3-81
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -14
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
DISCLOSURE-ALLOWED 3-41
DOMAIN-TYPE- 3-53
DOMAIN-VALUE- 3-54
EXPANSION-HISTORY
delivery envelope 3-14
message 3-42
probe 3-71
report 3-81
EXPANSION-PROHIBITED
message 3-42
probe 3-71
EXPLICIT-CONVERSION
MH-T- (continued)
enumerated values, DDL for A-15
message RD 3-46
probe RD 3-75
EXTENSIONS
delivery envelope 3-14
message 3-42
message RD 3-47
O/R name 3-54
per-recipient DR 3-61
per-recipient NDR 3-66
probe 3-71
probe RD 3-76
report 3-81
EXTENSION-TYPE 3-23
EXTENSION-VALUE 3-23
EXTERNAL-EITS 3-17
enumerated values, DDL for A-14
EXTERNAL-TRACE-INFO
message 3-42
probe 3-71
report 3-81
EXT-CRIT-FOR-DELIVERY 3-23
EXT-CRIT-FOR-SUBMISSION 3-23
EXT-CRIT-FOR-TRANSFER 3-23
FINE-RESOLUTION 3-30
G3-FAX-NBPS 3-17
G4-FAX-NBPS 3-17
GENERATION 3-54
GIVEN-NAME 3-54
GRAPHIC-CHARACTER-SETS 3-87
INFORMATION 3-10
INITIALS 3-54
INTENDED-RECIPIENT-NAME
delivery envelope 3-14
per-recipient DR 3-61
per-recipient NDR 3-66
INTENDED-RECIPIENT-NUMBER
per-recipient DR 3-61
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -15
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-55
ORGANIZATIONAL-UNIT-NME3-55
ORGANIZATION-NAME 3-55
ORIGINAL-EITS
delivery envelope 3-14
message 3-43
probe 3-71
report 3-82
ORIGINATOR-NAME
delivery envelope 3-14
message 3-43
probe 3-72
ORIGINATOR-REPORTREQUEST 3-67
MH-T- (continued)
enumerated values, DDL for A-16
message RD 3-47
per-recipient DR 3-62
probe RD 3-76
OTHER-RECIPIENT-NAMES 3-14
PAGE-FORMATS 3-88
PER-RECIPIENT-REPORTS 3-82
PREFERRED-DELIVERY-MODES
delivery envelope 3-15
enumerated values, DDL for A-18
message RD 3-47
probe RD 3-76
PRIORITY
delivery envelope 3-15
enumerated values, DDL for A-19
message 3-43
PRIVACY-MARK 3-85
PRIVATE-USE 3-88
PRMD-IDENTIFIER
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-35
MTS identifier 3-49
PRMD-NAME 3-55
RECIPIENT-DESCRIPTORS
message 3-43
probe 3-72
RECIPIENT-NAME
message RD 3-48
probe RD 3-77
RECIPIENT-NUMBER
message RD 3-48
probe RD 3-77
REPORTING-DL-NAME 3-83
REPORT-ADDITIONAL-INFO 3-82
REPORT-DESTINATION 3-82
MH-T- (continued)
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -16
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 A-12
MH-VN- constant values A-13
Military messaging attributes
ACP 127
data data 3-89
data parameters 3-89
message identifier 3-110
notification type 3-93, 3-131
recipient 3-93
supplementary information 3-93
ACP127 notification response 3-90
ADATP3 parameters 3-94
address list indicator 3-93, 3-110
address list of recipients 3-95
conversion EITS 3-90
Military messaging attributes (continued)
corrections data 3-98
corrections paramters 3-98
Date-Time Group 3-111
distribution codes 3-111
distribution extensions 3-99
forwarded encrypted data 3-103
forwarder envelope 3-103
IPM intended recipient 3-90
IPN originator 3-91
line oriented data 3-94
local handling instructions 3-112
members of address list of excluded
recipients 3-111
message data 3-120
message envelope 3-120
message identifier 3-118
message instructions 3-112
message type 3-112
notification from recipients of address
list 3-96
originator’s number 3-112
other recipienst indicator 3-112
other recipient designator type 3-126
other reipient designator 3-126
pilot forwarding information 3-113
pilot message 3-113
pilot message local handling
instructions 3-127
pilot message precedence 3-127
pilot recipient 3-128
pilot security 3-128
PLAD indicator
Military messaging attributes
originator’s PLAD 3-112
plain language address 3-112
precedence level in content header
copy recipient 3-111
primary recipient 3-113
privacy mark 3-85
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -17
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-35
in internal trace 3-35
report request
message RD 3-47, 3-62, 3-66
probe RD 3-76
responsibility
message RD 3-47, 3-62, 3-67
probe RD 3-76
trace of actions 3-33
MTA-to-MTA protocol 1-2
MTS identifier
creating 4-16
description of object class 3-48
message 3-43
probe 3-71
report 3-82, 3-83
Multivalued attribute 2-3
DDL constant for maximum number
of A-13
Multivalued attribute (continued)
retrieving syntax and value 4-35
retrieving values for 2-8
N
Named values, DDL A-1, A-5
Nationally defined body part 3-120
Negative notification 3-164/3-171
Nonbasic parameters
See G3 facsimile, G4 facsimile, teletex,
and videotex
Nondelivery
diagnostic 3-66
reason 3-67
report, per-recipient 3-63
Nonreceipt
notification, description of object
class 3-122
reason 3-124
Notification
See Interpersonal, Nonreceipt, and
Receipt notifications
Notification request 3-132
Null terminator 2-9
Numeric O/R address 3-56
Numeric-string syntax 2-4
Numeric-user identifier 3-55
O
Object
copying 4-20
creating 4-22
dangling B-66
defined 1-4
deleting 4-25
description of 2-1
in input queue 4-18
reserving 4-13
retaining 4-10, 4-16
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -18
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-2
SUCCESS B-1
OM-Ssyntax 2-4
UNSPECIFIED 2-8
OM-TARBITRARY-ENCODING 3-3
ASN1-ENCODING 3-4
CLASS 3-2
DATA-VALUE-DESCRIPTOR 3-4
DDL constant values for A-7
DIRECT-REFERENCE 3-4
INDIRECT-REFERENCE 3-4
OCTET-ALIGNED-ENCODING 3-4
OM-T-CLASS attribute
removing 4-41
Open
See GPI_OPEN_
Organization name in O/R name 3-55
Organization unit names 3-55
Original EITS
delivery envelope 3-14
message 3-43
probe 3-71
report 3-82
Originator 1-2
of IPM 3-112
of IPN 3-123, 3-130
Originator name
delivery envelope 3-14
message 3-43
probe 3-72
Originator report request
message RD 3-47
per-recipient DR 3-62
per-recipient NDR 3-67
probe RD 3-76
OSI/MHS 1-1, 1-5
manager process
See MHS manager process
OSI/MHS MTA 1-1, 1-5
OSI/MHS subsystem 1-1, 1-5
Other recipient names in delivery
envelope 3-14
Outbound communications
managing 1-4
transferring 1-5
Outbound-mapping errors B-40
Output queue, transferring object to 4-16
Overview, GPI 1-1
O/R descriptor 3-124
O/R name
description of object class 3-50
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -19
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 RD 3-47
probe RD 3-76
Prefixes
for classes 2-1
for procedure name 4-1
for syntax 2-4
for types 2-3
Primary body part 3-151
Primary code
parameter 4-51
Primary data types, DDL A-2
Primary recipients of IPM 3-113
Printable-string syntax 2-4
Priority
delivery envelope 3-15
for transfer in 4-14
message 3-43
Private use, teletex 3-88
PRMD identifier
bilateral information 3-10
environment object 3-20
external trace 3-26
internal trace 3-35
MTS identifier 3-49
See also Attempted PRMD identifier
PRMD name in O/R name 3-55
Probe
description of object 3-68
purpose 1-2
Procedure calls 4-1
C language C-1
conformance to API 1-7
Procedure errors, Guardian 90 B-20
Programming languages 1-1
Proprietary
procedures 1-7
return codes
See ZGPI-RC-
R
Read
See GPI_OM_READ_
Receipt
notification 3-129
time 3-130
Recipient 1-2
attribute 3-132
blind-copy 3-110
of message, intended 3-43
of probe, intended 3-73
Recipient descriptors
message 3-43
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -20
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
external trace 3-82
internal trace 3-82
MTS identifier 3-83
purpose 1-2
Request type
description of B-10
parameter 4-50
Required attributes, initializing 4-24
Reserved object 4-13
changing state of 4-10
Responsibility, EDIM 3-161, 3-164, 3-171
Return codes
checking B-1
Return codes (continued)
procedure to check 4-49
proprietary
See ZGPI-RCstandard X.400 API B-2
Return requested attribute 3-132
Returned IPM 3-124
Root object
classes of 2-2
copying 4-20
introduced 1-4
maximum number processed 4-14
S
Sample procedure call 4-3
Secondary code
description of values B-49
parameter 4-51
Secondary (second-level) DDL data
types A-4
Security elements, EDI 3-140
Segment of string 4-38
Sensitivity, IPM 3-114
Session
closing 4-6
opening 4-46
purpose of 1-3
Session identifier 1-4
obtaining 4-46
Severity of error B-11
Single-valued attribute 2-3
retrieving syntax and value 4-26, 4-30
retrieving with GPI_OM_LIST_ 4-38
Source domain 3-10
Standards groups and specifications xxviii,
1-7
State of reserved object 4-10
Status checking
See Error checking
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -21
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 attribute values in 4-35
Superobject 2-2
Supplementary information
per-recipient DR 3-62
per-recipient NDR 3-67
Supplementary receipt information 3-130
Surname 3-55
Swap volume 4-7
Symbolic constants, DDL A-5
Syntax
example of 2-2
introduced 2-1
multivalued attribute 4-35
notation for procedure calls 4-3
representation of 2-4
Syntax (continued)
retrieving from single-valued
attribute 4-26
single-valued attribute 4-30
videotex 3-137
T
TAL
DDL declarations A-1
external declaration file 4-1
Telephone number attribute 3-125
Teletex
body part 3-133
NBPS 3-133
object description 3-87
of EITS 3-17
Teletex-string syntax 2-4
Telex-compatible attribute 3-134
Terminal
G3 facsimile 3-29
identifier in O/R name 3-55
O/R address 3-56
teletex 3-87
type in O/R name 3-55
Tertiary DDL data types A-4
Text attribute, IA5-text body part 3-106
Third-level DDL data types A-4
This IPM attribute 3-114
Trace
See External trace and Internal trace
Transaction, TMF 4-20
Transfer in
finishing 4-10
starting 4-13
Transfer of communications
See Message transfer
Transfer option to remove parameter 4-11
Transfer out 4-16
requirements for 4-24
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -22
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 string 4-42
Videotex
body part 3-136
data 3-137
syntax 3-137
Videotex-string syntax 2-4
W
U
UA-to-UA protocol 1-2
Uncompressed images 3-30
Underscore (_), in DDL names 4-3
Unidentified body part 3-135
Unlimited length, images of 3-30
Unreserved object
availability of 4-18
leaving on input queue 4-11
User, IPM originator 3-115
User-relative identifier, IPM 3-115
UTC-time-string syntax 2-4
V
Value
example of 2-2
initial attribute 4-22
inserting in object 4-33
introduced 2-1
length, 3-1
limits (DDL constants for) A-12, A-24
multivalued attribute 4-35
position 2-7
Waiting for unreserved object 4-18
Warnings B-11
Write
See GPI_OM_WRITE_
X
XAPIA-1984 specification xxviii
XAPIA-1988 specification xxviii
X.121 address in O/R name 3-55
X.400 Application Program Interface
(API) 1-1
X.400 gateway 1-1
X.400 message 1-2
Z
ZGPI- external constants, DDL A-38
ZGPI-PARAM- DDL constants A-43
ZGPI-RCcodes, summary of B-14
GIP errors B-30
GPI internal errors B-16
GPI library errors B-25
Guardian 90 procedure errors B-20
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
Index -23
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
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising