Reorganize Document Lib Object (RGZDLO)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Reorganize Document Library Object (RGZDLO) command allows you to reorganize:
- all document library objects (optionally including unfiled mail documents)
- all filed documents not contained in a folder
- all document library objects within a specified folder
- all unfiled mail documents
- an individual document library object, specified by folder name, document name, or system-object-name
When a document is reorganized, unused storage is removed.
Restrictions:
- You must have all object (*ALLOBJ) or security administrator (*SECADM) special authority to specify DLO(*ALL) with either FLR(*ANY) or FLR(*NONE).
- To reorganize a document or folder, you must have *ALLOBJ or *SECADM special authority or you must have at least change (*CHANGE) authority to the document or folder and be enrolled in the system directory.
- To reorganize a document or folder, you must have exclusive access.
- To reorganize unfiled mail documents, all document and folder activity on the system must be stopped.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| DLO | Document library object | Character value, *ALL, *SYSOBJNAM | Required, Positional 1 |
| FLR | Folder | Character value, *NONE, *ANY | Optional, Positional 2 |
| SYSOBJNAM | System object name | Name | Optional |
| DAYS | Days since last referenced | 0-999, 0 | Optional |
| Reorganize unfiled mail | *NO, *YES, *ONLY | Optional |
| Top |
Document library object (DLO)
Specifies the name of the object being reorganized.
This is a required parameter.
- *ALL
- All document library objects are reorganized. If FLR(*NONE) is specified with this parameter, all folderless documents are reorganized. If FLR(*ANY) is specified with this parameter, all filed documents and folders are reorganized. If MAIL(*YES) is specified with this parameter, all unfiled mail documents as well as all filed documents and folders are reorganized. If MAIL(*ONLY) is specified with this parameter, only unfiled mail documents are reorganized. If FLR(name) is specified with this parameter, all folders and documents within it are reorganized.
- *SYSOBJNAM
- A system object name specified on the System object name (SYSOBJNAM) parameter is used to identify the document or folder being reorganized.
- name
- Specify the name of the document or folder to be reorganized. The Folder (FLR) parameter also can be used to reorganize a document by specifying reorganization of:
- The folder that contains the document being reorganized
- The folder that contains the nested folder that contains the document being reorganized
| Top |
Folder (FLR)
Specifies the folder that contains the documents or folders. If the documents or folders do not exist in a folder, *NONE is specified.
- *NONE
- The document or folder is not contained in a folder. When DLO(*ALL) is specified, this refers to all documents not contained in a folder; when DLO(name) is specified, this refers to a first-level folder.
- *ANY
- All document library objects will be reorganized including those not contained in any folder. This value is valid only when DLO(*ALL) is specified.
- name
- Specify the name of the folder that contains the documents or folders.
| Top |
System object name (SYSOBJNAM)
Specifies the system object name of an individual folder or document being reorganized.
| Top |
Days since last referenced (DAYS)
Specifies the number of days that must have elapsed since a document library object was last referred to before it can be reorganized.
- 0
- All objects requested will be reorganized.
- 1-999
- Specify the number of days that must have elapsed since a document library object was referred to before it can be reorganized.
| Top |
Reorganize unfiled mail (MAIL)
Specifies whether objects to be reorganized should include, omit, or be limited to unfiled mail documents.
- *NO
- Unfiled mail documents will not be reorganized.
- *YES
- Unfiled mail documents will be reorganized. This value is valid only when DLO(*ALL) and FLR(*ANY) are specified.
- *ONLY
- Only unfiled mail documents will be reorganized. This value is valid only if DLO(*ALL) and FLR(*ANY) are specified.
| Top |
Examples
Example 1: Reorganizing Folders and Documents
RGZDLO DLO(*ALL) FLR(*ANY)
This command reorganizes all filed folders and documents that exist on the system.
Example 2: Reorganizing Folders, Documents, and Unfiled Mail
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*YES)
This command reorganizes all filed folders, documents, and all unfiled mail documents that exist on the system.
Example 3: Reorganizing Unfiled Mail Documents
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*ONLY)
This command reorganizes all unfiled mail documents that exist on the system.
Example 4: Reorganizing Folderless Documents
RGZDLO DLO(*ALL) FLR(*NONE)
This command reorganizes all folderless documents that exist on the system.
Example 5: Reorganizing Documents Within Folders Within Folders
RGZDLO DLO(*ALL) FLR(FLRA)
This command reorganizes all documents within folders contained in folder FLRA, then the folders within folder FLRA are reorganized.
Example 6: Reorganizing an Individual Document or Folder
RGZDLO DLO(*SYSOBJNAM) SYSOBJNAM(DCN1371951)
This command reorganizes the individual document or folder identified by the SYSOBJNAM object.
Example 7: Reorganizing a Document
RGZDLO DLO(DOC1) FLR(FLRA)
This command reorganizes the document named DOC1 in folder FLRA.
Example 8: Reorganizing Documents Not Referenced
RGZDLO DLO(*ALL) FLR(*ANY) DAYS(30)
This command reorganizes all filed documents and folders that have not been referenced in the past 30 days.
| Top |
Error messages
*ESCAPE Messages
- CPF8AB1
- &1 objects reorganized; &2 objects not reorganized.
- CPF8AB2
- RGZDLO command failed.
| Top |