SpoolFileList

Use the SpoolFileList activity to query the IBM i system's spool file facility.

General

The General tab contains the following fields:

Field Process Property? Module Property? Description
Name No No The name to be displayed as the label for the activity in the process.
IBM i Connection No Yes Select the IBM i connection resource to be used by the SpoolFileList activity.

Description

A short description of the SpoolFileList activity.

Input

The Input tab contains the following elements:
Input Element Description
JobFilter Is composed of three fields, JobName, JobUser, and JobNumber. If any of these fields are provided, then all three are required. If a job filter is provided, it will resolve to a single file.
TimeFilter Filters the output by the time the spool file was created.
PrinterDevicesFilter Filters the output by the printer device that the spool file is queued to. Duplicate this node to form a list of printer devices.
UserDataFilter Filters the output by user data. Accepts a single value.
FormTypeFilter Filters the output by form type. For example "*STD".
OutputQueuesFilter Filters the output by output queue. You can specify multiple output queues where each one consists of a library name and an object name. For instance, library: "QUSRSYS" and object "QEZJOBLOG".
StatusFilter Filters the output by the file's status. The following values are acceptable:
  • "*READY"
  • "*OPEN"
  • "*CLOSED"
  • "*SAVED"
  • "*WRITING"
  • "*HELD"
  • "*MESSAGE"
  • "*PENDING"
  • "*PRINTER"
  • "*FINISHED"
  • "*SENDING
  • "*DEFERRED"

You can specify multiple statuses.

UsersFilter Filters the output by the user who owns the spool file. *CURRENT represents the user specified on the connection resource. You can specify multiple users.
Note: For more information on these elements, see the IBM reference documentation for the QGYOLSPL program.

The Output tab consists of the following elements:

Output Element Description
FileName The name of the file.
FileNumber The number of the file on the IBM i spooling system.
TotalPages The total number of pages in the file.
FileStatus The file's status, for instance, "*READY".
CreationTime The date and time of the file's creation.
UserData The user data associated with the file.
FormType The form type of the spooled file, for example, "*STD".
Priority The priority of the job which produced the file.
JobInfo The JobName, JobUser, and JobNumber associated with the file.
OutputQueue The library and the object name associated with the file.
PrinterDevice The device to which the file is queued if any.

Fault

The Fault tab lists exceptions that are thrown by the SpoolFileList activity:
Fault Thrown When...
IBMiPluginException The plug-in fails to get a status response due to a plug-in error.
ActivityTimedOutException The plug-in fails to get a status response due to a timeout error.
IBMiParameterConvertException The plug-in fails to convert the schema parameters.
IBMiRemoteException The plug-in fails to communicate with an IBM i system.