Work with Saved Spooled Files (WRKSPLFBRM)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Work with Saved Spooled Files using BRM (WRKSPLFBRM) command creates a display or report of saved spooled files based on specified libraries, output queues, auxiliary storage pools, files, job names, users, date ranges and sequences. Processing the Work with Saved Spooled Files command takes you to the Work with Saved Spooled Files display where you can remove, display or retrieve selected spooled file entries as well as work with media that contains saved spooled files. If you want to produce a report, the report that is produced is the Saved Spooled File report. The report, if printed, is written to printer file QP1AOQ.
To use this command, you must have the Backup Recovery and Media Services for IBM i licensed program installed.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| OUTQ | Output queue | Qualified object name | Optional, Positional 1 |
| Qualifier 1: Output queue | Name, *ALL | ||
| Qualifier 2: Library | Name, *ALL | ||
| ASP | Auxiliary storage pool | Character value, *ALL, *SYSTEM | Optional, Positional 2 |
| FILE | File | Name, *ALL | Optional, Positional 3 |
| JOB | Job name | Name, *ALL | Optional, Positional 4 |
| USER | User | Name, *ALL | Optional, Positional 5 |
| USRDTA | User data | Character value, *ALL | Optional, Positional 6 |
| SLTDATE | Select dates | Element list | Optional |
| Element 1: From date | Character value, *BEGIN, *CURRENT | ||
| Element 2: To date | Character value, *END, *CURRENT | ||
| SAVSTS | Save status | *ALL, *ERROR, *NOERROR | Optional |
| SORT | Sequence option | *DATE, *FILE, *JOB | Optional |
| FROMSYS | From system | Character value, *LCL | Optional |
| OUTPUT | Output | Optional |
| Top |
Output queue (OUTQ)
Specifies the name of the library and output queue that you want to include in the display or report.
Qualifier 1: Output queue
- *ALL
- Include all output queues in the display or report.
- output-queue-name
- Specify the name of an output queue that you want to include in the display or report.
Qualifier 2: Library
- *ALL
- All libraries or special values containing the spooled files are to be included in the list of spooled files.
- library-name
- Specify the name of a library that contained the spooled file.
| Top |
Auxiliary storage pool (ASP)
Specifies the auxiliary storage pool that contained the spooled files when the spooled files were saved.
- *ALL
- Include all auxiliary storage pools that contained saved spooled files in the report or display.
- *SYSTEM
- You want to include saved spooled files that were in the system (1) auxiliary storage pool in the report or display.
- auxiliary-storage-pool-number
- Specify the number of an auxiliary storage pool that contained the saved spooled filed you want to include in the report or display.
- auxiliary-storage-pool-name
- Specify the name of an auxiliary storage pool that contained the saved spooled file that you want to include in the report or display.
| Top |
File (FILE)
Specifies the name of the printer file that contained the spooled file when it was saved that you want to include in the display or report.
- *ALL
- Include all files in the display or report.
- file-name
- Specify the name of a file that you want to include in the display or report.
| Top |
Job name (JOB)
Specifies the name of the job that which created the spooled file that you want to include in the display or report.
- *ALL
- Include all spooled files for jobs in the display or report.
- job-name
- Specify the name of a job whose files are to be included in the display or report.
| Top |
User (USER)
Specifies the name of the user that created the spooled file that you want to include in the display or report.
- *ALL
- Include files for all users in the display or report.
- user-name
- Specify the name of a user whose files are to be included in the display or report.
| Top |
User data (USRDTA)
Specifies the data associated with the spooled file that was saved and that you want to include in the display or report.
- *ALL
- Include all user data in the display or report.
- user-data
- Specify the user data that you want to include in the display or report.
| Top |
Select dates (SLTDATE)
Specifies a range of dates that you want to use when reporting on saved spooled files. The From date is the beginning of a date range and the To date is the end of the date range.
Note: The From date is based on the date the spooled file was created.
Note: Using this parameter, it is possible to enter a date with no separator, or a number of days which can be up to 5 digits in length. For instance, if you are using month/day/year format, the number 12904 would be formatted as January 29, 2004. If on the other hand, you entered a number 13904, BRMS assume that this is not a date, but rather is a number. BRMS always tries to calculate a calendar date first when a number is entered and then if the date it calculates is not valid, assumes that it is a number of days. If the number that is entered is over 5 digits and the date that it calculates is not valid, you receive an error message.
Element 1: From date
- *BEGIN
- The earliest save date on the file is the beginning date of a date range.
- *CURRENT
- The current date is the beginning date of a date range.
- from-date
- Specify the date in job date format with or without date separators that you want to be the beginning date of a date range.
- number-of-days
- Specify the number of days before the current day that is used to determine the starting date of the date range.
Element 2: To date
- *END
- The last date found in the file is the end of the date range for the search.
- *CURRENT
- The current date is the ending date of the date range.
- to-date
- Specify the date in job date format with or without date separators that you want to be the ending date of a date range.
- number-of-days
- Specify the number of days before the current day that is used to determine the ending date of the date range.
| Top |
Save status (SAVSTS)
Specifies whether you want to display or report all successful saves, unsuccessful saves or both.
- *ALL
- You want to include media information that was saved successfully and unsuccessfully in the display or report.
- *ERROR
- You want to include only unsuccessful saves in the display or report.
- *NOERROR
- You want to include only successful saves in the display or report.
| Top |
Sequence option (SORT)
The saved spooled file report can be sequenced several ways.
- *DATE
- Sequences the saved spooled file report by date.
- *FILE
- Sequences the saved spooled file report by file.
- *JOB
- Sequences the saved spooled file report by job.
| Top |
From system (FROMSYS)
Specifies the location and network identification of the system whose spooled file information that you want to work with.
Note: Use the Display Network Attributes (DSPNETA) command to view the system network attributes.
Note: The BRMS Network feature (Option 1) is required to use this value if a value other than *LCL is specified.
- *LCL
- Specifies that the from-system is the local system. BRMS uses the Default local location name (LCLLOCNAME) network attribute and not the System name (SYSNAME) network attribute to determine the current system name. In most cases, the systems have the same value specified for LCLLOCNAME as for SYSNAME.
- location-name
- Specifies the Default local location name (LCLLOCNAME) network attribute of the remote system for the network operation. The current system Local network ID (LCLNETID) network attribute is used to connect with the remote system.
- network-id.location-name
- Specifies the Local network ID (LCLNETID) and the Default local location name (LCLLOCNAME) network attributes of the remote system for the network operation. Specify these values using the format nnnnnnnn.cccccccc where nnnnnnnn is the LCLNETID and cccccccc is the LCLLOCNAME.
| Top |
Output (OUTPUT)
Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
- *
- The output is displayed (if requested by an interactive job) or printed (if requested by a batch job).
- The output is printed with the job's spooled output.
| Top |
Examples
Example 1: Work with Saved Spooled Files by Date
WRKSPLFBRM SLTDATE('1/1/03' '4/2/03') SORT(*JOB)
This command displays the Work with Saved Spooled Files panel, showing a list of all spooled files that were saved from January 1 to April 2, 2003. The spooled files are displayed in job sequence.
Example 2: Work with Saved Spooled Files by ASP
WRKSPLFBRM ASP(PRIMETIME)
This command displays the Work with Saved Spooled Files panel, showing a list of all spooled files that were saved from auxiliary storage pool device PRIMETIME. The spooled files are displayed in date sequence.
| Top |
Error messages
*ESCAPE Messages
- BRM1917
- Feature not installed.
- BRM1921
- Feature not licensed.
- BRM2154
- ASP value of *ALL must be specified.
- BRM215A
- ASP value of *ALL or 1-32 must be specified.
- BRM40A2
- BRMS product initialization required.
| Top |