Retrieve DLO Authority (RTVDLOAUT)
| Where allowed to run: Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX) Threadsafe: No |
Parameters Examples Error messages |
The Retrieve Document Library Object Authority (RTVDLOAUT) command retrieves the authority assigned to a folder or filed document.
Restrictions:
- A user must be in the system distribution directory entry to retrieve the various authorities.
- A user must have at least use (*USE) authority to the filed document or folder.
- A user with less than all (*ALL) authority to the filed document or folder will only be able to retrieve that user's authority or the owner.
- A user must have *ALL authority to the object, or all object (*ALLOBJ) special authority, or be the owner of the filed document or folder, to retrieve all the authorities.
- A user must have *ALLOBJ special authority to retrieve the *ROOT folder public authority.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| DLO | Document library object | Character value, *DOCID, *LADNTSP, *SYSOBJNAM, *ROOT | Required, Positional 1 |
| FLR | Folder | Character value, *NONE | Optional, Positional 2 |
| DOCID | Document identifier | Character value, *NONE | Optional |
| LADNTSP | LADN timestamp | 0000000000000001-FFFFFFFFFFFFFFFF, *NONE | Optional |
| SYSOBJNAM | System object name | Name, *NONE | Optional |
| STRUSRAUTE | Starting user authority entry | 1-99999, 1 | Optional |
| OWNER | CL var for OWNER (10) | Character value | Optional |
| AUTL | CL var for AUTL (10) | Character value | Optional |
| SENSITIV | CL var for SENSITIV (20) | Character value | Optional |
| PUBAUT | CL var for PUBAUT (10) | Character value | Optional |
| CHKOUTUSR | CL var for CHKOUTUSR (32) | Character value | Optional |
| ACC | CL var for ACC (220) | Character value | Optional |
| USRAUT | CL var for USRAUT (1020) | Character value | Optional |
| GRPAUT | CL var for GRPAUT (340) | Character value | Optional |
| PGP | CL var for PGP (10) | Character value | Optional |
| Top |
Document library object (DLO)
Specifies the name of the document or folder for which authorities are retrieved.
- *ROOT
- The root folder contains all first-level folders. If folder *ROOT is specified only public authority will be returned by PUBAUT parameter. No other authorities will be returned.
- *LADNTSP
- The timestamp from the library-assigned document name (LADN) specified on the LADNTSP parameter is used to identify the document or folder.
- *SYSOBJNAM
- The system object name specified on the SYSOBJNAM parameter is used to identify the document or folder.
- name
- Specify the user-assigned name of the document or folder.
| Top |
Folder (FLR)
Specifies the name of the folder where the object specified on the DLO parameter is located.
- *NONE
- The name of folder that contains the object is not specified, the object is not contained in a folder, or the object is specified using the LADNTSP, or SYSOBJNAM parameter, or *ROOT was specified in the DLO parameter.
- name
- Specify the name of the folder that contains the object.
Note: FLR(*NONE) must be specified if the object is a first-level folder.
| Top |
Document identifier (DOCID)
Specifies the library-assigned name of the document or folder.
- *NONE
- The object is not identified using its document identifier (DOCID)
- document-identifier
- Specify the document identifier of the document or folder. The document identifier is 24 hexadecimal characters in length in the format YYYYMMDDHHMNSSHSSNSNSNSN, where:
- YYYY = year
- MM = month
- DD = day
- HH = hour
- MN = minute
- SS = second
- HS = hundredths of a second
- SNSNSNSN = system name
| Top |
LADN timestamp (LADNTSP)
Specifies the LADN timestamp of the document or folder.
- *NONE
- The object is not identified using its LADN timestamp.
- timestamp
- Specify the LADN timestamp of the document or folder. The LADN timestamp is 16 hexadecimal characters in length in the format YYYYMMDDHHMNSSHS, where:
- YYYY = year
- MM = month
- DD = day
- HH = hour
- MN = minute
- SS = second
- HS = hundredths of a second
| Top |
System object name (SYSOBJNAM)
Specifies the system object name.
- *NONE
- The object is not identified using its system object name.
- name
- Specify the 10-character system object name of the document or folder.
| Top |
Starting user authority entry (STRUSRAUTE)
Allows a user to specify the starting user authority entry number to use when retrieving specific user authorities (USRAUT parameter). STRUSRAUTE will enable retrieving specific user authorities for a DLO that has more than 50 specific user authorities. If no CL variable is provided for the USRAUT parameter, this parameter is ignored.
- 1
- User authority will be returned starting with the first specific user authority.
- 2-99,999
- User authority will be returned starting with the specified entry number. If the value is greater than the number of specific user authorities for the DLO, an error message will be sent and no specific user authorities will be returned.
| Top |
CL var for OWNER (10) (OWNER)
Specifies the name of a 10-character CL variable used to retrieve the owner of the selected document or folder.
| Top |
CL var for AUTL (10) (AUTL)
Specifies the name of a 10-character CL variable used to retrieve the authorization list assigned to the selected document or folder. The value *NONE is returned if no authorization list has been assigned.
| Top |
CL var for SENSITIV (20) (SENSITIV)
Specifies the name of a 20-character CL variable used to retrieve the sensitivity assigned to the selected document or folder.
- *NONE
- The document has no sensitivity restrictions.
- *PERSONAL
- The document is intended for the user as an individual.
- *PRIVATE
- The document contains information that should be accessed only by the owner.
- *CONFIDENTIAL
- The document contains information that should be handled according to company procedures.
| Top |
CL var for PUBAUT (10) (PUBAUT)
Specifies the name of a 10-character CL variable used to retrieve the public authority assigned to the selected document of folder.
- *USE
- User can view, print, or copy the document or folder.
- *CHANGE
- User can perform all operations listed for *USE and can also edit and mark the document for offline storage.
- *ALL
- User can perform all operations on the document, except change ownership of the document or folder or give themselves authority to work with the document after authority has been revoked.
- *EXCLUDE
- All users who are not otherwise authorized to this document or folder are denied access.
- USER DEF
- Authority to this document is user-defined and is not one of the system-defined sets of authorities (*ALL, *CHANGE, *USE, *EXCLUDE).
- *AUTL
- Authority specified in the authorization list being used by this document should determine public authority.
| Top |
CL var for CHKOUTUSR (32) (CHKOUTUSR)
Specifies the name of a 32-character CL variable used to retrieve the user profile who has the document checked out and the user profile on whose behalf the document was checked out. If no user has checked out the documented, the 32-character variable will be blank. If the document was not checked out by a user working on behalf of another user, the last 16 characters will be blanks.
| Top |
CL var for ACC (220) (ACC)
Specifies the name of a 200-character CL variable used to retrieve the access codes assigned to the specified document or folder.
| Top |
CL var for USRAUT (1020) (USRAUT)
Specifies the name of a 1020-character CL variable used to retrieve the specific user authority assigned to the document or folder. USRAUT will return a maximum of 50 specific authorities per invocation of the RTVDLOAUT command. If the document or folder has more than 50 specific user authorities associated with it, you can use the STRUSRAUTE parameter on subsequent invocations of RTVDLOAUT to return user authorities starting with the specified entry numbers.
Within the 1020-character CL variable are the total number of authorized users, the number of authority entries returned, the starting entry number and the ending entry number.
For example:
RTVDLOAUT DLO(MYDOC) FLR(MYFLR) USRAUT(&RTNUSRAUT) + STRUSRAUTE(1)
In the example above, MYDOC has 55 authorized users. The total number of specific user authorities will be 55. The number of authority entries returned will be 50. The starting authority entry number will be 1. The ending authority entry number will be 51.
| Top |
CL var for GRPAUT (340) (GRPAUT)
Specifies the name of a 340-character CL variable used to retrieve the group authority assigned to the specified document or folder. Only the groups associated to the user of this command will be returned.
| Top |
CL var for PGP (10) (PGP)
Specifies the name of a 10-character CL variable used to retrieve the primary group assigned to the specified document or folder. The value *NONE is returned if no primary group has been assigned.
| Top |
Examples
Example 1: Retrieve the Owner of a Document Library Object
RTVDLOAUT DLO(MYDOC) FLR(MYFLR) OWNER(&OWNER)
This command retrieves the owner of document library object MYDOC in folder MYFLR and stores the value in the variable &OWNER.
Example 2: Retrieve Private User Authorities for a Document
RTVDLOAUT DLO(MYDOC) FLR(MYFLR)
USRAUT(&RTNUSRAUT) STRUSRAUTE(1)
This command retrieves the user authorities for document MYDOC in folder MYFLR and stores the list in the &RTNUSRAUT variable. The list will contain up to 50 privately authorized users and their authorities.
| Top |
| Top |