Con-nect Application Programming Interface

The Con-nect Application Programming Interface (API) consists of a series of Natural subprograms which are delivered with Con-nect and can be used to access Con-nect data without using the online system.

This documentation is subdivided as follows:

General Information Information on all API subprograms.
External Communication Information on the parameter Node-parameters which is used by the API subprograms that refer to external nodes.
API Subprograms (see the List of API Subprograms below) Description of each API subprogram. Each description lists the required parameters, subprograms, and possible return codes. Many descriptions also provide an example program.
Return Codes List of all return codes.
Numbers Overview of all object numbers, document formats, address types, cabinet types, folder numbers and file numbers.

List of API Subprograms

The following is a list of all API subprograms currently available with Con-nect.

Name Description
Z-ACCEPT Accept or decline an invitation to a meeting.
Z-ADD01 Add a nickname for an address at an external node. Applies only to an external node which uses the spool file.
Z-ADD01A Add a nickname (including work address) for an address at an external node. Applies only to an external node which uses the spool file.
Z-ADD01B Add a nickname for an address at an external node or for an internal Con-nect address. Applies only to an external node which uses the spool file.
Z-ADD01T Add a nickname for an address at an external node. Applies also to an external node which uses the transport service.
Z-ADD03B Add an appointment.
Z-ADD03C Add an appointment.
Z-ADD04 Add a bulletin board.
Z-ADD05 Add a cabinet.
Z-ADD06 Add an appointment or the basic information of a meeting.
Z-ADD10 Add a distribution list.
Z-ADD10X Add a distribution list. ISN uses format P10.
Z-ADD11 Add a document from the contents of the Natural edit area.
Z-ADD11C Add a document using data from a text array.
Z-ADD11D Add a document using data from a text array.
Z-ADD11X Add a document from the contents of the Natural edit area. ISN uses format P10.
Z-ADD13 Add a folder and/or file.
Z-ADD13A Add a folder and/or file (enhanced functionality).
Z-ADD17 Add a member to an existing distribution list.
Z-ADD17A Add a member to a shared cabinet.
Z-ADD17B Add a member to an existing distribution list.
Z-ADD27 Add a reference document.
Z-ADD74 Add an external node which uses either the transport service or the spool file.
Z-ADD79 Add a logical printer.
Z-ADDATT Add attendees and resources to a meeting.
Z-ADDOBJ Add a user-defined object.
Z-ALIST Return the address list of a mail item.
Z-ALISTM Return the address list of a mail item with address index. ISN uses format P10.
Z-ALISTX Return the address list of a mail item. ISN uses format P10.
Z-CAN06 Cancel a meeting.
Z-CLSEQ Load the printer close sequence.
Z-CMD Invoke Con-nect from a user-written program and execute the specified Con-nect command sequence.
Z-CMDOBJ Validate a command or command-object combination for a specific cabinet.
Z-CMFVER Get the version number of the currently installed Con-form version.
Z-CNFIRM Confirm a message created with Z-MAILA and create a transport service item.
Z-COP11 Copy a document (to copy to another cabinet, you must be authorized to use that cabinet).
Z-COP11B Copy a document (to copy to another cabinet, you can specify the password of that cabinet).
Z-COP11C Copy a document with keywords and enclosures.
Z-COP11X Copy a document (to copy to another cabinet, you must be authorized to use that cabinet). ISN uses format P10.
Z-DETACH Detach cover notes, enclosed documents or attached notes from a document. Or detach attached notes from an appointment or meeting.
Z-DIS04 Display a list of bulletin boards.
Z-DIS04A Display the contents of a specific bulletin board.
Z-DIS04X Display the contents of a specific bulletin board. ISN uses format P10.
Z-DIS05 Display a list of cabinets.
Z-DIS05A Display a list of cabinets with backup information.
Z-DIS05F Display the cabinet profile of a specific cabinet.
Z-DIS05I Display the date and time formats and the sliding window (YSLW) value in the user profile of a specific cabinet.
Z-DIS05X Display a list of cabinets. ISN uses format P10.
Z-DIS11 Display a list of documents.
Z-DIS11A Display a list of documents with information on replies. ISN uses format P10. The list of documents can be displayed in descending alphabetical order.
Z-DIS11X Display a list of documents. ISN uses format P10. The list of documents can be displayed in descending alphabetical order.
Z-DIS13 Display a list of folders.
Z-DIS13A Display the contents of a specific folder or file.
Z-DIS13B Display the contents of a specific folder or file.
Z-DIS17A Display a list of all members of a distribution list, shared cabinet or private cabinet which the user has shared.
Z-DIS17B Display a list of all members of a distribution list, shared cabinet or private cabinet which the user has shared.
Z-DIS17C Display a list of all members of a shared cabinet. The list also includes the profile type of each member cabinet (shared cabinet profile, private cabinet profile or special profile).
Z-DIS17F Display the cabinet profile of a specific member of a shared cabinet.
Z-DIS20 Display a list of notepad pages.
Z-DIS23 Display a list of printer profiles.
Z-DIS27 Display a list of reference documents.
Z-DIS33 Display a list of users including work address information.
Z-DIS39A Display a list of all addressees to whom the user of a specific cabinet can send mail.
Z-DIS74 Display a list of external nodes.
Z-DIS79 Display a list of logical printers.
Z-DRIVER Load a printer profile into the Con-form buffer.
Z-ENC11 Enclose documents with a host document, or detach enclosures from a host document.
Z-ERA01 Erase a nickname.
Z-ERA03 Erase an appointment.
Z-ERA04 Erase a bulletin board.
Z-ERA05 Mark a cabinet for deletion or cancel a deletion mark.
Z-ERA05A Mark a cabinet for deletion and lock access to it, or cancel deletion and lock marks.
Z-ERA10 Erase a distribution list.
Z-ERA11 Erase a document.
Z-ERA11B Erase a document from a bulletin board.
Z-ERA11X Erase a document. ISN uses format P10.
Z-ERA13 Erase a folder or file.
Z-ERA17 Erase a member from a distribution list.
Z-ERA27 Erase a reference document.
Z-ERA74 Delete an external node which uses either the transport service or the spool file.
Z-ERA79 Delete a logical printer.
Z-ERAOBJ Erase a user-defined object.
Z-EXPU Update the expiration date and archive flag of a document.
Z-FIL11 File a document into another folder or file and/or rename it.
Z-FIL11A File a document into another folder or file (with all previous replies and identical keywords) or rename it.
Z-FIL11X File a document into another folder or file and/or rename it. ISN uses format P10.
Z-FIL13 File a folder in another folder, or remove a folder from the folder in which it is stored.
Z-FIL27 File a reference document into another folder or file and/or rename it.
Z-FILCNF Format and file a Cnf document.
Z-FILOB File a user-defined object into another folder or file and/or rename it.
Z-FORWD Forward mail.
Z-GET01 Return information about a nickname for an address at an external node or for an internal Con-nect address. Applies only to an external node which uses the spool file.
Z-GET01B Return information about a nickname for an address at an external node or for an internal Con-nect address, including Private-flag for nicknames, last name and first name of a user at an external node as well as the security levels for a nickname or user. Applies only to an external node which uses the spool file.
Z-GET01C Return the work and home address for a cabinet or nickname, including last name, first name and Private-flag for a nickname.
Z-GET01D Return the work and home address for a cabinet or nickname, including the Cc and Miscellaneous information.
Z-GET01E Return the work and home address for a cabinet or nickname, including the Cc and Miscellaneous information. The parameter list contains new Cc-3 parameters which apply to the mail status message. The format of the Miscellaneous parameters has been increased to 10 lines. All types of users can use this subprogram.
Z-GET01T Return information about a nickname for an address at an external node or for an internal Con-nect address. Applies also to an external node which uses the transport service.
Z-GET03B Return information about an appointment or meeting.
Z-GET04 Return an object which is contained in a specific bulletin board.
Z-GET04X Return an object which is contained in a specific bulletin board. ISN uses format P10.
Z-GET06A Return information about an appointment, meeting, reminder or todo.
Z-GET06B Return information about an appointment, meeting, reminder or todo, including the ISN of a calendar entry and the number of attached notes..
Z-GET06C Return information about notes that are attached to an appointment or meeting.
Z-GET06D Return the history of a meeting.
Z-GET06E Return the meeting version and, if applicable, either the update or cancelation message.
Z-GET11 Return the description of a document.
Z-GET11C Return a document, including cover notes and enclosed documents, into a text array.
Z-GET11D Return a document, including cover notes, attached notes and enclosed documents, into a text array.
Z-GET11X Return the description of a document. ISN uses format P10.
Z-GET27 Return information about a reference document.
Z-GET27A Return information about a reference document (including information when and by whom it was last modified).
Z-GET33 Return the date and time formats of a user and the language in which the user works.
Z-GET33A Return the work phone number of a user.
Z-GET33C Return the date and time formats of a user, the language in which the user works, and the sliding window value (YSLW).
Z-GET74 Return information about an external node which uses either the transport service or the spool file.
Z-GETADR Return the work and home address for a cabinet or nickname.
Z-GETAG Return the text of an agenda that has been attached to an appointment, meeting or invitation.
Z-GETOBJ Return the text lines of a user-defined object into a text array.
Z-GLOBAL Return the contents of global variables in the Con-nect global data area GL-STD.
Z-IN11G2 Return the document information.
Z-IN11GX Return the document information. ISN uses format P10.
Z-IN11U1 Update the document information.
Z-IN11UX Update the document information. ISN uses format P10.
Z-INBKT Return the number of items which are currently stored in the five files of the Inbasket.
Z-INF13 Return information about a specific folder or file. Also offers the possibility to modify the keywords and description of a folder or file.
Z-INFPR Return the print defaults of a cabinet.
Z-INFPRA Return the print defaults of a cabinet, including left margin and line wrapping.
Z-INOBG Return information about a specific user-defined object.
Z-INOBU Update information for a specific user-defined object.
Z-INVX Return information about an invitation to a meeting or a cancelation message.
Z-LOGS Return information about unsuccessful logon attempts to a cabinet.
Z-MAILA Send an object.
Z-MAILAX Send an object. ISN uses format P10.
Z-MCONFM Confirm the invitations to a meeting.
Z-MEMCAB Return a list of all cabinets and distribution lists in cabinet SYSCNT which have a specific cabinet as a member.
Z-MEMSHP Return a list of shared and private cabinets that a user is allowed to use.
Z-MLDFLT Modify the send defaults for a mail item that is to be sent with Z-MAILA.
Z-MLGETA Return the mail status message of a specific user and the time range in which it is to appear.
Z-MLGETB Return the mail status message of a specific user, the time range in which it is to appear and Cc information.
Z-MLGETC Return the mail status message of a specific user, the time range in which it is to appear, whether date and time are to be hidden, and Cc information.
Z-MLSGET Return the mail status message of a specific user.
Z-MOD01A Modify a nickname for an address at an external node. Applies only to an external node which uses the spool file.
Z-MOD01B Modify a nickname for an address at an external node, including last name and first name. Applies only to an external node which uses the spool file.
Z-MOD01C Modify the work and home address for a cabinet or nickname, including last name, initial and first name of a cabinet, or last name and first name of a nickname.
Z-MOD01D Modify the work and home address for a cabinet or nickname, including the Cc and Miscellaneous information.
Z-MOD01T Modify a nickname for an address at an external node. Applies also to an external node which uses the transport service.
Z-MOD05A Modify the date and time formats in the user profile of a specific cabinet.
Z-MOD05B Modify the menu and overlay calendar information in the user profile of a specific cabinet.
Z-MOD05C Modify the screen colors in the user profile of a specific cabinet.
Z-MOD05D Modify the print defaults in the user profile of a specific cabinet.
Z-MOD05E Modify the language code, default command sequence, blank substitute character and autosave interval in the user profile of a specific cabinet.
Z-MOD05F Modify the cabinet profile of a specific cabinet.
Z-MOD05H Modify the mail status message in the user profile of a specific cabinet.
Z-MOD05I Modify the date and time formats and the sliding window (YSLW) value in the user profile of a specific cabinet.
Z-MOD05J Modify the mail status message in the user profile of a specific cabinet, including Cc.
Z-MOD05K Modify the print defaults (including left margin and wrapping of printed lines) in the user profile of a specific cabinet.
Z-MOD05L Modify the mail status message in the user profile of a specific cabinet, including Cc. The time range can be hidden.
Z-MOD05M Modify the language code, system folder names, default command sequence, blank substitute character and autosave interval in the user profile of a specific cabinet. Cabinet-ISN uses format P10.
Z-MOD05N Activate/deactivate a command-object combination for a specific cabinet.
Z-MOD06 Modify an appointment or meeting.
Z-MOD11 Modify the text of an existing document using data from a text array.
Z-MOD13 Modify the name, sorting sequence and/or description of a folder (including system folder or TRS folder) or of a file contained in it.
Z-MOD17 Authorize a user to use another private cabinet, or modify the profile of a user who is authorized to use another private cabinet.
Z-MOD27 Modify the description, keywords, writer and title of a reference document.
Z-MOD79 Modify a logical printer.
Z-MODADR Modify the work and home address for a cabinet or nickname.
Z-MODPWD Modify the password.
Z-NOTE Maintain notepad pages.
Z-OPSEQ Load the printer open sequence.
Z-PRI11 Print a Txt or Cnf document.
Z-PRI11F Format and print a Cnf or Int document, or print a Txt document.
Z-PRI11G Format and print a Cnf or Int document, or print a Txt document. You can specify the pages to be printed.
Z-PRI11I Format and print a Cnf or Int document, or print a Txt document. You can control the printer and Con-form messages.
Z-PRI11X Print a Txt or Cnf document. ISN uses format P10.
Z-PRI11Y Format and print a Cnf or Int document, or print a Txt document. You can control the printer and Con-form messages. ISN uses format P10.
Z-REN05 Mark a cabinet for renaming purposes.
Z-REPLY Reply to mail.
Z-SCAN11 Search for a specific character string (search value) in a document.
Z-SEARCH Return a list of documents, reference documents, folders/files or user-defined objects, which have the specified keywords.
Z-SRCH03 Return a list of appointments or meetings which have the specified keywords.
Z-SRCH17 Return a list of all distribution lists containing a specific member.
Z-SRCHX Return a list of documents, reference documents, folders/files or user-defined objects which have the specified search criteria (keywords and/or names).
Z-STIME Return a list of time ranges in which all or most of the specified attendees and/or cabinets are available. Uses full quarters of an hour.
Z-STIME5 Return a list of time ranges in which all or most of the specified attendees and/or cabinets are available. Uses time slides consisting of 5 minutes.
Z-TRACNF Translate an RFT (revisable form text DCA) document. The document format of the resulting document is Cnf.
Z-TRADCA Translate a Cnf document. The document format of the resulting document is RFT (revisable form text DCA).
Z-TRAINT Translate a Cnf document. The document format of the resulting document is Int (intermediate).
Z-TRS11 File a document into a TRS folder and invert the document. Or move a document from one TRS folder to another TRS folder.
Z-TRSCL Close the TRS buffer.
Z-TRSOP Open the TRS buffer.
Z-UNDO Undo addressees of a mail item, including invitations to a meeting.
Z-VARSYM Return a list of all variables appearing in a document text.
Z-VARX Return a list of all variables appearing in a document text (enhanced functionality).