Data Management Library TRANSFER Reference Manual Product Version Release ID Transfer C31 C30.08 Edition Being Updated Part Number 040969 Update 1 Part Number 069139 Edition Print Date Abstract April 1992 This manual describes the programmatic interface to the TRANSFER delivery system and provides detailed reference information about the available units-of-work (UOWs), the operations the UOWs manage, and the syntax rules used for issuing UOWs.
Document History Edition Part Number Product Version Release ID Print Date First Update 1 40969 069139 TRANSFER C30 TRANSFER C31 C30 C30.08 July 1991 April 1992 New editions incorporate any updates issued since the previous edition. Copyright Export Statement Examples Ordering Information Copyright 1992 by Tandem Computers Incorporated. All rights reserved.
New and Changed Information New and Changed This update package changes descriptions of the following TISERV UOWs: Information for Update ACK-RECEIPT Package Number ADD-AUX-NAME 069139 ADD-ITEM-REC ALTER-FOLDER-DESCR ALTER-FOLDER-ORDER ALTER-ITEM-DESCR ALTER-ITEM-DES-B40 ALTER-ITEM-DES-C20 ALTER-PROFILE-ELEM CANCEL-PKG-TIME CREATE-DEPOT CREATE-FOLDER-B00 CREATE-FOLDER-B10 GET-AUX-NAME GET-CONFIG-NAME GET-FOLDER-DESC-C20 GET-FOLDER-DESCR GET-FOLDER-ORDER GET-ITEM-DES-C20 GET-ITEM-DESCR GET-PROFILE-ELEM GET-P
New and Changed Information Update Changes In addition, Appendix B now provides an explanation of the formats for TAREQ event packages, and Appendix C gives a complete list of configured names for TRANSFER entities. The update package also includes other minor technical and editorial changes.
New and Changed Information New TISERV UOWs New and Changed The parent manual, TRANSFER Reference Manual (Part Number 40969), released July Information for Manual 1991, includes the following new and changed information. Number 40969 The TRANSFER delivery system supports several new features, including: Shared depots, folders, and distribution lists Depot storage statistics collection and retrieval X.400 service elements, X.400 correspondents, and related X.
New and Changed Information New TISERV UOWs To support X.400 service elements, X.400 correspondents, and related X.
New and Changed Information Changed TISERV UOWs Changed TISERV UOWs The following TISERV UOWs provide new capabilities.
New and Changed Information Changed TISERV UOWs To support depot storage statistics: ACK-RECEIPT ADD-ITEM-REC ADD-MEMBER ATTACH-COMPNT-A01 ATTACH-EXTOBJ COPY-ITEM COPY-ITEM-B40 CREATE-DEPOT CREATE-FOLDER DELETE-DEPOT DELETE-DLIST DELETE-FOLDER DELETE-ITEM-REC DELETE-MEMBER DETACH-COMPNT DETACH-EXTOBJ SAVE-ITEM SAVE-ITEM-B40 SAVE-ITEM-BY-KEY SUBMIT-PKG UNSAVE-ITEM UOW To support X.400 service elements, X.400 correspondents, and related X.
Contents New and Changed Information About This Manual xvii Notation Conventions Section 1 iii xix Programmatic Interface to the TRANSFER Delivery System TISERV Interface 1-1 IPC Request and Reply Headers 1-1 Summary of TISERV UOWs 1-9 Session-Control UOWs 1-10 Item-Handling UOWs 1-10 Package-Handling UOWs 1-11 Folder-Manipulation UOWs 1-13 External-Object UOWs 1-14 Depot-Management UOWs 1-14 Administrative UOWs 1-16 X400 Management UOWs 1-19 TAREQ Interface 1-19 Agent Notification Messages 1-20 TAR
Contents X400-NAME Field 2-16 X400-DELIV-STATUS-FLAGS Field 2-17 X400-RECIP-REQ-FLAGS Field 2-18 UOW Definitions 2-20 ACK-RECEIPT 2-21 ADD-AUX-NAME 2-24 ADD-GROUP-MEMBER 2-27 ADD-ITEM-REC 2-31 ADD-MEMBER 2-36 ADD-RECIP 2-41 ADD-RECIP-C20 2-46 ADD-X400-AUX-NAME 2-51 ADD-X400-MEMBER 2-54 ADD-X400-RECIP 2-57 ALTER-AGENT-SELECT 2-62 ALTER-FOLDER-DESCR 2-67 ALTER-FOLDER-ORDER 2-74 ALTER-GROUP-MEMBER 2-79 ALTER-ITEM-DESCR 2-82 ALTER-ITEM-DES-B40 2-92 ALTER-ITEM-DES-C20 2-102 ALTER-ITEM-NAME 2-114 ALTER-PROFILE-E
Contents DELETE-AUX-NAME 2-186 DELETE-DEPOT 2-188 DELETE-DLIST 2-191 DELETE-FOLDER 2-194 DELETE-GROUP 2-197 DELETE-ITEM-REC 2-200 DELETE-MEMBER 2-203 DELETE-PROFILE-REC 2-206 DELETE-RECIP 2-208 DELETE-X400-MEMBER 2-210 DELETE-X400-RECIP 2-213 DETACH-COMPNT 2-216 DETACH-EXTOBJ 2-219 END-SESSION 2-225 GET-AGENT-SELECT 2-226 GET-AUX-NAME 2-230 GET-CONFIG-NAME 2-233 GET-DEPOT-STATS 2-238 GET-DLIST-DES-C20 2-244 GET-EXTOBJ 2-247 GET-FOLD-ENTRY-INFO 2-253 GET-FOLDER-DES-C20 2-256 GET-FOLDER-DESCR 2-261 GET-FOLDE
Contents GET-X400-ORIG 2-402 GET-X400-RECIP 2-404 NOOP 2-410 READ-NXT-GROUP-MBR 2-412 READ-NEXT-MEMBER 2-417 READ-NEXT-NAME 2-422 READ-PROFILE-REC 2-428 READ-PROF-REC-A02 2-432 READ-X400-MEMBER 2-438 SAVE-ITEM 2-441 SAVE-ITEM-B00 2-445 SAVE-ITEM-BY-KEY 2-450 SCAN-BY-ITEM-NAME 2-456 SCAN-FOLDER 2-461 SCAN-FOLDER-B00 2-465 SCAN-FOLDER-BY-KEY 2-469 SCAN-FOLDER-DETAIL 2-478 SET-CURRENT-CONTXT 2-483 SET-SYSTEM-PARAM 2-487 START-SESSION 2-491 START-SESSION-B40 2-497 SUBMIT-PKG 2-503 UNSAVE-ITEM 2-505 WHERE-MEMBE
Contents DELIV-ERR Errors 3-4 GUARDIAN 90 File Codes Summary of Error Codes 3-5 3-6 Appendix A UOWs Listed in Numeric Order Appendix B Status Packages Appendix C Configured Names for TRANSFER Entities Appendix D National Languages and Character Maps Appendix E Alphabetic Listing of Error Codes Glossary Glossary-1 Index Figures Index-1 Figure 1-1. IPC Message Format Figure 2-1. Adding a Record to an Item Figure 2-2. Package Delivery Time Milestones Figure 2-3.
Contents xiv Table 1-9. TISERV UOW for Package Receipt 1-13 Table 1-10. Summary of TISERV UOWs for Folder Manipulation Table 1-11. Summary of TISERV UOWs for External Objects Table 1-12. Summary of TISERV UOWs for Depots 1-14 Table 1-13. Summary of TISERV UOWs for Profiles 1-15 Table 1-14. Summary of TISERV UOWs for Folders 1-15 Table 1-15. Summary of TISERV UOWs for Agents 1-15 Table 1-16. Summary of TISERV UOWs for Depot Storage Statistics Table 1-17.
Contents Table 2-15. Importance Values 2-287 Table 2-16. Access Privileges Table 2-17. Depot Profile File Elements and Access Privileges Table 2-18. Depot Storage Statistics for SAVE-ITEM UOW Table 2-19. Depot Storage Statistics for SAVE-ITEM-B00 UOW Table 2-20. Depot Storage Statistics for SAVE-ITEM-BY-KEY UOW Table 2-21. SCAN-FOLDER-BY-KEY Sample Items Table 2-22. TISERV Response to SCAN-FOLDER-BY-KEY UOW Table 2-23. ITEMS-RETURNED Values Table 2-24.
Contents xvi 069139, Update 1 to 040969 Tandem Computers Incorporated
Notation Conventions The following list summarizes the conventions for syntax presentation in this manual. Notation Meaning UPPERCASE LETTERS Uppercase letters represent keywords and reserved words; enter these items exactly as shown. Lowercase italic letters represent variable items that you supply. Brackets enclose optional syntax items. A group of vertically aligned items enclosed in brackets represents a list of selections from which you can choose one or none. Braces enclose required syntax items.
About This Manual The TRANSFER Reference Manual describes units of work (UOWs) that allow you to request TRANSFER services from your program. This manual does not teach programming methodology or technique. It is intended for experienced application programmers who plan to include TRANSFER features in their programs.
About This Manual Related Manuals If your programs are written in a language other than SCREEN COBOL (SCOBOL), or if your programs communicate with programs that are not written in SCOBOL, one or more of the following manuals may be useful: C Reference Manual COBOL85 Reference Manual FORTRAN Reference Manual Pascal Reference Manual Transaction Application Language (TAL) Reference Manual The GUARDIAN 90 Operating System Programmer's Guide and the GUARDIAN 90 Operating System User's Guide provide information
1 Programmatic Interface to the TRANSFER Delivery System There are two types of TRANSFER processes that interface with your programs: The TRANSFER interactive server, TISERV, that can start and terminate sessions, perform item and package handling requests, and handle administrative requests. Your client can request services and receive responses from TISERV. The TRANSFER asynchronous requesters, TAREQs, that notify selected agents when a package arrives at a depot.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers Figure 1-1 shows a diagram of an IPC message. Figure 1-1.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers 02 ipc-retn-code 88 ipc-ok 88 invalid-version-code 88 invalid-session-id 88 service-denied 88 invalid-uow-header 88 rqst-too-long 88 reply-too-long 88 rqst-too-short 88 invalid-request-code 88 e-bad-transaction 88 e-err-profile-file 88 e-err-session-file 88 e-err-itemdesc-file 88 e-err-itemdata-file 88 e-err-recip-file 88 e-err-folder-file 88 e-err-dlist-file 88 e-err-ready-file 88 e-err-time-file 88 e-err-net-file 88 e-e
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers Individual fields in the IPC header contain the following information: REQUEST-CODE in a request to the TRANSFER delivery system, your application sets this field to indicate request processing conditions. In the request, this field always contains a value less than zero, as follows: STOP-ON-WARNING (-1) stops the processing if a UOW warning or error indication is encountered.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers RQST-ERR (3) indicates that the TRANSFER delivery system detected one of the following two error conditions: An error in the data in the IPC header occurred and the error is not specific to any particular UOW. An error in the range from 4900 to 5000 occurred in a UOW, earlier UOWs in the IPC message were processed successfully, and additional information about the error is stored in the IPC-RETN-CODE field.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers INVALID-VERSION-CODE (1) indicates that the request contained an IPC version code that the TRANSFER delivery system could not recognize. INVALID-SESSION-ID (2) indicates that the request contained a session ID that the TRANSFER delivery system could not recognize. For example, the IPC might have referenced a session that no longer exists. SERVICE-DENIED (3) is reserved for use by Tandem.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers E-ERR-PROFILE-FILE (4902) through E-ERR-INV-FOLDER-FILE (4922) indicate that an unexpected GUARDIAN 90 file error occurred on one of the TRANSFER database files. IPC-RETN-CODE-DETAIL contains the actual GUARDIAN 90 file error code. If you receive one of these errors and the request was issued under a TMF transaction, you must abort the TMF transaction. E-ERR-QUEUE-FILE (4924) indicates an error occurred on the queue file.
Programmatic Interface to the TRANSFER Delivery System IPC Request and Reply Headers UOWS-RETURNED indicates the number of response UOWs returned to your application in a reply from the TRANSFER delivery system. (This field is ignored in a request to the TRANSFER delivery system.) LOG-THIS-IPC specifies whether the request and its reply are logged (Y) or not logged (N) for this request.
Programmatic Interface to the TRANSFER Delivery System Summary of TISERV UOWs Summary of TISERV TISERV UOWs can be grouped according to the operations they perform. Section 2 UOWs describes each TISERV UOW.
Programmatic Interface to the TRANSFER Delivery System Session-Control UOWs Session-Control UOWs You use session-control UOWs to initiate and terminate sessions. Table 1-1 summarizes session-control UOWs. Table 1-1. Summary of TISERV UOWs for Session Control Item-Handling UOWs UOW UOW Code UOW Operation END-SESSION 102 %146 %H66 START-SESSION START-SESSION-B40 101 %145 %H65 100 %144 %H64 Ends a session in progress on behalf of a correspondent. Begins a session on behalf of a correspondent.
Programmatic Interface to the TRANSFER Delivery System Package-Handling UOWs You use the UOWs in Table 1-3 to manage named items. Table 1-3. Summary of TISERV UOWs for Named Items UOW UOW Code UOW Operation ALTER-ITEM-NAME 150 %226 %H96 GET-ITEM-NAME 152 %230 %H98 SCAN-BY-ITEM-NAME 151 %227 %H97 Assigns, alters, or removes a name for an instance of an item in a folder. Retrieves the name assigned to an item in a particular folder. Returns the ID, item name, and unsave time of items in a folder.
Programmatic Interface to the TRANSFER Delivery System Package-Handling UOWs You use the UOWs in Table 1-6 to modify item attributes before submittal. Table 1-6. Summary of TISERV UOWs for Submittal Preparation UOW UOW Code UOW Operation ALTER-ITEM-DESCR 116 %164 %H74 ALTER-ITEM-DESCR-B40 147 %223 %H93 ALTER-ITEM-DES-C20 187 %273 %HBB Updates application-controlled fields in an item descriptor. Updates application-controlled fields in an item descriptor, including the character-map specification.
Programmatic Interface to the TRANSFER Delivery System Folder-Manipulation UOWs You use the UOW in Table 1-9 to receive packages. Table 1-9. TISERV UOW for Package Receipt Folder-Manipulation UOWs UOW UOW Code UOW Operation ACK-RECEIPT 131 %203 %H83 Acknowledges receipt of a package. You use the UOWs in Table 1-10 to maintain folders. Table 1-10. Summary of TISERV UOWs for Folder Manipulation UOW UOW Code UOW Operation SAVE-ITEM 110 %156 %H6E Saves an item in a folder.
Programmatic Interface to the TRANSFER Delivery System External-Object UOWs External-Object UOWs You use the UOWs in Table 1-11 to manage external objects that accompany items. Table 1-11. Summary of TISERV UOWs for External Objects Depot-Management UOWs UOW UOW Code UOW Operation ATTACH-EXTOBJ 144 %220 %H90 DETACH-EXTOBJ 146 %222 %H92 GET-EXTOBJ 145 %221 %H91 Attaches a primary external object to an item, or an alternate external object to either an item or a primary external object.
Programmatic Interface to the TRANSFER Delivery System Depot-Management UOWs You use the UOWs in Table 1-13 to manage profiles. Table 1-13. Summary of TISERV UOWs for Profiles UOW UOW Code UOW Operation ALTER-PROFILE-ELEM 204 %314 %HCC Modifies one or more data elements in a depot or system profile. (To alter some profile attributes, system administrator capability is required.) DELETE-PROFILE-REC 214 %326 %HD6 Deletes a record in a depot profile.
Programmatic Interface to the TRANSFER Delivery System Administrative UOWs You use the UOWs in Table 1-16 to access the depot storage statistics facility. Table 1-16.
Programmatic Interface to the TRANSFER Delivery System Administrative UOWs You use the UOW in Table 1-18 to terminate sessions, shut down the TRANSFER delivery system, and monitor the load on the TRANSFER system. Table 1-18. TISERV UOW for Session Management UOW UOW Code UOW Operation GET-NEXT-SESSION 200 %310 %HC8 Returns the names of correspondents with active sessions to your application. (Requires system administrator capability.
Programmatic Interface to the TRANSFER Delivery System Administrative UOWs You use the UOWs in Table 1-21 to manage shared objects. Table 1-21.
Programmatic Interface to the TRANSFER Delivery System TAREQ Interface X400 Management UOWs You use the UOWs in Table 1-22 to add, alter, and delete X.400 recipients, X.400 distribution list members, and related X.400 objects. Table 1-22. Summary of TISERV UOWs for the X400 Gateway UOW UOW Code UOW Operation ADD-X400-AUXNAME 174 Adds an existing X.400 correspondent as an auxiliary user to a package. ADD-X400MEMBER 241 Adds an X.400 recipient to a TRANSFER distribution list.
Programmatic Interface to the TRANSFER Delivery System Agent Notification Messages Agent Notification Messages The TAREQ formats the agent notification message in accordance with the following data definition: DEF agent-link. 02 session-id. 03 dummy 02 sender-info. 03 sender-name 03 sender-applic-id 02 recipient-info. 03 recip-name 02 package-info. 03 package-id. 04 dummy 03 agent-selector 03 package-flags.
Programmatic Interface to the TRANSFER Delivery System Agent Notification Messages SENDER-APPLIC-ID is the numeric application ID that identifies the client who transmitted the package with TISERV. This value is matched against the agent selection range established by APPLIC-ID-LOW and APPLIC-ID-HIGH in the depot's agent profile records. RECIP-NAME is the name of the recipient to whom the package is sent. PACKAGE-ID is the ID of the header item for the package.
Programmatic Interface to the TRANSFER Delivery System TAREQ Event Packages In this definition, fields have the following meanings: ERROR-RETURN notifies the TAREQ of any action it should take at this point. The ERRORRETURN field is required and must contain one of the values listed in Table 1-23. Caution To avoid degradation of system performance, AGENT-RESTART (3) should be returned only for a transient problem, such as a file lock.
Programmatic Interface to the TRANSFER Delivery System TAREQ Event Packages The TAREQ calls a SCREEN COBOL agent with a CALL statement written in the following format: CALL agent-name USING AGENT-LINK, AGENT-LINK-REPLY. The linkage section of the user-supplied SCREEN COBOL program unit must correspond to this CALL statement.
2 TISERV UOW Descriptions Overview This section describes the available TISERV units-of-work (UOWs). The description of each UOW includes the following elements: The DDL format and syntax of the request UOW and its corresponding response UOW. (The letters -rsp in the name of each response UOW stand for response.) The content, function, and constraints of the individual fields transmitted within or returned by the UOW. The operations performed by TISERV in response to the UOW.
TISERV UOW Descriptions UOW Header and Return Code UOW Header and Each UOW transmitted to TISERV begins with a UOW header. The DDL definition for Return Code this header is: DEF uow-hdr. 02 self-ident 02 uow-code END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED. Individual fields in the UOW header contain the following information: SELF-IDENT always contains the characters UW to identify the header as a UOW header. UOW-CODE is a code value that identifies the specific UOW request being made.
TISERV UOW Descriptions Software Provided with the TRANSFER Delivery System Individual fields in the response UOW header contain the following additional information: UOW-RETN-CODE is the return code. If no errors occurred, the TRANSFER delivery system sets this field to 0. If an error occurred, the TRANSFER delivery system sets this field to a positive value ranging from 4000 through 5999; these values indicate the UOW was not processed.
TISERV UOW Descriptions Software Provided with the TRANSFER Delivery System GDDL contains DDL source code that can be run through the DDL compiler to produce UOW definitions for programs written in FORTRAN and TAL. (You can also use this file to produce UOW definitions for SCREEN COBOL and COBOL programs, although the GCOB and GLNK files generally serve that purpose better.
TISERV UOW Descriptions Software Provided with the TRANSFER Delivery System The manual describes return codes for each UOW under the explanation of the RETN-CODE field in the text that covers the UOW. However, the GDDL and GCOB files define return codes in the form of COBOL level 88 statements for the RETN-CODE field of each UOW, listing all error codes that TISERV might return.
TISERV UOW Descriptions Commonly Used Fields Fields defined as TYPE BINARY 16 in the manual and the GDDL file are defined as PIC S9(4) COMP or PIC 9(4) COMP in GCOB and GLNK. Commonly Used Certain DDL field definitions are common to several UOWs. The syntax for these Fields definitions is presented with the individual UOW descriptions in this manual. Information about their general use is summarized in the following paragraphs.
TISERV UOW Descriptions Commonly Used Fields DATE-TIME Field Several UOWs have fields that include the DATE-TIME DDL definition that governs the format of various dates and times that appear in the package header item. This definition is specified as: DEF date-time. 02 year 02 month 02 day-of-month 02 hour 02 minute 02 second END. PIC PIC PIC PIC PIC PIC 9(4). 9(2). 9(2). 9(2). 9(2). 9(2).
TISERV UOW Descriptions Commonly Used Fields UNITS is the unit of time specified in the QUANTITY field. This field allows the following values: D Specifies that days are the units specified in QUANTITY. H Specifies that hours are the units specified in QUANTITY. M Specifies that minutes are the units specified in QUANTITY. FOLDER-NAME Field The FOLDER-NAME field appears in many UOWs, where it identifies a folder. Its DDL definition is: DEF folder-name PIC X(80).
TISERV UOW Descriptions Commonly Used Fields ITEM-DESCR-FLAGS-2 The ITEM-DESCR-FLAGS-2 pertain to items that are package headers. The DDL definition for ITEM-DESCR-FLAGS-2 is: DEF item-descr-flags-2. 02 rel-date-reply-by 02 rel-date-submit-timed 02 rel-date-submit-until 02 autoforwarded 02 converted 02 defer-submit 02 body-part-encrypted 02 being-exported 02 reserved-8 02 reserved-9 02 reserved-10 02 reserved-11 02 reserved-12 02 reserved-13 02 reserved-14 02 reserved-15 END.
TISERV UOW Descriptions Commonly Used Fields REL-DATE-SUBMIT-UNTIL indicates whether the date specified in the SUBMIT-UNTIL field in the item descriptor is relative or absolute: Y The date specified in the SUBMIT-UNTIL field in the item descriptor is relative. N The date specified in the SUBMIT-UNTIL field in the item descriptor is absolute. AUTOFORWARDED indicates whether the package was autoforwarded through the X400 Gateway by an X400 user: Y The package was autoforwarded by a foreign X400 user.
TISERV UOW Descriptions Commonly Used Fields ITEM-HANDLE Field To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE. You can also use an ITEM-HANDLE to refer to an external object. ITEM-HANDLE is defined as follows: DEF item-handle. 02 handle-flag 02 uow-number 02 item-number END. PIC X(8). !VALUE HIGH-VALUES TYPE BINARY 16. TYPE BINARY 16. HANDLE-FLAG distinguishes the item handle from a standard item ID.
TISERV UOW Descriptions Commonly Used Fields A reference with ITEM-HANDLE can fail in all of the same ways a reference with ITEM-ID can fail. In addition, the following special cases can occur: If you use an item number that is less than the number of items requested in the UOW being referenced but greater than the number of items actually returned by the UOW being referenced, the warning W-ITEM-NOT-RETURNED (-4063) is returned.
TISERV UOW Descriptions Commonly Used Fields RECIP-REQUEST-FLAGS Field The RECIP-REQUEST-FLAGS field defines which requests were made for a particular TRANSFER recipient of a package. The DDL definition for RECIP-REQUEST-FLAGS is: DEF recip-request-flags.
TISERV UOW Descriptions Commonly Used Fields RECEIPT-NOTIFY indicates whether receipt notification has been requested for this recipient: Y Receipt notification has been requested for this recipient. N Receipt notification has not been requested for this recipient. Receipt notification is returned in the form of a status package when the recipient issues an ACK-RECEIPT UOW for the package and the package is not certified.
TISERV UOW Descriptions Commonly Used Fields NON-DELIV-NOTIFY indicates whether the originator requested a non-delivery notification if delivery fails: Y The originator requested non-delivery notification if delivery fails. N The originator did not request non-delivery notification if delivery fails. STORAGE-STAT Field Several UOWs related to the depot storage statistics facility have fields that include the STORAGE-STAT DDL definition.
TISERV UOW Descriptions Commonly Used Fields X400-NAME Field The X400-NAME field provides all of the possible attributes that make up an originator/recipient (O/R) name. Its DDL definition is: DEF x400-name. 02 country 02 admd 02 prmd 02 org-name 02 personal-name. 03 surname 03 given-name 03 initials 03 gen-qual 02 org-unit-1 02 org-unit-2 02 org-unit-3 02 org-unit-4 02 dom-def-1. 03 attr-type 03 attr-value 02 dom-def-2. 03 attr-type 03 attr-value 02 dom-def-3. 03 attr-type 03 attr-value 02 dom-def-4.
TISERV UOW Descriptions Commonly Used Fields Unused fields must be blank filled. Fields with values must contain blanks to the right of each value. Note X400-DELIV-STATUSFLAGS Field The fields for forms and variants other than Form 1, Variant 1 and Form 1, Variant 3 are reserved. The X400-DELIV-STATUS-FLAGS are similar to the DELIV-STATUS-FLAGS for TRANSFER recipients except that the X400-DELIV-STATUS-FLAGS apply to X400 recipients of packages.
TISERV UOW Descriptions Commonly Used Fields X400-RECIP-REQ-FLAGS Field The X400-RECIP-REQ-FLAGS define which requests were made for a particular X400 recipient of a package. The DDL definition for RECIP-REQUEST-FLAGS is: DEF x400-recip-req-flags.
TISERV UOW Descriptions Commonly Used Fields NON-RECEIPT-NOTIFY indicates whether non-receipt notification has been requested for this recipient: Y Non-receipt notification has been requested for this recipient. N Non-receipt notification has not been requested for this recipient. Non-receipt notification is returned in the form of a status package when a nonreceipt notification is returned by the recipient's user agent.
TISERV UOW Descriptions UOW Definitions UOW Definitions The remainder of this section presents the available UOWs in alphabetic order. Each definition begins with the DDL format for the UOW request and corresponding response, followed by a description of the fields and the operations performed.
TISERV UOW Descriptions ACK-RECEIPT ACK-RECEIPT (UOW Code 131) ACK-RECEIPT acknowledges the receipt of a package. This operation is recommended whenever a client retrieves a package from the INBOX folder; for example, whenever the client displays the contents of a package on behalf of a correspondent. DEF ack-receipt-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy END. DEF ack-receipt-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW".
TISERV UOW Descriptions ACK-RECEIPT RETN-CODE is the return code.
TISERV UOW Descriptions ACK-RECEIPT It is not necessary to call ACK-RECEIPT from within a transaction. ACK-RECEIPT automatically starts and ends a transaction if one is required to perform the request and no transaction ID is present. The TRANSFER delivery system automatically marks a package delivered to a group's INBOX folder as having been examined, to prevent the generation of messages pertaining to the expiration of the package.
TISERV UOW Descriptions ADD-AUX-NAME ADD-AUX-NAME (UOW Code 177) ADD-AUX-NAME adds an existing TRANSFER correspondent as an auxiliary user to a package. DEF add-aux-name-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy 02 aux-name-type 02 aux-name-seq-num 02 aux-name END. DEF add-aux-name-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 aux-name-seq-num 02 accepted-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 177. PIC PIC PIC PIC X(12). 9(4) COMP.
TISERV UOW Descriptions ADD-AUX-NAME AUX-NAME-SEQ-NUM specifies the sequence number of the auxiliary name that is to be added. Use the value -1 to request the next sequence number. If the value specified is not -1 or is not between 1 and 9999, then the TRANSFER delivery system returns error 4058, E-INVALID-REC-SEQ-NUM. AUX-NAME is the name of the TRANSFER correspondent that is to be added as an auxiliary user. This name can include a suffix. RETN-CODE is the return code.
TISERV UOW Descriptions ADD-AUX-NAME ADD-AUX-NAME Operation The ADD-AUX-NAME UOW allows clients to add TRANSFER correspondent names as auxiliary names to packages. Currently the only auxiliary names defined are authorizing users and reply-to recipients. The auxiliary names are added to item data records of types 104 and 105. An actual sequence number is required; the client stores this number in AUX-NAME-SEQ-NUM.
TISERV UOW Descriptions ADD-GROUP-MEMBER ADD-GROUP-MEMBER (UOW Code 246) ADD-GROUP-MEMBER adds existing local correspondents or groups as members of the specified interest group. DEF add-group-member-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 246. 02 group-name PIC X(80) VALUE SPACES. 02 num-wanted TYPE BINARY 16 UNSIGNED. 02 group-members PIC X(80) OCCURS 0 TO 5 TIMES DEPENDING ON num-wanted. 03 group-member-name PIC X(80). 03 member-is-admin TYPE BOOLEAN.
TISERV UOW Descriptions ADD-GROUP-MEMBER GROUP-MEMBER-NAME is the name of a new group member. The member can be either an existing local correspondent or an existing local interest group. MEMBER-IS-ADMIN is a flag that indicates whether the new member specified in the GROUPMEMBER-NAME field is also granted group administrative privileges. The new member must be a correspondent (rather than another group) to be able to be granted group administrative privileges. RETN-CODE is the return code.
TISERV UOW Descriptions ADD-GROUP-MEMBER MBR-RETN-CODE is an error or warning returned for each member name specified in the UOW for which an error occurred.
TISERV UOW Descriptions ADD-GROUP-MEMBER ADD-GROUP-MEMBER Operation ADD-GROUP-MEMBER adds new members to a local interest group. A group member must be a correspondent or interest group. If the new member is a correspondent, the new member can optionally be granted group administrative privileges. If the group profile voluntary sign-up flag is set to C, local correspondents can add themselves as nonadministrative group members.
TISERV UOW Descriptions ADD-ITEM-REC ADD-ITEM-REC (UOW Code 104) ADD-ITEM-REC adds a data record to an item. DEF add-item-rec-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-key. 03 item-id. 04 dummy 03 rec-type 03 rec-seq-num 02 data-byte-count 02 client-data. 03 element END. DEF add-item-rec-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 rec-seq-num END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 104. PIC X(12). PIC 9(4) COMP. PIC 9(4) COMP. TYPE BINARY 16 UNSIGNED.
TISERV UOW Descriptions ADD-ITEM-REC REC-TYPE describes what kind of record is being accessed. This field is not interpreted by the TRANSFER delivery system, but is stored with the item record and is returned by the GET-ITEM-REC UOW. Records are stored first in increasing order by REC-TYPE and, within each REC-TYPE, in increasing order by REC-SEQ-NUM. The values 100 through 999 are assigned for use by Tandem application packages.
TISERV UOW Descriptions ADD-ITEM-REC RETN-CODE is the return code.
TISERV UOW Descriptions ADD-ITEM-REC ADD-ITEM-REC Operation ADD-ITEM-REC adds a data record to an item. The record is identified by DATABYTE-COUNT and CLIENT-DATA. The item is identified by ITEM-KEY. TISERV assigns the sequence number indicated by REC-SEQ-NUM to this record. If you set REC-SEQ-NUM to -1, TISERV assigns the next highest unused sequence number within the record type specified. Note that the REC-SEQ-NUM value assigned to the record is returned in the response.
TISERV UOW Descriptions ADD-ITEM-REC Figure 2-1 illustrates adding a record to an item. Figure 2-1.
TISERV UOW Descriptions ADD-MEMBER ADD-MEMBER (UOW Code 220) ADD-MEMBER adds one or more members to a distribution list. These members can be correspondents, interest group names, private distribution lists, and group distribution lists. ADD-MEMBER can also accept a shared distribution list name as the target distribution list, so that interest group members with the proper privileges can add distribution list members to distribution lists owned by the group.
TISERV UOW Descriptions ADD-MEMBER DLIST-NAME is the name of the distribution list to which the new member is added. This can be a partially qualified name, including wild-card characters. In the response, the fully qualified name is returned. NUM-WANTED is the number of members to be added to the distribution list. You can specify any number of members, restricted only by the length of the entire IPC that contains this UOW. The maximum IPC length is defined during TRANSFER system configuration.
TISERV UOW Descriptions ADD-MEMBER To indicate problems with the distribution list name: 5625 5626 5627 5629 5631 5632 5635 5636 5647 5648 E-DLIST-NSRV-ERR E-DLIST-NOT-FOUND E-DLIST-BAD-NAME E-DLIST-NO-SUCH-NODE E-DLIST-NSRV-NOT-FOUND E-DLIST-NSRV-DOWN E-DLIST-ALIAS E-DLIST-NET-DOWN E-DLIST-NOT-SAME-NODE E-DLIST-AMBIGUOUS-NAME To indicate at least one of the members was not added: -4227 W-ERR-ON-MEMBER To indicate problems with the depot storage statistics facility: 4944 6114 6126 6127 E-ERR-DEPSTAT-F
TISERV UOW Descriptions ADD-MEMBER MBR-RETURN-CODE is a code that indicates the status of each member the UOW attempted to add. The message OK indicates that the member was successfully added.
TISERV UOW Descriptions ADD-MEMBER ADD-MEMBER Operation ADD-MEMBER adds the new members identified by MEMBER-NAME to the distribution list identified by DLIST-NAME. You can specify any number of new members even though the DDL format shows only five; the number is restricted only by the limit specified in the OCCURS clause and the length of the entire IPC that contains this UOW. The maximum IPC length is defined during TRANSFER system configuration.
TISERV UOW Descriptions ADD-RECIP ADD-RECIP (UOW Code 114) ADD-RECIP adds a correspondent name, a group name, or a distribution list name to a package recipient list. DEF add-recip-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 recip-name 02 recip-type 02 options. 03 use-depot-resol-flags 03 defer-local-resolution 03 defer-remote-resolution 03 derived-from-dlist 03 reply-request 03 reserved-4 PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 114.
TISERV UOW Descriptions ADD-RECIP within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. RECIP-NAME is the name of the recipient to be added to the recipient list. The name can identify either a correspondent or a distribution list. This can be a partially qualified name, provided local and remote name resolution is not deferred in the depot profile. The name can include wild-card characters and a suffix.
TISERV UOW Descriptions ADD-RECIP N The TRANSFER delivery system immediately resolves these names. DERIVED-FROM-DLIST is used only by TAREQ processes. This field must be set to N. REPLY-REQUEST specifies whether a reply is requested from this recipient: Y This recipient has been requested to reply to the original package. N This recipient has not been requested to reply to the original package. The TRANSFER delivery system does not force a reply; clients must do so.
TISERV UOW Descriptions ADD-RECIP RESERVED-6 is reserved for use by Tandem. This field must be set to N. NON-RECEIPT-NOTIFY specifies whether a non-receipt notification message is to be returned to the originator if the recipient does not receive the package: Y Non-receipt notification has been requested for this recipient. Nonreceipt notification is returned in the form of a status package if the recipient removes the package from all of a correspondent's folders without issuing an ACK-RECEIPT UOW.
TISERV UOW Descriptions ADD-RECIP To indicate other problems: 4010 4035 4041 4042 -4049 4051 4052 4065 -4067 -4069 E-BAD-TRANSACTION E-ITEM-NOT-FOUND E-ITEM-UNALTERABLE E-ITEM-NOT-PKG-HDR W-REC-ALREADY-EXISTS E-MUST-BE-YN E-RESERVED-MUST-BE-N E-INVALID-RECIP-TYPE W-REMOTE-NAME-ACCEPTED W-NODE-NAME-UNKNOWN To indicate problems with an item handle: 4062 -4063 E-INVALID-ITEM W-ITEM-NOT-RETURNED RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a furt
TISERV UOW Descriptions ADD-RECIP-C20 ADD-RECIP-C20 (UOW Code 189) ADD-RECIP-C20 adds a recipient to a package recipient list. DEF add-recipient-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 recip-name 02 recip-type 02 options.
TISERV UOW Descriptions ADD-RECIP-C20 within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. RECIP-NAME is the name of the recipient to be added to the recipient list. The name can identify either a correspondent or a distribution list. This can be a partially qualified name, provided local and remote name resolution is not deferred in the depot profile. The name can include wild-card characters and a suffix.
TISERV UOW Descriptions ADD-RECIP-C20 DEFER-REMOTE-RESOLUTION Y The TRANSFER delivery system defers the resolution of remotely defined names. N The TRANSFER delivery system immediately resolves these names. DERIVED-FROM-DLIST is used only by TAREQ processes. This field must be set to N. REPLY-REQUEST Y This recipient has been requested to reply to the original package. N This recipient has not been requested to reply to the original package.
TISERV UOW Descriptions ADD-RECIP-C20 DONT-MARK-AS-ORIG specifies whether a recipient is added as an original recipient. Original recipient names are transported to all nodes to which the package is transported. Y The recipient is added to a package as a non-original recipient, and the recipient name is transported only to the node specified with the recipient name. On nodes where the name is not to be processed, the package is marked so that it is not processed on those nodes.
TISERV UOW Descriptions ADD-RECIP-C20 To indicate other problems: 4010 4035 4041 4042 -4049 4051 4052 4065 -4067 -4069 E-BAD-TRANSACTION E-ITEM-NOT-FOUND E-ITEM-UNALTERABLE E-ITEM-NOT-PKG-HDR W-REC-ALREADY-EXISTS E-MUST-BE-YN E-RESERVED-MUST-BE-N E-INVALID-RECIP-TYPE W-REMOTE-NAME-ACCEPTED W-NODE-NAME-UNKNOWN To indicate problems with an item handle: 4062 -4063 E-INVALID-ITEM W-ITEM-NOT-RETURNED RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a
TISERV UOW Descriptions ADD-X400-AUX-NAME ADD-X400-AUX-NAME (UOW Code 174) ADD-X400-AUX-NAME adds an existing X400 correspondent as an auxiliary user to a package. DEF add-x400-aux-name-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 174. 02 item-id. 03 dummy PIC X(12). 02 aux-name-type PIC 9(4) COMP. 02 aux-name-seq-num PIC S9(4) COMP. 02 x400-name. END. DEF add-x400-aux-name-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions ADD-X400-AUX-NAME AUX-NAME-SEQ-NUM specifies the sequence number of the auxiliary name that is to be added. This field can have a value of -1 or 1 through 9999, inclusive: -1 indicates that the name should be given the next sequence number and be added to the end of the list. If the value specified is not -1 or is not in the range 1 through 9999, then the error E-INVALID-REQ-SEQ-NUM is returned.
TISERV UOW Descriptions ADD-X400-AUX-NAME ADD-X400-AUX-NAME Operation The ADD-X400-AUX-NAME UOW allows clients to add foreign X400 names as auxiliary names to packages. Currently the only auxiliary names defined are authorizing users and reply-to recipients. If the item specified was created before the installation of the C20 version of the TRANSFER delivery system, then E-CANT-ADD-X400-NAME is returned. If the TRANSFER X400-CONFIGURED flag is not set to Y, then E-X400-NOTCONFIGURED is returned.
TISERV UOW Descriptions ADD-X400-MEMBER ADD-X400-MEMBER (UOW Code 241) ADD-X400-MEMBER adds an X400 recipient to a TRANSFER distribution list. DEF add-x400-member-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 dlist-name 02 x400-member-name. END. DEF add-x400-member-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name 02 dlist-name 02 member-node-num 02 member-seq-num END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 241. PIC X(80) VALUE SPACES. PIC X(80).
TISERV UOW Descriptions ADD-X400-MEMBER RETN-CODE is the return code.
TISERV UOW Descriptions ADD-X400-MEMBER ADD-X400-MEMBER Operation Because the X400 members of a distribution list are ordered by sequence number, it is possible to create gaps in the distribution list as members are deleted. These gaps are not reused during normal member addition; members are simply added to the end of the list.
TISERV UOW Descriptions ADD-X400-RECIP ADD-X400-RECIP (UOW Code 171) ADD-X400-RECIP adds an X400 recipient to a package. DEF add-x400-recip-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 recip-type 02 recip-seq-num 02 options. 03 reply-requested 03 deliv-notify 03 receipt-notify 03 non-receipt-notify 03 p2-recip-only 03 reserved-5 03 reserved-6 03 reserved-7 02 p2-recip-only 02 x400-recip-name. END. DEF add-x400-recip-rsp. 02 hdr. 03 self-ident 03 uow-code PIC AA VALUE "UW".
TISERV UOW Descriptions ADD-X400-RECIP RECIP-TYPE specifies the type of recipient that is to be added. This field can contain values ranging from 300 through 9999. The values 300 through 999 are reserved by Tandem. If you specify a value outside of the range from 300 through 9999, the error E-INVALID-RECIP-TYPE is returned. Some values for RECIP-TYPE have special meaning if the item type for the package specified by ITEM-ID is 109 through 114 (mail packages).
TISERV UOW Descriptions ADD-X400-RECIP DELIV-NOTIFY specifies whether a delivery notification message is to be returned when the package is delivered to the recipient's user agent: Y A delivery notification message is to be returned when the package is delivered to the recipient's user agent. N A delivery notification message is not requested. Note Not all X.400 implementations support delivery notification and therefore delivery notification is not guaranteed.
TISERV UOW Descriptions ADD-X400-RECIP P2-RECIP-ONLY specifies whether an additional record with recip-type 300 should be made. The default value of N would add it, while a value of Y would only add one record with the specified recip-type. RESERVED-5 through RESERVED-7 are reserved by Tandem; these fields must be set to N. X400-RECIP-NAME specifies the originator/recipient name of the recipient. The validity of the combination of originator/recipient name attributes is checked.
TISERV UOW Descriptions ADD-X400-RECIP TRANSFER delivery system to provide for unique keys. When the recipient record is added to the X400NAME file, an extra field is added to help make the record unique. Clients cannot specify this value; it is added implicitly by the TRANSFER delivery system. You need not display this value to users; it is only used to uniquely identify records in the X400NAME file.
TISERV UOW Descriptions ALTER-AGENT-SELECT ALTER-AGENT-SELECT (UOW Code 208) ALTER-AGENT-SELECT changes agent selection criteria for a depot. Typically, this UOW is issued after a GET-AGENT-SELECT UOW. DEF alter-agent-select-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 208. 02 filler TYPE CHARACTER 4. 02 corr-name PIC X(80) VALUE SPACES. 02 group-name REDEFINES corr-name. 02 filler TYPE CHARACTER 1. 02 action TYPE CHARACTER 1.
TISERV UOW Descriptions ALTER-AGENT-SELECT INSERT-AFTER-REC (I) inserts the selection criteria defined by UOW fields AGENT-NAME through AGENT-DATA. Place these criteria in the agent list after the record identified by AGENT-REC-NUM. To insert the record at the beginning of the list, set AGENT-REC-NUM to 0. REWRITE-REC (W) updates the agent specified by AGENT-REC-NUM. DELETE-REC (D) deletes the agent specified by AGENT-REC-NUM.
TISERV UOW Descriptions ALTER-AGENT-SELECT APPLIC-ID-FOR-LOGON is the application ID to be used in the START-SESSION UOW when the AGENTFLAG field is set to Y, meaning that a session is started before the agent is invoked. APPLIC-ID-LOW, APPLIC-ID-HIGH, AGENT-SEL-LOW, and AGENT-SEL-HIGH define numeric ranges used by TAREQs to select an agent. These fields can contain values ranging from 0 through 9999. Agent selection is as follows: 1.
TISERV UOW Descriptions ALTER-AGENT-SELECT To indicate problems with the correspondent name: 5600 5607 5601 5611 5602 5622 5604 5623 5606 E-CORR-NSRV-ERR E-CORR-NSRV-DOWN E-CORR-NOT-FOUND E-CORR-NET-DOWN E-CORR-BAD-NAME E-CORR-NOT-SAME-NODE E-CORR-NO-SUCH-NODE E-CORR-AMBIGUOUS-NAME E-CORR-NSRV-NOT-FOUND To indicate other problems: 4010 4047 4054 4055 4058 4093 4201 4214 4230 4231 4232 4902 E-BAD-TRANSACTION E-REC-NOT-FOUND E-INVALID-AGENT-SEL E-INVALID-APPLIC-ID E-INVALID-REC-SEQ-NUM E-SECURITY-VIOLATIO
TISERV UOW Descriptions ALTER-AGENT-SELECT ALTER-AGENT-SELECT Operation ALTER-AGENT-SELECT creates, deletes, or updates the requested agent selection entry recorded in the depot profile file. The agent is identified by AGENT-REC-NUM. The selection entry is contained in fields AGENT-NAME through AGENT-DATA. The list of agents for a depot is ordered by agent record number (AGENT-REC-NUM field). Existing agents can have AGENT-REC-NUM values in the range of 1 through 500.
TISERV UOW Descriptions ALTER-FOLDER-DESCR ALTER-FOLDER-DESCR (UOW Code 236) ALTER-FOLDER-DESCR modifies the ordering criteria and item retention time for an existing folder. DEF alter-folder-descr-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name 02 attributes-to-alter. 03 ordering-criteria. 05 ordering-discipline 05 applic-order-type 05 options.
TISERV UOW Descriptions ALTER-FOLDER-DESCR DEF alter-folder-descr-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 retn-code retn-code-detail corr-name folder-name folder-attributes. 03 ordering-criteria. 05 ordering-discipline 05 filler 05 applic-order-type 05 options. 10 ascending-sequence 10 allow-duplicates 10 reserved-2 10 reserved-3 10 reserved-4 10 reserved-5 10 reserved-6 10 reserved-7 03 item-retention-time. 05 quantity 05 units 05 filler 03 reserved PIC AA VALUE "UW".
TISERV UOW Descriptions ALTER-FOLDER-DESCR ATTRIBUTES-TO-ALTER lets you select the folder attribute fields to be changed. Y Select the corresponding FOLDER-ATTRIBUTES field for alteration. N Disable the corresponding FOLDER-ATTRIBUTES field for alteration. Fields labeled as RESERVED are reserved for use by Tandem. Set these fields to N or SPACES, depending on the definition of the field.
TISERV UOW Descriptions ALTER-FOLDER-DESCR ASCENDING-SEQUENCE determines whether items are saved within the folder in ascending or descending key order. Y Save items in ascending key order. N Save items in descending key order. Variable length APPLIC-DEFINED keys that are used with descending key order do not collate in the correct order unless the application pads the key with enough bytes to make it a constant length for all entries in the folder.
TISERV UOW Descriptions ALTER-FOLDER-DESCR You can also set this field to P, provided that you set QUANTITY to 0. 0 P specifies that the profile constraint should be used. The item retention time for the folder then becomes the same as the item retention time for the depot in which the item resides. Also, you can set this field to C, provided that you set QUANTITY to 0. 0 C sets the item retention time for the folder to the default retention time specified for folder creation in the depot profile.
TISERV UOW Descriptions ALTER-FOLDER-DESCR To indicate other problems: 4010 4051 4052 4093 4105 4201 4265 4266 4267 4902 4912 4968 E-BAD-TRANSACTION E-MUST-BE-YN E-RESERVED-MUST-BE-N E-SECURITY-VIOLATION E-CONCURRNT-FLD-UPDATE E-CONTEXT-ERR E-INVALID-ORD-DISCIPLN E-INVALID-APP-ORD-TYPE E-ITEMS-IN-FLD E-ERR-PROFILE-FILE E-ERR-FOLDER-FILE E-SPECIAL-FLD To indicate problems with the item retention time: 4072 4074 -4269 4270 E-UNITS-MUST-BE-DHM E-INVALID-REL-TIME-QUANTITY W-TIME-TOO-LONG E-INVALID-FOLDER E
TISERV UOW Descriptions ALTER-FOLDER-DESCR ALTER-FOLDER-DESCR Operation ALTER-FOLDER-DESCR can update ordering criteria and item retention time for a specified folder. Field values in this UOW indicate the new ordering criteria and item retention time. Folder order affects the sequence in which items are saved and subsequently referenced. Each item saved in a folder has an associated ordering key.
TISERV UOW Descriptions ALTER-FOLDER-ORDER ALTER-FOLDER-ORDER (UOW Code 234) ALTER-FOLDER-ORDER modifies the ordering criteria for an existing folder. The folder must be empty. DEF alter-folder-order-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 02 corr-name folder-name ordering-discipline filler applic-order-type options. 03 ascending-sequence 03 allow-duplicates 03 reserved-2 03 reserved-3 03 reserved-4 03 reserved-5 03 reserved-6 03 reserved-7 END. DEF alter-folder-order-rsp. 02 hdr.
TISERV UOW Descriptions ALTER-FOLDER-ORDER FOLDER-NAME is the name of an existing folder that is empty. You can enter the special folder names INBOX, WASTEBASKET, and OUTLOG if the folders are empty. These special folders cannot have APPLIC-DEFINED (A) ordering discipline. An attempt to use APPLIC-DEFINED ordering for these folders returns the error E-SPECIAL-FLD. These special folders must allow duplicates.
TISERV UOW Descriptions ALTER-FOLDER-ORDER APPLIC-ORDER-TYPE distinguishes between types of ordering disciplines and is meaningful only if ORDERING-DISCIPLINE is APPLIC-DEFINED (A). If ORDERING-DISCIPLINE is not APPLIC-DEFINED, the field is ignored. This field is not interpreted by the TRANSFER delivery system, but is stored as part of the folder's ordering criteria. The field is returned by the GET-FOLDERORDER and GET-FOLDER-DESCR UOWs.
TISERV UOW Descriptions ALTER-FOLDER-ORDER RESERVED-2 through RESERVED-7 are reserved for use by Tandem. These fields must be set to N. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions ALTER-FOLDER-ORDER To indicate other problems: 4010 4051 4052 4093 4105 4201 4265 4266 4267 4902 4912 4968 E-BAD-TRANSACTION E-MUST-BE-YN E-RESERVED-MUST-BE-N E-SECURITY-VIOLATION E-CONCURRNT-FLD-UPDATE E-CONTEXT-ERR E-INVALID-ORD-DISCIPLN E-INVALID-APP-ORD-TYPE E-ITEMS-IN-FLD E-ERR-PROFILE-FILE E-ERR-FOLDER-FILE E-SPECIAL-FLD RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by th
TISERV UOW Descriptions ALTER-GROUP-MEMBER ALTER-GROUP-MEMBER (UOW Code 247) ALTER-GROUP-MEMBER revokes or grants group administrative privileges to an existing member of the specified local interest group. The member must be a correspondent and not a group. DEF alter-group-member-uow. 02 hdr. 03 self-ident 03 uow-code 02 group-name 02 group-member-name 02 member-is-admin 02 filler END. DEF alter-group-member-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 END.
TISERV UOW Descriptions ALTER-GROUP-MEMBER RETN-CODE is the return code.
TISERV UOW Descriptions ALTER-GROUP-MEMBER ALTER-GROUP-MEMBER Operation ALTER-GROUP-MEMBER revokes or grants group administrative privileges to an existing member of the specified local interest group. The member can be a direct or indirect member of the group named in GROUP-NAME.
TISERV UOW Descriptions ALTER-ITEM-DESCR ALTER-ITEM-DESCR (UOW Code 116) ALTER-ITEM-DESCR updates fields in an item descriptor. The descriptor can apply to an individual item or an item that is a package header. This UOW is used primarily to set a number of attributes for a package prior to submission of that package for delivery. Typically, this UOW is issued after a GET-ITEM-DESCR UOW. DEF alter-item-descr-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 update-control 02 fields-to-alter.
TISERV UOW Descriptions ALTER-ITEM-DESCR 03 err-pkg-suppress-flags. invalid-recip invalid-dlist reserved-2 too-late-to-deliver expired-unexamined pkg-compressed reserved-5 04 04 04 04 04 04 04 04 reserved-6 04 reserved-7 02 alterable-fields. 03 item-type 03 rel-date-earliest 03 rel-date-latest 03 rel-date-expiration 03 reserved-3 03 earliest-deliv-date. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 03 latest-deliv-date.
TISERV UOW Descriptions ALTER-ITEM-DESCR 03 expiration-date. date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 03 priority 03 agent-selector 03 deliv-control-flags. 04 certified 04 conversion-prohib 04 reserved-1 04 04 04 TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES conversion-prohib TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES dont-disclose-recips TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES defer-transport TYPE BOOLEAN. TYPE BOOLEAN.
TISERV UOW Descriptions ALTER-ITEM-DESCR DEF alter-item-descr-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 END. retn-code retn-code-detail PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 116. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header. The UOW-CODE value is 116. ITEM-ID identifies the item whose descriptor record is to be changed.
TISERV UOW Descriptions ALTER-ITEM-DESCR ALTERABLE-FIELDS lets you indicate what updating should be done to the fields for which Y was specified under FIELDS-TO-ALTER. These fields and their allowable entries are defined as follows: ITEM-TYPE indicates the type of the item, as defined by the application. Appendix A of the TRANSFER Programming Guide lists reserved ITEM-TYPE values.
TISERV UOW Descriptions ALTER-ITEM-DESCR Figure 2-2 illustrates package delivery time milestones. Figure 2-2. Package Delivery Time Milestones Delivery Time Window Windows Expiration Time Window Milestones Submitted Date Earliest Delivery Date Actual Delivery Date Latest Delivery Date Expiration Date TIME 002 EXPIRATION-DATE is the date on which the package expires.
TISERV UOW Descriptions ALTER-ITEM-DESCR package with a nonzero expiration field, the TRANSFER delivery system increases that field so that it exceeds the configured minimum value. The interval between the LATEST-DELIV-DATE and EXPIRATION-DATE is the package expiration time window. You can specify the EXPIRATIONDATE as an absolute calendar date or a number of time units from LATESTDELIV-DATE. An absolute or relative date is indicated by the REL-DATEEXPIRATION field.
TISERV UOW Descriptions ALTER-ITEM-DESCR CONVERSION-PROHIB is reserved for use by Tandem. DONT-DISCLOSE-RECIPS specifies whether only the name of the recipient that performs either a GET-RECIP-REC UOW or a GET-RECIP-REC-C20 UOW is returned. Y Only the name of the recipient that performs either a GET-RECIP-REC UOW or a GET-RECIP-REC-C20 UOW is returned. N The names of all recipients in addition to the name of the recipient that performs either a GET-RECIP-REC UOW or a GET-RECIP-RECC20 UOW are returned.
TISERV UOW Descriptions ALTER-ITEM-DESCR ERR-PKG-SUPPRESS-FLAGS lets you suppress the effects of specific asynchronous errors. Fields within ERR-PKG-SUPPRESS-FLAGS are as follows: INVALID-RECIP through PKG-COMPRESSED denote asynchronous errors detected by the TRANSFER delivery system. If one of these errors occurs and error reporting is not suppressed, the TRANSFER delivery system transmits a package reporting the error to the sender. Y Suppress the error-reporting package.
TISERV UOW Descriptions ALTER-ITEM-DESCR ALTER-ITEM-DESCR Operation ALTER-ITEM-DESCR alters the fields in an item descriptor. This UOW selects for alteration those fields chosen in FIELDS-TO-ALTER, and modifies them in accordance with the information supplied in ALTERABLE-FIELDS. If you do not issue this UOW for a package, the package is delivered by the TRANSFER delivery system in accordance with default values assumed at package creation.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 ALTER-ITEM-DES-B40 (UOW Code 147) ALTER-ITEM-DES-B40 updates fields in an item descriptor. The descriptor can apply to an individual item or an item that is a package header. This UOW is used primarily to set a number of attributes for a package prior to submission of that package for delivery. Typically, this UOW is issued after a GET-ITEM-DESCR UOW. DEF alter-item-des-b40-uow. 02 hdr. 03 self-ident 03 uow-code item-id.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 04 reserved-2 04 too-late-to-deliver 04 expired-unexamined 04 pkg-compressed 04 reserved-5 04 reserved-6 04 reserved-7 02 alterable-fields. 03 item-type 03 rel-date-earliest 03 rel-date-latest 03 rel-date-expiration 03 reserved-3 03 earliest-deliv-date. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 03 latest-deliv-date. 04 date-time.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 05 units 05 filler 03 priority 03 agent-selector 03 deliv-control-flags. 04 certified 04 conversion-prohib 04 reserved-1 A. X. 9(3) COMP. 9(4) COMP. 04 04 TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES conversion-prohib TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES dont-disclose-recips TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES defer-transport TYPE BOOLEAN. REDEFINES dont-remove-on-expire TYPE BOOLEAN. TYPE BOOLEAN. REDEFINES probe-msg TYPE BOOLEAN. TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions ALTER-ITEM-DES-B40 DEF alter-item-des-b40-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 END. retn-code retn-code-detail PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 147. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header. The UOW-CODE value is 147. ITEM-ID identifies the item whose descriptor record is to be changed.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 ALTERABLE-FIELDS indicates what updating should be done to the fields for which Y was specified under FIELDS-TO-ALTER. These fields and their allowable entries are defined as follows: ITEM-TYPE indicates the type of the item, as defined by the application. Appendix A of the TRANSFER Programming Guide lists reserved ITEM-TYPE values.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 EXPIRATION-DATE is the date on which the package expires. On this date, the package is automatically removed from the INBOX of any recipient who has not already acknowledged its receipt through the ACK-RECEIPT UOW. Packages that are acknowledged or are in other folders are not affected by expiration.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 DELIV-CONTROL-FLAGS specifies whether or not the package is certified. Fields within DELIVCONTROL-FLAGS are as follows: CERTIFIED specifies whether the package is certified; that is, whether a certification package is returned to the sender whenever a recipient acknowledges receipt of a package via the ACK-RECEIPT UOW. Y Flag the package for certification. N Do not flag the package for certification.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 DONT-REMOVE-ON-EXPIRE specifies whether the package is removed from a recipient's INBOX folder when it expires unexamined. Y The package remains in the recipient's INBOX folder after the package expires unexamined. N The package is removed from the recipient's INBOX folder when the package expires. PROBE-MSG, X-400-RETURN-CONTENT, and RESERVED-7 are reserved for use by Tandem. These fields must be set to N.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 CODE-SET-ID uniquely identifies the character map used to enter data associated with the item. To select the map for the desired character set, enter the corresponding value from Table 2-3. If both CODE-PAGE-ID and CODE-SET-ID contain 0, no mapping is done. PAGE-STRING and SET-STRING redefine CODE-PAGE-ID and CODE-SET-ID, respectively, for MOVE operations in SCREEN COBOL and COBOL programs. Table 2-3.
TISERV UOW Descriptions ALTER-ITEM-DES-B40 RETN-CODE is the return code.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 ALTER-ITEM-DES-C20 (UOW Code 170) ALTER-ITEM-DES-C20 updates fields in an item descriptor. The descriptor can apply to an individual item or an item that is a package header. This UOW is used primarily to set a number of attributes for a package prior to submission of that package for delivery. Typically, this UOW is issued after a GET-ITEM-DES-C20 UOW. DEF alter-item-des-c20-uow. 02 hdr. 03 self-ident 03 uow-code item-id.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 03 byte 03 err-pkg-suppress-flags.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 04 delta-time 05 quantity 05 units 05 filler 05 filler 03 latest-deliv-date. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 05 filler 03 expiration-date. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 05 filler 03 priority 03 agent-selector 03 deliv-control-flags.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 04 04 probe-msg reserved-5 04 04 reserved-6 reserved-7 byte 03 03 err-pkg-suppress-flags. invalid-recip invalid-dlist reserved-2 too-late-to-deliver expired-unexamined pkg-compressed reserved-5 04 04 04 04 04 04 04 04 04 reserved-6 reserved-7 byte-flags 03 03 char-map-id code-page-id page-string 04 04 04 04 code-set-id set-string 03 03 03 03 sensitivity reply-by-date importance submit-timed. 04 date-time.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 04 delta-time. 05 quantity 05 units 05 filler 03 submit-until. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 04 delta-time 05 quantity 05 units 05 filler 05 filler 03 filler END. DEF alter-item-des-c20-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 END. retn-code retn-code-detail PIC 9(4) COMP. PIC A. PIC X. PIC 9(4). PIC 9(2). PIC 9(2). PIC 9(2). PIC 9(2). PIC 9(2). REDEFINES date-time. PIC 9(4) COMP. PIC A. PIC X. PIC X(10).
TISERV UOW Descriptions ALTER-ITEM-DES-C20 FIELDS-TO-ALTER lets you select the fields to be altered within the item descriptor. Y Select the field for alteration. N Disable the field from alteration. The meaning of each item descriptor field that your process can access is discussed under ALTERABLE-FIELDS. Your process can retrieve all of these fields with the GET-ITEM-DES-C20 UOW.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 In DELTA-TIME, UNITS is the unit of time denoted in QUANTITY. You can set UNITS to D (for days), H (for hours), or M (for minutes). To specify one day, for example, set QUANTITY to 1 and UNITS to D. LATEST-DELIV-DATE is the latest date at which the TRANSFER delivery system can deliver the package. You must specify the date as an absolute calendar date or as a number of time units from EARLIEST-DELIVERY-DATE.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 AGENT-SELECTOR is the agent selector criteria, as created by the ALTER-AGENT-SELECT UOW. This is a number that is stored with the package to determine which agents are invoked when the package is delivered. See the description of the ALTERAGENT-SELECT UOW in this section. See Appendix B, “Status Packages,” on the use of agent selectors in TRANSFER status packages. DELIV-CONTROL-FLAGS specifies whether or not the package is certified.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 DEFER-TRANSPORT specifies whether the package is transported immediately to remote TRANSFER nodes or on the date specified by the earliest date in the item descriptor. Y The package is not transported to remote TRANSFER nodes until the date specified by the earliest date in the item descriptor. N The package is immediately transported to remote TRANSFER nodes.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 CODE-PAGE-ID identifies the base (canonical) character set on which the character map is based. This subfield should always be set to 65300 (indicating the standard base character set) or to 0 (indicating the character set always supplied by the TRANSFER delivery system). If this field does not contain either of these values, the TRANSFER delivery system sets it to 65300 and returns the warning -4136, W-INVALID-CMAP-ID.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 IMPORTANCE contains a value ranging from 0 through 9999 and specifies the level of importance of an item. Table 2-5 lists the values allowed in this field. Table 2-5. Importance Values Value Meaning 0 through 100 101 through 200 201 through 200 Low importance Normal importance High importance SUBMIT-TIMED specifies when the package is actually to be submitted.
TISERV UOW Descriptions ALTER-ITEM-DES-C20 RETN-CODE is the return code.
TISERV UOW Descriptions ALTER-ITEM-NAME ALTER-ITEM-NAME (UOW Code 150) ALTER-ITEM-NAME assigns a name to an item in a private folder or shared folder, alters the name of an item or removes a name from a named item. This UOW can only be issued within a TMF transaction. DEF alter-item-name-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 folder-name item-id. 03 dummy 02 options.
TISERV UOW Descriptions ALTER-ITEM-NAME ITEM-ID is the ID of the item to be named or whose name is to be modified or deleted. (The first item in the folder is indicated by the value of the figurative constant LOWVALUES.) To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. OPTIONS contains one subfield for your use and seven subfields reserved for use by Tandem.
TISERV UOW Descriptions ALTER-ITEM-NAME RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions ALTER-ITEM-NAME ALTER-ITEM-NAME Operation ALTER-ITEM-NAME assigns a name to an instance of an item in a specified folder, alters an existing name for that item or removes a name from a named item. This UOW can only be issued within a TMF transaction. If the item is in a private folder or a bulletin board, the correspondent must be the session that originally saved the instance of the item in the folder. Your process can reference the item either by its item ID or an item handle.
TISERV UOW Descriptions ALTER-PROFILE-ELEM ALTER-PROFILE-ELEM (UOW Code 204) ALTER-PROFILE-ELEM alters data elements in a depot profile record. This UOW is typically used after a GET-PROFILE-ELEM UOW. Definition I is a DDL skeleton format to which definitions can be added; it is for general applications use. DEF alter-profile-elem-usk. 02 hdr. 03 self-ident 03 uow-code 02 filler 02 corr-name 02 group-name 02 num-returned END. DEF alter-profile-elem-rsk. 02 hdr.
TISERV UOW Descriptions ALTER-PROFILE-ELEM Definition II is for TAL programs. DEF alter-profile-elem-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 filler corr-name group-name num-returned elem-data-block END. DEF alter-profile-elem-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 02 retn-code retn-code-detail corr-name group-name num-returned elem-retn-code PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 204. TYPE CHARACTER 4. PIC X(80) VALUE SPACES. REDEFINES corr-name.
TISERV UOW Descriptions ALTER-PROFILE-ELEM NUM-RETURNED is the number of data elements that you alter. You can specify any number of elements, restricted only by the length of the entire IPC that contains this UOW. In the response, this field contains: The number actually altered if no serious errors are detected 0 if serious errors are detected ELEM-DATA-BLOCK is used in Definition II only. It represents specific fields to be altered, and is either 36 or 84 bytes long.
TISERV UOW Descriptions ALTER-PROFILE-ELEM RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions ALTER-PROFILE-ELEM ALTER-PROFILE-ELEM Operation The ALTER-PROFILE-ELEM UOW and the GET-PROFILE-ELEM UOW complement each other. Because these two UOWs are closely involved with one another and because they share common field definitions except for the one discussed in the following paragraph, the details of their operation are presented together in this manual, under the description of the GET-PROFILE-ELEM UOW.
TISERV UOW Descriptions ALTER-PROFILE-ELEM GUARDIAN-PASSWORD is the correspondent logon password required for validation of an altered GUARDIAN 90 ID. If you are changing GUARDIAN-USER-NAME, you must supply the GUARDIAN 90 password. The TRANSFER delivery system accepts the password without verification under the following conditions: If the depot requesting the change has a GUARDIAN 90 user ID of group.
TISERV UOW Descriptions ALTER-STATS-PARAMS ALTER-STATS-PARAMS (UOW Code 272) ALTER-STATS-PARAMS sets or changes configuration parameters for depot storage statistics. ALTER-STATS-PARAMS does not immediately affect the state of the depot storage statistics facility; the parameters changed by this UOW take effect when the TRANSFER delivery system is stopped and restarted. You can use ALTER-STATSPARAMS if you have system administrator write privileges. DEF alter-stats-params-uow. 02 hdr TYPE UOW-HDR.
TISERV UOW Descriptions ALTER-STATS-PARAMS HDR is the UOW header. The UOW-CODE value is 272. FIELDS-TO-ALTER contains boolean values. For each value set to Y, the TRANSFER delivery system uses the associated value in the ALTERABLE-FIELDS section to alter the field. ALTERABLE-FIELDS contains all of the alterable configuration parameters. When the associated boolean value in the FIELDS-TO-ALTER section is set to Y, the TRANSFER delivery system sets the configuration parameter to this value.
TISERV UOW Descriptions ALTER-STATS-PARAMS RESERVED and RESERVED-1 through RESERVED-9 are reserved for Tandem use. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions ATTACH-COMPNT-A01 ATTACH-COMPNT-A01 (UOW Code 136) ATTACH-COMPNT-A01 attaches an item as a component to another item. DEF attach-compnt-a01-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 136. 02 parent-item-id. 03 dummy PIC X(12). 02 compnt-id. 03 dummy PIC X(12). 02 rel-position TYPE BINARY 16. 02 compnt-type PIC 9(4) COMP. END. DEF attach-compnt-a01-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions ATTACH-COMPNT-A01 REL-POSITION, the new component would occupy the thirty-first position in the list. Figure 2-3. Attaching a New Component to a Parent Item Component 1 Component 2 Component 3 ••• Existing List Component 28 Component 29 Component 30 Component 31 New Component Added by ATTACH-COMPNT-A01 UOW 003 COMPNT-TYPE is a numeric value that the TRANSFER delivery system saves with the component.
TISERV UOW Descriptions ATTACH-COMPNT-A01 RETN-CODE is the return code.
TISERV UOW Descriptions ATTACH-COMPNT-A01 ATTACH-COMPNT-A01 Operation ATTACH-COMPNT-A01 attaches one item as a component of another. TISERV records the item IDs of components in components list records that are treated as part of the parent item. If this operation is successful, the component count in the parent item descriptor and the parent count in the component item descriptor are both incremented by 1.
TISERV UOW Descriptions ATTACH-EXTOBJ ATTACH-EXTOBJ (UOW Code 144) ATTACH-EXTOBJ attaches a primary external object to an item or an alternate external object to either a primary external object or an item. DEF attach-extobj-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 parent parent-id 03 dummy 02 parent-handle 02 02 02 02 02 02 object-name defaults object-type rel-position user-values options.
TISERV UOW Descriptions ATTACH-EXTOBJ PARENT denotes the object to which the attachment is to be made. This field can specify either an item or a primary external object. PARENT-ID and PARENT-HANDLE redefine this field to indicate the object ID or item handle, respectively, that specifically identifies this object.
TISERV UOW Descriptions ATTACH-EXTOBJ PARENT-IS-OBJECT-NAME specifies whether the name of the object or the object ID is used to specify the parent. Y Parent is specified by object name. N Parent is specified by object ID. ALTERNATE-ATTACHMENT specifies whether the attachment is an alternate attachment or a primary attachment. Y Attachment is an alternate attachment. N Attachment is a primary attachment.
TISERV UOW Descriptions ATTACH-EXTOBJ 4124 4125 4126 4128 4132 4305 4470 E-INVALID-OBJECT-TYPE E-TOO-MANY-ATTACHMENTS E-PARENT-MUST-BE-ITEM E-MUST-BE-ALTERNATE E-EXTOBJ-BEING-DELETED E-INVALID-FILENAME E-BAD-ID-OR-PASSWORD To indicate problems with the depot storage statistics facility: 4944 6114 6126 6127 E-ERR-DEPSTAT-FILE E-DSF-INTERNAL-ERROR E-DSF-STAT-ARRAY E-DSF-BAD-TIMESTAMP RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system, or is a further quali
TISERV UOW Descriptions ATTACH-EXTOBJ ATTACH-EXTOBJ Operation ATTACH-EXTOBJ attaches the specified external object to the specified item or primary external object, as a primary or alternate attachment. The possibilities are: A primary attachment to an item An alternate attachment to an item An alternate attachment to a primary external object This UOW can only be issued within a TMF transaction.
TISERV UOW Descriptions ATTACH-EXTOBJ verifies that it has read access to the object and sets up pointers to the object in the TRANSFER database. When the TRANSFER delivery system copies a file for primary or alternate attachment, it generates a name for the new file. The TRANSFER delivery system establishes a value for use as the initial file name when the system is initialized or converted from an earlier version, and then increments this value each time it must allocate a file name.
TISERV UOW Descriptions ATTACH-EXTOBJ default volume and subvolume. If the node name is not included with the file name, the TRANSFER delivery system assumes that the file is on the local system. If the name expansion fails, E-INVALID-FILENAME is returned. The TRANSFER delivery system does not support the attachment of partitioned files. If you attempt to make such an attachment, E-PARTITIONED-FILE is returned. You can attach an audited file to an object.
TISERV UOW Descriptions ATTACH-EXTOBJ If the depot storage statistics facility is active, collection depends on the value of COUNT-ITEMS-ONCE and whether the parent item is the highest item, as shown in Table 2-7. Table 2-7. Depot Storage Statistics for the ATTACH-EXTOBJ UOW 2–138 COUNTITEMS-ONCE Parent item the highest item? Depot Storage Statistics N Y or N Y Y Y N Depot storage statistics increase for all folders in which the parent item is stored.
TISERV UOW Descriptions CANCEL-PKG CANCEL-PKG (UOW Code 118) CANCEL-PKG cancels a package. A package can only be canceled by its sender. DEF cancel-pkg-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy END. DEF cancel-pkg-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 118. PIC X(12). PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 118. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header.
TISERV UOW Descriptions CANCEL-PKG RETN-CODE is the return code.
TISERV UOW Descriptions CANCEL-PKG-TIMED CANCEL-PKG-TIMED (UOW Code 188) CANCEL-PKG-TIMED cancels a package that has been submitted with a value specified in the SUBMIT-TIMED field. A package can only be canceled by its sender. DEF cancel-pkg-timed-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 188. 02 item-id. 03 dummy PIC X(12). END. DEF cancel-pkg-timed-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 188.
TISERV UOW Descriptions CANCEL-PKG-TIMED To indicate that the SUBMIT-TIMED field contains a value that does not correspond to a time or date in the future: E-PAST-DATE-TIME To indicate problems with an item handle: 4062 -4063 4071 -4071 E-INVALID-ITEM W-ITEM-NOT-RETURNED E-PAST-DATE-TIME W-PAST-DATE-TIME RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions COPY-ITEM COPY-ITEM (UOW Code 107) COPY-ITEM makes a copy of an existing item, The correspondent can save the copy in any local group folder to which the correspondent has access or in any folder in the correspondent's private depot. DEF copy-item-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 options. 03 copy-data 03 copy-recips 03 copy-compnts 03 reserved-3 END. DEF copy-item-rsp. 02 hdr. 03 self-ident 03 uow-code PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 107.
TISERV UOW Descriptions COPY-ITEM OPTIONS allow you to specify what is included in the copying operation: COPY-DATA specifies whether to copy all data records associated with the item: Y Copy all data records associated with the item. N Does not copy all data records associated with the item. COPY-RECIPS specifies whether to copy all recipients associated with the item if the item is a package header item: Y Copy all recipients associated with the item if the item is a package header item.
TISERV UOW Descriptions COPY-ITEM To indicate problems with the depot storage statistics facility: 4944 6114 6126 6127 E-ERR-DEPSTAT-FILE E-DSF-INTERNAL-ERROR E-DSF-STAT-ARRAY E-DSF-BAD-TIMESTAMP RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. NEW-ITEM-ID is the ID of the new item created by the copy operation.
TISERV UOW Descriptions COPY-ITEM COPY-ITEM Operation COPY-ITEM makes a copy of an existing item, thus creating a new item. If the COPYDATA field is set to Y, the new item contains the same client data as the item specified by ITEM-ID. This operation is equivalent to issuing a CREATE-ITEM request, followed by one ADD-ITEM-REC request for each client record in the original item. The new item is identified by the ID in NEW-ITEM-ID.
TISERV UOW Descriptions COPY-ITEM-B40 COPY-ITEM-B40 (UOW Code 108) COPY-ITEM-B40 makes a copy of an existing item. The correspondent can save the copy in any local group folder to which the correspondent has access, or in any of the folders in the correspondent's private depot. Unlike the COPY-ITEM UOW, this UOW selectively copies the item and, optionally, primary attachments, alternate attachments, and X400 recipients. DEF copy-item-b40-uow. 02 hdr. 03 self-ident 03 uow-code item-id.
TISERV UOW Descriptions COPY-ITEM-B40 HDR is the UOW header. The UOW-CODE value is 108. ITEM-ID is the item to be copied (the source item). To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEMHANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. RESERVED-VALUES-1 and RESERVED-VALUES-2 are reserved for use by Tandem; these fields must be filled with null characters.
TISERV UOW Descriptions COPY-ITEM-B40 COPY-PRI-EXTOBJS specifies whether to attach all primary attachments of the original item to the new copy of the item: Y Attach all primary attachments of the original item to the new copy of the item. N Do not attach all primary attachments of the original item to the new copy of the item.
TISERV UOW Descriptions COPY-ITEM-B40 RETN-CODE is the return code.
TISERV UOW Descriptions COPY-ITEM-B40 If the item is a package header, the TRANSFER delivery system copies alterable fields into the new item descriptor; these are the fields that you can modify with the ALTERITEM-DESCR UOW. (However, if the original item is submitted as a package, all date fields in the copy are reset to their default values. In particular, the copy is alterable and unsubmitted, even if the original is not.
TISERV UOW Descriptions CREATE-DEPOT CREATE-DEPOT (UOW Code 201) CREATE-DEPOT creates a new correspondent and depot. This UOW can be issued only by correspondents with system administrator write privileges. DEF create-depot-uow. 02 hdr. 03 self-ident 03 uow-code 02 new-corr 02 model-name END. DEF create-depot-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 201. PIC X(80). PIC X(80) VALUE SPACES. PIC AA VALUE "UW".
TISERV UOW Descriptions CREATE-DEPOT RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions CREATE-DEPOT CREATE-DEPOT Operation The CREATE-DEPOT UOW adds a new correspondent to the system by entering the correspondent name in the TRANSFER name directory, and creates a depot for that correspondent. The depot is created on the same node as the copy of TISERV accessed by this UOW. Also, the correspondent is automatically added to the PUBLIC group at the local node.
TISERV UOW Descriptions CREATE-DLIST CREATE-DLIST (UOW Code 217) CREATE-DLIST creates a distribution list. DEF create-dlist-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 dlist-name END. DEF create-dlist-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 END. retn-code retn-code-detail corr-name PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 217. PIC X(80) VALUE SPACES. PIC X(80). PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 217. TYPE BINARY 16. TYPE BINARY 16. PIC X(80).
TISERV UOW Descriptions CREATE-DLIST RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions CREATE-DLIST-C20 CREATE-DLIST-C20 (UOW Code 252) CREATE-DLIST-C20 creates shared or private distribution lists. DEF create-dlist-c20-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 02 corr-name dlist-name sharing-attributes. 03 sharing-discipline 03 reserved-1 END. DEF create-dlist-c20-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 retn-code retn-code-detail corr-name sharing-attributes. 03 sharing-discipline 03 reserved-1 PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 252.
TISERV UOW Descriptions CREATE-DLIST-C20 DLIST-NAME is the name to be assigned to the new distribution list. The name must be either a TRANSFER simple name or a fully qualified name. If you are creating a PUBLIC distribution list, the distribution list name must be unique among the set of local interest group names, correspondent names, PUBLIC folder names, and PUBLIC distribution list names.
TISERV UOW Descriptions CREATE-DLIST-C20 RETN-CODE is the return code.
TISERV UOW Descriptions CREATE-DLIST-C20 CREATE-DLIST-C20 Operation CREATE-DLIST-C20 creates a shared or private distribution list. If a group distribution list is being created, the input distribution list name must be qualified by the interest group name. In addition, the session in use by the correspondent must have the authority to create the group distribution list.
TISERV UOW Descriptions CREATE-FOLDER CREATE-FOLDER (UOW Code 227) CREATE-FOLDER creates a new folder. This UOW is maintained for version compatibility with previous TRANSFER versions. CREATE-FOLDER-B00 is the recommended UOW. DEF create-folder-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name END. DEF create-folder-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 227. PIC X(80) VALUE SPACES.
TISERV UOW Descriptions CREATE-FOLDER RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions CREATE-FOLDER CREATE-FOLDER Operation CREATE-FOLDER creates a new folder with the name assigned in FOLDER-NAME. The folder is created with the ordering criteria and item retention time that were specified for the folder in the profile. If the folder created is shared by a group, the folder has a bulletin-board-sharing discipline. If the depot storage statistics facility is active, an IFOLDER statistics record is added for the folder and the statistics for it are initialized to 0.
TISERV UOW Descriptions CREATE-FOLDER-B00 CREATE-FOLDER-B00 (UOW Code 232) CREATE-FOLDER-B00 creates a new folder and establishes the ordering criteria by which items are stored in the folder. DEF create-folder-b00-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 02 corr-name folder-name ordering-discipline filler applic-order-type options. 03 ascending-sequence 03 allow-duplicates 03 reserved-2 03 reserved-3 03 reserved-4 03 reserved-5 03 reserved-6 03 reserved-7 END. DEF create-folder-b00-rsp.
TISERV UOW Descriptions CREATE-FOLDER-B00 CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. If the correspondent is an administrator of an interest group or is a system administrator with write privileges, the correspondent can create shared group distribution lists.
TISERV UOW Descriptions CREATE-FOLDER-B00 APPLIC-ORDER-TYPE can be used to distinguish between types of ordering disciplines, and is meaningful only if ORDERING-DISCIPLINE is APPLIC-DEFINED (A). If ORDERING-DISCIPLINE is not APPLIC-DEFINED, the field is ignored. This field is not interpreted by the TRANSFER delivery system, but is stored as part of the folder's ordering criteria and is returned by the GET-FOLDER-ORDER and GETFOLDER-DESCR UOWs.
TISERV UOW Descriptions CREATE-FOLDER-B00 RESERVED-2 through RESERVED-7 are reserved for use by Tandem. These fields must be set to N. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions CREATE-FOLDER-B00 CREATE-FOLDER-B00 Operation CREATE-FOLDER-B00 creates a new folder with the specified ordering criteria. The item retention time is taken from the profile. Folder order affects the order in which items are saved and subsequently referenced. SCAN-FOLDER, SCAN-FOLDER-B00, and SCAN-FOLDER-BY-KEY UOWs return items according to the ordering key by which items are saved in the folder.
TISERV UOW Descriptions CREATE-FOLDER-B10 CREATE-FOLDER-B10 (UOW Code 235) CREATE-FOLDER-B10 creates a new folder and establishes both ordering criteria and default retention time for items stored in the folder. DEF create-folder-b10-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 02 corr-name folder-name folder-attributes. 03 ordering-criteria. 05 ordering-discipline 05 filler 05 applic-order-type 05 options.
TISERV UOW Descriptions CREATE-FOLDER-B10 10 reserved-3 10 reserved-4 10 reserved-5 10 reserved-6 10 reserved-7 03 item-retention-time 05 quantity 05 units 05 filler 03 reserved TYPE TYPE TYPE TYPE TYPE PIC PIC PIC PIC BOOLEAN BOOLEAN BOOLEAN BOOLEAN BOOLEAN VALUE VALUE VALUE VALUE VALUE "N". "N". "N". "N". "N". 9(4) COMP. A. X. X(16) VALUE SPACES. END. HDR is the UOW header. The UOW-CODE value is 235. CORR-NAME is the name of the correspondent represented by the calling process.
TISERV UOW Descriptions CREATE-FOLDER-B10 EARLIEST-DELIV-DATE (E) saves items that are package headers and are unalterable by earliest delivery date, saves items that are package headers and are alterable by creation date, and saves items that are not package headers. APPLIC-DEFINED (A) saves items in order of the ordering key specified by the application in the SAVE-ITEM-BY-KEY UOW.
TISERV UOW Descriptions CREATE-FOLDER-B10 OPTIONS provides additional criteria for saving items. ASCENDING-SEQUENCE determines whether items are saved within the folder in ascending or descending key order. Y Save items in ascending key order. N Save items in descending key order. Variable-length APPLIC-DEFINED keys that are used with descending key order do not collate in the correct order unless the application pads the key with enough bytes to make it a constant length for all entries in the folder.
TISERV UOW Descriptions CREATE-FOLDER-B10 UNITS is the unit of time denoted in QUANTITY. You can set UNITS o D (for days), H (for hours), or M (for minutes). For any unit, 0 means “no maximum” (items are saved forever). You can also set this field to P, provided that you set QUANTITY to 0. 0 P specifies that the profile constraint should be used. The item retention time for the folder then becomes the same as the item retention time for the depot in which it resides.
TISERV UOW Descriptions CREATE-FOLDER-B10 To indicate other problems: 4010 4051 4052 4093 4201 4265 4266 4902 E-BAD-TRANSACTION E-MUST-BE-YN E-RESERVED-MUST-BE-N E-SECURITY-VIOLATION E-CONTEXT-ERR E-INVALID-ORD-DISCIPLN E-INVALID-APP-ORD-TYPE E-ERR-PROFILE-FILE The W-TIME-TOO-LONG warning appears if the item retention time you specified exceeds the depot constraint. The folder is still created, but its default item retention time is cut back to the constraint value.
TISERV UOW Descriptions CREATE-GROUP CREATE-GROUP (UOW Code 244) CREATE-GROUP creates a new interest group and a group depot. This UOW can only be issued by a system administrator with write privileges, unless the interest group creation flag indicates that system administrator authority is not required for interest group creation. DEF create-group-uow. 02 hdr. 03 self-ident 03 uow-code 02 new-group 02 model-group 02 initial-member END. DEF create-group-rsp.
TISERV UOW Descriptions CREATE-GROUP RETN-CODE is the return code.
TISERV UOW Descriptions CREATE-GROUP RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. CREATE-GROUP Operation CREATE-GROUP adds a new local interest group to the system by entering the group name in the TRANSFER name directory, and creates a depot for that group.
TISERV UOW Descriptions CREATE-ITEM CREATE-ITEM (UOW Code 103) CREATE-ITEM creates an item. DEF create-item-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-type 02 is-pkg-hdr 02 reserved-1 END. DEF create-item-rsp. 02 hdr 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 item-id. 03 dummy END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 103. PIC 9(4) COMP. TYPE BOOLEAN. TYPE BOOLEAN VALUE "N". TYPE UOW-HDR. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 103. TYPE BINARY 16.
TISERV UOW Descriptions CREATE-ITEM 0 4010 4051 4052 4056 OK E-BAD-TRANSACTION E-MUST-BE-YN E-RESERVED-MUST-BE-N E-INVALID-ITEM-TYPE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. ITEM-ID is the ID assigned to the new item and returned by the TRANSFER delivery system. CREATE-ITEM Operation CREATE-ITEM creates a new item and returns the ID in the ITEM-ID field.
TISERV UOW Descriptions DEL-GROUP-MEMBER DEL-GROUP-MEMBER (UOW Code 248) DEL-GROUP-MEMBER removes one or more local members of an interest group. DEF del-group-member-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 248. 02 group-name PIC X(80) VALUE SPACES. 02 delete-all-flag TYPE BOOLEAN VALUE "N". 02 filler TYPE CHARACTER 1 VALUE SPACE. 02 num-wanted TYPE BINARY 16 UNSIGNED . 02 group-member-names PIC X(80) OCCURS 0 TO 5 TIMES DEPENDING ON num-wanted. END.
TISERV UOW Descriptions DEL-GROUP-MEMBER GROUP-MEMBER-NAMES is an array of names of direct group members that are to be deleted. The member names can either be correspondent names or a local interest group name. RETN-CODE is the return code.
TISERV UOW Descriptions DEL-GROUP-MEMBER To indicate other problems: 4010 4051 4092 4093 4201 -4227 4247 4902 4914 4943 E-BAD-TRANSACTION E-MUST-BE-YN E-INVALID-NUM-RQSTD E-SECURITY-VIOLATION E-CONTEXT-ERR W-ERR-ON-MEMBER E-GROUP-MBR-NOT-FOUND E-ERR-PROFILE-FILE E-ERR-DLIST-FILE E-ERR-INTGROUP-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions DEL-GROUP-MEMBER DEL-GROUP-MEMBER Operation DEL-GROUP-MEMBER removes one or more local members of an interest group. The member specified must be a direct member of the interest group.
TISERV UOW Descriptions DEL-X400-AUX-NAME DEL-X400-AUX-NAME (UOW Code 176) DEL-X400-AUX-NAME deletes an auxiliary recipient from an unsubmitted package. DEF del-x400-aux-name-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 176. 02 item-id. 03 dummy PIC X(12). 02 aux-name-type PIC 9(4) COMP. 02 aux-name-node-num TYPE BINARY 32 UNSIGNED. 02 aux-name-seq-num PIC S9(4) COMP. END. DEF del-x400-aux-name-rsp. 02 hdr TYPE UOW-HDR. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions DEL-X400-AUX-NAME AUX-NAME-NODE-NUM specifies the internal data required to uniquely identify the X400 auxiliary name record to be deleted. This field contains a value that specifies the number of the EXPAND node where the name was added to the package. It is used internally by the TRANSFER delivery system to uniquely identify records in the X400NAME file. Clients need not display this information to users.
TISERV UOW Descriptions DELETE-AUX-NAME DELETE-AUX-NAME (UOW Code 179) DELETE-AUX-NAME deletes an auxiliary TRANSFER recipient from an unsubmitted package. DEF delete-aux-name-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 179. 02 item-id. 03 dummy PIC X(12). 02 aux-name-type PIC 9(4) COMP. 02 aux-name-seq-num PIC S9(4) COMP. END. DEF delete-aux-name-rsp. 02 hdr TYPE UOW-HDR. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 179.
TISERV UOW Descriptions DELETE-AUX-NAME RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions DELETE-DEPOT DELETE-DEPOT (UOW Code 202) DELETE-DEPOT deletes a correspondent and depot. This UOW can be issued only by correspondents with system administrator write privileges. DEF delete-depot-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 force-flag 02 filler END. DEF delete-depot-rsp. 02 hdr 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 202. PIC X(80). TYPE BOOLEAN. PIC X VALUE SPACE. .
TISERV UOW Descriptions DELETE-DEPOT RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions DELETE-DEPOT DELETE-DEPOT Operation DELETE-DEPOT deletes a correspondent and the associated depot. The UOW removes all profile records relating to the correspondent identified by CORR-NAME, and also removes the correspondent name from the TRANSFER name directory. In addition, the TRANSFER delivery system removes any distribution lists and folders relating to the depot. Note Deletion does not occur if a session is active at the depot when this UOW is issued.
TISERV UOW Descriptions DELETE DLIST DELETE-DLIST (UOW Code 218) DELETE-DLIST deletes a distribution list. DEF delete-dlist-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 dlist-name 02 force-flag 02 filler END. DEF delete-dlist-rsp. 02 hdr 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name 02 dlist-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 218. PIC X(80) VALUE SPACES. PIC X(80). TYPE BOOLEAN. TYPE CHARACTER 1. . PIC AA VALUE "UW".
TISERV UOW Descriptions DELETE DLIST FORCE-FLAG determines whether TISERV forces deletion even if the distribution list contains members. Y Force deletion. N Do not force deletion. If the distribution list contains members, the distribution list is not deleted; an error indication is returned, and you should abort the transaction. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions DELETE DLIST To indicate other problems: 4010 4051 4093 4201 4225 4902 4914 E-BAD-TRANSACTION E-MUST-BE-YN E-SECURITY-VIOLATION E-CONTEXT-ERR E-MEMBERS-EXIST E-ERR-PROFILE-FILE E-ERR-DLIST-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions DELETE-FOLDER DELETE-FOLDER (UOW Code 230) DELETE-FOLDER deletes a folder. DEF delete-folder-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name 02 force-flag 02 filler END. DEF delete-folder-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name 02 folder-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 230. PIC X(80) VALUE SPACES. PIC X(80). TYPE BOOLEAN. TYPE CHARACTER 1 VALUE SPACES. PIC AA VALUE "UW".
TISERV UOW Descriptions DELETE-FOLDER FORCE-FLAG determines whether TISERV forces the deletion even if the folder contains packages or items. Y Force deletion. N Do not force deletion. If the folder contains packages or items, the folder is not deleted; an error indication is returned, and you should abort the transaction. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions DELETE-FOLDER To indicate other problems: 4010 4051 4093 4105 4201 4213 -4218 4902 4912 4922 E-BAD-TRANSACTION E-MUST-BE-YN E-SECURITY-VIOLATION E-CONCURRNT-FLD-UPDATE E-CONTEXT-ERR E-ITEMS-EXIST W-CONTENTS-PURGED E-ERR-PROFILE-FILE E-ERR-FOLDER-FILE E-ERR-INV-FOLDER-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions DELETE-GROUP DELETE-GROUP (UOW Code 245) DELETE-GROUP deletes a local interest group and the group depot. The current correspondent must be a system administrator with write privileges or the correspondent that created the group. The PUBLIC special group cannot be deleted. DEF delete-group-uow. 02 hdr. 03 self-ident 03 uow-code 02 group-name 02 force-flag 02 filler END. DEF delete-group-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 group-name END.
TISERV UOW Descriptions DELETE-GROUP RETN-CODE is the return code.
TISERV UOW Descriptions DELETE-GROUP DELETE-GROUP Operation DELETE-GROUP deletes a group by removing all profile records relating to the group identified by GROUP-NAME, deleting all folders and distribution lists defined for the group, and removing the group name for the TRANSFER name directory. In addition, all references to the deleted group are removed from the local files that maintain group membership information for correspondents and groups.
TISERV UOW Descriptions DELETE-ITEM-REC DELETE-ITEM-REC (UOW Code 105) DELETE-ITEM-REC deletes a data record from an item. DEF delete-item-rec-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 105. 02 item-key. 03 item-id. 04 dummy PIC X(12). 03 rec-type PIC 9(4) COMP. 03 rec-seq-num PIC S9(4) COMP. END. DEF delete-item-rec-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 105. 02 retn-code TYPE BINARY 16.
TISERV UOW Descriptions DELETE-ITEM-REC REC-SEQ-NUM is the sequence number assigned to the record. The number can range from 1 through 9999; the value 0 is invalid for this field. This field provides unique key values for multiple records having the same item ID and record type. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. RETN-CODE is the return code.
TISERV UOW Descriptions DELETE-ITEM-REC DELETE-ITEM-REC Operation DELETE-ITEM-REC deletes the record identified by REC-TYPE and REC-SEQ-NUM from the item identified by ITEM-ID. If the depot storage statistics facility is active, collection depends on the value of the COUNT-ITEMS-ONCE configuration parameter and whether the item is the highestlevel item or a subordinate item. Table 2-9 lists the collection conditions. Table 2-9.
TISERV UOW Descriptions DELETE-MEMBER DELETE-MEMBER (UOW Code 221) DELETE-MEMBER deletes one or more members from a distribution list. Members can be correspondent names, group names, or distribution list names. DEF delete-member-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 dlist-name 02 num-wanted 02 member-name END. DEF delete-member-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name 02 dlist-name 02 num-returned 02 mbr-retn-code PIC AA VALUE "UW".
TISERV UOW Descriptions DELETE-MEMBER contains this UOW. The maximum IPC length is defined during TRANSFER system configuration. MEMBER-NAME is the name of the correspondent or distribution list to be deleted from the list identified by DLIST-NAME. This must be a fully qualified name and must exactly match a name in the distribution list, including the suffix. In the OCCURS DEPENDING ON clause, the value 5 is an arbitrary value suitable for most applications; you can reset it to any other value.
TISERV UOW Descriptions DELETE-MEMBER To indicate problems with the depot storage statistics facility: 4944 6114 6126 6127 E-ERR-DEPSTAT-FILE E-DSF-INTERNAL-ERROR E-DSF-STAT-ARRAY E-DSF-BAD-TIMESTAMP To indicate other problems: 4010 4093 4201 -4227 4902 4914 E-BAD-TRANSACTION E-SECURITY-VIOLATION E-CONTEXT-ERR W-ERR-ON-MEMBER E-ERR-PROFILE-FILE E-ERR-DLIST-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error d
TISERV UOW Descriptions DELETE-PROFILE-REC DELETE-PROFILE-REC (UOW Code 214) DELETE-PROFILE-REC deletes a profile record from a depot. DEF delete-profile-rec-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 group-name 02 rec-type 02 rec-seq-num 02 depot-flag 02 filler END. DEF delete-profile-rec-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 END. retn-code retn-code-detail corr-name PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 214. PIC X(80) VALUE SPACES. REDEFINES corr-name. PIC 9(4) COMP.
TISERV UOW Descriptions DELETE-PROFILE-REC DEPOT-FLAG determines whether the UOW references a depot profile record or a system control record. Y The UOW references a depot profile record, as indicated by CORRNAME. N The UOW references a system control record. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions DELETE-RECIP DELETE-RECIP (UOW Code 115) DELETE-RECIP deletes a recipient from a package recipient list. DEF delete-recipient-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 115. 02 item-id. 03 dummy PIC X(12). 02 recip-name PIC X(120). END. DEF delete-recipient-name-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 115. 02 retn-code TYPE BINARY 16. 02 retn-code-detail TYPE BINARY 16. END.
TISERV UOW Descriptions DELETE-RECIP RETN-CODE is the return code.
TISERV UOW Descriptions DELETE-X400-MEMBER DELETE-X400-MEMBER (UOW Code 243) DELETE-X400-MEMBER deletes a an X400 member of a local TRANSFER distribution list. DEF delete-x400-member-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 243. 02 corr-name PIC X(80) VALUE SPACES. 02 dlist-name PIC X(80). 02 member-node-num TYPE BINARY 32 UNSIGNED. 02 member-seq-num PIC S9(4) COMP. END. DEF delete-x400-member-rsp. 02 hdr TYPE UOW-HDR. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions DELETE-X400-MEMBER MEMBER-NODE-NUM is the internal data used to uniquely identify the member to be deleted. The field contains a value which specifies the EXPAND node number where the name was added to the package. The TRANSFER delivery system uses this field to uniquely identify records in the X400NAME file. Clients need not display this information to users. MEMBER-SEQ-NUM is the sequence number of the member to be deleted.
TISERV UOW Descriptions DELETE-X400-MEMBER DELETED-MEMBER specifies the node number, sequence number, and name of the X400 member deleted. DELETE-X400-MEMBER Operation The DELETE-X400-MEMBER UOW deletes an X400 recipient name from a TRANSFER distribution list. The name is specified using a sequence number obtained from READ-X400-MEMBER. If the TRANSFER X400-CONFIGURED flag is not set to Y, then E-X400-NOT-CONFIGURED is returned. You can check the value of this flag with the GET-CONFIG-NAME UOW.
TISERV UOW Descriptions DELETE-X400-RECIP DELETE-X400-RECIP (UOW Code 173) DELETE-X400-RECIP deletes an X400 recipient from an unsubmitted package. DEF delete-x400-recip-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 173. 02 item-id. 03 dummy PIC X(12). 02 recip-type PIC 9(4) COMP. 02 recip-node-num TYPE BINARY 32 UNSIGNED. 02 recip-seq-num PIC S9(4) COMP. 02 options 03 p2-recip-only TYPE BOOLEAN. 03 reserved-1 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions DELETE-X400-RECIP RECIP-TYPE specifies the recipient type for the X400 recipient to be deleted. The value of this field can range from 0 through 99 or from 300 through 9999. If one of these values is not specified, the error E-INVALID-RECIP-TYPE will be returned. RECIP-NODE-NUM specifies a value used to uniquely identify the recipient to be deleted. This field contains a value which specifies the EXPAND node number where the recipient was added to the package.
TISERV UOW Descriptions DELETE-X400-RECIP RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. DELETED-RECIP specifies the name, type, node number, and sequence number of the deleted recipient.
TISERV UOW Descriptions DETACH-COMPNT DETACH-COMPNT (UOW Code 113) DETACH-COMPNT detaches a component item from a parent. DEF detach-compnt-uow. 02 hdr. 03 self-ident 03 uow-code 02 parent-item-id. 03 dummy 02 rel-position 02 compnt-id. 03 dummy END. DEF detach-compnt-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 detached-position 02 detached-compnt. 03 dummy END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 113. PIC X(12). TYPE BINARY 16. PIC X(12). PIC AA VALUE "UW".
TISERV UOW Descriptions DETACH-COMPNT RETN-CODE is the return code.
TISERV UOW Descriptions DETACH-COMPNT DETACH-COMPNT Operation DETACH-COMPNT detaches a component item from its parent item by removing it from the parent components list. You can reference this record in the UOW either by its relative position within the components list (with the REL-POSITION field) or by its item ID (with the COMPNT-ID field).
TISERV UOW Descriptions DETACH-EXTOBJ DETACH-EXTOBJ (UOW Code 146) DETACH-EXTOBJ detaches a primary external object from an item or detaches an alternate external object from either an item or a primary external object. DEF detach-extobj-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 parent parent-id 03 dummy 02 parent-handle 02 02 02 rel-position object-name object-id 03 dummy 02 object-handle 02 options.
TISERV UOW Descriptions DETACH-EXTOBJ item handle, object ID, or object name (as indicated by the contents of the OPTIONS field). PARENT-ID and PARENT-HANDLE redefine this field to indicate the object ID or item handle, respectively, that specifically denotes the object.
TISERV UOW Descriptions DETACH-EXTOBJ Y Attachment is alternate attachment. N Attachment is primary attachment. CHILD-IS-OBJECT-NAME indicates whether the attachment to be detached is specified by name or object ID/item handle. This field is only used if the REL-POSITION field is set to 0. Y Child is specified by object name. N Child is specified by object ID or item handle. If any OPTIONS subfields do not contain Y nor N, then E-MUST-BE-YN is returned.
TISERV UOW Descriptions DETACH-EXTOBJ RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. DETACHED-POSITION is the position in the attachment list that was occupied by the detached object relative to the other items in the list. DETACH-EXTOBJ Operation DETACH-EXTOBJ detaches an external object from an item or a primary external object.
TISERV UOW Descriptions DETACH-EXTOBJ For detachment of an alternate object from an item: PARENT-IS-ITEM is set to Y. PARENT-IS-OBJECT-NAME is set to N. If PARENT-IS-OBJECT-NAME is set to Y, E-PARENT-MUST- BE-ITEM is returned. CHILD-IS-OBJECT-NAME is set to Y if the object is specified by name. CHILD-IS-OBJECT-NAME is set to N if the object is specified by object ID or item handle. ALTERNATE-ATTACHMENT is set to Y. The PARENT field must contain an item ID or an item handle.
TISERV UOW Descriptions DETACH-EXTOBJ In the OBJECT-NAME field, if you specify the object by name, you must use a fully qualified network file name in external format. This is the same type of name returned by the ATTACH-EXTOBJ and GET-EXTOBJ UOWs. If the attachment being dissolved is the last attachment of this file on this node, and if the GUARDIAN 90 user ID under which the TRANSFER delivery system is running owns the file, an asynchronous event is scheduled to purge the file.
TISERV UOW Descriptions END-SESSION END-SESSION (UOW Code 102) END-SESSION terminates a session. DEF end-session-uow. 02 hdr. 03 self-ident 03 uow-code END. DEF end-session-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 102. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 102. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header. The UOW-CODE value is 102. RETN-CODE is the return code.
TISERV UOW Descriptions GET-AGENT-SELECT GET-AGENT-SELECT (UOW Code 207) GET-AGENT-SELECT retrieves agent selection criteria for a depot. DEF get-agent-select-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 group-name 02 agent-rec-num 02 action 02 filler END. DEF get-agent-select-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 END.
TISERV UOW Descriptions GET-AGENT-SELECT CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank. In the response, the fully qualified name is returned.
TISERV UOW Descriptions GET-AGENT-SELECT RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions GET-AGENT-SELECT AGENT-FLAG determines whether the agent requires the associated TAREQ to begin a session on its behalf before the agent can run. Y Session initiation is required. N Session initiation is not required. APPLIC-ID-FOR-LOGON is the application ID to be used in establishing the session when the AGENTFLAG is set to Y. APPLIC-ID-LOW, APPLIC-ID-HIGH, AGENT-SEL-LOW, and AGENT-SEL-HIGH define numeric ranges used to select the agent.
TISERV UOW Descriptions GET-AUX-NAME GET-AUX-NAME (UOW Code 178) GET-AUX-NAME retrieves the names of authorizing users and reply-to recipients for a package. DEF get-aux-name-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 aux-name-type 02 aux-name-seq-num 02 options. 03 skip-exact 03 any-seq-num 03 strip-local-node-name 03 reserved-3 03 reserved-4 03 reserved-5 03 reserved-6 03 reserved-7 02 num-requested END. DEF get-aux-name-rsp. 02 hdr. 03 self-ident 03 uow-code PIC AA VALUE "UW".
TISERV UOW Descriptions GET-AUX-NAME ITEM-ID is the ID of the item whose auxiliary TRANSFER names are to be returned. In the UOW response, the item ID is returned to this field. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. AUX-NAME-TYPE specifies the type of auxiliary name that is to be retrieved.
TISERV UOW Descriptions GET-AUX-NAME RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions GET-CONFIG-NAME GET-CONFIG-NAME (UOW Code 132) GET-CONFIG-NAME retrieves the configured name for a TRANSFER file, process, or other special entity. DEF get-config-name-uow. 02 hdr. 03 self-ident 03 uow-code 02 network-node-name 02 entity-name END. DEF get-config-name-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 END. retn-code retn-code-detail configured-name PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 132. PIC X(32). PIC X(32). PIC AA VALUE "UW".
TISERV UOW Descriptions GET-CONFIG-NAME RETN-CODE is the return code.
TISERV UOW Descriptions GET-CONFIG-NAME GET-CONFIG-NAME Operation GET-CONFIG-NAME retrieves the configured name for the entity identified by ENTITY-NAME. This name is returned in the CONFIGURED-NAME field. The TRANSFER delivery system stores this information as follows: The B40 version of the TRANSFER delivery system maintains the names of the special TRANSFER folders (INBOX-FOLDER, OUTLOG-FOLDER, and WASTEBASKET- FOLDER) as part of site-supported text.
TISERV UOW Descriptions GET-CONFIG-NAME These four names are only returned if they are defined at the local node. The language and character set of these four names depends on the conditions shown in Table 2-12. If the TRANSFER entity is defined at a remote node, the request is not allowed. Table 2-12.
TISERV UOW Descriptions GET-CONFIG-NAME CHAR-MAP-ID identifies the preferred character map for the character set used by default to enter and display data at the node. This map relates native codes to characters in the base (canonical) character set. It is indicated by the following subfields: CODE-PAGE-ID identifies the base character set on which the character map is based. This subfield is always set to the code that indicates the base character set used by the TRANSFER system.
TISERV UOW Descriptions GET-DEPOT-STATS GET-DEPOT-STATS (UOW Code 282) GET-DEPOT-STATS retrieves the depot storage statistics for a depot. DEF get-depot-stats-uow. 02 hdr. 03 self-ident 03 uow-code 02 filler 02 filler 02 corr-name 03 group-name 02 num-wanted 02 stats-offset 02 options. 03 select-by-date 03 select-date 03 use-prev-file 03 old-stats-first 03 use-avg-stats 03 reserved-1 03 reserved-2 03 reserved-3 03 reserved-4 03 reserved-5 02 reserved END. DEF get-depot-stats-rsp. 02 hdr.
TISERV UOW Descriptions GET-DEPOT-STATS 02 options. 03 select-by-date 03 select-date 03 use-prev-file 03 old-stats-first 03 use-avg-stats 03 reserved-1 03 reserved-2 03 reserved-3 03 reserved-4 03 reserved-5 02 reserved 02 num-returned 02 stats 03 03 03 03 03 03 03 03 03 03 03 03 begin-date end-date total-storage extobj-storage itemdata-storage dlist-storage num-dlist-members num-items num-folders reserved-1 reserved-2 reserved-3 TYPE BINARY 16 UNSIGNED VALUE 0. TYPE DATE-TIME. TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions GET-DEPOT-STATS If NUM-WANTED is 0, only the COUNT-STATS are returned. If NUM-WANTED is 1, there is one occurrence of STATS. The BEGIN-DATE and END-DATE are the same and are the current date and time. STATS-OFFSET is the number of statistics to offset from the available statistics with the given search criteria. This field should be used when you want more statistics for a depot than are returned by one UOW response.
TISERV UOW Descriptions GET-DEPOT-STATS N Retrieve unaveraged statistics. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following conditions.
TISERV UOW Descriptions GET-DEPOT-STATS STATS are the depot storage statistics. The depot storage statistics are either averaged or unaveraged, depending on the value of USE-AVG-STATS. The number of occurrences of statistics depends on NUM-RETURNED. The statistics include the following: BEGIN-DATE is the starting date of the sample interval in which the statistics were collected. END-DATE is the ending date of the sample interval in which the statistics were collected.
TISERV UOW Descriptions GET-DEPOT-STATS GET-DEPOT-STATS Operation GET-DEPOT-STATS retrieves statistics for a depot based on the options specified in the UOW. If the number of statistics for the depot is less than or equal to the number requested or if no statistics match the requested selection criteria when statistics are available, the warning W-EOF is returned in the RETN-CODE field.
TISERV UOW Descriptions GET-DLIST-DES-C20 GET-DLIST-DES-C20 (UOW Code 254) GET-DLIST-DES-C20 retrieves the attributes of a private or shared distribution list. DEF get-dlist-des-c20-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 dlist-name END. DEF get-dlist-des-c20-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 retn-code retn-code-detail corr-name dlist-name sharing-attributes. 03 sharing-discipline 03 reserved-1 02 creator END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 254.
TISERV UOW Descriptions GET-DLIST-DES-C20 RETN-CODE is the return code.
TISERV UOW Descriptions GET-DLIST-DES-C20 SHARING-ATTRIBUTES describe a shared folder and indicate the sharing discipline for group members without group administrative privileges who can access the shared folder. One of the following values is returned: P indicates that the current folder is a private folder and that sharing discipline is meaningless. S indicates that the distribution list is a private distribution list.
TISERV UOW Descriptions GET-EXTOBJ GET-EXTOBJ (UOW Code 145) GET-EXTOBJ retrieves the names and object IDs of the objects attached to an item or to a primary external object. DEF get-extobj-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 parent parent-id 03 dummy 02 parent-handle 02 02 start-position options. 03 parent-is-item 03 parent-is-object-name 03 alternate-attachment 03 filter-by-user-values 03 reserved-1 03 reserved-2 03 reserved-3 03 reserved-4 02 filter-values.
TISERV UOW Descriptions GET-EXTOBJ 03 object-id. dummy object-type user-values rel-position 04 03 03 03 PIC X(12). TYPE BINARY 16 UNSIGNED. PIC X(32). TYPE BINARY 16. END. HDR is the UOW header. The UOW-CODE value is 145. PARENT denotes the parent whose external object attachments are to be retrieved. This field can specify a primary object name, a primary external object ID, an item ID, or an item handle.
TISERV UOW Descriptions GET-EXTOBJ ALTERNATE-ATTACHMENT specifies whether the attachments to be retrieved are alternate or primary attachments. Y Attachment is alternate attachment. N Attachment is primary attachment. FILTER-BY-USER-VALUES specifies whether the TRANSFER delivery system should only return attachments with the user values denoted by the USER-VALUES field of this UOW: Y Attachments are filtered by USER-VALUES. N Attachments are not filtered USER-VALUES.
TISERV UOW Descriptions GET-EXTOBJ RETN-CODE is the return code.
TISERV UOW Descriptions GET-EXTOBJ GET-EXTOBJ UOW Operation GET-EXTOBJ returns the external object attachments to a specified object, whether the parent object is an item or a preliminary external object.
TISERV UOW Descriptions GET-EXTOBJ ID under which the TRANSFER delivery system is running owns the file which is being returned, then the file is secured according to the configured security vector. To refer to an item or object produced by a previous UOW within the same IPC, you can use an item handle instead of an item ID or object ID, as noted earlier in this section.
TISERV UOW Descriptions GET-FOLD-ENTRY-INFO GET-FOLD-ENTRY-INFO (UOW Code 149) GET-FOLD-ENTRY-INFO retrieves the attributes of an item saved in a specified folder, including the name of the correspondent who saved the item, the unsave time, and the item name, if any. This UOW can be issued by a correspondent with read access to the folder entry. DEF get-fold-entry-info-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 folder-name item-id. 03 dummy END. DEF get-fold-entry-info-rsp. 02 hdr.
TISERV UOW Descriptions GET-FOLD-ENTRY-INFO FOLDER-NAME is the name of a folder in which an instance of the item exists. The name can be supplied in abbreviated form, but the TRANSFER delivery system must be able to determine a unique and unambiguous folder name. from the abbreviated form. In the response, this field contains the fully qualified name assigned to the folder (including the correspondent name, folder name, system trigger, and node name).
TISERV UOW Descriptions GET-FOLD-ENTRY-INFO RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. UNSAVE-TIME is the time of day and date when the item is automatically removed from the folder. These values are returned in timestamp (absolute) format; if this field is set to 0, no unsave time was specified when the item was saved.
TISERV UOW Descriptions GET-FOLDER-DES-C20 GET-FOLDER-DES-C20 (UOW Code 253) GET-FOLDER-DES-C20 retrieves the attributes of a shared or private folder, including the ordering criteria, the item retention time, and an indication of whether the folder is private or shared. DEF get-folder-des-c20-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name END. DEF get-folder-des-c20-rsp. 02 hdr.
TISERV UOW Descriptions GET-FOLDER-DES-C20 HDR is the UOW header. The UOW-CODE value is 253. CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank.
TISERV UOW Descriptions GET-FOLDER-DESC-C20 To indicate other problems: 4010 4093 4105 4106 4201 4902 E-BAD-TRANSACTION E-SECURITY-VIOLATION E-CONCURRNT-FLD-UPDATE E-BAD-ORD-CRITERIA E-CONTEXT-ERR E-ERR-PROFILE-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions GET-FOLDER-DESC-C20 OPTIONS provides additional criteria for saving items. ASCENDING-SEQUENCE indicates whether items are saved within the folder in ascending or descending key order. Y Items are saved in ascending key order. N Items are saved in descending key order. ALLOW-DUPLICATES indicates whether or not duplicate keys are allowed. Y Duplicate ordering keys are allowed. N Duplicate ordering keys are not allowed.
TISERV UOW Descriptions GET-FOLDER-DESC-C20 SHARING-ATTRIBUTES is a set of attributes describing a shared folder and indicates the sharing discipline for group members without group administrative privileges who can access the shared folder. One of the following values is returned: P indicates that the current folder is a private folder and that sharing discipline is meaningless. B indicates that the folder is a bulletin board. Group members can save items in the folder or delete items saved in it.
TISERV UOW Descriptions GET-FOLDER-DESCR GET-FOLDER-DESCR (UOW Code 237) GET-FOLDER-DESCR retrieves both the ordering criteria and the default item retention time for a folder. TRANSFER interest group members can retrieve the attributes of folders for groups of which they are members. DEF get-folder-descr-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name END. DEF get-folder-descr-rsp. 02 hdr.
TISERV UOW Descriptions GET-FOLDER-DESCR CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank. In the response, the fully qualified correspondent name is returned.
TISERV UOW Descriptions GET-FOLDER-DESCR To indicate other problems: 4010 4093 4105 4106 4201 4902 E-BAD-TRANSACTION E-SECURITY-VIOLATION E-CONCURRNT-FLD-UPDATE E-BAD-ORD-CRITERIA E-CONTEXT-ERR E-ERR-PROFILE-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions GET-FOLDER-DESCR OPTIONS provides additional criteria for saving items. ASCENDING-SEQUENCE indicates whether items are saved within the folder in ascending or descending key order. Y Items are saved in ascending key order. N Items are saved in descending key order. ALLOW-DUPLICATES indicates whether or not duplicate keys are allowed. Y Duplicate ordering keys are allowed. N Duplicate ordering keys are not allowed.
TISERV UOW Descriptions GET-FOLDER-ORDER GET-FOLDER-ORDER (UOW Code 233) GET-FOLDER-ORDER retrieves the ordering criteria for a folder. TRANSFER interest group members can retrieve the attributes of folders for groups of which they are members. DEF get-folder-order-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 folder-name END. DEF get-folder-order-rsp. 02 hdr.
TISERV UOW Descriptions GET-FOLDER-ORDER FOLDER-NAME is the name of the folder to be retrieved. The name must be either a TRANSFER simple name or a fully qualified name. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions GET-FOLDER-ORDER ORDERING-DISCIPLINE specifies what information TISERV uses as the ordering key when saving items in the folder as follows. TIME-SAVED (T) specifies that items are to be saved in chronological order of the time a SAVEITEM UOW is executed for the items. CREATOR-NAME (C) specifies that items are to be saved in alphabetic order by the node name and then the correspondent name of the creator.
TISERV UOW Descriptions GET-FOLDER-ORDER ALLOW-DUPLICATES indicates whether or not duplicate keys are allowed. Y Duplicate ordering keys are allowed. N Duplicate ordering keys are not allowed. This field has no effect if the ORDERING-DISCIPLINE is TIME-SAVED (T); TIME-SAVED ordering already ensures a unique key. RESERVED-2 through RESERVED-7 are reserved for use by Tandem. These fields must be set to N.
TISERV UOW Descriptions GET-FOLDER-STATS GET-FOLDER-STATS (UOW Code 283) GET-FOLDER-STATS retrieves the folder statistics for a depot. DEF get-folder-stats-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 283. 02 corr-name PIC X(80) VALUE SPACES. 03 group-name PIC X(80) VALUE SPACES REDEFINES corr-name. 02 folder-name PIC X(80) VALUE SPACES. 02 reserved TYPE CHARACTER 10 VALUE SPACES. END. DEF get-folder-stats-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions GET-FOLDER-STATS To indicate successful retrieval of folder statistics: 0 OK To indicate problems with the correspondent or group name: 5601 5602 5605 5623 5798 E-CORR-NOT-FOUND E-CORR-BAD-NAME E-CORR-SECURITY E-CORR-AMBIGUOUS-NAME E-GROUP-AMBIGUOUS-NAME To indicate problems with the depot storage statistics facility: 6118 6119 6136 6137 E-DSF-NOT-ENABLED E-DSF-NOT-READY E-DSF-INVALID-FOLDER E-NO-STATS-FOR-DEPOT To indicate problems with the folder name: 5676 5677 E-FLD-NOT-F
TISERV UOW Descriptions GET-FOLDER-STATS RESERVED is reserved for use by Tandem. GET-FOLDER-STATS Operation GET-FOLDER-STATS retrieves folder storage statistics for a depot's folder. The folder storage statistics always reflect the current state for the folder. Use GET-FOLDERSTATS in combination with the READ-NEXT-NAME UOW to obtain statistics for all folders in a depot.
TISERV UOW Descriptions GET-ITEM-COMPNT-A01 GET-ITEM-COMPNT-A01 (UOW Code 137) GET-ITEM-COMPNT-A01 retrieves one or more component items in a parent item. DEF get-item-compnt-a01-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 start-position 02 options. 03 filter-by-item-type 03 filter-by-compnt-type 02 filter-values. 03 item-type 03 compnt-type 02 num-requested PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 137. 02 03 END. DEF get-item-compnt-a01-rsp. 02 hdr.
TISERV UOW Descriptions GET-ITEM-COMPNT-A01 ITEM-ID identifies the parent item to which the components belong. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. START-POSITION is the relative position in the components list of the first item for which data is to be returned. OPTIONS provides criteria for selecting component items by ITEM-TYPE or by COMPNTTYPE.
TISERV UOW Descriptions GET-ITEM-COMPNT-A01 RETN-CODE is the return code.
TISERV UOW Descriptions GET-ITEM-COMPNT-A01 GET-ITEM-COMPNT-A01 Operation GET-ITEM-COMPNT-A01 returns the item ID and item type of each component item requested by ITEM-ID, START-POSITION, and NUM-REQUESTED. The information is returned in COMPNT-ENTRY. The TRANSFER delivery system lets you directly access component items at any time during the current session.
TISERV UOW Descriptions GET-ITEM-DES-C20 GET-ITEM-DES-C20 (UOW Code 187) Note GET-ITEM-DES-C20 retrieves fields from an item descriptor. The GET-ITEM-DES-C20 UOW requires two READS of the database, unlike the GET-ITEM-DESCR UOW, which requires only one READ of the database. Use GET-ITEM-DES-C20 only if you need fields that are not in GET-ITEM-DESCR. DEF get-item-des-c20-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id dummy 03 END. DEF get-item-des-c20-rsp. 02 hdr.
TISERV UOW Descriptions GET-ITEM-DES-C20 02 creation-date. year month day-of-month hour minute second 02 creator-name 02 submitted-date. 03 year 03 month 03 day-of-month 03 hour 03 minute 03 second 02 earliest-deliv-date. 03 date-time. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second 03 delta-time 04 quantity 04 units 05 filler 04 filler 02 latest-deliv-date. 03 date-time.
TISERV UOW Descriptions GET-ITEM-DES-C20 03 delta-time quantity units 05 filler 04 filler 02 sender-zone-offset 02 priority 02 applic-id 02 agent-selector 02 deliv-control-flags. 03 certified 03 conversion-prohib 03 reserved-1 04 04 03 03 dont-disclose-recips reserved-2 03 03 defer-transport reserved-3 03 03 dont-remove-on-expire reserved-4 03 03 probe-msg reserved-5 03 03 X400-return-content reserved-6 03 reserved-7 err-pkg-suppress-flags.
TISERV UOW Descriptions GET-ITEM-DES-C20 02 char-map-id. code-page-id page-string 03 03 03 03 code-set-id set-string 02 02 stats-seq-num item-stats. 03 extobj-storage 03 itemdata-storage 03 num-data-recs 02 filler 02 item-descr-flags-2.
TISERV UOW Descriptions GET-ITEM-DES-C20 02 submit-timed. date-time. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second 03 delta-time 04 quantity 04 units 05 filler 04 filler 02 submit-every. 03 delta-time. 04 quantity 04 units 04 filler 02 submit-until. 03 date-time. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second 03 delta-time 04 quantity 04 units 05 filler 04 filler 02 filler END. 03 PIC 9(4). PIC 9(2). PIC 9(2). PIC 9(2). PIC 9(2). PIC 9(2). REDEFINES date-time. PIC 9(4) COMP.
TISERV UOW Descriptions GET-ITEM-DES-C20 RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries: 0 4035 OK E-ITEM-NOT-FOUND To indicate problems with an item handle: 4062 -4063 E-INVALID-ITEM W-ITEM-NOT-RETURNED RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. UPDATE-CONTROL is the current update control count.
TISERV UOW Descriptions GET-ITEM-DES-C20 SUBMITTED indicates whether the package has been posted. CANCELLED indicates whether the package, if posted, was canceled. CLONED indicates whether the package is a copy of a package that was transported from another node. REL-DATE-EARLIEST, REL-DATE-LATEST, and REL-DATE-EXPIRATION specifies whether the entries in the EARLIEST-DELIV-DATE, LATEST-DELIVDATE, and EXPIRATION-DATE fields are absolute dates or relative to submit time. Y Dates are relative dates.
TISERV UOW Descriptions GET-ITEM-DES-C20 LATEST-DELIV-DATE is the latest date at which the TRANSFER delivery system can deliver the package, specified either as an absolute calendar date or as a number of time units from EARLIEST-DELIV-DATE. EXPIRATION-DATE is the date and time at which the package expires, specified either as an absolute calendar date or as a number of time units from LATEST-DELIV-DATE. If expiration has not been requested, this field contains zeros.
TISERV UOW Descriptions GET-ITEM-DES-C20 AGENT-SELECTOR is the agent selector criteria, as created by the ALTER-AGENT-SELECT UOW. This number determines which agents are invoked when the package is delivered. AGENT-SELECTOR is stored with the package. See the description of the ALTERAGENT-SELECT UOW in this section. See Appendix B, “Status Packages,” on the use of agent selectors in TRANSFER status packages. DELIV-CONTROL-FLAGS specifies whether or not the package is certified.
TISERV UOW Descriptions GET-ITEM-DES-C20 STATS-SEQ-NUM indicates if there are statistics for this item. If STATS-SEQ-NUM is set to -1, there are statistics for this item, and the item is unalterable. If STATS-SEQ-NUM is 0, there are no statistics for this item. For example, the depot storage statistics facility may be turned off or SPREP may not have reached this item. If STATS-SEQ-NUM is set to a value greater than 0, the item is alterable.
TISERV UOW Descriptions GET-ITEM-DES-C20 REL-DATE-SUBMIT-UNTIL specifies whether the date in the SUBMIT-UNTIL field is a relative date or an absolute date. Y The date in the SUBMIT-UNTIL field is a relative date. N The date in the SUBMIT-UNTIL field is an absolute date. AUTOFORWARDED indicates whether the message was autoforwarded. You can use this field for incoming messages; you cannot set AUTOFORWARDED for a message. CONVERTED is reserved for use by Tandem.
TISERV UOW Descriptions GET-ITEM-DES-C20 REPLY-BY-DATE contains the date and time by which replies are to be returned by the recipients. The TRANSFER delivery system does not require recipients to return replies. The field can contain a relative or absolute date, depending on the value of RELDATE-REPLY-BY. For messages that are exported to X400 users, the date applies to mail packages only. IMPORTANCE contains a value ranging from 0 through 9999 and specifies the level of importance of an item.
TISERV UOW Descriptions GET-ITEM-DES-C20 GET-ITEM-DES-C20 Operation GET-ITEM-DES-C20 returns the item descriptor fields for the item identified by ITEMID. Access to the item is granted if the item is saved in any shared group folders accessible to the group of which the correspondent is a member. If the correspondent does not have access privileges to the item specified in the UOW, the error E-ITEM-NOTFOUND is returned.
TISERV UOW Descriptions GET-ITEM-DESCR GET-ITEM-DESCR (UOW Code 122) GET-ITEM-DESCR retrieves fields from an item descriptor. DEF get-item-descr-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. dummy 03 END. DEF get-item-descr-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 02 02 02 retn-code retn-code-detail update-control item-type parent-count compnt-count item-descr-flags.
TISERV UOW Descriptions GET-ITEM-DESCR 02 submitted-date. year month day-of-month hour minute second 02 earliest-deliv-date. 03 date-time. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second 03 delta-time 04 quantity 04 units 04 filler 02 latest-deliv-date. 03 date-time. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second 03 delta-time 04 quantity 04 units 04 filler 02 expiration-date. 03 date-time.
TISERV UOW Descriptions GET-ITEM-DESCR 02 02 02 applic-id agent-selector deliv-control-flags. 03 certified 03 conversion-prohib 03 reserved-1 03 03 dont-disclose-recips reserved-2 03 03 defer-transport reserved-3 03 03 dont-remove-on-expire reserved-4 03 03 probe-msg reserved-5 03 03 reserved-6 reserved-7 02 err-pkg-suppress-flags.
TISERV UOW Descriptions GET-ITEM-DESCR HDR is the UOW header. The UOW-CODE value is 122. ITEM-ID identifies the item whose descriptor record is to be retrieved. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. RETN-CODE is the return code.
TISERV UOW Descriptions GET-ITEM-DESCR ITEM-DESCR-FLAGS describe miscellaneous flags that appear in the item descriptor. The fields within ITEM-DESCR-FLAGS are as follows: IS-PKG-HDR indicates whether the item is a package header. UNALTERABLE indicates whether the item is unalterable. If this field is set to Y, the entire item is unalterable; you cannot change the item descriptor, components list, or data records. SUBMITTED indicates whether the package has been posted.
TISERV UOW Descriptions GET-ITEM-DESCR SUBMITTED-DATE is the date and time at which the package was posted. If the package has never been submitted, this field contains zeros. EARLIEST-DELIV-DATE is the earliest date at which the package can be delivered, specified as either an absolute calendar date or as a number of time units from submission time. An absolute or relative date is indicated by N or Y, respectively, in the REL-DATEEARLIEST field, as described under ITEM-DESCR-FLAGS.
TISERV UOW Descriptions GET-ITEM-DESCR APPLIC-ID is the numeric application ID associated with the session during which the item was created. This value is used as agent selection criteria at recipient depots, together with the value of AGENT-SELECTOR. The contents and meaning of these fields are defined by your application. After delivering a package, the TRANSFER delivery system examines these two fields to determine what agent to invoke.
TISERV UOW Descriptions GET-ITEM-DESCR CHAR-MAP-ID identifies the character map that applies to the text used in the item data. This map relates native codes to characters in the base character set. It is indicated by the following subfields: CODE-PAGE-ID identifies the base (canonical) character set on which the character map is based. CODE-SET-ID uniquely identifies the character map for the canonical character set specified by CODE-PAGE-ID.
TISERV UOW Descriptions GET-ITEM-NAME GET-ITEM-NAME (UOW Code 152) GET-ITEM-NAME retrieves the name assigned to an instance of a named item saved in a folder. DEF get-item-name-uow. 02 hdr. 03 self-ident 03 uow-code 02 02 folder-name item-id. 03 dummy END. DEF get-item-name-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 02 retn-code retn-code-detail folder-name item-id. 03 dummy 02 unsave-time 02 simple-item-name END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 152. PIC X(80). PIC X(12).
TISERV UOW Descriptions GET-ITEM-NAME RETN-CODE is the return code.
TISERV UOW Descriptions GET-ITEM-NAME GET-ITEM-NAME Operation GET-ITEM-NAME retrieves the name associated with a named item in a particular folder, the unsave time for that item, and the item ID. The folder must be owned by the current correspondent, and the item ID supplied must correspond to an item saved in that folder. Access to the item is granted if the item is saved in any shared group folders accessible to the group of which the correspondent is a member.
TISERV UOW Descriptions GET-ITEM-REC GET-ITEM-REC (UOW Code 125) GET-ITEM-REC retrieves one or more data records from an item. DEF get-item-rec-uow. 02 hdr. 03 self-ident 03 uow-code starting-key. item-id. 04 dummy 03 rec-type 03 rec-seq-num 02 options. 03 skip-exact 03 any-rec-type 03 any-seq-num 03 reserved-3 02 num-requested PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 125. 02 03 02 max-datasize 02 pad-char 02 filler END. DEF get-item-rec-rsp. 02 hdr.
TISERV UOW Descriptions GET-ITEM-REC ITEM-ID is the item ID of the item to which the record belongs. REC-TYPE is the type assigned to the record. REC-TYPE describes what kind of record is being accessed. The TRANSFER delivery system stores REC-TYPE with the item record but does not interpret the field. The TRANSFER delivery system stores records in increasing order by REC-TYPE, and stores records in increasing order by REC-SEQ-NUM within each REC-TYPE.
TISERV UOW Descriptions GET-ITEM-REC record sequence number greater than or equal to REC-SEQ-NUM, or with type greater than REC-TYPE and any sequence number. N Only records of type REC-TYPE are returned. ANY-SEQ-NUM is meaningful only if ANY-REC-TYPE is set to N. If ANY-REC-TYPE is set to N and ANY-SEQ-NUM is set to N, one record at most is returned. If SKIP-EXACT is set to N, the record matches the REC-TYPE and REC-SEQ-NUM specified in STARTING-KEY.
TISERV UOW Descriptions GET-ITEM-REC Figure 2-4. Record Retrieval by GET-ITEM-REC • • • ITEM-ID REC-TYPE REC-SEQ-NUM Starting Point (STARTING-KEY) 1,2,1 1,2,2 1,2,3 Retrieval of all records with ID = 1, REC-TYPE = 2 1,2,4 1,2,5 1,2,6 • • • Last-Record Limit (NUM-REQUESTED) 004 MAX-DATASIZE refers to the data portion of each record; this value is the maximum number of bytes that can be retrieved.
TISERV UOW Descriptions GET-ITEM-REC RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions GET-ITEM-REC DATA-STRING contains the data portion of the record. The length of the data in DATASTRING can be modified, but should be consistent with the value in MAXDATASIZE. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in RECS-RETURNED. If another UOW response follows this one in the same IPC, this next response begins immediately after the element last returned.
TISERV UOW Descriptions GET-ITEM-REC-B40 GET-ITEM-REC-B40 (UOW Code 148) GET-ITEM-REC-B40 retrieves one or more data records from an item, including the data records of an external object. DEF get-item-rec-b40-uow. 02 hdr. 03 self-ident 03 uow-code starting-key. item-id. 04 dummy 03 rec-type 03 rec-seq-num 02 options.
TISERV UOW Descriptions GET-ITEM-REC-B40 HDR is the UOW header. The UOW-CODE value is 148. STARTING-KEY identifies the first possible item data record that can be retrieved. The record is determined by the ITEM-ID, REC-TYPE, and REC-SEQ-NUM specified. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. OPTIONS provides criteria for selecting the item data records.
TISERV UOW Descriptions GET-ITEM-REC-B40 EXTOBJ-REC specifies whether the application retrieves data from the specified external object. Y Read data from external object. N Do not read data from external object. PARENT-IS-ITEM specifies whether the ID indicated in STARTING-KEY refers to an item or a primary external object. This field is used only if EXTOBJ-REC is set to Y. Y ID refers to an item. N ID refers to a primary external object.
TISERV UOW Descriptions GET-ITEM-REC-B40 NUM-REQUESTED specifies the number of records to be returned. This value affects the length of the response. The records are returned starting with the lowest record type and lowest sequence number matching the STARTING-KEY and OPTIONS selected. All records within a record type are returned in sequence number order before records of the next higher record type.
TISERV UOW Descriptions GET-ITEM-REC-B40 RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. NUM-RETURNED is the number of records returned by the TRANSFER delivery system in the response. RECS-RETURNED is the data array that contains the records retrieved. For this array, you must define array limits and element sizes that are consistent with the records requested in the UOW.
TISERV UOW Descriptions GET-ITEM-REC-B40 DATA-LEN contains the length of the data (non-key) portion of the record prior to retrieval, regardless of the value specified by MAX-DATASIZE. DATA-STRING contains the data portion of the record. The length of the data in DATASTRING can be modified, but should be consistent with MAX-DATASIZE. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in RECS-RETURNED.
TISERV UOW Descriptions GET-ITEM-REC-B40 or not OPTIONS is selected, however, the TRANSFER delivery system never retrieves a record whose key is less than STARTING-KEY considered in its entirety. If there are fewer records than specified by NUM-REQUESTED, the number of records retrieved is less than the number requested. In this case, the warning W-EOF is returned in the RETN-CODE field.
TISERV UOW Descriptions GET-ITEM-STATS GET-ITEM-STATS (UOW Code 284) GET-ITEM-STATS retrieves the statistics for items saved in a folder. For alterable items, this UOW returns the size of the entire item tree. DEF get-item-stats-uow. 02 hdr. 03 self-ident 03 uow-code 02 num-wanted 02 reserved 02 item-id. 03 dummy END. DEF get-item-stats-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 reserved 02 num-returned 02 stats 03 item-id.
TISERV UOW Descriptions GET-ITEM-STATS RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following conditions: 0 4035 4063 -4063 4111 6118 6119 6137 OK E-ITEM-NOT-FOUND E-ITEM-NOT-RETURNED W-ITEM-NOT-RETURNED E-INVALID-RESERVED E-DSF-NOT-ENABLED E-DSF-NOT-READY E-NO-STATS-FOR-DEPOT RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions GET-ITEM-STATS GET-ITEM-STATS Operation GET-ITEM-STATS retrieves storage statistics for the specified ITEM IDs. The statistics returned are always for the entire item tree for this item. One or more SCAN-FOLDER UOWs can be issued prior to this UOW to retrieve the ITEM-IDs.
TISERV UOW Descriptions GET-NEXT-SESSION GET-NEXT-SESSION (UOW Code 200) GET-NEXT-SESSION returns names of correspondents with active sessions. This UOW can only be issued by correspondents with system administrator privileges. DEF get-next-session-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 200. 02 filler TYPE BINARY 32. 02 start-session-id. 03 dummy PIC X(18). 02 num-wanted TYPE BINARY 16 UNSIGNED. 02 num-returned TYPE BINARY 16 UNSIGNED. END.
TISERV UOW Descriptions GET-NEXT-SESSION RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries: 0 -4001 4010 4093 4904 OK W-EOF E-BAD-TRANSACTION E-SECURITY-VIOLATION E-ERR-SESSION-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions GET-PROFILE-ELEM GET-PROFILE-ELEM (UOW Code 203) GET-PROFILE-ELEM retrieves data elements from a depot or system profile. Typically, this UOW is issued before an ALTER- PROFILE-ELEM UOW. Definition I is a DDL skeleton for general applications use. DEF get-profile-elem-usk. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 203. 02 corr-name TYPE PIC X(80) VALUE SPACES. 02 group-name REDEFINES corr-name. END. DEF get-profile-elem-rsk. 02 hdr.
TISERV UOW Descriptions GET-PROFILE-ELEM HDR is the UOW header. The UOW-CODE value is 203. CORR-NAME is the name of the correspondent whose depot profile is retrieved. This is also the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank.
TISERV UOW Descriptions GET-PROFILE-ELEM To indicate problems with the correspondent name: 5600 5601 5602 5604 5606 5607 5611 5622 5623 E-CORR-NSRV-ERR E-CORR-NOT-FOUND E-CORR-BAD-NAME E-CORR-NO-SUCH-NODE E-CORR-NSRV-NOT-FOUND E-CORR-NSRV-DOWN E-CORR-NET-DOWN E-CORR-NOT-SAME-NODE E-CORR-AMBIGUOUS-NAME To indicate other problems: 4010 4093 4201 -4210 4902 E-BAD-TRANSACTION E-SECURITY-VIOLATION E-CONTEXT-ERR W-IDENTIFIER-ERRS E-ERR-PROFILE-FILE RETN-CODE-DETAIL is an error number returned by a subsystem
TISERV UOW Descriptions GET-PROFILE-ELEM GET-PROFILE-ELEM Operation GET-PROFILE-ELEM retrieves one or more specific data elements from the Profile file. You can use this UOW by itself or in conjunction with the ALTER-PROFILE-ELEM UOW, which alters the data elements retrieved by GET-PROFILE-ELEM. Typically, you retrieve the data elements with the GET-PROFILE-ELEM UOW and then modify some or all of them with the ALTER-PROFILE-ELEM UOW.
TISERV UOW Descriptions GET-PROFILE-ELEM Definition I (for General Applications Use) The data structure provided by Definition I is convenient for most applications, and is simpler to use than Definition II. You typically construct a GET-PROFILE-ELEM UOW by specifying all fields up to and including NUM-RETURNED, and then specifying separate definitions for each element.
TISERV UOW Descriptions GET-PROFILE-ELEM The DDL equivalent is: DEF myget-profile-elem-uow. 05 get-profile-elem-usk 05 num-wanted 05 05 05 END. id-depot-privilege-flags id-depot-mail-filename id-depot-folder-defaults DEF myget-profile-elem-rsp. 05 get-profile-elem-rsk 05 data-depot-privilege-flags 05 data-depot-mail-filename 05 data-depot-folder-defaults END. TYPE *. TYPE BINARY 16 UNSIGNED VALUE 3. TYPE *. TYPE *. TYPE *. TYPE TYPE TYPE TYPE *. *. *. *.
TISERV UOW Descriptions GET-PROFILE-ELEM Figure 2-5 illustrates the storage layout for Example 1. Figure 2-5. Storage Layout for GET-PROFILE-ELEM self-ident UW self-ident UW uow-code 203 uow-code 203 retn-code corr-name retn-code-detail num-wanted 3 ID 7 ID 1003 ID 22 corr-name num-returned 3 info for ID 7 info for ID 1003 info for ID 22 GET-PROFILE-ELEM 006 Example 2 An ALTER-PROFILE-ELEM request and response is written for the same three elements specified in Example 1.
TISERV UOW Descriptions GET-PROFILE-ELEM 01 myalter-prof-elem-rsp. copy alter-profile-elem-rsk of gcob. copy rtn-depot-privilege-flags of gcob. copy rtn-depot-mail-filename of gcob. copy rtn-depot-folder-defaults of gcob. The response contains return codes for each altered identifier. The DDL equivalent is: DEF myalter-prof-elem-uow. 05 alter-profile-elem-usk 05 data-depot-privilege-flags 05 data-depot-mail-filename 05 data-depot-folder-defaults END. TYPE TYPE TYPE TYPE *. *. *. *.
TISERV UOW Descriptions GET-PROFILE-ELEM Figure 2-6 illustrates the storage layout for Example 2. Figure 2-6.
TISERV UOW Descriptions GET-PROFILE-ELEM As previously noted, the format of ELEM-DATA-BLOCK, which really consists of individual definitions for each data element, is the same for both the GET-PROFILEELEM response UOW and the ALTER-PROFILE-ELEM UOW. When the ALTER-PROFILE-ELEM UOW is invoked, the TRANSFER delivery system first validates all modifications. If these modifications are valid, the TRANSFER delivery system performs them.
TISERV UOW Descriptions GET-PROFILE-ELEM Table 2-17 lists the data elements in the Profile file, and includes the element identifier number as entered in ELEM-IDENTIFIER, the contents of the element, and the access privilege required for the GET-PROFILE-ELEM or ALTER-PROFILE-ELEM UOW. The DDL for each identifier follows Table 2-17. Table 2-17.
TISERV UOW Descriptions GET-PROFILE-ELEM Table 2-17.
TISERV UOW Descriptions GET-PROFILE-ELEM Table 2-17. Depot Profile File Elements and Access Privileges (Page 3 of 3) Element Identifier Content GET-PROFILE-ELEM Access Privilege ALTER-PROFILE-ELEM Access Privilege Name of correspondent who last updated the profile Depot profile phone number for PS MAIL clients using FAXLINK.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1 Element Identifier 1 Element Identifier 1 accesses the depot password. DEF data-depot-password. 02 elem-identifier 02 dd-password-rtn 02 old-password 02 new-password END. TYPE TYPE TYPE TYPE BINARY 16 VALUE 1. BINARY 16. CHARACTER 16. CHARACTER 16. ELEM-IDENTIFIER is 1. DD-PASSWORD-RTN is E-INVALID-IDENTIFIER, because you can alter this profile element , but you cannot retrieve it using the GET-PROFILE-ELEM UOW.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 2 RTN-DEPOT-PASSWORD is one of the following values: 0 4238 4300 OK E-TFER-PROFILE-ABSENT E-PASSWORD-MATCH-FAIL Element Identifier 2 Element Identifier 2 accesses the default delivery window for a depot. DEF data-depot-deltas. 02 elem-identifier 02 dd-deltas-rtn 02 deliv-start-delta. 03 quantity 03 units 03 filler 02 deliv-end-delta. 03 quantity 03 units 03 filler 02 expiration-delta. 03 quantity 03 units 03 filler 02 filler END.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 3 DELIV-END-DELTA is the default time period between initiation of delivery and latest permitted delivery time. EXPIRATION-DELTA is the default time period between delivery end and the time when the package expires. The return code is defined as follows: DEF rtn-depot-deltas TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 4 MAXIMUM-PRIORITY is the maximum priority that can be assigned to packages submitted from the depot. Only a system administrator can change this field. The return code is defined as follows: DEF rtn-depot-priorities TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 4 LOGON-RESTRICTED-FLAG determines whether anyone can log on at the depot. Y Permit logon. N Prohibit logon. Only system administrators can alter this field, and only for a depot other than their own. ADMIN-RESTRICTED-FLAG indicates whether the correspondent has access to the TRANSFER ADMIN screen interface. Individual clients or programs must interpret and enforce this flag; the TRANSFER delivery system is limited to storing the information.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 4 This flag is used in special cases where a client wishes to add a recipient name or member name even if that name does not exist. Caution The DEFER-LOCAL-FLAG is typically set to N; the overhead for checking validity of local correspondents is small. The DEFER-REMOTE-FLAG is typically set to Y; the overhead is higher for validity checking across nodes.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 5 RTN-DEPOT-SERVICE-FLAGS is one of the following values: 0 4051 4052 4093 4238 OK E-MUST-BE-YN E-RESERVED-MUST-BE-N E-SECURITY-VIOLATION E-TFER-PROFILE-ABSENT Element Identifier 5 Element Identifier 5 accesses depot log flags. DEF data-depot-log-flags. 02 elem-identifier TYPE BINARY 16 VALUE 5. 02 dd-log-flags-rtn TYPE BINARY 16. 02 diagnostic-log-flag TYPE BOOLEAN. 02 reserved-flag2 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 7 The return code is defined as follows: DEF rtn-depot-log-flags TYPE BINARY 16. RTN-DEPOT-LOG-FLAGS is one of the following values: 0 4051 4052 4238 OK E-MUST-BE-YN E-RESERVED-MUST-BE-N E-TFER-PROFILE-ABSENT Element Identifier 7 Element Identifier 7 accesses depot privilege flags. DEF data-depot-privilege-flags. 02 elem-identifier TYPE BINARY 16 VALUE 7. 02 dd-privilege-flags-rtn TYPE BINARY 16. 02 sys-admin-flag TYPE CHARACTER 1.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 8 The return code is defined as follows: DEF rtn-depot-privilege-flags TYPE BINARY 16. RTN-DEPOT-PRIVILEGE-FLAGS is one of the following values: 0 4093 4238 4388 OK E-SECURITY-VIOLATION E-TFER-PROFILE-ABSENT E-PRIV-MUST-BE-RWN Element Identifier 8 Element Identifier 8 accesses the GUARDIAN 90 ID for a depot. DEF data-depot-guardian-id.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 9 Note Element Identifier 8 does not return a value in the GUARDIAN-PASSWORD field when it is used for the GET-PROFILE-ELEM UOW; the field is used only for the ALTER-PROFILE-ELEM UOW. See ALTERPROFILE-ELEM earlier in this section for a discussion of this field. The return code is defined as follows: DEF rtn-depot-guardian-id TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 10 0 4238 OK E-TFER-PROFILE-ABSENT SESSION-ENDED contains the date and time that the last session for the depot ended. This excludes sessions automatically initiated by the TRANSFER delivery system for an agent. SESSION-STARTED contains the date and time that the last session began. The return code is defined as follows: DEF rtn-depot-session-ended TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 11 0 4238 OK E-TFER-PROFILE-ABSENT DEPOT-CREATED is the date and time of the depot creation. VERSION-CREATED is the version of the TRANSFER delivery system that created the depot. For example, version A01 would include the letter A and a REV-NUMBER equal to 01. The return code is defined as follows: DEF rtn-depot-created-time TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 12 0 4238 OK E-TFER-PROFILE-ABSENT DEPOT-UPDATED is the date and time that the depot was last updated with the ALTER-PROFILEELEM UOW. The return code is defined as follows: DEF rtn-depot-updated-time TYPE BINARY 16. RTN-DEPOT-UPDATED-TIME is one of the following values: 0 4302 OK E-NOT-UPDATABLE Element Identifier 12 Element Identifier 12 accesses the version code of the Profile file. DEF data-sys-file-version.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 13 DEF rtn-sys-file-version TYPE BINARY 16. RTN-SYS-FILE-VERSION is one of the following values: 0 4302 OK E-NOT-UPDATABLE Element Identifier 13 Element Identifier 13 accesses package delivery time limits. DEF data-sys-window-limits. 02 elem-identifier TYPE BINARY 16 VALUE 13. 02 ds-window-limits-rtn TYPE BINARY 16. 02 max-lifespan. 03 quantity PIC 9(4) COMP. 03 units PIC A. 03 filler PIC X. 02 min-deliv. 03 quantity PIC 9(4) COMP.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 14 MIN-EXPIRE is the minimum period allowed between the latest delivery time and the expiration time for a package. If a submitted package violates these last two limits, the TRANSFER delivery system adjusts the package to conform to these limits and does not reject the package. Updates to these fields do not affect any sessions currently in progress. The return code is defined as follows: DEF rtn-sys-window-limits TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 14 DGP-GROUP-PROP-RTN is one of the following: 0 4244 4257 OK E-GROUP-PROFILE-ABSENT E-MUST-BE-CA OBJ-CREATION-PRIV indicates whether any group member can create folders and distribution lists for a group or whether only group administrators can do so: C specifies that any correspondent can create folders and distribution lists for a group. A specifies that only group administrators can create folders and distribution lists for a group.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 16 Element Identifier 16 Element Identifier 16 accesses depot print-control flags for PS MAIL clients. DEF data-depot-mail-print-ctl. 02 elem-identifier TYPE BINARY 16 VALUE 16. 02 ddm-print-ctl-rtn TYPE BINARY 16. 02 page-flag TYPE BOOLEAN. 02 filler TYPE CHARACTER 1 VALUE SPACES. 02 page-indent-columns PIC 9(4) COMP. 02 filler TYPE CHARACTER 28 VALUE SPACES. END. ELEM-IDENTIFIER is 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 17 Element Identifier 17 Element Identifier 17 accesses depot operation flags. DEF data-depot-mail-flags. 02 elem-identifier 02 ddm-flags-rtn 02 read-sequence-flag 02 reply-default-flag 02 date-presentation-flag 02 edit-flag 02 rtn-to-logon-flag 02 highlite-mail-flag 02 overlap-flag 02 filler END. TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE BINARY 16 VALUE 17. BINARY 16. CHARACTER 1. CHARACTER 1. CHARACTER 1. BOOLEAN. BOOLEAN. BOOLEAN.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 17 DATE-PRESENTATION indicates the format in which the date presented on packages sent from the depot should be displayed. D Present the date in world format (dd/mm/yy). M Present the date in USA format (mm/dd/yy). EDIT-FLAG indicates whether Edit VS (Virtual Screen) is automatically invoked if EDIT is being used. Y Automatically invoke Edit VS. N Do not automatically invoke Edit VS.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 17 The return code is defined as follows: DEF rtn-depot-mail-flags TYPE BINARY 16. RTN-DEPOT-MAIL-FLAGS is one of the following values: 0 4239 4051 4382 4383 4384 OK E-MAIL-PROFILE-ABSENT E-MUST-BE-YN E-MUST-BE-SLT E-MUST-BE-TCN E-MUST-BE-MD DDM-VOLUME-RTN is one of the following: 0 4239 OK E-MAIL-PROFILE-ABSENT NODE is the name of the node at which the PS MAIL client's default volume is defined.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 22 Element Identifier 22 Element Identifier 22 accesses default ordering criteria and maximum retention time for items saved or delivered into a folder in the depot. DEF data-depot-folder-defaults. 02 elem-identifier TYPE BINARY 16 VALUE 22. 02 ddf-defaults-rtn TYPE BINARY 16. 02 folder-attributes. 03 ordering-criteria. 05 ordering-discipline TYPE CHARACTER 1. 05 filler PIC X(1) VALUE SPACES. 05 applic-order-type PIC 9(4) COMP. 05 options.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 22 DDF-DEFAULTS-RTN is one of: 0 4093 4238 -4269 OK E-SECURITY-VIOLATION E-TFER-PROFILE-ABSENT W-TIME-TOO-LONG ORDERING-DISCIPLINE specifies what information TISERV should use as the ordering key when saving items in the folder. For possible values and their meaning, see the CREATEFOLDER-B10 UOW.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 24 The return code is defined as follows: DEF rtn-depot-folder-defaults TYPE BINARY 16. RTN-DEPOT-FOLDER-DEFAULTS is one of the following values: 0 4051 4052 4072 4074 4093 4238 4265 -4269 OK E-MUST-BE-YN E-RESERVED-MUST-BE-N E-UNITS-MUST-BE-DHM E-INVALID-REL-TIME-QTY E-SECURITY-VIOLATION E-TFER-PROFILE-ABSENT E-INVALID-ORD-DISCIPLN W-TIME-TOO-LONG Element Identifier 24 Element Identifier 24 accesses interest group creation privileges.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 26 A specifies that only a system administrator with write privileges can create an interest group. System administrators with write privileges can alter this profile element. Any correspondent can read this profile element. Element Identifier 26 Element Identifier 26 accesses session privileges. DEF data-session-privileges. 02 elem-identifier 02 ds-privileges-rtn 02 sys-admin-flag 02 user-owner-flag 02 depot-type-flag 02 group-depot-flags.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 26 DEPOT-TYPE-FLAG indicates whether the session is doing work on a correspondent depot or a group depot. C Correspondent depot G Group depot GROUP-DEPOT-FLAGS indicates the session's privileges with respect to the group. GROUP-DEPOTFLAGS has no meaning if DEPOT-TYPE-FLAG is set to C. SESSION-MEMBER-FLAG specifies whether the session represents a member of the group: Y The session user is a member of the group.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 27 RTN-SESSION-PRIVILEGES is one of the following values: 0 4302 OK E-NOT-UPDATABLE Element Identifier 27 Element Identifier 27 accesses the dummy definition used for a short ELEMENTBLOCK. DEF data-dummy-short. 02 elem-identifier 02 dd-short-rtn 02 filler END. TYPE BINARY 16 VALUE 27. TYPE BINARY 16. TYPE CHARACTER 32 VALUE 27. ELEM-IDENTIFIER is 27. DD-SHORT-RTN is OK.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 29 Element Identifier 29 Element Identifier 29 accesses the depot language and character map used by the TRANSFER delivery system for input and output during sessions. DEF data-depot-lang-cmap. 02 elem-identifier 02 dda-char-set-rtn 02 language-id 02 char-map-id. 03 code-page-id 03 page-string 03 code-set-id 03 set-string 02 filler TYPE BINARY 16 VALUE 29. TYPE BINARY 16. TYPE BINARY 16 UNSIGNED. TYPE BINARY 16 UNSIGNED.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 29 supplied by the ALTER-PROFILE-ELEM UOW, both CODE-PAGE-ID and CODE-SET-ID must fall in the range from 1 through 65535. PAGE-STRING and SET-STRING redefine CODE-PAGE-ID and CODE-SET-ID, respectively, for MOVE operations in SCREEN COBOL and COBOL programs. When you modify DATA-DEPOT-LANG-CMAP values with the ALTERPROFILE-ELEM UOW, the TRANSFER delivery system does not use the new values until the correspondent starts a new session.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 30 Element Identifier 30 Element Identifier 30 accesses the default document format for WPLINK users who use the depot. DEF data-depot-bgdoc-format. 02 elem-identifier TYPE BINARY 16 VALUE 30. 02 ddb-defaults-rtn TYPE BINARY 16. 02 bg-document-format TYPE CHARACTER 32. END. ELEM-IDENTIFIER is 30.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1003 The return code is defined as follows: DEF rtn-depot-bgdoc-format TYPE BINARY 16. RTN-DEPOT-BGDOC-FORMAT is one of the following values: 0 4239 4314 4315 4931 OK E-MAIL-PROFILE-ABSENT E-WPLINK-NOT-FOUND E-INVALID-BGDOC-FORMAT E-ERR-FORMAT-NAME-FILE Element Identifier 1003 Element Identifier 1003 accesses the default output file name for PS MAIL clients. DEF data-depot-mail-filename.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1004 0 4239 4305 OK E-MAIL-PROFILE-ABSENT E-INVALID-FILENAME Element Identifier 1004 Element Identifier 1004 accesses default creation information for an interest group. DEF data-group-creation. 02 elem-identifier 02 dgc-creation-rtn 02 creator-name 02 creation-date-time. 03 year 03 month 03 day-of-month 03 hour 03 minute 03 second 02 version-created. 03 letter 03 rev-number 02 filler END. TYPE BINARY 16 VALUE 1004. TYPE BINARY 16.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1005 Element Identifier 1005 Element Identifier 1005 accesses the default destination for marksense items. DEF data-depot-fax-routing. 02 elem-identifier 02 ddf-routing-rtn 02 default-fax-routing END. TYPE BINARY 16 VALUE 1005. TYPE BINARY 16. TYPE CHARACTER 80. ELEM-IDENTIFIER is 1005.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1006 Element Identifier 1006 Element Identifier 1006 accesses the default folder for marksense items. DEF data-depot-fax-folder1. 02 elem-identifier 02 ddf-folder-rtn 02 default-fax-folder1 END. TYPE BINARY 16 VALUE 1006. TYPE BINARY 16. TYPE CHARACTER 80. ELEM-IDENTIFIER is 1006.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1007 Element Identifier 1007 Element Identifier 1007 accesses the name of the recipient who receives notification of FAXLINK delivery failures. DEF data-depot-fax-deliv-fail. 02 elem-identifier TYPE BINARY 16 VALUE 1007. 02 ddf-deliv-rtn TYPE BINARY 16. 02 deliv-failure-corr TYPE CHARACTER 80. END. ELEM-IDENTIFIER is 1007.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1008 Element Identifier 1008 Element Identifier 1008 accesses the default formatter program for PS MAIL clients. DEF data-depot-formatter. 02 elem-identifier 02 dd-formatter-rtn 02 mail-formatter-name 02 filler END. TYPE TYPE TYPE TYPE BINARY 16 VALUE 1008. BINARY 16. CHARACTER 36. CHARACTER 44 VALUE SPACES. ELEM-IDENTIFIER is 1008.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1009 Element Identifier 1009 Element Identifier 1009 accesses the name of a host-resident program for IXF data transfers on behalf of PS MAIL clients. DEF data-depot-IXF-host. 02 elem-identifier 02 ddi-host-rtn 02 host-file-transfer 02 filler END. TYPE TYPE TYPE TYPE BINARY 16 VALUE 1009. BINARY 16. CHARACTER 36. CHARACTER 44 VALUE SPACES. ELEM-IDENTIFIER is 1009.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1010 Element Identifier 1010 Element Identifier 1010 accesses the name of a workstation-resident program for IXF data transfers on behalf of PS MAIL clients. DEF data-depot-IXF-PC. 02 elem-identifier 02 ddi-pc-rtn 02 pc-file-transfer END. TYPE BINARY 16 VALUE 1010. TYPE BINARY 16. TYPE CHARACTER 80. ELEM-IDENTIFIER is 1010.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1011 Element Identifier 1011 Element Identifier 1011 accesses the name of the correspondent associated with the current session. DEF data-session-corr. 02 elem-identifier 02 ds-corr-rtn 02 session-corr-name END. TYPE BINARY 16 VALUE 1011. TYPE BINARY 16. PIC X(80). ELEM-IDENTIFIER is 1011. DS-CORR-RTN is OK. SESSION-CORR-NAME is the fully qualified name of the logged-on correspondent.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1013 DD-LONG-RTN is OK. The return code is defined as follows: DEF rtn-dummy-long TYPE BINARY 16. RTN-DUMMY-LONG contains the following value: 0 OK Element Identifier 1013 Element Identifier 1013 accesses the name of the correspondent who last updated the profile. DEF data-depot-updated-by. 02 elem-identifier 02 dd-updated-by-rtn 02 updated-by-corr-name END. TYPE BINARY 16 VALUE 1013. TYPE BINARY 16. PIC X(80). ELEM-IDENTIFIER is 1013.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1014 RTN-DEPOT-UPDATED-BY is one of the following values: 0 4302 OK E-NOT-UPDATABLE Element Identifier 1014 Element Identifier 1014 accesses the default phone number for PS MAIL clients using FAXLINK. DEF data-depot-device-option. 02 elem-identifier TYPE 02 ddd-option-rtn TYPE 02 default-device-option TYPE 02 filler TYPE END. BINARY 16 VALUE 1014. BINARY 16. CHARACTER 50. CHARACTER 30 VALUE SPACES. ELEM-IDENTIFIER is 1014.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1015 Element Identifier 1015 Element Identifier 1015 accesses the depot editor file name for PS MAIL clients. DEF data-depot-editor-name. 02 elem-identifier 02 dde-filename-rtn 02 mail-editor-name 02 filler END. TYPE TYPE TYPE TYPE BINARY 16 VALUE 1015. BINARY 16. CHARACTER 36. CHARACTER 44 VALUE SPACES. ELEM-IDENTIFIER is 1015.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1016 Element Identifier 1016 Element Identifier 1016 accesses X400 name defaults. DEF data-depot-x400-defaults-1. 02 elem-identifier TYPE BINARY 16 VALUE 1016. 02 ddm1-rtn TYPE BINARY 16. 02 country PIC X(3). 02 filler PIC X. 02 admd-name PIC X(16). 02 prmd-name PIC X(16). 02 country-is-X121 TYPE BOOLEAN. 02 admd-is-numeric TYPE BOOLEAN. 02 prmd-is-numeric TYPE BOOLEAN. 02 filler PIC X(41). END. ELEM-IDENTIFIER is 1016.
TISERV UOW Descriptions GET-PROFILE-ELEM Element Identifier 1017 COUNTRY-IS-X121 indicates whether the country code is in X121 format. Y Country name is in X121 format. N Country name is not in X121 format. ADMD-IS-NUMERIC indicates whether the ADMD name is numeric or alphanumeric. Y ADMD name is numeric. N ADMD name includes alphanumeric and special characters. PRMD-IS-NUMERIC indicates whether the PRMD name is numeric or alphanumeric. Y PRMD name is numeric.
TISERV UOW Descriptions GET-RECIP-REC GET-RECIP-REC (UOW Code 126) GET-RECIP-REC retrieves recipient records for a package. DEF get-recip-rec-uow. 02 hdr 03 self-ident 03 uow-code 02 TYPE UOW-HDR. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 126. recip-key. item-id. 04 dummy PIC X(12). 03 recip-name PIC X(120). 02 options. 03 get-exact TYPE BOOLEAN. 03 generic-suffix TYPE BOOLEAN. 03 skip-exact TYPE BOOLEAN. 03 strip-local-node-name TYPE BOOLEAN. 03 reserved-4 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions GET-RECIP-REC 04 04 04 04 04 04 04 04 delivered TYPE BOOLEAN. examined TYPE BOOLEAN. certification-acked TYPE BOOLEAN. canceled TYPE BOOLEAN. expired TYPE BOOLEAN. async-resolved TYPE BOOLEAN. discarded-unexamined TYPE BOOLEAN VALUE "N". reserved-6 REDEFINES discarded-unexamined TYPE BOOLEAN. 04 nrn-sent TYPE BOOLEAN. 04 reserved-7 REDEFINES nrn-sent TYPE BOOLEAN. 04 is-original-recip TYPE BOOLEAN. 04 is-local-dlist TYPE BOOLEAN. 04 is-local-corr TYPE BOOLEAN.
TISERV UOW Descriptions GET-RECIP-REC 04 04 04 04 04 04 04 04 is-original-recip is-local-dlist is-local-corr is-remote-recip reserved-12 reserved-13 reserved-14 reserved-15 03 date-delivered. 04 year 04 month 04 day-of-month 04 hour 04 minute 04 second TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE PIC PIC PIC PIC PIC PIC BOOLEAN. BOOLEAN. BOOLEAN. BOOLEAN. BOOLEAN VALUE BOOLEAN VALUE BOOLEAN VALUE BOOLEAN VALUE "N". "N". "N". "N". 9(4). 9(2). 9(2). 9(2). 9(2). 9(2). END. HDR is the UOW header.
TISERV UOW Descriptions GET-RECIP-REC SKIP-EXACT indicates whether TISERV begins its retrieval with the record specified in RECIP-KEY or with the next record in the recipient file. Y Start retrieval with the first record following the one specified in RECIP-KEY, whether or not the specified record actually exists. N Start retrieval with the exact record specified in RECIP-KEY (if that record is present) or with the first record following that one (if the exact record is not present).
TISERV UOW Descriptions GET-RECIP-REC STATUS-FLAGS specifies that only recipient records whose status flag matches this input value are retrieved. FILTER-BY-STATUS-FLAG must be set to Y. The status flags maintained by the TRANSFER delivery system contain status information about the delivery of a package with respect to a particular recipient. These flags are set by the TAREQ that delivers the package to the recipient.
TISERV UOW Descriptions GET-RECIP-REC NRN-SENT indicates whether a non-receipt notification has been issued for the recipient. This field is set by TWORK and used by TWORK and by TISERV to determine if a non-receipt notification needs to be sent for the recipient when the package is discarded unexamined. RESERVED-6 through RESERVED-15 are reserved for use by Tandem. These fields are always set to N.
TISERV UOW Descriptions GET-RECIP-REC To indicate problems with an item handle: 4062 -4063 E-INVALID-ITEM W-ITEM-NOT-RETURNED RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. NUM-RETURNED is the number of records returned in the response.
TISERV UOW Descriptions GET-RECIP-REC To retrieve a recipient list beginning with the first recipient in the list, for example: set SKIP-EXACT to Y; set GET-EXACT to N; and set GENERIC-SUFFIX to N. When you specify filtering criteria in OPTIONS and FILTER-VALUES, only recipient records that meet all of these criteria are returned. The number of recipient records retrieved might be less than the number requested if there are fewer recipients than meet the request criteria.
TISERV UOW Descriptions GET-RECIP-REC-C20 GET-RECIP-REC-C20 (UOW Code 181) GET-RECIP-REC-C20 retrieves recipient records for a package. DEF get-recip-rec-uow. 02 hdr 03 self-ident 03 uow-code 02 TYPE UOW-HDR. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 181. recip-key. item-id. 04 dummy PIC X(12). 03 recip-name PIC X(120). 02 options. 03 get-exact TYPE BOOLEAN. 03 generic-suffix TYPE BOOLEAN. 03 skip-exact TYPE BOOLEAN. 03 strip-local-node-name TYPE BOOLEAN. 03 reserved-4 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions GET-RECIP-REC-C20 02 filter-values. recip-type PIC 9(4) COMP. status-flags. 04 delivered TYPE BOOLEAN. 04 examined TYPE BOOLEAN. 04 certification-acked TYPE BOOLEAN. 04 canceled TYPE BOOLEAN. 04 expired TYPE BOOLEAN. 04 async-resolved TYPE BOOLEAN. 04 discarded-unexamined TYPE BOOLEAN. 04 reserved-6 REDEFINES discarded-unexamined TYPE BOOLEAN. 04 nrn-sent TYPE BOOLEAN. 04 reserved-7 REDEFINES nrn-sent TYPE BOOLEAN. 04 is-original-recip TYPE BOOLEAN. 04 is-local-dlist TYPE BOOLEAN.
TISERV UOW Descriptions GET-RECIP-REC-C20 04 04 04 04 04 04 04 04 04 reserved-7 reserved-8 reserved-9 reserved-10 reserved-11 reserved-12 reserved-13 reserved-14 reserved-15 03 deliv-err 03 deliv-status-flags. 04 delivered 04 examined 04 certification-acked 04 canceled 04 expired 04 async-resolved 04 reserved-6 04 nrn-sent 04 reserved-7 04 is-original-recip 04 is-local-dlist 04 is-local-corr 04 is-remote-recip 04 reserved-12 04 reserved-13 04 reserved-14 04 reserved-15 03 date-delivered.
TISERV UOW Descriptions GET-RECIP-REC-C20 OPTIONS establishes criteria for selectively retrieving records. In these options, the entry Y selects the option, while the entry N suppresses it. GET-EXACT retrieves the recipient record that exactly matches the name specified in RECIP-KEY. GENERIC-SUFFIX retrieves all recipient records for the recipient specified in RECIP-KEY, regardless of whatever suffix might be appended to the recipient name. If GET-EXACT is set to Y, GENERIC-SUFFIX is ignored.
TISERV UOW Descriptions GET-RECIP-REC-C20 FILTER-VALUES defines the filter by which records are selected for retrieval. This field applies only if FILTER-BY-RECIP-TYPE or FILTER-BY-STATUS-FLAG is selected in the OPTIONS field. FILTER-VALUES includes the following: RECIP-TYPE specifies a recipient type and determines that only records of this type are retrieved. FILTER-BY-RECIP-TYPE must be set to Y. STATUS-FLAGS specifies that only recipient records whose status flag matches this input value are retrieved.
TISERV UOW Descriptions GET-RECIP-REC-C20 DISCARDED-UNEXAMINED indicates whether the recipient has discarded the package without having examined it (by issuing an ACK-RECEIPT UOW). Discarding a package consists of removing it from all folders in the depot. This flag can be set either by TISERV or by TWORK, depending on which of them actually removes the item. This field supports non-receipt notification as specified in the NRN-SENT field.
TISERV UOW Descriptions GET-RECIP-REC-C20 NUM-REQUESTED is the number of records to be retrieved. The size of the response depends on how many records you request. RETN-CODE is the return code.
TISERV UOW Descriptions GET-RECIP-REC-C20 DELIV-NOTIFY indicates that delivery notification has been requested for this recipient. Delivery notification is returned in the form of a STATUS package when this package is saved in the recipient's INBOX folder. RECEIPT-NOTIFY indicates that receipt notification has been requested for this recipient. Receipt notification is returned in the form of a STATUS package when the recipient issues an ACK-RECEIPT UOW for the package and the package is not certified.
TISERV UOW Descriptions GET-RECIP-REC-C20 The retrieval can begin with the exact recipient name specified in RECIP-KEY if such a recipient name exists; or with the next one depending on the value of the SKIP-EXACT field in the OPTIONS structure. To reference the first recipient in the recipient list, specify an empty RECIP-NAME field, set RECIP-NAME to all blanks or begin the field with a null character. To retrieve a recipient list beginning with the first recipient in the list, for example: 1.
TISERV UOW Descriptions GET-STATS-PARAMS GET-STATS-PARAMS (UOW Code 273) GET-STATS-PARAMS retrieves the configuration parameters of the depot storage statistics facility for either the current configuration or the next configuration. The values for these parameters are stored as a directory data entry in the data branch of the directory. This UOW can be issued by any correspondent. DEF get-stats-params-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 273.
TISERV UOW Descriptions GET-STATS-PARAMS 03 hour 03 minute 03 second 02 reserved END. PIC 9(2). PIC 9(2). PIC 9(2). TYPE CHARACTER 20 VALUE SPACES. HDR is the UOW header. The UOW-CODE value is 273. SELECT-CONFIG allows access to the current, next, or previous configuration parameters. A value of PREV-CONFIG returns the configuration that existed when TRANSFER XCOOL completed. RETN-CODE is the return code.
TISERV UOW Descriptions GET-STATS-PARAMS START-TIME indicates the time of day that statistics collection is done. SAMPLE-INTERVAL is the time that elapses during the collection of each depot storage statistic. NUM-STATS is the number of statistics (unaveraged) that are stored in the DEPSTAT file. NUM-AVG-STATS is the number of averaged statistics that are stored in the DEPSTAT file. COUNT-ITEMS-ONCE indicates whether saved items are counted each time they are saved in the depot or only once.
TISERV UOW Descriptions GET-X400-AUX-NAME GET-X400-AUX-NAME (UOW Code 175) GET-X400-AUX-NAME retrieves the X400 authorizing user names or reply-to recipient names for a package. DEF get-x400-aux-name-uow. 02 hdr. 03 self-ident 03 uow-code item-id. dummy 02 aux-name-type 02 aux-node-num 02 aux-name-seq-num 02 options. 03 skip-exact 03 any-seq-num 03 reserved-2 03 reserved-3 03 reserved-4 03 reserved-5 03 reserved-6 03 reserved-7 END. DEF get-x400-aux-name-rsp. 02 hdr.
TISERV UOW Descriptions GET-X400-AUX-NAME AUX-NAME-TYPE specifies the type of auxiliary name that is to be retrieved. The value of this field must be either 104 (for an authorizing user) or 105 (for a "reply to" recipient). If the value for AUX-NAME-TYPE does not follow these rules, the error EINVALID-AUX-NAME-TYPE is returned. AUX-NAME-NODE-NUM specifies the internal data where retrieval is to begin. The value specifies the number of the EXPAND node where the name was added to the package.
TISERV UOW Descriptions GET-X400-AUX-NAME RETN-CODE is the return code.
TISERV UOW Descriptions GET-X400-AUX-NAME GET-X400-AUX-NAME Operation GET-X400-AUX-NAME retrieves the X400 authorizing user or reply-to recipient names for a package. The names are retrieved in order using the AUX-NAME-TYPE, AUX-NAME-NODE-NUM, and AUX-NAME-SEQ-NUM values specified.
TISERV UOW Descriptions GET-X400-CONFIG GET-X400-CONFIG (UOW Code 264) GET-X400-CONFIG retrieves the X400 gateway node configuration values. DEF get-x400-config-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 264. 02 filler PIC X(100). END. DEF get-x400-config-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 0. 02 retn-code TYPE BINARY 16. 02 retn-code-detail TYPE BINARY 16. 02 node-name PIC X(32). 02 country PIC X(4).
TISERV UOW Descriptions GET-X400-CONFIG ADMD-NAME is the Administration Management Domain (ADMD) name configured for the X400 gateway node. PRMD-NAME is the Private Management Domain (PRMD) name configured for the X400 gateway node. GET-X400-CONFIG Operation The GET-X400-CONFIG UOW allows clients to retrieve the values of COUNTRY, ADMD, and PRMD configured for the gateway node, which is configured for the current node.
TISERV UOW Descriptions GET-X400-NAME GET-X400-NAME (UOW Code 265) GET-X400-NAME retrieves the X400 O/R name generated for a specified TRANSFER correspondent name. DEF get-x400-name-uow. 02 hdr. 03 self-ident 03 uow-code 02 corr-name 02 filler END. DEF get-x400-name-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 corr-name 02 node-name 02 x400-name. END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 265. PIC X(120). PIC X(100). PIC AA VALUE "UW".
TISERV UOW Descriptions GET-X400-NAME NODE-NAME is the name of the X400 gateway node configured for the current node. This node exports any message created on this node. The backslash (\) is included with the node name. X400-NAME is the O/R name that is generated by the gateway node specified in NODE-NAME when messages are exported.
TISERV UOW Descriptions GET-X400-ORIG GET-X400-ORIG (UOW Code 180) GET-X400-ORIG retrieves the X400 O/R name of the originator of a package that was created by a foreign X400 user and imported through the gateway. DEF get-x400-orig-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy 02 orig-type END. DEF get-x400-orig-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 x400-name. END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 180. PIC X(12).
TISERV UOW Descriptions GET-X400-ORIG RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries: 0 4035 4062 -4063 4164 4165 4167 4175 OK E-ITEM-NOT-FOUND E-INVALID-ITEM W-ITEM-NOT-RETURNED E-INVALID-ORIG-TYPE E-NOT-X400-ITEM E-NO-P2-CREATOR E-X400-NOT-CONFIGURED RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions GET-X400-RECIP GET-X400-RECIP (UOW Code 172) GET-X400-RECIP retrieves a list of X400 recipients of a package. DEF get-x400-recip-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 172. 02 recip-type PIC 9(4) COMP. 02 recip-node-num TYPE BINARY 32 UNSIGNED. 02 recip-seq-num PIC S9(4) COMP. 02 options. 03 skip-exact TYPE BOOLEAN. 03 any-recip-type TYPE BOOLEAN. 03 any-seq-num TYPE BOOLEAN. 03 reserved-3 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions GET-X400-RECIP 05 05 05 05 05 05 05 05 is-original-recip TYPE reserved-9 TYPE reserved-10 TYPE reserved-11 TYPE reserved-12 TYPE reserved-13 TYPE reserved-14 TYPE reserved-15 TYPE BOOLEAN BOOLEAN BOOLEAN BOOLEAN BOOLEAN BOOLEAN BOOLEAN BOOLEAN VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE "N". "N". "N". "N". "N". "N". "N". "N". END. DEF get-x400-recip-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 172. 02 retn-code TYPE BINARY 16.
TISERV UOW Descriptions GET-X400-RECIP 03 is-original-recip 03 03 03 03 03 03 03 02 02 END. reserved-9 reserved-10 reserved-11 reserved-12 reserved-13 reserved-14 reserved-15 export-date x400-recip-name TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N". TYPE date-time. TYPE x400-name. HDR is the UOW header. The UOW-CODE value is 172.
TISERV UOW Descriptions GET-X400-RECIP OPTIONS specifies the following fields: SKIP-EXACT specifies where retrieval is to begin: Y Retrieval is to begin with the record immediately following the record specified by RECIP-TYPE, RECIP-NODE-NUM, and RECIP-SEQNUM, even if that record does not exist. N Retrieval is to begin with the record specified by RECIP-TYPE, RECIPNODE-NUM, and RECIP-SEQ-NUM if that record exists or the record immediately following it, if it does not exist.
TISERV UOW Descriptions GET-X400-RECIP RETN-CODE is the return code.
TISERV UOW Descriptions GET-X400-RECIP There is one exception to the preceding rule. If the package's item type is 100 (STATUS package), then RECIP-TYPE values of 200 through 207 are allowed. These recipient types allow the client to retrieve the actual and intended recipients being reported on by the STATUS package. These are not "real" recipients of the STATUS package. The client needs to be aware of that.
TISERV UOW Descriptions NOOP NOOP (UOW Code 0) NOOP transmits a dummy UOW to TISERV. This UOW does not require the establishment of a session. DEF noop-uow. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 data-size 02 noop-data END. DEF noop-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 data-size 02 noop-data PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 0. TYPE BINARY 16. TYPE BINARY 16. TYPE BINARY 16 UNSIGNED.
TISERV UOW Descriptions NOOP NOOP Operation NOOP lets you transmit a dummy UOW to TISERV and receive a dummy response. The data transmitted in the UOW is returned without modification in the response. To help identify all IPC messages that are logged, you can use the NOOP UOW to include, after every IPC header, client data that identifies the source of the transaction.
TISERV UOW Descriptions READ-NXT-GROUP-MBR READ-NXT-GROUP-MBR (UOW Code 249) READ-NXT-GROUP-MBR retrieves the members of a local interest group. DEF read-nxt-group-mbr-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 02 filler TYPE BINARY 16. 02 filler TYPE BINARY 16. 02 group-name PIC X(80). 02 start member PIC X(80) VALUE SPACES. 02 start-type TYPE CHARACTER 1 VALUE "A". 02 filler TYPE BOOLEAN. 02 name-format TYPE BINARY 16 VALUE 1.
TISERV UOW Descriptions READ-NXT-GROUP-MBR GROUP-NAME is the name of the local interest group from which group membership is to be retrieved. You can use a partially- qualified name; in the response, the fully qualified name is returned. START-MEMBER specifies the name of the group member with which retrieval starts. The member can be either a local correspondent or local interest group name. You can use a partially qualified name. To start at the beginning of the membership list, set this field to spaces.
TISERV UOW Descriptions READ-NXT-GROUP-MBR FULL-QUALIFICATION (1) specifies that the name is to be returned in its fully qualified form: name @ node Full qualification is the default. EXPANSION-OPTION specifies the selective filtering and retrieval of either direct group members only or of direct and indirect group members: DIRECT-MEMBERSHIP (0) requests retrieval of the names of direct group members.
TISERV UOW Descriptions READ-NXT-GROUP-MBR RETN-CODE is the return code.
TISERV UOW Descriptions READ-NXT-GROUP-MBR MEMBER-IS-ADMIN specifies whether the group member has group administrative privileges: Y The interest group member has group administrative privileges. N The interest group member does not have group administrative privileges. MEMBER-IS-GROUP specifies whether the interest group member is a correspondent or a group. Y The interest group member is a group. N The interest group member is a correspondent.
TISERV UOW Descriptions READ-NEXT-MEMBER READ-NEXT-MEMBER (UOW Code 219) READ-NEXT-MEMBER retrieves members of a distribution list. DEF read-next-member-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 219. 02 filler TYPE BINARY 16. 02 filler TYPE BINARY 16. 02 corr-name TYPE PIC X(80) VALUE SPACES. 02 dlist-name TYPE PIC X(80). 02 start-member PIC X(120) VALUE SPACES. 02 start-type TYPE CHARACTER 1 VALUE "A". 02 filler TYPE BOOLEAN.
TISERV UOW Descriptions READ-NEXT-MEMBER CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank. In the response, the fully qualified name is returned.
TISERV UOW Descriptions READ-NEXT-MEMBER FULL-QUALIFICATION (1) specifies that the name is to be returned in fully qualified format, which is the TRANSFER name in its full form: name [ . name ] @system PRE-SEARCH-LIST (2) specifies that names belonging to CORR-NAME are returned as simple names; for example, the name SYS-ADMIN.DLIST @TM is returned simply as DLIST if the correspondent requesting the name is SYS-ADMIN @TM. Names belonging to other correspondents at this node are returned as name [ .
TISERV UOW Descriptions READ-NEXT-MEMBER To indicate problems with the distribution list name: 5625 5626 5627 5629 5631 5632 5636 5647 5648 E-DLIST-NSRV-ERR E-DLIST-NOT-FOUND E-DLIST-BAD-NAME E-DLIST-NO-SUCH-NODE E-DLIST-NSRV-NOT-FOUND E-DLIST-NSRV-DOWN E-DLIST-NET-DOWN E-DLIST-NOT-SAME-NODE E-DLIST-AMBIGUOUS-NAME To indicate other problems: -4001 4093 4201 4229 4902 4914 W-EOF E-SECURITY-VIOLATION E-CONTEXT-ERR E-MUST-BE-EA E-ERR-PROFILE-FILE E-ERR-DLIST-FILE RETN-CODE-DETAIL is an error number return
TISERV UOW Descriptions READ-NEXT-MEMBER READ-NEXT-MEMBER Operation The READ-NEXT-MEMBER UOW retrieves the names of members from the distribution list identified by DLIST-NAME in a range identified by START-MEMBER and NUM-WANTED. To begin a retrieval with the first member on the list, set the START-MEMBER field to spaces. The names of the retrieved members are stored in the array MEMBER-NAME.
TISERV UOW Descriptions READ-NEXT-NAME READ-NEXT-NAME (UOW Code 224) READ-NEXT-NAME retrieves correspondent names, group names, distribution list names, or folder names defined in the TRANSFER delivery system. DEF read-next-name-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 224. 02 filler TYPE BINARY 16. 02 filler TYPE BINARY 16. 02 corr-name PIC X(80) VALUE SPACES. 02 partial PIC X(80) VALUE SPACES. 02 name-type PIC X(32). 02 kind TYPE BINARY 16.
TISERV UOW Descriptions READ-NEXT-NAME CORR-NAME is the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank. In the response, the fully qualified name is returned.
TISERV UOW Descriptions READ-NEXT-NAME RECALL-WITHIN-CURRENT-DIRECTORY (4) continues the previous search from the point specified by the contents of MATCHER and DIR-NO, which were returned on a previous call. It limits the search for the next name to the directory in which first name was found (as indicated by the DIR-NO field). RESTRICTION-FLAG restricts the name search. Settings are as follows: RESTRICT-TO-WDIR (0) restricts the search to names belonging to the CORR-NAME depot.
TISERV UOW Descriptions READ-NEXT-NAME FULL-QUALIFICATION (1) specifies that the name is to be returned in full qualification format, which returns the TRANSFER name in its full form: name [ . name ] @ system PRE-SEARCH-LIST (2) specifies that names belonging to CORR.NAME are to be returned as simple names. For example, the name SYS-ADMIN.FOLDER1 @TM is returned simply as FOLDER1 if the correspondent requesting the name is SYS-ADMIN @TM.
TISERV UOW Descriptions READ-NEXT-NAME RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions READ-NEXT-NAME READ-NEXT-NAME Operation READ-NEXT-NAME scans the TRANSFER name directory and returns the next name or group of names encountered on each call. You can use this UOW to display lists of folder names, distribution list names, or correspondent names. In selecting names for retrieval, this UOW supports wild-card matching of names.
TISERV UOW Descriptions READ-PROFILE-REC READ-PROFILE-REC (UOW Code 212) READ-PROFILE-REC reads a user-maintained depot profile record. This UOW is provided to maintain compatibility for programs written prior to TRANSFER version A02. READ-PROF-REC-A02 is the recommended UOW. DEF read-profile-rec-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 212. 02 corr-name PIC X(80) VALUE SPACES. 02 group-name REDEFINES corr-name. 02 rec-type PIC 9(4) COMP.
TISERV UOW Descriptions READ-PROFILE-REC REC-TYPE is the type assigned to the record by your application. In the response, the type of the record accessed for retrieval is returned. The record type must be 1000 or greater; 0 to 999 are reserved for use by Tandem. REC-SEQ-NUM is the sequence number assigned to the record. In the response, the sequence number of the record retrieved is returned. DEPOT-FLAG determines whether the UOW references a depot profile record or a system control record.
TISERV UOW Descriptions READ-PROFILE-REC RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions READ-PROFILE-REC READ-PROFILE-REC Operation READ-PROFILE-REC reads a user-maintained record from the depot Profile file and returns the data portion of the record. Although the profile record header is not returned, the record type and sequence number from this header are made available as separate fields (REC-TYPE and REC-SEQ-NUM). The UOW must start on a word boundary.
TISERV UOW Descriptions READ-PROF-REC-A02 READ-PROF-REC-A02 (UOW Code 231) READ-PROF-REC-A02 reads a user-maintained depot profile record. DEF read-prof-rec-a02-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 02 corr-name PIC X(80) VALUE SPACES. 02 group-name REDEFINES corr-name. 02 rec-type PIC 9(4) COMP. 02 rec-seq-num PIC S9(4) COMP. 02 options. 03 skip-exact TYPE BOOLEAN. 03 any-rec-type TYPE BOOLEAN. 03 any-seq-num TYPE BOOLEAN. 03 depot-flag TYPE BOOLEAN.
TISERV UOW Descriptions READ-PROF-REC-A02 CORR-NAME is the name of the correspondent whose depot profile record is to be read. This is also the name of the correspondent represented by the calling process. You can specify a partially qualified name, including wild-card characters. Only system administrators can enter correspondent names other than their own in this field; correspondents without system administrator privileges must enter their own names or leave the field blank.
TISERV UOW Descriptions READ-PROF-REC-A02 ANY-SEQ-NUM is meaningful only if ANY-REC-TYPE is set to N. If ANY-REC-TYPE is set to N and ANY-SEQ-NUM is set to Y, any subsequent profile records whose REC-TYPE field matches the given RECTYPE field can be returned. If ANY-REC-TYPE is set to N and ANY-SEQ-NUM is set to N, at most one record whose REC-TYPE and REC-SEQ-NUM match the given values is returned. DEPOT-FLAG determines whether the UOW references a depot profile record or a system control record.
TISERV UOW Descriptions READ-PROF-REC-A02 RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions READ-PROF-REC-A02 REC-SEQ-NUM contains the record sequence number. UPDATE-CONTROL is the counter used to control concurrent updates of the profile record. If you are planning to update or delete a profile record, you must pass the UPDATECONTROL field returned by this UOW to the WRITE-PROFILE-REC or DELETE-PROFILE-REC UOW. DATA-LEN contains the length of the data portion of the record prior to retrieval, regardless of the value specified by MAX-DATASIZE.
TISERV UOW Descriptions READ-PROF-REC-A02 READ-PROF-REC-A02 Operation READ-PROF-REC-A02 reads a user-maintained record from the depot Profile file and returns the data portion of the record. Although the profile record header is not returned, the record type and sequence number from this header are made available as separate fields (REC-TYPE and REC-SEQ-NUM). The TRANSFER delivery system pads or truncates each record to a fixed length before returning the record.
TISERV UOW Descriptions READ-X400-MEMBER READ-X400-MEMBER (UOW Code 242) READ-X400-MEMBER retrieves the X400 members of a TRANSFER distribution list. DEF read-x400-member-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 242. 02 filler TYPE BINARY 16. 02 filler TYPE BINARY 16. 02 corr-name PIC X(80) VALUE SPACES. 02 dlist-name PIC X(80). 02 start-node-num TYPE BINARY 32 UNSIGNED. 02 start-seq-num PIC S9(4) COMP. 02 start-type TYPE CHARACTER 1 VALUE "E".
TISERV UOW Descriptions READ-X400-MEMBER START-NODE-NUM is the internal data required to uniquely specify where retrieval is to begin. The MEMBER-NODE-NUM field contains a value that specifies the number of the EXPAND node where the name was added to the package. The field is used internally by the TRANSFER delivery system to uniquely identify records in the X400NAME file. Clients need not display this information to users.
TISERV UOW Descriptions READ-X400-MEMBER 5635 5636 5647 5648 E-DLIST-ALIAS E-DLIST-NET-DOWN E-DLIST-NOT-SAME-NODE E-DLIST-AMBIGUOUS-NAME RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. UPDATE-FLAG indicates whether the current correspondent is allowed to update the distribution list being read: Y The correspondent is allowed to update the distribution list.
TISERV UOW Descriptions SAVE-ITEM SAVE-ITEM (UOW Code 110) SAVE-ITEM saves an item in a folder that has any ordering discipline except APPLICDEFINED; the SAVE-ITEM-BY-KEY UOW must be used to save items in folders with APPLIC-DEFINED ordering. SAVE-ITEM can still be used to save items in folders created by TRANSFER A01/A02. SAVE-ITEM differs from the SAVE-ITEM-B00 UOW in that it does not have an unsave option to have items automatically removed at a specified time.
TISERV UOW Descriptions SAVE-ITEM RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SAVE-ITEM SAVE-ITEM Operation SAVE-ITEM saves the item identified by ITEM-ID in the folder identified by FOLDERNAME at the correspondent depot. The saved item remains in the folder until it either is automatically removed after the folder item retention time or until you explicitly unsave it with the UNSAVE-ITEM UOW in this or a later session. Items are stored according to the folder's ordering criteria, as follows: TIME-SAVED (T)—The item is saved in chronological order.
TISERV UOW Descriptions SAVE-ITEM The options are listed in Table 2-18. Table 2-18. Depot Storage Statistics for SAVE-ITEM UOW 2–444 Value of COUNT-ITEMS-ONCE Has the item been saved in the depot? N Y or N Y N Y Y 069139, Update 1 to 40969 Tandem Computers Incorporated Statistics Depot storage statistics increase by the amount in the item. Depot storage statistics increase by the amount in the item. Depot statistics are not changed.
TISERV UOW Descriptions SAVE-ITEM-B00 SAVE-ITEM-B00 (UOW Code 141) SAVE-ITEM-B00 saves an item in a folder that has any ordering discipline except APPLIC-DEFINED; the SAVE-ITEM-BY-KEY UOW must be used to save items in folders with APPLIC-DEFINED ordering. SAVE-ITEM-B00 includes an unsave option to have items automatically removed from the folder at a specified time. DEF save-item-b00-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy 02 folder-name 02 flags.
TISERV UOW Descriptions SAVE-ITEM-B00 ITEM-ID identifies the item to be saved. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. FOLDER-NAME is the name of the folder, with an ordering discipline other than APPLICDEFINED, in which the item is to be saved.
TISERV UOW Descriptions SAVE-ITEM-B00 P Equates UNSAVE-TIME to the maximum item retention time allowed for items stored at the depot, as recorded in the depot profile. The retention time for the individual item becomes the same as the retention time constraint for the depot in which it resides. For example, to save an item in a folder and not have the item automatically unsaved, set the date and time parameters as follows: 1. Set DATE-IS-REL to Y 2. Set UNITS to M, H, or D 3.
TISERV UOW Descriptions SAVE-ITEM-B00 -4269 4906 4912 4922 W-TIME-TOO-LONG E-ERR-ITEMDESC-FILE E-ERR-FOLDER-FILE E-ERR-INV-FOLDER-FILE RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. SAVE-ITEM-B00 Operation SAVE-ITEM-B00 saves the item identified by ITEM-ID in the folder identified by FOLDER-NAME at the correspondent depot.
TISERV UOW Descriptions SAVE-ITEM-B00 If the depot storage statistics facility is active, collection depends on the value of COUNT-ITEMS-ONCE and on whether or not the item has been saved in the depot. Conditions are listed in Table 2-19. Table 2-19.
TISERV UOW Descriptions SAVE-ITEM-BY-KEY SAVE-ITEM-BY-KEY (UOW Code 139) SAVE-ITEM-BY-KEY saves an item in a folder that has an ordering discipline of APPLIC-DEFINED. The ordering key used to save the item is supplied by the application. DEF save-item-by-key-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 139. 02 item-id. 03 dummy PIC X(12). 02 folder-name PIC X(80). 02 flags. 03 date-is-rel TYPE BOOLEAN. 03 reserved-1 TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions SAVE-ITEM-BY-KEY ITEM-ID identifies the item to be saved. To refer to an item produced by a previous UOW within the same IPC, you can replace ITEM-ID with ITEM-HANDLE, which is defined in the “Commonly Used Fields” subsection of this manual. FOLDER-NAME is the name of the folder, with an ordering discipline of APPLIC-DEFINED, in which the item is to be saved.
TISERV UOW Descriptions SAVE-ITEM-BY-KEY If you set QUANTITY to 0 and UNITS to F or P: F specifies the folder default should be used. The retention time for the individual item becomes the same as the retention time for the folder in which it resides. P specifies the profile constraint. The retention time for the individual item becomes the same as the retention time for the depot in which it resides.
TISERV UOW Descriptions SAVE-ITEM-BY-KEY RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SAVE-ITEM-BY-KEY SAVE-ITEM-BY-KEY Operation SAVE-ITEM-BY-KEY saves the item identified by ITEM-ID in the folder identified by FOLDER-NAME at the correspondent depot. The folder in which the item is being saved must have an ordering discipline of APPLIC-DEFINED. If a SAVE-ITEM-BY-KEY UOW is issued on a folder with an ordering discipline other than APPLIC-DEFINED, the error E-INCORRECT-FLDORDER is returned. You cannot save an item in the same folder more than once.
TISERV UOW Descriptions SAVE-ITEM-BY-KEY If the depot storage statistics facility is active, collection depends on the value of COUNT-ITEMS-ONCE and on whether or not the item has been saved into the depot. Conditions are listed in Table 2-20. Table 2-20.
TISERV UOW Descriptions SCAN-BY-ITEM-NAME SCAN-BY-ITEM-NAME (UOW Code 151) SCAN-BY-ITEM-NAME scans the contents of a folder and retrieves the item ID, item name, and unsave time of one or more named items. Only named items that fit the specified search criteria are returned; all other named items, and all unnamed items, are skipped over. DEF scan-by-item-name-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 151. 02 folder-name PIC X(80).
TISERV UOW Descriptions SCAN-BY-ITEM-NAME FOLDER-NAME is the name of a folder in which an instance of the item is saved. You can supply the name in wild-card form, but the name must resolve to a unique and unambiguous folder name. The folder can be a private folder owned by the correspondent, a folder shared by a group, or a bulletin board, if the correspondent is a member of the group that owns the folder.
TISERV UOW Descriptions SCAN-BY-ITEM-NAME FIRST-CALL indicates whether this is an initial name search or a continuation of a previous name search from the point specified by the input item name and the value of RECALL-MATCH-LENGTH. Y The search is an initial name search. N The search is a continuation of previous search. ITEM-TYPE indicates the type of item to be retrieved; all other types of items are ignored. Use this field only if FILTER-BY-ITEM-TYPE is set to Y.
TISERV UOW Descriptions SCAN-BY-ITEM-NAME 4092 4105 4151 -4152 4153 4912 4922 E-INVALID-NUM-REQUESTED E-CONCURRNT-FLD-UPDATE E-INVALID-ITEM-NAME W-AMBIGUOUS-ITEM-NAME E-INVALID-MATCH-LEN E-ERR-FOLDER-FILE E-ERR-INV-FOLDER-FILE To indicate problems with the folder name: 5675 5676 5677 5678 5679 5680 5681 5682 5686 5697 5698 E-FLD-NSRV-ERR E-FLD-NOT-FOUND E-FLD-BAD-NAME E-FLD-BAD-TYPE E-FLD-NO-SUCH-NODE E-FLD-SECURITY E-FLD-NSRV-NOT-FOUND E-FLD-NSRV-DOWN E-FLD-NET-DOWN E-FLD-NOT-SAME-NODE E-FLD-AMBIGUOUS-
TISERV UOW Descriptions SCAN-BY-ITEM-NAME the same scan. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in ITEMS-RETURNED. If another UOW response follows this one in the same IPC, the next response begins immediately after the element last returned. SCAN-BY-ITEM-NAME Operation SCAN-BY-ITEM-NAME retrieves information about one or more named items in a folder.
TISERV UOW Descriptions SCAN-FOLDER SCAN-FOLDER (UOW Code 120) SCAN-FOLDER scans the contents of a folder and retrieves the IDs of items in the folder. SCAN-FOLDER returns item IDs according to the ordering key by which items were saved in the folder. If you scan a folder that is in APPLIC-DEFINED order and requires the ordering key of each item, use the SCAN-FOLDER-BY-KEY UOW.
TISERV UOW Descriptions SCAN-FOLDER FOLDER-NAME is the name of the folder whose contents are to be scanned. This can be a private folder owned by the correspondent or any local shared folder owned by a group of which the correspondent is a member. ITEM-ID identifies the item in the folder following which the retrieval is to start. You can begin with the first item in the folder by setting this field to binary zeros.
TISERV UOW Descriptions SCAN-FOLDER RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SCAN-FOLDER NUM-REQUESTED. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in ITEMS-RETURNED. If another UOW response follows this one in the same IPC, this next response begins immediately after the element last returned. SCAN-FOLDER Operation SCAN-FOLDER retrieves the IDs of the items in the range denoted by ITEM-ID and NUM-REQUESTED and places these IDs in the array named ITEMS-RETURNED.
TISERV UOW Descriptions SCAN-FOLDER-B00 SCAN-FOLDER-B00 (UOW Code 142) SCAN-FOLDER-B00 scans the contents of a folder and retrieves the IDs and unsave time of items in the folder. SCAN-FOLDER-B00 returns item IDs according to the ordering key by which items were saved in the folder. If an application scans a folder that is in APPLIC-DEFINED order and requires the ordering key of each item, the SCAN-FOLDER-BY-KEY UOW must be used.
TISERV UOW Descriptions SCAN-FOLDER-B40 HDR is the UOW header. The UOW-CODE value is 142. FOLDER-NAME is the name of the folder whose contents are to be scanned. This can be a private folder owned by the correspondent or any local shared folder owned by a group of which the correspondent is a member. ITEM-ID identifies the item in the folder following which the retrieval is to start. You can begin with the first item in the folder by setting this field to binary zeros.
TISERV UOW Descriptions SCAN-FOLDER-B40 RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SCAN-FOLDER-B40 ITEMS-RETURNED is an array that contains the IDs and the unsave time of the items retrieved from the folder. The size of this array must be consistent with the number of items requested, as defined in NUM-REQUESTED. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in ITEMS-RETURNED. If another UOW response follows this one in the same IPC, this next response begins immediately after the last element returned.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY SCAN-FOLDER-BY-KEY (UOW Code 140) SCAN-FOLDER-BY-KEY retrieves the item ID, item type, unsave time, and the corresponding ordering key and key length of items saved in folders with APPLICDEFINED ordering. Items are returned in application ordering key sequence. SCANFOLDER-BY-KEY does not return the names of retrieved items. These names can be obtained with the GET-ITEM-NAME UOW. DEF scan-folder-by-key-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW".
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY 03 03 03 03 03 03 02 reserved-3 reserved-4 reserved-5 reserved-6 reserved-7 item-type num-requested 02 02 02 02 02 02 02 starting-key-len generic-key-len max-key-len pad-char starting-duplicate starting-key num-returned 02 items-returned item-id. dummy 03 item-type 03 unsave-time. 04 date-time. 05 year 05 month 05 day-of-month 05 hour 05 minute 05 second 03 ordering-key-length 03 ordering-key TYPE BOOLEAN VALUE "N". TYPE BOOLEAN VALUE "N".
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY FILTER-BY-ITEM-TYPE allows you to filter the scan by selecting only items of a given type from the folder. To select filtering, set FILTER-BY-ITEM-TYPE to Y and use the ITEMTYPE field to specify the item type. To suppress filtering, set FILTER-BY-ITEM-TYPE to N. In the response, the input to FILTER-BY-ITEM-TYPE and ITEM-TYPE is echoed as output.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY NUM-REQUESTED is the number of items to be retrieved from the folder. The value of NUMREQUESTED affects the size of the response UOW. The maximum of this number is dependent on the value of MAX-KEY-LEN. The suggested maximum for a MAX-KEY-LEN of 200 would be 10.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY MAX-KEY-LEN refers to the ORDERING-KEY field returned with each item in ITEM-RETURNED. This is the maximum number of bytes in ORDERING-KEY to be returned. The maximum value for MAX-KEY-LEN is 200. If this field is less than 0 or greater than 200, the error E-INVALID-KEY-LEN is returned. Ordering keys that are shorter than MAX-KEY-LEN are automatically padded with the padding character specified by the PAD-CHAR field.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY NUM-RETURNED is the number of items retrieved from the folder. The number of items retrieved might be less than the number of items requested (NUM-REQUESTED) because of one of the following reasons: The folder contains fewer items in the range specified by the passed starting key information. The folder contains fewer items in the subset specified for generic matching.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY SCAN-FOLDER-BY-KEY Example The following example illustrates the operation of the SCAN-FOLDER-BY-KEY UOW. Six items are stored in a folder with an APPLIC-DEFINED ordering discipline. The items are stored as shown in Table 2-21. Table 2-21.
TISERV UOW Descriptions SCAN-FOLDER-BY-KEY TISERV begins retrieval and sets SCAN-FOLDER-BY-KEY fields to values that correspond to the item being scanned. Table 2-22 lists the values that TISERV sets as it progresses through the folder. Table 2-22.
TISERV UOW Descriptions SCAN-FOLDER-DETAIL SCAN-FOLDER-DETAIL (UOW Code 184) SCAN-FOLDER-DETAIL scans a folder according to the specified selection criteria for retrieving a specific set of items from a folder. DEF scan-folder-detail-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 184. 02 folder-name PIC X(80). 02 item-id. 03 dummy PIC X(12). 02 item-handle PIC X(12) REDEFINES item-id. 02 options. 03 filter-by-item-type TYPE BOOLEAN.
TISERV UOW Descriptions SCAN-FOLDER-DETAIL DEF scan-folder-detail-rsp. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 184. 02 retn-code TYPE BINARY 16. 02 retn-code-detail TYPE BINARY 16. 02 folder-name PIC X(80). 02 num-returned TYPE BINARY 16 UNSIGNED. 02 items-returned. 03 item-id. 04 dummy PIC X(12) OCCURS 0 TO 100 TIMES DEPENDING ON num-returned. END. HDR is the UOW header. The UOW-CODE value is 184. FOLDER-NAME is the name of the folder to be scanned.
TISERV UOW Descriptions SCAN-FOLDER-DETAIL MAILED-BEFORE, MAILED-ON, and MAILED-SINCE are date and time fields that you can use to select items that have been mailed since, mailed before, or mailed on a specific date or on a specific date and at a specific time. PRES-ORDER is the order in which items selected should be returned. Items are either returned in folder order or are sorted by time of sending or by sender name.
TISERV UOW Descriptions SCAN-FOLDER-DETAIL RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions SCAN-FOLDER-DETAIL ITEMS-RETURNED is an array that contains the IDs of the items retrieved from the folder. SCAN-FOLDER-DETAIL Operation SCAN-FOLDER-DETAIL scans the specified source folder, sorts the resulting items according to the requested presentation order, and returns those items that match the specified selection criteria.
TISERV UOW Descriptions SET-CURRENT-CONTXT SET-CURRENT-CONTXT (UOW Code 186) SET-CURRENT-CONTXT specifies the depot or folder that is to be searched first when access to an item must be verified. This permits the TRANSFER delivery system to optimize the checking of item access to items saved in interest group folders. DEF set-current-contxt-uow. 02 hdr. 03 self-ident 03 uow-code 02 context-folder 02 context-depot END. DEF set-current-contxt-rsp. 02 hdr. 03 self-ident 03 uow-code 02 02 02 END.
TISERV UOW Descriptions SET-CURRENT-CONTXT To indicate that the UOW was successful: 0 OK To indicate problems with the folder name: 5675 5676 5677 5679 5681 5682 5686 5697 5698 E-FLD-NSRV-ERR E-FLD-NOT-FOUND E-FLD-BAD-NAME E-FLD-NO-SUCH-NODE E-FLD-NSRV-NOT-FOUND E-FLD-NSRV-DOWN E-FLD-NET-DOWN E-FLD-NOT-SAME-NODE E-FLD-AMBIGUOUS-NAME To indicate problems with the depot name: 5600 5601 5602 5603 5604 5605 5606 5607 5611 5622 5623 5624 E-CORR-NSRV-ERR E-CORR-NOT-FOUND E-CORR-BAD-NAME E-CORR-BAD-TYPE E-CO
TISERV UOW Descriptions SET-CURRENT-CONTXT SET-CURRENT-CONTXT Operation For most item-handling UOWs, the TRANSFER delivery system verifies that the correspondent has access to the item by reading the IFOLDER file to see if the session has an instance of the item saved in one of the folders for the current depot's session.
TISERV UOW Descriptions SET-CURRENT-CONTXT private or group folder which the correspondent can access, the UOW returns a W-NOT-FOUND-IN-CONTEXT warning.
TISERV UOW Descriptions SET-SYSTEM-PARAM SET-SYSTEM-PARAM (UOW Code 238) SET-SYSTEM-PARAM alters certain system parameters as recorded in the configuration directory. Specifically, this UOW enables or disables the external objects capability and changes the system default language and character map. A TMF transaction is required for this UOW. DEF set-system-param-uow. 02 hdr. 03 self-ident 03 uow-code params-to-alter.
TISERV UOW Descriptions SET-SYSTEM-PARAM PARAMS-TO-ALTER lets you select specific parameters to be altered in the configuration directory. Y Select the field for alteration. N Disable the field from alteration. The meanings of EXTOBJ and SYS-LANG-CMAP-ID are explained under PARAM-VALUES, later in this description. RESERVED-2 through RESERVED-7 are reserved for use by Tandem. These fields must be set to N. If EXTOBJ and SYS-LANG-CMAP-ID are not set to either Y nor N, then E-MUSTBE-YN is returned.
TISERV UOW Descriptions SET-SYSTEM-PARAM CODE-SET-ID uniquely identifies the character map used to enter data associated with the item. The values permitted in this field are listed in Appendix D. PAGE-STRING and SET-STRING redefine CODE-PAGE-ID and CODE- SET-ID, respectively, for MOVE operations in SCREEN COBOL and COBOL programs. If you supply an invalid CHAR-MAP-ID, E-INVALID-CHAR-MAP-ID is returned.
TISERV UOW Descriptions SET-SYSTEM-PARAM SET-SYSTEM-PARAM Operation This UOW alters two system parameters maintained in the configuration directory: the external objects capability (EXTOBJS-ENABLED field) and the system language character map (SYS-LANG-CMAP-ID field). To alter these values, set the appropriate PARAMS-TO-ALTER subfield to Y and enter new values in the corresponding PARAM-VALUES subfield.
TISERV UOW Descriptions START-SESSION START-SESSION (UOW Code 101) START-SESSION starts a session. DEF start-session-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 101. 02 applic-id PIC 9(4) COMP. 02 corr-name PIC X(120). 02 password PIC X(16). 02 curr-local-time. 03 year PIC 9(4). 03 month PIC 9(2). 03 day-of-month PIC 9(2). 03 hour PIC 9(2). 03 minute PIC 9(2). 03 second PIC 9(2). 02 redef-local-time REDEFINES curr-local-time. 03 century PIC 9(2).
TISERV UOW Descriptions START-SESSION CORR-NAME is the name of an existing correspondent represented by the requesting process. Refer to the CREATE-DEPOT UOW description for additional information about how to create a correspondent. PASSWORD is the password required to establish the session, as defined in the system by the ALTER-PROFILE-ELEM UOW. CURR-LOCAL-TIME is the current date and time as obtained by the requesting process.
TISERV UOW Descriptions START-SESSION To indicate problems related to the defaulted language and character map identification: 5800 E-TEXT-SERVICE To indicate other problems: 4005 -4005 Note E-CONCURRENT-SESSION W-CONCURRENT-SESSION If concurrent sessions are allowed (see GET-PROFILE-ELEM, Element Identifier 4, for details), the warning -4005 W-CONCURRENT-SESSIONS might be returned. The application may do an END-TRANSACTION and continue using this session.
TISERV UOW Descriptions START-SESSION The same transformations are applied to any stored time zone differences. The sender time zone difference stored in a package header is initially set to the session (server-requester) time zone difference when the package is submitted.
TISERV UOW Descriptions START-SESSION In COBOL or SCREEN COBOL, you can use the following code sequence to set the local time field of this UOW: 01 COBOL-TIME. 05 TRANSFER-TIME 05 FILLER ... PIC 9(6). PIC 9(2). PROCEDURE DIVISION. MOVE 19 TO UOW SS-CENTURY. ACCEPT ACCEPT-DATE FROM DATE. ACCEPT COBOL-TIME FROM TIME. MOVE ACCEPT-TIME TO TRANSFER-TIME.
TISERV UOW Descriptions START-SESSION Language and Character Map Within a Session A preferred language and a character map are associated with every TRANSFER session. The TRANSFER delivery system uses the language and character map to process requests within the session. Once a session is underway, you cannot alter its language or character map.
TISERV UOW Descriptions START-SESSION-B40 START-SESSION-B40 (UOW Code 100) START-SESSION-B40 starts a session and allows you to select the preferred language and character map for the session. DEF start-session-B40-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 100. 02 applic-id PIC 9(4) COMP. 02 corr-name PIC X(120). 02 password PIC X(16). 02 curr-local-time. 03 year PIC 9(4). 03 month PIC 9(2). 03 day-of-month PIC 9(2). 03 hour PIC 9(2). 03 minute PIC 9(2).
TISERV UOW Descriptions START-SESSION-B40 APPLIC-ID is the numeric application ID, as defined by your application. All packages created during this session inherit this attribute as part of their item descriptor; you can then use this field as an agent-selection criterion at depots receiving this package. The values 100 through 999 are reserved for use by Tandem; see Appendix A in the TRANSFER Programming Guide for reserved APPLIC-ID values.
TISERV UOW Descriptions START-SESSION-B40 CODE-SET-ID uniquely identifies the character map used to enter data. To select the desired map, enter one of the permitted values listed in Appendix D. If both CODE-PAGE-ID and CODE-SET-ID contain 0, the TRANSFER delivery system selects the default map for sessions, as noted under “START-SESSIONB40 UOW Operation.” PAGE-STRING and SET-STRING redefine CODE-PAGE-ID and CODE- SETID, respectively, for MOVE operations in SCREEN COBOL and COBOL programs.
TISERV UOW Descriptions START-SESSION-B40 4007 4010 4013 4015 4017 4019 4021 4055 4073 4201 E-LOGON-DISALLOWED E-BAD-TRANSACTION E-NO-DEPOT-FOR-CORR E-INVALID-PASSWORD E-RESTRICTED-OPERATION E-ALREADY-IN-SESSION E-INVALID-ZONE-OFFSET E-INVALID-APPLIC-ID E-INVALID-DATE-TIME E-CONTEXT-ERR RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions START-SESSION-B40 START-SESSION-B40 Operation START-SESSION-B40 validates the correspondent identity and right to communicate with the TRANSFER delivery system at the local node, and establishes the running environment for a new session. This UOW cannot be issued from within an established session; the TRANSFER delivery system performs work for only one session within a single IPC request. If present in a request, this UOW can be preceded only by NOOP or GET-CONFIG-NAME UOWs.
TISERV UOW Descriptions START-SESSION-B40 A preferred language and a character map are associated with every TRANSFER session. The values for these parameters are specified by the START-SESSION-B40 UOW that initiates the session. The TRANSFER delivery system uses these values, together with the value in the VERSION-CODE field of the IPC header, to determine what language and character map to use in processing requests within the session.
TISERV UOW Descriptions SUBMIT-PKG SUBMIT-PKG (UOW Code 117) SUBMIT-PKG submits a package for delivery. DEF submit-pkg-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy END. DEF submit-pkg-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 117. PIC X(12). PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 117. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header. The UOW-CODE value is 117.
TISERV UOW Descriptions SUBMIT-PKG To indicate problems with an item handle: 4062 -4063 E-INVALID-ITEM W-ITEM-NOT-RETURNED To indicate problems with the depot storage statistics facility: 4944 6114 6126 6127 E-ERR-DEPSTAT-FILE E-DSF-INTERNAL-ERROR E-DSF-STAT-ARRAY E-DSF-BAD-TIMESTAMP RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system.
TISERV UOW Descriptions UNSAVE-ITEM UNSAVE-ITEM (UOW Code 111) UNSAVE-ITEM removes an item from a folder. DEF unsave-item-uow. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy 02 folder-name END. DEF unsave-item-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail END. PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 111. PIC X(12). PIC X(80). PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 111. TYPE BINARY 16. TYPE BINARY 16. HDR is the UOW header. The UOW-CODE value is 111.
TISERV UOW Descriptions UNSAVE-ITEM RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following.
TISERV UOW Descriptions UNSAVE-ITEM UNSAVE-ITEM Operation UNSAVE-ITEM removes the item identified by ITEM-ID from the folder identified by FOLDER-NAME. Prior to any UNSAVE-ITEM request for an item, you can issue a SAVE-ITEM request to save the item in the WASTEBASKET folder. If you save the item, the application can access the item and reclaim it should the need arise at any time before ending the current session. When an item is unsaved from a folder, the item is scheduled for deletion from the system.
TISERV UOW Descriptions UNSAVE-ITEM If the depot storage statistics facility is active, the amount of the item is subtracted from the folder storage statistics. Table 2-24 describes how statistics are collected for the UNSAVE-ITEM UOW. Table 2-24.
TISERV UOW Descriptions WHERE-MEMBER-OF WHERE-MEMBER-OF (UOW Code 250) WHERE-MEMBER-OF retrieves a list of one or more interest groups of which the correspondent (or group) is a local member, and indicates in which of the groups retrieved the correspondent (or group) has administrative privileges. DEF where-member-of-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 02 filler TYPE BINARY 16. 02 filler TYPE BINARY 16. 02 group-member-name PIC X(80).
TISERV UOW Descriptions WHERE-MEMBER-OF GROUP-MEMBER-NAME is the name of the local correspondent or interest group for which a list of group memberships is to be retrieved. You can use a partially qualified name; in the response, the fully qualified name is returned. You can use spaces to specify the current correspondent. Patterns are not allowed in this field. START-GROUP is the name of the interest group with which retrieval is to start. You can use a partially qualified name.
TISERV UOW Descriptions WHERE-MEMBER-OF FILTER-OPTION specifies the selective filtering and retrieval of group members specified in GROUP-MEMBER-NAME having group administrative privileges: ALL-GROUP-TYPES (0) specifies that group members are to be retrieved whether or not they have group administrative privileges. This is the default value. WHERE-ADMIN-ONLY (1) specifies that only groups for which the correspondent has group administrative privileges are to be retrieved.
TISERV UOW Descriptions WHERE-MEMBER-OF RETN-CODE-DETAIL is an error number returned by a subsystem other than the TRANSFER delivery system or is a further qualification of an error detected by the TRANSFER delivery system. NUM-RETURNED is the number of group member names actually returned.
TISERV UOW Descriptions WHERE-SAVED WHERE-SAVED (UOW Code 121) WHERE-SAVED retrieves the names of folders containing the specified item. DEF where-saved-UOW. 02 hdr. 03 self-ident 03 uow-code 02 item-id. 03 dummy 02 prev-folder 02 num-requested END. DEF where-saved-rsp. 02 hdr. 03 self-ident 03 uow-code 02 retn-code 02 retn-code-detail 02 num-returned 02 folders-returned PIC AA VALUE "UW". TYPE BINARY 16 UNSIGNED VALUE 121. PIC X(12). PIC X(80). TYPE BINARY 16 UNSIGNED VALUE 5. PIC AA VALUE "UW".
TISERV UOW Descriptions WHERE-SAVED RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions WHERE-SAVED FOLDERS-RETURNED is an array that contains the folder names returned by TISERV. The size of this array must be consistent with the value specified in NUM-REQUESTED. The array begins with the folder that follows the folder specified in PREV-FOLDER and that contains the item. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in FOLDERS-RETURNED.
TISERV UOW Descriptions WHERE-SAVED-C20 WHERE-SAVED-C20 (UOW Code 185) WHERE-SAVED-C20 retrieves the names of private and shared folders containing a specified item. DEF where-saved-c20-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 185. 02 item-id. 03 dummy PIC X(12). 02 prev-folder PIC X(80). 02 folder-set TYPE BINARY 16 UNSIGNED VALUE 0. 02 group-name PIC X(80). 02 num-requested TYPE BINARY 16 UNSIGNED VALUE 5. END. DEF where-saved-c20-rsp. 02 hdr.
TISERV UOW Descriptions WHERE-SAVED-C20 FOLDER-SET is the set of folders to be searched for instances of the specified item. This field can have one of the following options: ALL-FOLDERS specifies that private folders owned by the correspondent and the shared folders of all the groups of which the correspondent is a member are to be searched. PRIVATE-FOLDERS specifies that only the private folders owned by the correspondent are to be searched.
TISERV UOW Descriptions WHERE-SAVED-C20 RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions WHERE-SAVED-C20 FOLDERS-RETURNED is an array that contains the folder names returned by TISERV. The size of this array must be consistent with the value specified in NUM-REQUESTED. The array begins with the folder that follows the folder specified in PREV-FOLDER and that contains the item. The TRANSFER delivery system assigns only enough space to accommodate the NUM-RETURNED elements in FOLDERS-RETURNED.
TISERV UOW Descriptions WRITE-PROFILE-REC WRITE-PROFILE-REC (UOW Code 213) WRITE-PROFILE-REC writes or updates a user-maintained depot profile record. DEF write-profile-rec-uow. 02 hdr. 03 self-ident PIC AA VALUE "UW". 03 uow-code TYPE BINARY 16 UNSIGNED VALUE 213. 02 corr-name PIC X(80) VALUE SPACES. 02 group-name REDEFINES corr-name. 02 rec-type PIC 9(4) COMP. 02 rec-seq PIC 9(4) COMP. 02 depot-flag TYPE BOOLEAN VALUE "Y". 02 filler TYPE CHARACTER 1. 02 update-control PIC S9(4) COMP.
TISERV UOW Descriptions WRITE-PROFILE-REC REC-TYPE is the type assigned to the record by your application. The value in this field must be greater than 799. Values 800 through 999 are reserved for use by Tandem. Values 1000 through 9999 are available for customer use. REC-SEQ is the sequence number to be assigned to the record. The number can range from 1 through 9999. DEPOT-FLAG determines whether the UOW references a depot profile record or a system control record.
TISERV UOW Descriptions WRITE-PROFILE-REC NUM-DATA is the number of bytes written by TISERV. This entry can have a maximum value of 1500. PROFILE-DATA is the array that contains the new record to be written or the update information for an existing record. You can modify the array size within the system limitation of 1500 bytes. RETN-CODE is the return code. TISERV returns a code in this field to indicate one of the following entries.
TISERV UOW Descriptions WRITE-PROFILE-REC WRITE-PROFILE-REC Operation WRITE-PROFILE-REC writes or updates a user-maintained record in the depot Profile file. The UOW must start on a word boundary. Each response consumes a whole number of words of the IPC reply. To update a record, you supply the update counter for that record in the UPDATECONTROL field.
3 Error Codes Overview Error Code Fields This section describes the types of error codes that your process can receive from the TRANSFER delivery system. Error codes can be returned to a TRANSFER application process in the interprocess communication (IPC) header, in the UOW header, and in responses to certain UOWs. This section lists and explains all error codes that can be returned to a TRANSFER application process. Table 3-1 lists error code fields and the locations of the error code fields. Table 3-1.
Error Codes IPC-RETN-CODE-DETAIL Errors IPC-RETN-CODE-DETAIL Errors RETN-CODE Errors A value other than 0 in the IPC-RETN-CODE-DETAIL field of the IPC header indicates that, although the data in the IPC header was correct, an error was detected by the GUARDIAN 90 operating system. The meaning of this error also depends upon the content of the IPC-RETN-CODE field. For information about these particular errors, refer to the GUARDIAN 90 Operating System Programmer's Guide.
Error Codes RETN-CODE-DETAIL Errors All UOW code numbers that are passed to the TRANSFER delivery system by your application and that are not explicitly listed in this appendix return one of these errors to the RETN-CODE field: E-INVALID-UOW-HDR—a request error. The UOW code is undefined in the system. E-RESTRICTED-OPERATION—a UOW error. The UOW is reserved for use by TAREQ processes. E-UOW-NOT-IMPLEMENTED—a UOW error. The code is reserved for a UOW that is not yet implemented.
Error Codes MBR-RETN-CODE Errors Table 3-4. Errors in DATE-TIME Subfields Error Value Returned in RETN-CODE-DETAIL DATE-TIME Subfield Containing the Error 1 2 3 4 5 6 YEAR MONTH DAY-OF-MONTH HOUR MINUTE SECOND MBR-RETN-CODE Errors The MBR-RETN-CODE field of the ADD-MEMBER and DELETE-MEMBER UOWs can contain error codes numbered from 5650 through 5674. ELEM-RETN-CODE Errors Error codes can sometimes be returned in the responses to the ALTER-PROFILEELEM and GET-PROFILE-ELEM UOWs.
Error Codes GUARDIAN 90 File Codes GUARDIAN 90 File Codes GUARDIAN 90 file codes can be returned in some error code fields. These codes indicate which the TRANSFER delivery system received the error. File codes are listed and identified in Table 3-5. Table 3-5.
Error Codes Summary of Error Codes—Error 1 Summary of Error Codes The rest of this section lists errors reported by the TRANSFER delivery system in ascending numeric order, including: The error number associated with each error and the field in which the error is reported (indicated in parentheses) The mnemonic text that describes the error and the specific meaning of the error Error code text begins with E. Warning code text begins with W.
Error Codes Summary of Error Codes—Error 5 2 INVALID-SESSION-ID Field. IPC-RETN-CODE Meaning. The request contained a session ID that could not be recognized by the TRANSFER delivery system. Perhaps the IPC referenced a session that no longer existed. 3 RQST-ERR Field. PW-REPLY-CODE Meaning. A request error occurred. This type of error indicates that something was wrong in the data in the IPC header, and that the error probably does not apply to any particular UOW.
Error Codes Summary of Error Codes—Error 6 Meaning. The request was too long to be handled by TISERV. (The TISERV parameter MAXREQUEST specifies the size of the largest request that TISERV can process.) 6 REPLY-TOO-LONG Field. IPC-RETN-CODE Meaning. The reply from the server was too long to fit into the allocated reply buffer. 7 RQST-TOO-SHORT Field. IPC-RETN-CODE Meaning. The request was too short; it contained fewer UOWs than the number specified in the UOWS-TO-PROCESS field.
Error Codes Summary of Error Codes—Error 4013 4005 E-CONCURRENT-SESSION W-CONCURRENT-SESSION Field. RETN-CODE Meaning. Your application attempted to start a session for a correspondent (with the START-SESSION UOW) while another session was already in progress for the same correspondent. This can be either an error or a warning message, depending on the configuration of the depot. 4007 E-LOGON-DISALLOWED Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4015 4015 E-INVALID-PASSWORD Field. RETN-CODE Meaning. Your process attempted to start a session for a correspondent who entered an invalid password. 4017 E-RESTRICTED-OPERATION Field. RETN-CODE Meaning. Your process issued a UOW that should only be issued by the TRANSFER delivery system. 4019 E-ALREADY-IN-SESSION Field. RETN-CODE Meaning. Your process issued a START-SESSION UOW without first resetting the session ID in the IPC header.
Error Codes Summary of Error Codes—Error 4040 Meaning. Your process referenced an item that was not saved in any of your folders, created by you in the current session, or returned by the TRANSFER delivery system in response to a GET-ITEM-COMPNT-A01 UOW in the current session. 4036 E-ITEM-TOO-COMPLEX Field. RETN-CODE Meaning. Your process issued an ATTACH-COMPNT or SUBMIT-PKG UOW for an item that involved too many levels of nesting. Restructure the item to include fewer levels, and retry the request.
Error Codes Summary of Error Codes—Error 4041 Meaning. Your process attempted to attach a component (ATTACH-COMPNT-A01 UOW), detach a component (DETACH-COMPNT UOW), retrieve a component (GETITEM-COMPNT-A01 UOW), or post a package (SUBMIT-PKG UOW); but the TRANSFER delivery system detected an internal inconsistency for the referenced item in its descriptor. 4041 E-ITEM-UNALTERABLE Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4050 Meaning. TSCHED was unavailable for posting or canceling a package or acknowledging its receipt. TISERV will attempt to schedule the services without using TSCHED. If TISERV succeeds, only the warning is returned; otherwise, the error is returned.
Error Codes Summary of Error Codes—Error 4051 4051 E-MUST-BE-YN W-MUST-BE-YN Field. RETN-CODE Meaning. Your process attempted to set a flag in the TRANSFER database to a value other than Y, N, y, or n. 4052 E-RESERVED-MUST-BE-N Field. RETN-CODE Meaning. Your process tried to set a TRANSFER database flag that is reserved for future use by the TRANSFER delivery system. Such flags are initialized to N, and must remain at this setting. 4053 E-COPY-ITEM-DISALLOWED Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4062 4056 E-INVALID-ITEM-TYPE Field. RETN-CODE Meaning. Your process entered an item type value that was outside the range of 0 through 9999. 4057 E-INVALID-REL-POSITION Field. RETN-CODE Meaning. While attaching, detaching, or retrieving a component item (with the ATTACH-COMPNT, DETACH-COMPNT, or GET-ITEM-COMPNT UOWs, respectively), your process specified a relative position for the item within the component list that was out of range.
Error Codes Summary of Error Codes—Error 4063 4063 W-ITEM-NOT-RETURNED Field. RETN-CODE Meaning. The ITEM-NUMBER in your item handle was greater than the number of items that were returned. 4065 E-INVALID-RECIP-TYPE Field. RETN-CODE Meaning. In the ADD-RECIP UOW, your process specified a recipient type that was not within the range of 0 through 9999. 4067 W-REMOTE-NAME-ACCEPTED Field. RETN-CODE Meaning. Your process specified a correspondent or distribution list supposedly defined at a remote node.
Error Codes Summary of Error Codes—Error 4078 4072 E-UNITS-MUST-BE-DHM Field. RETN-CODE Meaning. Your process specified a unit of time, as in a delivery date, but did not specify D (for day), H (for hour), or M (for minute) in the UNITS field. (To enter 0 as a quantity of time, type 0 in the QUANTITY field and D, H, or M in the UNITS field; this unit of time will always be output as 0 D.) 4073 E-INVALID-DATE-TIME Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4079 Meaning. Your process specified a delivery priority for a package that was outside the range of 0 through 199. 4079 W-PRIORITY-REDUCED Field. RETN-CODE Meaning. In a request to post a package (SUBMIT-PKG UOW), your process submitted a package with a priority that was too high, and the TRANSFER delivery system reduced it to the value defined as the limit for the depot. 4080 E-PKG-NOT-RECEIVED Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4090 4084 E-PKG-NOT-SUBMITTED Field. RETN-CODE Meaning. A correspondent tried to cancel a package that was not submitted. 4085 E-DATA-TOO-LONG Field. RETN-CODE Meaning. Your process tried to add a record to an item (with the ADD-ITEM-REC UOW), but the record exceeded the maximum allowed length of 2000 bytes. 4086 W-DATASIZE-ADJUSTED Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4092 4092 E-INVALID-NUM-RQSTD Field. RETN-CODE Meaning. Your process specified 0 or a negative value for the NUM-REQUESTED field of a UOW. 4093 E-SECURITY-VIOLATION Field. RETN-CODE Meaning. Your process tried to access or modify a data element that can only be accessed by the depot owner or a system administrator. 4094 E-PKG-CANCELED Field. RETN-CODE Meaning. Your process attempted to acknowledge receipt of a package whose delivery has been canceled.
Error Codes Summary of Error Codes—Error 4105 Meaning. An item was retrieved, but the corresponding ordering key was longer than the buffer space allocated for the ordering key in the response. The ordering key was truncated. 4101 W-MAX-KEY-LEN-ADJUSTED Field. RETN-CODE Meaning. Your process specified an odd number for MAX-KEY-LEN. You should specify an even number for this value so that all elements of the returned array are word aligned.
Error Codes Summary of Error Codes—Error 4106 Meaning. Your process attempted to access a folder that was being updated at the same time. Either the folder was being deleted or the folder order was being altered. Caution 4106 If the UOW requires a TMF transaction, your process must issue an ABORT-TRANSACTION statement, or the folder might become inconsistent. E-BAD-ORD-CRITERIA Field. RETN-CODE Meaning. The ordering criteria for the folder is invalid. Report this error to your Tandem representative.
Error Codes Summary of Error Codes—Error 4123 Meaning. Your process specified a primary external object as a parent, but this object could not be found or was not accessible to the correspondent. 4118 E-EXTOBJ-NOT-FOUND Field. RETN-CODE Meaning. Your process specified, in a UOW, an external object that could not be found. 4119 E-EXTOBJ-ERR Field. RETN-CODE Meaning. An error occurred while the TRANSFER delivery system was attempting to operate on the external object specified.
Error Codes Summary of Error Codes—Error 4124 Meaning. Your process attempted to attach a partition of a partitioned file as a primary or an alternate attachment. 4124 E-INVALID-OBJECT-TYPE Field. RETN-CODE Meaning. Your process specified an external object of a type that the TRANSFER delivery system does not support; the only currently authorized type is indicated by the value 1 in the OBJECT-TYPE field, denoting a GUARDIAN 90 file. 4125 E-TOO-MANY-ATTACHMENTS Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4133 both set to N). However, primary external objects can only have alternate external objects as attachments. 4129 E-PRIMARY-EXTOBJ Field. RETN-CODE Meaning. Your process issued a UOW intended to return an item ID, but the UOW was passed the object ID of a primary external object instead. 4130 E-ALTERNATE-EXTOBJ Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4134 4134 E-FUP-ERROR Field. RETN-CODE-DETAIL Meaning. The File Utility Program (FUP) failed while duplicating a file, but did not report an error number. 4135 E-INVALID-REC-NUM Field. RETN-CODE Meaning. The GET-ITEM-REC-B40 UOW transmitted a value of less than -1 in the EXTOBJ-REC-NUM field. 4136 W-INVALID-CMAP-ID Field. RETN-CODE Meaning. In the ALTER-ITEM-DES-B40 UOW, the CODE-PAGE-ID subfield of the CHAR-MAP-ID field contained a value other than 65300.
Error Codes Summary of Error Codes—Error 4164 4152 W-AMBIGUOUS-ITEM-NAME Field. RETN-CODE Meaning. Your process supplied an abbreviated item name that was ambiguous to the TRANSFER delivery system. An abbreviation must resolve to one unique name. Further qualify your abbreviation with additional characters, and try the operation again. 4153 E-INVALID-MATCH-LEN Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4165 4165 E-NOT-X400-ITEM Field. RETN-CODE Meaning. The value for the ORIG-TYPE field of the GET-X400-ORIG UOW is 100 or 101, but the item specified did not originate from a foreign X.400 user; the X400-ORIG flag in ITEM-DESCR-FLAGS is set to N. 4166 W-X400-NAMES Field. RETN-CODE Meaning. The item or distribution list requested with the GET-RECIP-REC, GETRECIP-REC-C20, GET-AUX-NAME, or READ-NEXT-MEMBER UOWs also has X.400 names associated with it.
Error Codes Summary of Error Codes—Error 4174 4171 E-INVALID-IMPORTANCE Field. RETN-CODE Meaning. The value specified for the IMPORTANCE field of the ALTER-ITEM-DESC20 UOW is not in the range from 0 through 9999. 4172 E-INVALID-SENSITIVITY Field. RETN-CODE Meaning. The value specified for the SENSITIVITY field of the ALTER-ITEM-DES-C20 UOW is not in the range 0 through 9999. 4173 E-NOT-SAME-DOMAIN Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4175 4175 E-X400-NOT-CONFIGURED Field. RETN-CODE Meaning. Your process requested an X400 function, but the X400-CONFIGURED flag in the configuration directory is set to N. The X400-CONFIGURED flag can contain the value Y on C30 or later versions of the TRANSFER delivery system: If a node is grouped into a domain, the flag is set to Y. If a node is not grouped into a domain, the flag is set to N.
Error Codes Summary of Error Codes—Error 4213 4207 E-MODEL-NOT-GROUP Field. RETN-CODE Meaning. The model group specified is a correspondent depot, not a group depot. 4208 E-CORR-BLANK Field. RETN-CODE Meaning. Your process attempted to add a new correspondent, but left the CORRNAME field blank. 4209 E-INVALID-IDENTIFIER Field. ELEM-RETN-CODE Meaning. A request to obtain or update profile data elements included an identifier that the TRANSFER delivery system could not recognize.
Error Codes Summary of Error Codes—Error 4214 4214 E-INVALID-AGENT-NAME Field. RETN-CODE Meaning. In the ALTER-AGENT-SELECT UOW, your process specified an invalid agent name. For instance, the name might have contained embedded blanks or special characters not valid in a SCREEN COBOL program name. 4218 W-CONTENTS-PURGED Field. RETN-CODE Meaning. Your process attempted to delete (with the DELETE-FOLDER UOW) either the INBOX or WASTEBASKET folder.
Error Codes Summary of Error Codes—Error 4231 4222 E-CANNOT CHANGE TO CONTEXT OF SPECIFIED CORRESPONDENT Field. RETN-CODE Meaning. The CORR-NAME field of the UOW directed that TISERV do the operation as the specified correspondent, but TISERV could not change to the context of that correspondent. The detailed error code at the right of the error message contains additional information. 4225 E-MEMBERS-EXIST Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4232 4232 E-INVALID-AGENT-TYPE Field. RETN-CODE Meaning. Your process attempted to set an AGENT-TYPE flag to a value other than Y or N. 4237 E-INVALID-GUARD-NAME Field. RETN-CODE Meaning. Your process attempted to reference a file with an invalid GUARDIAN 90 file name. 4238 E-TFER-PROFILE-ABSENT Field. RETN-CODE Meaning. Your process referenced a correspondent for whom no TRANSFER profile record was present.
Error Codes Summary of Error Codes—Error 4250 4241 E-TFER-CTL-REC-ABSENT Field. RETN-CODE Meaning. The TRANSFER delivery system could not locate a required system control record. Call your Tandem representative. 4244 E-ERR Field. RETN-CODE Meaning. The TRANSFER group profile for the current group is missing. 4247 E-GROUP-MBR-NOT-FOUND Field. RETN-CODE Meaning. You attempted to delete a member from a group, but the name is not a member of that group. 4248 E-GROUP-MBR-EXISTS Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4253 4253 E-PUBDL-ALREADY-EXISTS Field. RETN-CODE Meaning. A PUBLIC distribution list with the specified name already exists. The set of PUBLIC distribution list names, correspondent names, and interest group names on the local node must be unique. 4254 E-GROUP-IS-PUBLIC Field. RETN-CODE Meaning. You attempted to perform an operation (such as deleting the group) not permitted on the PUBLIC depot. 4255 E-GRP-MEMBERS-EXIST Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4267 4259 E-MBR-NOT-SAME-NODE Field. RETN-CODE Meaning. You specified a remote name as a member of a local group. Group members must be local with respect to the group. 4260 E-MBR-NOT-DIRECT Field. RETN-CODE Meaning. You requested an operation that can be performed only on a direct group member. (You cannot perform the operation on a member of a nested group.) 4262 E-DL-MBR-NOT-GROUP-MBR Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4268 4268 E-SPECIAL-FLD Field. RETN-CODE Meaning. Your process attempted to alter the ordering criteria of the INBOX, OUTLOG, or WASTEBASKET to values invalid for a special folder. A special folder cannot have an APPLIC-DEFINED ordering discipline and must allow duplicate ordering keys. 4269 W-TIME-TOO-LONG Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4303 4278 E-REQ-PARAM-MISSING Field. RETN-CODE Meaning. A required parameter was not supplied. This error indicates an error in the coding of the client and should not be visible to the user. 4279 E-INVALID-SHARING-DIS Field. RETN-CODE Meaning. The sharing discipline specified in the CREATE-FOLDER-C20 or CREATEDLIST-C20 UOW is invalid. 4300 E-PASSWORD-MATCH-FAIL Field. ELEM-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4304 4304 E-INVALID-GUARDIAN-ID Field. ELEM-RETN-CODE Meaning. Your process specified a blank or invalid GUARDIAN-ID, or an invalid password. Enter a valid GUARDIAN-ID (which can be NONE) or password. This is a detailed identifier error, accompanied by UOW error 4210. 4305 E-INVALID-FILENAME Field. ELEM-RETN-CODE Meaning. In an ALTER-PROFILE-ELEM UOW, your process specified an invalid GUARDIAN 90 file name. Enter a name that is acceptable to GUARDIAN 90.
Error Codes Summary of Error Codes—Error 4315 4310 E-PRIORITY-SEQUENCE Field. ELEM-RETN-CODE Meaning. Your process specified priority numbers that were not in logical sequence (LOW greater than HIGH, for example). This is a detailed identifier error, accompanied by UOW error 4210. 4311 E-INVALID-EDITOR Field. ELEM-RETN-CODE Meaning. Your process specified an invalid text editor file name. 4312 E-LANGUAGE-INVALID Field. ELEM-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4381 4381 E-DISK-DOES-NOT-EXIST Field. ELEM-RETN-CODE Meaning. Your process referenced the name of a disk that does not exist. This is a detailed identifier error, accompanied by UOW error 4210. 4382 E-MUST-BE-SLT Field. ELEM-RETN-CODE Meaning. Your process tried to set the MESSAGE-SEQUENCE flag to a value other than S, L, or T. This is a detailed identifier error, accompanied by UOW error 4210. 4383 E-MUST-BE-TCN Field. ELEM-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4601 4391 E-MUST-BE-IS Field. ELEM-RETN-CODE Meaning. Your process tried to set to another value a flag that can only be set to I or S. This is a detailed identifier error, accompanied by UOW error 4210. 4392 E-MUST-BE-DISK Field. ELEM-RETN-CODE Meaning. Your process supplied the name of a nondisk file (such as a process or printer name) where a disk file name was required. This is a detailed identifier error, accompanied by UOW error 4210.
Error Codes Summary of Error Codes—Error 4602 4602 E-XPORT-FAILED Field. DELIV-ERR in Recip Record Meaning. The TAREQ could not transport the package to this recipient, probably because the package was nested too deeply. 4603 E-TOO-LATE-TO-XPORT Field. DELIV-ERR in Recip Record Meaning. The TAREQ could not transport the package to this recipient because the delivery window closed. In some cases, this situation could result in multiple instances of a TAREQ event package.
Error Codes Summary of Error Codes—Error 4613 4608 E-TOO-LATE-TO-DELIV Field. DELIV-ERR in Recip Record Meaning. The TAREQ could not deliver the package to a recipient before the delivery window closed. 4609 E-INCONSISTENT-RECIP Field. DELIV-ERR in Recip Record Meaning. In the recipient record, inconsistent record types have been recorded. Call your Tandem Representative. Note 4610 Errors 4610 through 4622 reflect errors passed between TRANSFER asynchronous processing components.
Error Codes Summary of Error Codes—Error 4614 4614 E-ASYNC-BAD-SEQUENCE Meaning. The component receiving an interprocess message determined from its function that the sender of the message was not in the state that the receiver anticipated. The components will synchronize themselves. 4615 W-ASYNC-PRE-TRECV Meaning. A remote TRANSFER system is running, but its TSCHED does not know how to handle a request to have a TRECV assigned.
Error Codes Summary of Error Codes—Error 4625 4620 E-ASYNC-INVALID-SEQNO Meaning. The synchronization between two components has become confused. The components will correct the situation. 4621 E-ASYNC-BAD-PASSWORD Meaning. A component supplied the wrong password and cannot start its own session. The component will get a corrected password and try again to start the session. This error can occur because some components use computed rather than stored passwords. 4622 E-ASYNC-WRONG-REV Meaning.
Error Codes Summary of Error Codes—Error 4626 4626 E-ASYNC-CHAR-SET-NOT-SUPP Meaning. Your process attempted to transport an item to a node running a version of the TRANSFER delivery system prior to B40. The CHAR-MAP-ID setting for the item did not match the SYSTEM-CHAR-MAP-ID setting. 64627 E-ASYNC-CAN'T-CONVERT-NAME Meaning.
Error Codes Summary of Error Codes—Error 4912 4904 E-ERR-SESSION-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning. An error occurred on the file named SESSION, which defines all of the currently active sessions. 4906 E-ERR-ITEMDESC-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning. An error occurred on the file named ITEMDESC, which contains the item descriptors for all items and packages defined for the node, and for all packages received from other nodes. 4908 E-ERR-ITEMDATA-FILE Field.
Error Codes Summary of Error Codes—Error 4914 4914 E-ERR-DLIST-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning. An error occurred on the file named DLIST, which contains the names of members of distribution lists defined at the node. 4916 E-ERR-READY-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning. An error occurred on the file named READY, which contains the TISERV scheduler ready queue. (Each record in this file represents a task ready for assignment to an asynchronous requester.
Error Codes Summary of Error Codes—Error 4931 4924 E-ERR-QUEUE-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning. An error occurred on the queue file. IPC-RETN-CODE-DETAIL contains the file code of the file on which the error occurred. If you receive this error and the request was issued under a TMF transaction, you must abort the TMF transaction; you should then retry the request under a new transaction. 4926 E-ERR-IATTACH-FILE Field. IPC-RETN-CODE, RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 4932 4932 E-ERR-BLOCKED-FILE Field. RETN-CODE Meaning. An error occurred during an I/O operation on a TRANSFER blocked file. The RETN-CODE-DETAIL field contains the GUARDIAN 90 error code describing the problem. Also, a diagnostic message in the TISERV OUT file gives the details of the problem and the name of the file involved. 4939 E-X400NAME-FILE Field. RETN-CODE Meaning. An error occurred involving the X400NAME file.
Error Codes Summary of Error Codes—Error 5300 4944 E-ERR-DEPSTAT-FILE Field. RETN-CODE Meaning. Your process attempted to access the DEPSTAT file, on which the GUARDIAN 90 operating system detected an error. 4945 E-ERR-DEPSTATO-FILE Field. RETN-CODE Meaning. Your process attempted to access the DEPSTATO file, and GUARDIAN 90 returned an error. 4980 E-WRONG-GUARDIAN-USERID Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5450 5450 E-DATA-NSVR-ERR Field. RETN-CODE Meaning. The name server encountered an error while processing a TRANSFER internal data name. The RETN-CODE-DETAIL field contains a specific GUARDIAN 90 or name server error code describing the problem. 5451 E-DATA-NOT-FOUND Field. RETN-CODE Meaning. The name server could not locate a TRANSFER internal data name. 5452 E-DATA-BAD-NAME Field. RETN-CODE Meaning. A TRANSFER internal data name contains a syntax error.
Error Codes Summary of Error Codes—Error 5602 5459 E-DATA-NOT-EMPTY Field. RETN-CODE Meaning. The TRANSFER delivery system tried to delete an internal data name on behalf of your process but failed because the name was still in use. 5461 E-DATA-NET-DOWN Field. RETN-CODE Meaning. Your process required the TRANSFER delivery system to access an internal data name on another node but the required node was not available. 5462 E-DATA-ALREADY-EXISTS Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5603 5603 E-CORR-BAD-TYPE Field. RETN-CODE Meaning. Your process referenced a correspondent name and the name was located by the TRANSFER delivery system, but it was not of type CORRESPONDENT. 5604 E-CORR-NO-SUCH-NODE Field. RETN-CODE Meaning. The node referenced by your process either does not exist, or was specified with an invalid name. This condition is analogous to placing a telephone call to an area code that does not exist. 5605 E-CORR-SECURITY Field.
Error Codes Summary of Error Codes—Error 5624 5609 E-CORR-NOT-EMPTY Field. RETN-CODE Meaning. This error reflects a problem with the name directory. Call your Tandem representative. 5611 E-CORR-NET-DOWN Field. RETN-CODE Meaning. Processing of a correspondent or recipient name required access to names at other nodes, but the network was down. This condition is analogous to placing a telephone call to a number that is either disconnected or busy. 5612 E-CORR-ALREADY-EXISTS Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5625 5625 E-DLIST-NSRV-ERR Field. RETN-CODE Meaning. The name server encountered an error while processing a distribution list. The RETN-CODE-DETAIL field contains the GUARDIAN 90 file error code describing the problem. 5626 E-DLIST-NOT-FOUND Field. RETN-CODE Meaning. The name server could not locate the distribution list referenced by your process. Either the list does not exist, or an improper name was supplied. 5627 E-DLIST-BAD-NAME Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5636 5631 E-DLIST-NSRV-NOT-FOUND Field. RETN-CODE Meaning. The TRANSFER delivery system could not locate the distribution list's name server. 5632 E-DLIST-NSRV-DOWN Field. RETN-CODE Meaning. The distribution list's name server was not operating correctly. The RETNCODE-DETAIL field contains the GUARDIAN 90 file error code describing the problem. 5633 E-DLIST-NO-PARENT Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5637 5637 E-DLIST-ALREADY-EXISTS Field. RETN-CODE Meaning. Your process tried to create a distribution list (with the CREATE-DLIST UOW) using a name that was already in use for a distribution list or folder in your depot. The distribution list was not created. 5647 E-DLIST-NOT-SAME-NODE Field. RETN-CODE Meaning. Your process requested an operation on a distribution list defined at another node, but the operation is restricted to distribution lists at your node.
Error Codes Summary of Error Codes—Error 5656 correspondent did not exist in the system, or your process supplied an invalid correspondent name. 5652 E-MBR-BAD-NAME Field. MBR-RETN-CODE Meaning. Your process attempted to add a member (ADD-MEMBER UOW) or delete a member (DELETE-MEMBER UOW) of a distribution list, and you specified either an invalid correspondent name or a blank one. The name might have contained embedded blanks or illegal characters. 5653 E-MBR-BAD-TYPE Field. MBR-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5657 node. Wait until the node becomes available, and then attempt to add or delete the name again. 5657 E-MBR-NSRV-DOWN Field. MBR-RETN-CODE Meaning. Your process tried to add a member to a distribution list (ADD-MEMBER UOW), but the distribution list member's name server was not operating correctly. 5658 E-MBR-NO-PARENT Field. MBR-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5678 5673 E-MBR-AMBIGUOUS-NAME Field. MBR-RETN-CODE Meaning. In a request to add or delete a member on a distribution list (ADD-MEMBER or DELETE-MEMBER UOW), your process entered the name of a member containing a wild-card character, but more characters are needed to make the name unique. 5674 E-MBR-BAD-SUFFIX Field. MBR-RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5679 Meaning. Your process entered a folder name and the name server located that name, but the name represented an object other than a folder. 5679 E-FLD-NO-SUCH-NODE Field. RETN-CODE Meaning. Your process specified a folder with a node name that either was invalid or that referenced a nonexistent node. 5680 E-FLD-SECURITY Field. RETN-CODE Meaning. A security violation occurred in a reference to a folder. 5681 E-FLD-NSRV-NOT-FOUND Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5701 5686 E-FLD-NET-DOWN Field. RETN-CODE Meaning. Processing of a folder name required access to names at other nodes, but the network was down. 5687 E-FLD-ALREADY-EXISTS Field. RETN-CODE Meaning. Your process tried to create a folder and used a name that was already in use for a folder or distribution list in your depot. The folder was not created. 5697 E-FLD-NOT-SAME-NODE Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5702 5702 E-ALIAS-BAD-NAME Field. RETN-CODE Meaning. The name server could not locate the name specified in the GET-CONFIGNAME UOW. 5703 E-ALIAS-BAD-TYPE Field. RETN-CODE Meaning. Your process referenced a name in the GET-CONFIG-NAME UOW and the name server located that name, but the name represented an object of a type not valid for the context in which it was referenced. 5704 E-ALIAS-NO-SUCH-NODE Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5723 Meaning. The name server for an object referenced by the GET-CONFIG-NAME UOW was not operating correctly. The RETN-CODE-DETAIL field contains the GUARDIAN 90 file error describing the problem. 5708 E-ALIAS-NO-PARENT Field. RETN-CODE Meaning. A system error occurred. Call your Tandem representative. 5709 E-ALIAS-NOT-EMPTY Field. RETN-CODE Meaning. A system error occurred. Call your Tandem Representative. 5710 E-ALIAS-ALIAS Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5725 Meaning. The GET-CONFIG-NAME UOW referenced a name containing a wild-card character, but more characters are needed to make the name unique. 5725 E-MODEL-NSRV-ERR Field. RETN-CODE Meaning. The name server encountered an error while processing a model name. The RETN-CODE-DETAIL field contains the GUARDIAN 90 file error code describing the problem. 5726 E-MODEL-NOT-FOUND Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5736 5730 E-MODEL-SECURITY Field. RETN-CODE Meaning. A security violation occurred in a reference to a model depot. 5731 E-MODEL-NSRV-NOT-FOUND Field. RETN-CODE Meaning. Your process entered a CREATE-DEPOT UOW, but the TRANSFER delivery system could not locate the model depot's name server. 5732 E-MODEL-NSRV-DOWN Field. RETN-CODE Meaning. Your process entered a CREATE-DEPOT UOW, but the model depot's name server was not operating correctly.
Error Codes Summary of Error Codes—Error 5737 5737 E-MODEL-ALREADY-EXISTS Field. RETN-CODE Meaning. A system error occurred. Call your Tandem representative. 5747 E-MODEL-NOT-SAME-NODE Field. RETN-CODE Meaning. In a CREATE-DEPOT UOW, your process referenced a model depot located at another node. 5748 E-MODEL-AMBIGUOUS-NAME Field. RETN-CODE Meaning. In a CREATE-DEPOT UOW, your process referenced a model depot name containing a wild-card character, but more characters are needed to make the name unique.
Error Codes Summary of Error Codes—Error 5756 5751 E-RECIP-NOT-FOUND Field. RETN-CODE Meaning. The name server could not locate the recipient referenced by your process. Either the list does not exist, or an improper name was supplied. 5752 E-RECIP-BAD-NAME Field. RETN-CODE Meaning. Your process entered either an invalid recipient name or a blank one. The name, for instance, might have contained embedded blanks or illegal characters, or might have been too long. 5753 E-RECIP-BAD-TYPE Field.
Error Codes Summary of Error Codes—Error 5757 5757 E-RECIP-NSRV-DOWN Field. RETN-CODE Meaning. The recipient's name server was not operating correctly. The RETN-CODEDETAIL field contains the GUARDIAN 90 file error code describing the problem. 5758 E-RECIP-NO-PARENT Field. RETN-CODE Meaning. A system error occurred. Call your Tandem representative. 5759 E-RECIP-NOT-EMPTY Field. RETN-CODE Meaning. A system error occurred. Call your Tandem representative. 5761 E-RECIP-NET-DOWN Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5780 5774 E-RECIP-BAD-SUFFIX Field. RETN-CODE Meaning. Your process specified a recipient name with an improper suffix. Perhaps the parentheses were not balanced, or the name contained illegal characters. 5775 E-GROUP-NSRV-ERR Field. RETN-CODE Meaning. A name processing error occurred on an interest group name. 5776 E-GROUP-NOT-FOUND Field. RETN-CODE Meaning. The interest group specified does not exist. 5777 E-GROUP-BAD-NAME Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 5781 Meaning. A security violation occurred on the interest group name. 5781 E-GROUP-NSRV-NOT-FOUND Field. RETN-CODE Meaning. The name processor for the interest group was not found. 5782 E-GROUP-NSRV-DOWN Field. RETN-CODE Meaning. The name processor for the interest group is down. 5783 E-GROUP-NO-PARENT Field. RETN-CODE Meaning. The interest group has no parent directory entry. The root directory for the group name specified is missing.
Error Codes Summary of Error Codes—Error 5810 5798 E-GROUP-AMBIGUOUS-NAME Field. RETN-CODE Meaning. An error occurred because an abbreviation specified for an interest group name does not uniquely identify a single group. 5800 E-TEXT-SERVICE Field. IPC-RETN-CODE, RETN-CODE Meaning. The TRANSFER Text Facility could not establish the language and character map information required to support the request. More details appear in IPC-RETNCODE-DETAIL or RETN-CODE-DETAIL. 5801 E-CHAR-MAP-NOT-FOUND Field.
Error Codes Summary of Error Codes—Error 6001 6001 W-QUEUE-EMPTY Field. RETN-CODE Meaning. This error is returned by DEQ. There are no entries on the Queue file for the specified QUEUE-NAME. 6002 E-TOO-MANY-WAITERS Field. RETN-CODE Meaning. This error is returned by WAITQ. The Wait Manager cannot handle additional waiting requesters. The Wait Manager should be configured with a larger value for the MAXWAITERS parameters. 6003 E-INVALID-WAITPRIORITY Field. RETN-CODE Meaning.
Error Codes Summary of Error Codes—Error 6118 6005 W-WAIT-TIMEOUT Field. RETN-CODE Meaning. This error is returned by WAITQ. The WAITQ UOW has been responded to because of elapsed time, not because of a new entry on the Queue file. 6006 E-WAITMANAGER-UNAVAIL Field. IPC-RETN-CODE, RETN-CODE Meaning. This error is returned by ENQ. There is an error in communicating with the Wait Manager.
Error Codes Summary of Error Codes—Error 6119 6119 E-DSF-NOT-READY Meaning. You requested storage statistics that are not yet available. The depot statistics facility is currently calculating these statistics. 6120 E-NO-STATS-PARAMS Meaning. The configuration parameters you requested do not exist. 6121 E-INVALID-STATS-STATE Meaning. An invalid value was supplied for setting up the depot statistics facility.
Error Codes Summary of Error Codes—Error 6136 6125 E-INVALID-START-TIME Meaning. You specified an invalid START TIME. 6127 E-DSF-BAD-TIMESTAMP Meaning. During calculation of statistics, the depot statistics facility detected an invalid date and time, either because the system date and/or time is wrong or because the date and/or time was previously set wrong and was used during the collection of statistics. Report this error to your system manager.
Error Codes Summary of Error Codes—Error 6137 6137 E-NO-STATS-FOR-DEPOT Meaning. The error occurred because of either of the following reasons: Statistics were requested for a depot that has been excluded from statistics collections. Statistics were requested from the previous file when the depot was not part of the TRANSFER delivery system. Note 6138 If statistics from the current file are being requested and the depot has not been excluded, you should report this error to your Tandem representative.
Appendix A UOWs Listed in Numeric Order Table A-1 lists all TISERV UOWs in numerical order, giving the decimal, octal, and hexadecimal UOW codes for each. The TRANSFER delivery system can maintain a debug log file that contains a history of UOW activity. In a debug log file, individual UOWs are referenced by UOW number rather than by name. For more information about the debug log file, see the TRANSFER Installation and Management Guide. Table A-1.
UOWs Listed in Numeric Order Table A-1.
UOWs Listed in Numeric Order Table A-1.
Appendix B Status Packages The TRANSFER TAREQ process generates status packages for certain events that can occur during delivery of a package. Status packages provide error or status information and include the actual package that triggered the event. The application ID for packages generated byTRANSFER is always TAREQ (100). The agent selector value indicates the event that triggered the package, as entered in the AGENT-SELECTOR field of the agent notification message.
Status Packages Event Packages 1-17 Figure B-1 shows the format for TAREQ event packages 1-17. Figure B-1.
Status Packages Event Packages 1-17 Figure B-2.
Status Packages Event Packages 1-17 Events 1-17 are these: B–4 1 TRANSFER SYSTEM ERROR 2 RECIPIENT HAS EXAMINED CERTIFIED PACKAGE 3 PACKAGE HAS INVALID RECIPIENT 4 PACKAGE HAS DISTRIBUTION LIST WITH INVALID RECIPIENT 5 AGENT COULD NOT BE INVOKED 6 PACKAGE COULD NOT BE DELIVERED TO RECIPIENT IN TIME 7 RECIPIENT DID NOT EXAMINE PACKAGE BEFORE IT EXPIRED 8 RECIPIENT HAS ALREADY EXAMINED CANCELED PACKAGE 9 SENDER CANCELED PACKAGE AFTER YOU EXAMINED IT 10 PACKAGE CANNOT BE TRANSPORTED TO RE
Status Packages Event Packages 1-17 12 AGENT HAS LOGGED AN ERROR 13 TRANSPORT FAILED. node DOES NOT SUPPORT EXTERNAL OBJECTS 14 TRANSPORT FAILED. EXTERNAL OBJECTS DISABLED AT node 15 TRANSPORT FAILED.
Status Packages Event Packages Numbered 22 and Higher Event Packages TAREQ event packages numbered 22 and higher have various formats. Figure B-3 Numbered 22 and shows the general format of these event packages. These packages contain additional Higher records, which are spelled out in the description of each status package that follows the figure. Figure B-3.
Status Packages Event Packages—Package 24 22 PACKAGE DELIVERED TO TRANSFER RECIPIENT Cause. If a delivery notification has been requested for a TRANSFER recipient, this status package is returned to the package creator when the original package is saved into the recipient's INBOX folder. This status package is sent from the TRANSFER delivery system to the originator of the message. Meaning. The attached package was successfully delivered to the INBOX folder of the indicated TRANSFER recipients.
Status Packages Event Packages—Package 25 recipient from all of the recipient's folders without first issuing an ACK-RECEIPT UOW. Meaning. The attached package was not examined by the indicated TRANSFER recipients for whom nonreceipt notification was requested. Parameters. None. List Records. TRANSFER recipient names in collated form. Special Item Data Records. None. X400NAME Records. None. 25 PACKAGE DELIVERED TO X.400 RECIPIENT. Cause. If delivery notification is requested for an X.
Status Packages Event Packages—Package 26 X400NAME Records. The following records are returned: 200-203: The names of the actual recipients. The record sequence numbers are 1 through 9999. 204-207: The names of intended recipients. The record sequence number corresponds to the recipient's corresponding actual recipient name. Usage Notes. If the package is attached as a component, the following information applies: If the original package still exists on the Gateway node, it is attached as a component.
Status Packages Event Packages—Package 27 X400NAME Records. The following records are returned: 200-203: The actual recipients being reported on. 204-207: The corresponding intended recipients, if they exist. Usage Notes. The following additional information is included with this package: The X400-ORIG flag is set in the item descriptor. If the package is attached as a component, the following information applies: If the original package still exists on the Gateway node, it is attached as a component.
Status Packages Event Packages—Package 28 The package has the X400-ORIG flag set in the item descriptor. Usage Notes. If the package is attached as a component, the following information applies: If the original package still exists on the Gateway node, it is attached as a component. If the original does not exist on the Gateway node when the notification is imported, a new item is created with item type 120.
Status Packages Event Packages—Package 29 Usage Notes. If the package is attached as a component, the following information applies: If the original package still exists on the Gateway node, it is attached as a component. If the original does not exist on the Gateway node when the notification is imported, a new item is created, having an item type of 120. The P1 message ID of the message being reported on (the original) is placed in item data record 120,1. 29 X.400 RECIPIENT DOES NOT SUPPORT DATA TYPES.
Status Packages Event Packages—Package 30 If the original does not exist on the Gateway node when the notification is imported, a new item is created with item type 120. The P1 message ID of the message being reported on (the original) is placed in item data record 120,1. 30 PACKAGE NOT DELIVERED TO X.400 RECIPIENT IN TIME. Cause. If a nondelivery notification for X.
Status Packages Event Packages—Package 31 If the original does not exist on the Gateway node when the notification is imported, a new item is created with item type 120. The P1 Message Id of the message being reported on (the original) is placed in item data record 120,1. 31 PACKAGE RECEIVED BY X.400 RECIPIENT Cause. If receipt notification is requested for an X.
Status Packages Event Packages—Package 33 32 PACKAGE NOT RECEIVED BY X.400 RECIPIENT Cause. If nonreceipt notification is requested for an X.400 recipient, and that recipient does not receive the package, then the UA should generate a nonreceipt notification message. This notification is mapped into this status package. This status package is sent from X400 to the originator of the message. It is created by the Importer process. Meaning. The attached package was not received by the indicated X.
Status Packages Event Packages—Package 34 Meaning. The attached package, which has been cancelled, has already been exported to the indicated X.400 recipients. These recipients cannot be cancelled. Parameters. None. List Records. None. Special Item Data Records. None. X400NAME Records. 200-203: The X.400 recipients that have already been exported. This package has the X400-ORIG flag set in the item descriptor. 34 PACKAGE SPECIFIES X.400 RECIPIENTS. Cause.
Status Packages Event Packages—Package 38 Parameters. None. List Records. None. Special Item Data Records. None. X400NAME Records. 200-203: The TRANSFER delivery system returns the X.400 recipient names in question. This package has the X400-ORIG flag set in the item descriptor. 36 NODE name DOES NOT SUPPORT X.400 ORIGINATED ITEMS. Cause. If the item tree of a package contains an item marked as X.
Status Packages Event Packages—Package 39 39 PACKAGE CREATOR CANNOT BE MAPPED TO X.400 NAME FORMAT. Cause. If a package creator name is of a form which does not follow the personal name mapping guidelines set forth for TRANSFER names or if the creator name has fields which are longer than those specified as pragmatic constraints for the various subattributes of the X.400 personal name attribute, then this status package is returned. This status package is sent from X400 to the originator of the message.
Status Packages Event Packages—Package 49 49 EXPORT TO X.400 FAILED Cause. The package being processed was unable to be exported. The export was retried three times, but an error occurred each time. Meaning. The export of the attached package failed. Examine the system logs at the Gateway node to determine the cause. This status package is sent from the Export server to the originator of the message. Parameters. None. List Records. None. Special Item Data Records. None. X400NAME Records. None.
Appendix C Configured Names for TRANSFER Entities This appendix lists the names of various TRANSFER files, processes, and other entities configured in the TRANSFER delivery system. For releases earlier than B40, all of these names are defined in the configuration directory. For B40 and later releases, however, INBOX-FOLDER, OUTLOG-FOLDER, and WASTEBASKET-FOLDER are maintained as part of site-supported text and the remaining names are defined in the configuration directory.
Configured Names for TRANSFER Entities EXTOBJS-FILE EXTOBJS-FILE is the GUARDIAN 90 file name of the External Objects file, in the form: \node.$volume.subvolume.file EXTOBJS-SECURITY EXTOBJSUBVOL FOLDER-FILE EXTOBJS-SECURITY is the GUARDIAN 90 security vector in the form of four ASCII characters used by the TRANSFER delivery system, after an attachment is made, to secure all external object files owned by the GUARDIAN 90 user ID under which the TRANSFER delivery system is running.
Configured Names for TRANSFER Entities Table C-1.
Configured Names for TRANSFER Entities OLD-DEPTSTAT-FILE OLD-DEPTSTAT-FILE is the GUARDIAN 90 file name of the Old Depot Statistics file, in the form: \node.$volume.subvolume.file OUTLOG-FOLDER PATHMON-PROCESS OUTLOG-FOLDER is the configured name for the OUTLOG folder. The native language and character map used in returning the folder name depends on the presence or absence of a session and the version code associated with the request, as listed in Table C-1.
Configured Names for TRANSFER Entities SYSTEM-CHAR-MAP-ID SYSTEM-CHAR-MAP-ID is the ID of the character map used by all nodes in this TRANSFER network. In any particular network, this entity must have the same value for all nodes. This entity is defined as: DEF char-map-id. 10 code-page-id 10 page-string 10 code-set-id 10 set-string END. SYSTEM-LANG-CMAP-ID SYSTEM-LANG-CMAP-ID is the entity that combines the IDs of the TRANSFER system's default language and character map.
Configured Names for TRANSFER Entities TSCHED-PROCESS TSCHED-PROCESS is the GUARDIAN 90 name of the TSCHED process, in the form: \node.$process VOLUME00 Through VOLUME19 VOLUME00 through VOLUME19 are the names of the disk volumes used by the external objects feature for storage of GUARDIAN 90 files. This information is maintained in the form: \node.$volume WASTEBASKET-FOLDER WASTEBASKET-FOLDER is the configured name for the WASTEBASKET folder.
Appendix D National Languages and Character Maps Table D-1 lists the national languages supported by Tandem, along with the values used to specify them in the LANGUAGE-ID field of various UOWs. Table D-1.
National Languages and Character Maps Table D-2 lists character maps supported by Tandem, together with the values used to indicate them in the CODE-SET-ID field of various UOWs. In this field, positive values are used in programs written in languages other than TAL and SCREEN COBOL; negative values are used in programs written in TAL and SCREEN COBOL. Table D-2.
Appendix E Alphabetic Listing of Error Codes Table E-1 lists TRANSFER error messages in alphabetic order. Along with the error messages are their decimal, octal, and decimal numeric values. Note that the initial letters E (for error) or W (for warning) are not included in this list. Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Alphabetic Listing of Error Codes Table E-1.
Glossary ADMD. See Administration Management Domain. ADMD name. The name of the ADMD that is assigned to a TRANSFER correspondent; the ADMD name comes from the configuration parameters when the X400 gateway is installed on a node. All TRANSFER correspondents registered on nodes grouped into the same domain have the same ADMD name. ADMIN. An application that allows administrators to perform administrative tasks for correspondents, interest groups, distribution lists, folders, and the TRANSFER system.
Glossary Bulletin board. A folder for an interest group. Group members can read items in the group bulletin board folder and save items to the bulletin board for other members to read. Character map. A set of codes that establishes the correspondence between the native form of a character and a character in the base character set. In effect, this map is a set of rules for encoding or representing characters in that set.
Glossary Default model depot. The depot whose profiles are copied when a model depot is not specified for a new correspondent. The default model depot is established when TRANSFER is initialized. Default model group depot. The group depot whose profiles are copied when a model depot is not specified for a new group. The default model group depot is established when TRANSFER is initialized. Defaults file. A file that contains keyword parameters and default values to be used as the source of a define file.
Glossary Depot storage old statistics. Displayed on the OLD STATISTICS screen, the samples taken for the preceding configuration period if the depot storage facility was keeping previous samples. Depot storage statistic. The byte count of data stored in a depot. This data includes item data, external objects, and distribution list records. Item data is data saved in data records for all item and record types.
Glossary Foreign correspondent. An X400 user in a PRMD and ADMD outside the TRANSFER network. Foreign domain. An X400 domain outside the TRANSFER network. FOSERV. Format server, used in the FORMAT server class to format screen data internally for the PS MAIL 6530 and PS MAIL 3270 clients. FPSERV. File Utility Program (FUP) server, which is invoked by the TISERV, TWORK, and GFILE to create and copy external objects. It is not configured as a PATHWAY server class. Fully qualified correspondent name.
Glossary Interprocess communication (IPC). The request to or reply from the TRANSFER interactive server. The IPC contains a header and one or more units-of-work. IPC header. The first entry in an IPC. The header in an IPC request establishes processing conditions. The header in an IPC reply indicates what occurred during processing. IPC interface. The means by which a client communicates with TRANSFER. Item.
Glossary Name server (NAMESRV). A TRANSFER process that manages the TRANSFER name directory. Name space. The database managed by the TRANSFER name server. It contains lists of all correspondents on a node of a TRANSFER system, all distribution lists and folders owned by those correspondents, and the relationships between all correspondents and the distribution lists and folders they own. It also contains entries for most of the configuration entities defined in the system.
Glossary stay in the OUTLOG for the length of time configured, usually 24 hours. The OUTLOG cannot be deleted. P-1. X.400 protocol used to format and route messages through the X400 network. P-1 message. An X400 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. The combination of an envelope and its content is functionally equivalent to a TRANSFER package.
Glossary the same domain have the same PRMD name. PRMD names are required for X400 messages coming into a TRANSFER system; PRMD names are optional for X400 messages exported from a TRANSFER system. Process. A running program. Profile. A collection of attributes that describes an individual depot, a group depot, or the system as a whole. Each depot has a TRANSFER correspondent profile and a mail profile. Any depot can also include one or more agent profiles and user-supplied profiles.
Glossary Recipient. A correspondent to whom a package is delivered. Recipient list. The names of correspondents, interest groups, and distribution lists that are to receive a particular package. The recipient list is an attribute of the package and applies only to the package for which the recipient list is created. Contrast with distribution list. Recipient name. A correspondent name, interest group name, or distribution list name that appears in the recipient list for a particular package. Registration.
Glossary Site Update (SUT) Tape. The tape on which Tandem 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. SMSERV. The interactive TRANSFER system-management server, which performs system-management functions. The system-management server is called by TMANAGER. SPREP.
Glossary abbreviations, keywords, and the names of objects. It also handles such output text as prompts, screen field labels, error messages, and help information. The text server, in addition, performs various character mapping functions. For example, it manages the transformation of characters from external to internal format. TFRONT pseudo-terminal. TRANSFER receiver front end.
Glossary TRANSFER interactive server (TISERV). A TRANSFER server that starts and terminates sessions, services item and package handling requests, and handles administrative requests. TRANSFER name directory. A directory of all names of correspondents, interest groups, distribution lists, and folders defined at the local node. TRANSFER uses this directory whenever a local name is supplied by a correspondent. TRANSFER X400 gateway.
Glossary UOW. See Unit-of-work. User application. An application that a user develops and supplies to run on a TRANSFER system. User ID. A name assigned by the system manager, consisting of a group ID and a unique user ID (for example, REP.STEVE). User-defined profile. A depot profile that includes information about a correspondent for programs developed by Tandem users. User-DSV.
Glossary X400-EXPORT-PROBLEM folder. A special folder that holds X400 messages that were not exported because of a problem. X400 gateway node. The node where the TRANSFER X400 gateway is installed. Each group of TRANSFER nodes has a single TRANSFER X400 gateway node. When you send a package to a foreign recipient, the package is transported to the gateway node and is then exported. X400-IMPORT folder. A special folder that holds X400 messages that were successfully imported. X400 Importer server.
Index A ACK-RECEIPT UOW 2-21 ADD-AUX-NAME UOW 2-24 ADD-GROUP-MEMBER UOW 2-27 ADD-ITEM-REC UOW 2-31 ADD-MEMBER UOW 2-36 ADD-RECIP UOW 2-41 ADD-RECIP-C20 UOW 2-46 ADD-X400-AUX-NAME UOW 2-51 ADD-X400-MEMBER UOW 2-54 ADD-X400-RECIP UOW 2-57 Agents GLOSS-1 notification messages reply format 1-21 TAREQ format 1-20 selection criteria defining numeric ranges for 2-64 modifying 2-62 retrieving 2-226 ALTER-AGENT-SELECT UOW 2-62 ALTER-FOLDER-DESCR UOW 2-67 ALTER-FOLDER-ORDER UOW 2-74 ALTER-GROUP-MEMBER UOW 2-79 ALTER-
Index Authorizing users (X400) See Auxiliary names Auxiliary names adding 2-24 adding (X400) 2-51 deleting 2-186 deleting (X400) 2-184 retrieving 2-230 B BOOLEAN fields 2-6 C CANCEL-PKG UOW 2-139 CANCEL-PKG-TIMED UOW 2-141 Character map GLOSS-2 default 2-496, 2-502 specifying 2-487 supported D-2 COBOL COPY statement 2-4 Component items attaching 2-127 detaching 2-216 retrieving 2-272 Configuration parameters altering 2-487 retrieving names of 2-233 retrieving parameters of depot storage statistics facility
Index deleting 2-188 in distribution list adding 2-36 adding (X400) 2-54 deleting 2-203 in recipient list adding 2-41, 2-46 adding (X400) 2-57 listing interest groups of 2-509 names, retrieving equivalent X400 O/R 2-400 with active sessions 2-316 names,retrieving 2-422 CREATE-DEPOT UOW 2-152 CREATE-DLIST UOW 2-155 CREATE-DLIST-C20 UOW 2-157 CREATE-FOLDER UOW 2-161 CREATE-FOLDER-B00 UOW 2-164 CREATE-FOLDER-B10 UOW 2-169 CREATE-GROUP UOW 2-175 CREATE-ITEM UOW 2-178 D Data elements, Profile file See Depots, P
Index PIC 9(4) COMP field 2-12 RECIP-REQUEST-FLAGS field 2-13 STORAGE-STAT field 2-15 UPDATE-CONTROL field 2-15 X400-DELIV-STATUS-FLAGS field 2-17 X400-NAME field 2-16 X400-RECIP-REQ-FLAGS field 2-18 Default retention time, establishing 2-169 DEL-GROUP-MEMBER UOW 2-180 DEL-X400-AUX-NAME UOW 2-184 DELETE-AUX-NAME UOW 2-186 DELETE-DEPOT UOW 2-188 DELETE-DLIST UOW 2-191 DELETE-FOLDER UOW 2-194 DELETE-GROUP UOW 2-197 DELETE-ITEM-REC UOW 2-200 DELETE-MEMBER UOW 2-203 DELETE-PROFILE-REC UOW 2-206 DELETE-RECIP UO
Index default recipient, FAXLINK delivery failure notification 2-364 default WPLINK document format 2-359 depot creation time 2-341 depot language 2-357 depot operation flags 2-348 FAXLINK default phone numbers 2-370 GUARDIAN 90 ID 2-328 interest group creation defaults 2-361 interest group creation privileges 2-353 interest group settings 2-345 IXF host-resident program 2-366 IXF workstation-resident program 2-367 log flags 2-337 long ELEMENT-BLOCK name 2-368 maximum retention time 2-351 package delivery
Index creating 2-155, 2-157 deleting 2-191 deleting as members from distribution lists 2-203 deleting members 2-203 deleting members (X400) 2-210 retrieving attributes 2-244 retrieving members 2-417 retrieving members (X400) 2-438 retrieving names of 2-422 X400 considerations 2-56 Dummy UOW (NOOP) 2-410 E END-SESSION UOW 2-225 Error codes alphabetic listing E-1 field locations 3-1 GUARDIAN 90 3-5 itemized 3-6 Event packages 1-22 1-17 B-1 22 and higher B-6 format B-2, B-6 External objects GLOSS-4 attaching
Index modifying ordering criteria 2-67, 2-74 removing items in 2-505 removing names of items stored in 2-114 retrieving a list of for a specific item 2-513 retrieving attributes of items stored in 2-253 retrieving item information 2-456, 2-469, 2-483 retrieving item information by ordering key 2-461, 2-465 retrieving item retention time 2-256, 2-261 retrieving items in 2-478 retrieving names of 2-422 retrieving names of items stored in 2-297 retrieving ordering criteria 2-256, 2-261, 2-265 saving items 2-4
Index GET-NEXT-SESSION UOW 2-316 GET-PROFILE-ELEM UOW 2-318 storage layout of UOW response 2-324 GET-RECIP-REC UOW 2-374 GET-RECIP-REC-C20 UOW 2-382 GET-STATS-PARAMS UOW 2-391 GET-X400-AUX-NAME UOW 2-394 GET-X400-CONFIG UOW 2-398 GET-X400-NAME UOW 2-400 GET-X400-ORIG UOW 2-402 GET-X400-RECIP UOW 2-404 GLNK file 2-3 GROUP-MEMBER-NAME field 2-8 GROUP-NAME field 2-8 Groups See Interest groups I Importance 2-287, GLOSS-5 Imported packages,retrieving the X400 originator (O/R) name of 2-402 Interest groups GLOSS
Index Items GLOSS-6 adding data records to 2-31 as components attaching 2-127 detaching 2-216 retrieving 2-272 assigning names to 2-114 copying 2-143 with attachments 2-147 creating 2-178 deleting data records from 2-200 importance values 2-287 in folders listing where stored 2-513, 2-516 naming 2-114 removing 2-505 retrieving attributes of 2-253 setting default retention time for 2-169 setting ordering criteria for 2-164, 2-169 modifying retention time 2-67 named retrieving item ID and item name by orderi
Index L Languages default 2-502 national, supported D-1 specifying 2-487 Languages, default 2-496 LOG-THIS-IPC field 1-8 N Names retrieving 2-297, 2-422 retrieving process names 2-233 TRANSFER entities C-1 Non-receipt notification 2-44, 2-48 NOOP UOW 2-410 O Ordering criteria establishing during folder creation 2-164, 2-169 modifying 2-67, 2-74 retrieving 2-256, 2-261, 2-265 P Packages GLOSS-8 acknowledging delivery of 2-22 adding recipients 2-41, 2-46 X400 recipients 2-57 attaching items as components 2-1
Index retrieving auxiliary names (X400) 2-394 retrieving recipient records 2-374, 2-382 retrieving reply-to recipients 2-230 retrieving X400 originator (O/R) name 2-402 retrieving X400 recipient names 2-404 setting attributes 2-82, 2-92, 2-102 submitting 2-503 updating item descriptors in header 2-82, 2-92, 2-102 PIC 9(4) COMP fields 2-12 Primary external objects See External objects Private distribution lists, retrieving attributes of 2-244 Process names, retrieving 2-233 Profile file elements See Depots,
Index retrieving 2-374, 2-382 retrieving X400 auxiliary names 2-394 retrieving X400 recipient names 2-404 Records, data, retrieving from an item 2-300, 2-306 Reply-to recipients (X400) See Auxiliary names REQUEST-CODE field 1-4 S SAVE-ITEM UOW 2-441 SAVE-ITEM-B00 UOW 2-445 SAVE-ITEM-BY-KEY UOW 2-450 SCAN-BY-ITEM-NAME UOW 2-456 SCAN-FOLDER UOW 2-461 SCAN-FOLDER-B00 UOW 2-465 SCAN-FOLDER-BY-KEY UOW 2-469 SCAN-FOLDER-DETAIL UOW 2-478 SCREEN COBOL COPY statement 2-4 Sensitivity 2-286, GLOSS-10 SESSION-ID field
Index T TAREQ status packages B-1 TAREQ process agent selection 2-64 event packages 1-22 interface to 1-19 TISERV process, interface to 1-1 Transaction Monitoring Facility (TMF), UOW requirements 2-1 TRANSFER environment altering configuration parameters 2-487 file names C-1 process names C-1 retrieving file names 2-233 source code files 2-3 TRANSFER processes 1-1 U Units of work See UOWs UNSAVE-ITEM UOW 2-505 UOW GLOSS-13 UOWs and TMF transactions 2-1 definitions 2-20 format 2-4 individual ACK-RECEIPT 2-2
Index ALTER-ITEM-DES-C20 2-102 ALTER-ITEM-DESB40 2-92 ALTER-ITEM-DESCR 2-82 ALTER-ITEM-NAME 2-114 ALTER-PROFILE-ELEM 2-118 ALTER-STATS-PARAM 2-124 ATTACH-COMPNT-A01 2-127 ATTACH-EXTOBJ 2-131 CANCEL-PKG 2-139 CANCEL-PKG-TIMED 2-141 COPY-ITEM 2-143 COPY-ITEM-B40 2-147 CREATE-DEPOT 2-152 CREATE-DLIST 2-155 CREATE-DLIST-C20 2-157 CREATE-FOLDER 2-161 CREATE-FOLDER-B00 2-164, 2-169 CREATE-GROUP 2-175 CREATE-ITEM 2-178 DEL-GROUP-MEMBER 2-180 DEL-X400-AUX-NAME 2-184 DELETE-AUX-NAME 2-186 DELETE-DEPOT 2-188 DELETE-
Index GET-FOLDER-DES-C20 2-256 GET-FOLDER-DESCR 2-261 GET-FOLDER-ORDER 2-265 GET-FOLDER-STATS 2-269 GET-ITEM-COMPNT-A01 2-272 GET-ITEM-DES-C20 2-276 GET-ITEM-DESCR 2-289 GET-ITEM-NAME 2-297 GET-ITEM-REC 2-300 GET-ITEM-REC-B40 2-306 GET-ITEM-STATS 2-313 GET-NEXT-SESSION 2-316 GET-PROFILE-ELEM 2-318 GET-RECIP-REC 2-374 GET-RECIP-REC-C20 2-382 GET-STATS-PARAMS 2-391 GET-X400-AUX-NAME 2-394 GET-X400-CONFIG 2-398 GET-X400-NAME 2-400 GET-X400-ORIG 2-402 GET-X400-RECIP 2-404 NOOP 2-410 READ-NEXT-GROUP-MBR 2-412 R
Index WHERE-MEMBER-OF 2-509 WHERE-SAVED 2-513 WHERE-SAVED-C20 2-516 WRITE-PROFILE-REC 2-520 listed in numeric order A-1 request header 2-2 response header 2-2 summarized 1-9/19 configuring and managing the TRANSFER environment 1-16 controlling sessions 1-10 handling items 1-10 handling packages 1-11 managing depots 1-14 managing external objects 1-14 managing X400 elements 1-19 manipulating folders 1-13 UOWS-RETURNED field 1-8 UOWS-TO-PROCESS field 1-7 UPDATE-CONTROL field 2-15 V VERSION-CODE field 1-5 W W
Index X X400 adding authorizing users 2-51 adding reply-to recipients 2-51 deleting correspondents from distribution list 2-210 deleting recipients 2-213 retrieving authorizing names 2-394 retrieving auxiliary names 2-394 retrieving distribution list members 2-438 retrieving Gateway configuration values 2-398 retrieving O/R name 2-402 retrieving O/R names 2-400 retrieving reply-to recipient names 2-394 X400-DELIV-STATUS-FLAGS field 2-17 X400-NAME field 2-16 X400-RECIP-REQ-FLAGS field 2-18 069139 Tandem Co
