Z-REN05

This document covers the following topics:

Description

Mark a cabinet for renaming purposes.

Only a supervisor or cabinet administrator can use this subprogram.

After a cabinet has been marked, it is not renamed until the date specified in the parameter Date-rename has been reached and utility "Rename Cabinets" is run. For further information, see Rename Cabinets in the Con-nect Utilities documentation.

This subprogram can also be used to cancel a cabinet for rename and to obtain the status of a cabinet.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1:no ET.
Cabinet A8 R   The cabinet ID of a supervisor or cabinet administrator.
Password A8 R   The password of the above cabinet.
Function A1 R   S=set status to pending for renaming. R=reset status pending for renaming. D=display status.
Current-cabinet-name A8 R   Name of cabinet before rename.
New-cabinet-name A8 R   Pertains only to Function S. The name of the cabinet after rename completed.
Date-rename A8 O   Pertains only to Function S. Format=yyyymmdd. Date specified is interpreted as GMT date and GMT time as 0. If date is not specified, the current date is assumed.
Status-pending-rename A1   X X=cabinet is marked for rename. Empty=cabinet is not marked for rename.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
03 Password incorrect
15 Invalid administrator status
51 Invalid name (check syntax for New-cabinet-name)
52 Object with specified name already exists (New-cabinet-name)
90 Function is not correct
91 Cabinet record does not exist
92 Cabinet is already marked for rename
93 Cabinet is already marked for move
94 Cabinet is already marked for deletion
95 New-cabinet-name already used as new name for another cabinet
96 Invalid date format
97 Passed date
98 Cabinet was not marked for rename
99 Cabinet SYSCNT must not be used

Subprograms

Z-122
Z-120
Z-123
Z-1200&0
Z-MPPNM

Example

0010 DEFINE DATA
0020 *
0030 LOCAL
0040 1 RETURN-CODE           (N2)
0050 1 CABINET               (A8)
0060 1 PASSWORD              (A8)
0070 1 FUNCTION              (A1) 
0080 1 CURRENT-CABINET-NAME  (A8)
0090 1 NEW-CABINET-NAME      (A8)
0100 1 DATE-RENAME           (A8)
0110 1 STATUS-PENDING-RENAME (A1)
0120 *
0130 END-DEFINE
0140 *
0150 MOVE 'CABINET'   TO CABINET
0160 MOVE 'PASSWORD'  TO PASSWORD
0170 MOVE 'S'         TO FUNCTION 
0180 MOVE 'TEST1'     TO CURRENT-CABINET-NAME
0190 MOVE 'TEST2'     TO NEW-CABINET-NAME
0200 MOVE  19991010   TO DATE-RENAME
0210 *
0220 CALLNAT 'Z-REN05'
0230         RETURN-CODE
0240         CABINET
0250         PASSWORD
0260         FUNCTION
0270         CURRENT-CABINET-NAME
0280         NEW-CABINET-NAME
0290         DATE-RENAME
0300         STATUS-PENDING-RENAME
0310 *
0320 IF RETURN-CODE EQ 0
0330         WRITE 'The cabinet 'CURRENT-CABINET-NAME' is
0340                 marked for renaming '
0350 ELSE
0360         WRITE 'Return code' RETURN-CODE
0370 END-IF
0380 *
0390 END