The AUTHCODE service changes or
retrieves the authorization code in the SCLM accounting information
for members in a library that match a given pattern. The AUTHCODE
service does not change the member's statistics or any other value
in the accounting record, including the change date and time.
The
AUTHCODE service can either set all authorization codes that match
a given member and type pattern, or set only those authorization codes
that also already have a particular authorization code.
To
set the authorization code for all members that match a pattern, leave
the from_authcode parameter blank.
If
only members with a certain authorization code are to be set, use
the from_authcode parameter to tell SCLM
to change only those members with the given authorization code.
To
retrieve the authorization code, leave both the from_authcode and
the to_authcode parameters blank. The existing authorization code is returned in
variable ZSAAUTH if a single member is requested. If a pattern is
requested, the existing authorization codes can be retrieved from
the AUTHCODE report.
Command invocation format
>>-FLMCMD--AUTHCODE,project--,-+---------+--,group--,type------->
'-prj_def-'
.-C-.
>--,member--,-+---------------+--,-+-------------+--,-+---+----->
'-from_authcode-' '-to_authcode-' '-U-'
>--,-+-------------+--,-+-------------+------------------------><
'-dd_authmsgs-' '-dd_authrept-'
Call invocation format
>>-lastrc--:=--FLMLNK('AUTHCODE',sclm_id,--,group--,type-------->
.-C-.
>--,member--,from_authcode--,to_authcode--,-+---+--------------->
'-U-'
>--+--------------------------------+--);----------------------><
'-,dd_authmsgs--+--------------+-'
'-,dd_authrept-'
ISPF interface panel
Figure 1. AUTHCODE Service panel Menu SCLM Utilities Help
──────────────────────────────────────────────────────────────────────────────
SCLM FLMCMD AUTHCODE Service - Entry Panel
SCLM Library:
Project . . . SCLMTEST
Alternate . .
Group . . . . DEV1
Type . . . . SOURCE
Member . . .
From Authorization code (If blank, all authcodes are changed for
change request)
To Authorization code (Required for change request)
Mode . . 1 1. Conditional
2. Unconditional
DD Names for output data sets:
Error message data set (Blank to write messages to the terminal)
Report data set . . . . (Blank to write report to the terminal)
Command ===>
F1=HELP F2= F3=END F4=DATASETS F5=FIND F6=CHANGE
F9=SWAP F10=LEFT F11=RIGHT F12=SUBMIT
Parameters
- project
- The project name. The maximum parameter length is 8 characters.
- prj_def
- The project definition name. It defaults to the project name.
The maximum parameter length is 8 characters.
- sclm_id
- An SCLM ID associated with a given project and project definition.
The INIT service generates the SCLM ID. The maximum parameter length
is 8 characters.
- group
- The group at which the member's authcode is to be changed. The
maximum parameter length is 8 characters.
- type
- A pattern used to select the types of members whose authcode is
to be changed. The maximum parameter length is 10 characters.
- member
- A pattern used to select the members whose authcode is to be changed.
You must specify a valid member name or a valid pattern. The maximum
parameter length is 10 characters.
- C|U
- Indicates whether the AUTHCODE service is to execute conditionally
(C) or unconditionally (U). This parameter only applies if the member
name is a pattern. If C is selected, processing stops after the first
error (default). If U is selected, the service continues to the next
member even if an error occurs.
- from_authcode
- The authorization code to be changed from. If the from_authcode
is blank and the to_authcode is given, then all members matching the
pattern have the authcode updated. If the from_authcode is not blank,
only those members matching the pattern, and whose authcode matches
the from_authcode, are updated. The maximum parameter length is 8
characters.
- to_authcode
- The authorization code to be changed to. If the to_authcode and
the from_authcode are both blank, no changes are made. If the from_authcode
is given, then the to_authcode is required. The maximum parameter
length is 8 characters.
- dd_authmsgs
- DDNAME of the destination of the AUTHCODE messages. If you specify
a blank ddname, SCLM routes the authcode messages to the default output
device, such as your terminal. Otherwise, before you call the AUTHCODE
service, you must allocate the ddname. The following attributes should
be used:
- DISP=MOD
- RECFM=F
- LRECL=80
- BLKSIZE=80.
The maximum parameter length is 8 characters.
- dd_authrept
- DDNAME of the destination of the AUTHCODE report. If you specify
a blank ddname, SCLM routes the authcode report to the default output
device, such as your terminal. Otherwise, before you call the AUTHCODE
service, you must allocate the ddname. The following attributes should
be used:
- RECFM=FBA
- LRECL=80
- BLKSIZE=3120.
The maximum parameter length is 8 characters.
Return codes
Other return codes might be
produced by the FLMCMD or the FLMLNK processor. See SCLM service return codes for more information.
Possible
return codes are:
- 0
- Normal completion. Authcode changed or reported successfully.
- 2
- Normal completion. Authcode not changed. One of the following
occurred:
- To_authcode = existing authcode (no change needed)
- From_authcode requested does not equal existing authcode (no change
wanted)
- Member is not editable.
- 4
- Warning condition. Segment exists at a lower level with an authcode
not equal to the to_authcode, which could
overlay the current segment.
- 8
- Error condition. Invalid type, member, or mode parameter. See
the dd_authmsgs for details.
- 12
- Severe error condition. Accounting record not found or severe
error.
- 16
- Severe error condition. One of the following occurred:
- Not authorized to update to_authcode,
access_key mismatch, or not authorized to update data set.
- Verification failed.
- Error updating accounting record.
- Invalid group.
SCLM might not produce messages because
there was an error invoking the AUTHCODE module.
Example of command invocation format
This
example shows a command interface to the AUTHCODE service, to update
the authorization code of SCLM70.USER.SOURCE(A) from base to private.
FLMCMD AUTHCODE,SCLM70,SCLM7010,USER,SOURCE,A,BASE,PRIVATE
This
example shows a command interface to the AUTHCODE service to unconditionally
update the authorization code from base to private for all members
beginning with FLM in all types of group USER in project SCLM70.
FLMCMD AUTHCODE,SCLM70,SCLM7010,USER,*,FLM*,BASE,PRIVATE,U
This
example selects the FLMCMD AUTHCODE service with no from_authcode
or to_authcode. It then gets the authcode value from variable ZSAAUTH
in the ISPF SHARED pool.
/* rexx exec to retrieve an authcode */
PARMS = 'SCLM70,SCLM7010,USER,SOURCE'
MEM = 'BES3 '
address ispexec 'select cmd(FLMCMD AUTHCODE,'PARMS','MEM')'
address ispexec 'vget zsaauth shared'
say 'authcode is' zsaauth
Call invocation format
This example shows
a program call to the AUTHCODE service. The example assumes that the
START and INIT services have already completed successfully.
CALL FLMLNK('AUTHCODE ',SLMID,'USER ', 'SOURCE ','A ',
'BASE ','PRIVATE ','C ', MSGDD,
REPTDD) RETCODE(R15);
This example shows a program
call to the AUTHCODE service to unconditionally update the authorization
code from 'base' to 'private' for all members beginning with FLM in
all types of group USER in project SCLM70.
CALL FLMLNK('AUTHCODE ',SLMID,'USER ', '* ', 'FLM* ',
' ','PRIVATE ','U ', MSGDD,
REPTDD) RETCODE(R15);
Example of an AUTHCODE report
*********************************************************************************
*********************************************************************************
**
**
** SOFTWARE CONFIGURATION AND LIBRARY MANAGER (SCLM)
**
** AUTHCODE UPDATE REPORT
**
** 1999/03/08 11:02:15
**
** PROJECT: PDFTDEV
** ALTERNATE: PDFTNEWL
** GROUP: BETH
** TYPE: ARCHDEF
** MEMBER: B*
** FROM_AUTHCODE: PRIVATE
** TO_AUTHCODE: BASE
** MODE: UNCONDITIONAL
**********************************************************************************
**********************************************************************************
STARTING ENDING COMPLETION
MEMBER TYPE AUTHCODE AUTHCODE STATUS
-------- -------- -------- -------- -----------
BETHTEST ARCHDEF BASE BASE NOT_ATTEMPTED
BETH7 ARCHDEF PRIVATE BASE SUCCEEDED
BETH8 ARCHDEF PRIVATE BASE SUCCEEDED
BETH9 ARCHDEF PRIVATE FAILED
BROKE ARCHDEF BASE BASE NOT_ATTEMPTED
BXC ARCHDEF NOT_EDITABLE