Z-IN11UX

This document covers the following topics:


Description

Update the document information.

This subprogram is the same as Z-IN11U1 with the one exception that the parameter ISN uses the format P10.

Parameters which are not completed in the parameter list (except the Expiration-date) are deleted from the document information. Thus, to retain the existing values, you must specify them once more before you invoke this subprogram. You can invoke Z-IN11GX prior to this subprogram to obtain the current values.

If the parameter Expiration-date is 0 (zero), the expiration date is not updated (i.e. the previously defined value will still be used).

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet in which the document information is to be updated.
Password A8 R   The password of the above cabinet.
Document-name A32 R*   The name of the document for which you want to update the document information. Need not be specified, if the first line of the Description is specified. Either Document-name or ISN, not both.
ISN P10 R* X The ISN of the document for which you want to update the document information. Input: either ISN or Document-name, not both. You can invoke Z-DIS11X prior to this subprogram to obtain the ISN for the desired document.
Description A60/1:4 O   A brief description for the document. If you do not specify a Document-name, you must specify a Description.
Keywords A15/1:6 O   Keywords are helpful when you search for an object. You can specify up to 6 keywords. A keyword must not contain an asterisk (*).
Private-flag A1 O   If marked, the document is a private object.
Security-flags A4 O   The security levels for Read, Modify, Copy and Print. Values 0 to 9.
Formatting-profile A32 O   The name of the formatting profile.
Pre-format-procedures A32/1:4 O   The names of the pre-formatting procedures.
Post-format-procedures A32/1:4 O   The names of the post-formatting procedures.
Expiration-date N8 O   The expiration date of the document. Format yyyymmdd. The date you specify is checked against the default value ("Days until Expiration") specified by the system administrator. The expiration date must not be lower than the sum of the current date and the default value.
Archive-flag A1 O   If marked, the document is stored on some other medium (e.g. on tape) when the expiration date is reached.

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
16 Document is locked - editing was not completed
51 Invalid name
53 Requested object does not exist
54 At least one keyword was invalid
62 Invalid date format
70 The security levels must be numeric
71 Invalid pre-formatting procedure name
72 Invalid post-formatting procedure name
81 Invalid formatting profile name
90 Invalid expiration date
91 The security levels must not be higher than in profile

Subprograms

Z-120
Z-122
Z-123
Z-128
Z-147
Z-175
Z-1200&0

Example

0010 *
0020 * Example program to update the document information.
0030 *
0040 DEFINE DATA
0050 LOCAL
0060 1 RETURN-CODE                (N2)
0070 1 CABINET                    (A8)
0080 1 PASSWORD                   (A8)
0090 1 DOCUMENT-NAME              (A32)
0100 1 ISN                        (P10)
0110 1 DESCRIPTION                (A60/1:4)
0120 1 KEYWORDS                   (A15/1:6)
0130 1 PRIVATE-FLAG               (A1)
0140 1 SECURITY-FLAGS             (A4)
0150 1 FORMATTING-PROFILE         (A32)
0160 1 PRE-FORMAT-PROCEDURES      (A32/1:4)
0170 1 POST-FORMAT-PROCEDURES     (A32/1:4)
0180 1 EXPIRATION-DATE            (N8)
0190 1 ARCHIVE-FLAG               (A1)
0200 *
0210 END-DEFINE
0220 *
0230 RESET RETURN-CODE
0240 MOVE 'CABINET'  TO CABINET
0250 MOVE 'PASSWORD' TO PASSWORD
0260 MOVE 1234567890 TO ISN
0270 *
0280 MOVE 'Example - Description 1.' TO DESCRIPTION(1)
0290 MOVE 'Doc. description 2.'      TO DESCRIPTION(2)
0300 MOVE 'Doc. description 3.'      TO DESCRIPTION(3)
0310 MOVE 'Doc. description 4.'      TO DESCRIPTION(4)
0320 MOVE 'Key 1'                    TO KEYWORDS(1)
0330 MOVE 'Key 2'                    TO KEYWORDS(2)
0340 MOVE 'Key 3'                    TO KEYWORDS(3)
0350 MOVE 'Key 4'                    TO KEYWORDS(4)
0360 MOVE 'Key 5'                    TO KEYWORDS(5)
0370 MOVE 'Key 6'                    TO KEYWORDS(6)
0380 MOVE 'X'                        TO PRIVATE-FLAG
0390 MOVE '6666'                     TO SECURITY-FLAGS
0400 MOVE 20010807                   TO EXPIRATION-DATE
0410 MOVE 'X'                        TO ARCHIVE-FLAG
0420 *
0430 CALLNAT 'Z-IN11UX'
0440   RETURN-CODE
0450   CABINET
0460   PASSWORD
0470   DOCUMENT-NAME
0480   ISN
0490   DESCRIPTION(*)
0500   KEYWORDS(*)
0510   PRIVATE-FLAG
0520   SECURITY-FLAGS
0530   FORMATTING-PROFILE
0540   PRE-FORMAT-PROCEDURES(*)
0550   POST-FORMAT-PROCEDURES(*)
0560   EXPIRATION-DATE
0570   ARCHIVE-FLAG
0580 *
0590 IF  RETURN-CODE EQ 0
0600   WRITE 'Document was updated'
0610 ELSE
0620   WRITE 'Return code ' RETURN-CODE
0630 END-IF
0640 *
0650 END