Z-FIL27

This document covers the following topics:

Description

File a reference document into another folder or file and/or rename it.

You can file a reference document into folder Work or any user-defined folder. You cannot file a reference document into a system folder such as the Inbasket or Outbasket.

If you do not want to rename the reference document, you must leave New-name blank.

If you do not want to file the reference document (i.e. you only want to rename it), you must leave both New-folder and New-file blank.

When you file a reference document which is currently stored in the Inbasket file New, the corresponding address list is updated so that the reception status of the reference document indicates that it has been read. In this case, END TRANSACTION is automatically issued.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet in which the reference document is stored.
Password A8 R   The password of the above cabinet.
Ref-document-name A32 R*   The name of the reference document to be filed. Either Ref-document-name or ISN, not both.
ISN P10 R* X The ISN of the reference document to be filed. Either ISN or Ref-document-name, not both.
New-name A32 O   If specified the reference document is filed with a new name.
New-folder A15 O   The name of the folder in which the reference document is to be stored. You must not specify a system folder (except Work).
New-file A15 O   The name of a file within the above folder in which the reference document is to be stored.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
03 Password incorrect
04 ISN was not found
06 TRS could not be invoked
08 Supply either ISN or name, not both
09 ISN does not point to correct object
10 Function not valid for a system folder
51 Invalid name
52 Object with specified name already exists
53 Requested object does not exist
55 Requested folder/file does not exist
73 Invalid folder/file name
90 Object was already named and filed as specified

Subprograms

Z-120
Z-122
Z-123
Z-147
Z-150
Z-161
Z-165
Z-175
Z-177
Z-180
Z-190
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-1200&0

Example

0010 DEFINE DATA
0020 *
0030 LOCAL
0040 *
0050 1 RETURN-CODE               (N2)
0060 1 CABINET                   (A8)
0070 1 PASSWORD                  (A8)
0080 1 REF-DOCUMENT-NAME         (A32)
0090 1 ISN                       (P10)
0100 1 NEW-NAME                  (A32)
0110 1 NEW-FOLDER                (A15)
0120 1 NEW-FILE                  (A15)
0130 *
0140 END-DEFINE
0150 *
0160 *
0170 INPUT (IP=OFF AD=A'_')
0180         'Cabinet         ' CABINET
0190      /  'Password        ' PASSWORD (AD=N)
0200      /  'Ref. Document   ' REF-DOCUMENT-NAME
0210      // 'New Name        ' NEW-NAME
0220      // 'New Folder      ' NEW-FOLDER
0230      /  '    File        ' NEW-FILE
0240 *
0250 *
0260 IF   REF-DOCUMENT-NAME NE ' '
0270      CALLNAT 'Z-FIL27'
0280           RETURN-CODE
0290           CABINET
0300           PASSWORD
0310           REF-DOCUMENT-NAME
0320           ISN
0330           NEW-NAME
0340           NEW-FOLDER
0350           NEW-FILE
0360 *
0370      IF   RETURN-CODE EQ 0
0380           WRITE 'Reference document was filed and renamed'
0390      ELSE
0400           WRITE 'Reference document cannot be modified' RETURN-CODE
0410      END-IF
0420 END-IF
0430 *
0440 END