Z-FILCNF

This document covers the following topics:


Description

Format and file a Cnf document.

If the Cnf document has enclosures, the enclosures must be Cnf or Txt documents.

The document format of the resulting document is Txt. Error messages, warnings and information are inserted as comments into the Txt document.

You cannot format and file a Cnf document which is currently stored in a system folder such as the Inbasket (except Work).

Successful termination of Z-FILCNF always results in an END TRANSACTION. You are not able to control transaction handling.

Parameters

Parameter Format In Out Remarks
Return-code N2   X  
Cabinet A8 R   The cabinet in which the Cnf document is stored.
Password A8 R   The password of the above cabinet.
Cnf-document-name A32 R*   The name of the Cnf document to be formatted. Either Cnf-document-name or Cnf-ISN, not both.
Cnf-ISN P10 R*   The ISN of the Cnf document to be formatted. Either Cnf-ISN or Cnf-document-name, not both.
New-document-name A32 R   The name for the Txt document.
New-folder A15 O   The folder in which the Txt document is to be stored. You must not specify a system folder (except Work) or TRS folder. Default: Work.
New-file A15 O   The name of a file within the above folder in which the Txt document is to be stored.
Formatting-profile A32 O   If left blank, the user's formatting profile is used. If the user has not specified a formatting profile, FPROFILE is used.
Pre-formatting-procedure A1 O   If marked, the pre-formatting procedures which are linked to the document are activated.
System-variables A1 O   If marked, the system variables are replaced with the appropriate values.
Keywords A15/1:6 O   Keywords are helpful when you search for an object. You can specify up to 6 keywords for the Txt document. A keyword must not contain an asterisk (*).
Days-until-expiration N4 O   Defines the number of days the new document is kept before it can be deleted from the system. When you specify a value that is smaller than or equal to 0, the system default is used (see the Con-nect Administration documentation for further information on the system defaults).
New-ISN P10   X The ISN of the Txt document.

Return Codes

00 Success
02 Invalid cabinet name
03 Password incorrect
04 ISN was not found
08 Supply either ISN or name, not both
09 ISN does not point to correct object
10 Function not valid for a system folder (to file new documents into)
51 Invalid name
52 Document with specified name already exists
53 Requested object does not exist
54 At least one keyword was invalid
55 Requested folder/file does not exist
56 Requested folder is a TRS folder
59 Requested procedure not found
65 This is not a Con-form document
81 Invalid formatting profile name
87 System address record for system variables not found
91 Supply Cnf-document-name or Cnf-ISN
92 No formatting profile found for specified cabinet
93 Function not available for document in Inbasket, Outbasket or Wastebasket

Subprograms

Z-105
Z-120
Z-122
Z-123
Z-125
Z-135
Z-147
Z-150
Z-163
Z-168
Z-169
Z-175
Z-190
Z-1200&0

Example

0010 *
0020 DEFINE DATA
0030 LOCAL
0040 1 RETURN-CODE              (N2)
0050 1 CABINET                  (A8)
0060 1 PASSWORD                 (A8)
0070 1 CNF-DOCUMENT-NAME        (A32)
0080 1 CNF-ISN                  (P10)
0090 1 NEW-DOCUMENT-NAME        (A32)
0100 1 NEW-FOLDER               (A15)
0110 1 NEW-FILE                 (A15)
0120 1 FORMATTING-PROFILE       (A32)
0130 1 PRE-FORMATTING-PROCEDURE (A1)
0140 1 SYSTEM-VARIABLES         (A1)
0150 1 KEYWORDS                 (A15/1:6)
0160 1 DAYS-UNTIL-EXPIRATION    (N4)
0170 1 NEW-ISN                  (P10)
0180 *
0190 END-DEFINE
0200 *
0210 MOVE 'LS' TO CABINET
0220 INPUT 'CNF-DOCUMENT-NAME' CNF-DOCUMENT-NAME /
0230       'NEW-DOCUMENT-NAME' NEW-DOCUMENT-NAME
0240 MOVE 'FORMATTING-PROFILE' TO  FORMATTING-PROFILE
0250 MOVE 30  TO  DAYS-UNTIL-EXPIRATION
0260 MOVE 'X' TO  SYSTEM-VARIABLES
0270 MOVE 'X' TO  PRE-FORMATTING-PROCEDURE
0280 *
0290 CALLNAT 'Z-FILCNF'
0300   RETURN-CODE
0310   CABINET
0320   PASSWORD
0330   CNF-DOCUMENT-NAME
0340   CNF-ISN
0350   NEW-DOCUMENT-NAME
0360   NEW-FOLDER
0370   NEW-FILE
0380   FORMATTING-PROFILE
0390   PRE-FORMATTING-PROCEDURE
0400   SYSTEM-VARIABLES
0410   KEYWORDS (*)
0420   DAYS-UNTIL-EXPIRATION
0430   NEW-ISN
0440 WRITE 'Return code' RETURN-CODE
0450 END