From the Retain Window, you can start, stop, view, and delete retained documents. You can schedule documents to print at a specific time, search the document list for text, and set the document disposition. You can also modify the document attributes for routing documents to spool printers.
When documents enter the Retain Window, their state is automatically set to Hold. Before you restore documents to the spool, you can enable them to print by setting the document state to Ready. The document attributes must also match a spool printer’s attributes for the document to print. Use one of these methods to set the document state to Ready.
Restoring a print job that contains multiple data sets in the Ready state may cause some of the data sets to print out of order. To avoid this, restore the job to the Spool Window in the Hold state.
Right-click a document or a group of selected documents, and select Ready.
Select the individual document or group of documents you want to start.
On the menu bar, select Document | Ready.
Select the document or group of documents you want to start.
From the toolbar, click the Ready button.
Click the toolbar’s ReadyMode button. (When the button is active, it appears pressed in on the toolbar.)
Click the documents you want to set to ready.
When you have finished, click the ReadyMode button again to switch back to a normal pointer.
You can prevent or stop spool documents from printing by setting the document state to Hold using one of these methods. When documents enter the Retain Window, their state is automatically set to Hold.
Right-click a document or a group of selected documents, and select Hold.
Select the individual document or group of documents you want to stop or put on hold.
On the menu bar, select Document | Hold.
Select the document or group of documents you want to stop or put on hold.
From the toolbar, select the Hold button.
Click the toolbar’s HoldMode button. (When the button is active, it appears pressed in on the toolbar.)
Click the documents you want to stop or put on hold.
When you have finished, click the HoldMode button again to switch back to a normal pointer.
You can delete an individual document or group of spool documents with one of these methods:
Right-click a document or a group of selected documents, and select Delete.
Select the individual document or group of documents you want to delete.
On the menu bar, select Document | Delete.
Select the individual document or group of documents you want to delete.
From the toolbar, select the Delete button.
To perform this task, you must have appropriate
user access rights.
Open the Configuration Utility.
From the Spool and Retain tab, under Options, click Purge Files. This will remove all files from the retain folder.
Do not delete retain documents with the Windows Explorer.
You must delete documents directly from the Retain Window.
You can view the text of a retained document using one of these methods:
Right-click the document, and select View. The document text displays in EBCDIC, which is the default display for the viewer.
Select the document to view.
On the menu bar, select Document | View.
To perform this task, you must have appropriate
user access rights.
Select the document you want to view.
From the toolbar, select the View button.
The selected document displays in the Viewer utility window. For more information about the Viewer utility, select Help from the Viewer window.
You can view retained document properties using one of these methods.
Right-click the document, and select Properties.
Use the tree view to select the header sections and fields containing the values you want to view.
When you finish viewing properties, click OK or Cancel to exit the Properties dialog box and return to the Retain Window.
Select the document to view.
On the menu bar, select Document | Properties.
Use the tree view to select the header sections and fields containing the values you want to view.
When you finish viewing properties, click OK or Cancel to exit the Properties dialog box and return to the Retain Window.
Select the document you want to view.
From the toolbar, select the Properties button.
Use the tree view to select the header sections and fields containing the values you want to view.
When you finish viewing properties, click OK or Cancel to exit the Properties dialog box and return to the Retain Window.
You can send retained documents to programs of your choice. Destination programs are stored in \\Program Files\Barr\Spooler\SendTo. If the SendTo folder does not already exist, it will be automatically created when you right-click a document in the Spool Window.
You must be granted the Document
- View user access right to use this option.
Once you have established destination programs, they will appear in the Retain Window's Send To list. A maximum of 20 destination programs can display in the Send To list. To set up destination programs, use one of the following methods.
Create program shortcuts in the SendTo folder.
Copy programs to the SendTo folder.
To send a document to a destination program, use one of the following methods in the Retain Window. Files sent from the spool to other programs are read-only. If you want to modify and save a file, use the program's Save As option.
On the menu bar, select Document | Send To | Program.
Right-click a document and select Send To | Program.
You can edit fields in the Retain Window’s document list before you restore documents to the Spool Window. Gray columns are protected and cannot be edited. You can change values for all document attributes except for Document, Size, Date, and Time. The new attribute values are stored in the document’s spool header. Use the following methods to edit fields.
To perform this task, you must have appropriate user access rights.
Right-click a document to display the Document commands menu.
Double-click a field to activate field edit mode so you can type a value (if the field accepts data entry). For example, double-click the Class field. In field edit mode, you can:
Right-click to display a menu of edit choices, such as cut, copy, and paste.
Use the tab keys to move between editable fields.
You can search the information displayed for each document listed on the Retain Window. For example, you can search for document names that end in the extension .rpt.
Complete the following steps to search for a text string.
On the menu bar, select Document | Find.
Enter the text to search for, and select the search Direction.
Click Find Next.
When the retain feature is enabled, documents are retained by default, unless you set their dispositions to Delete. Complete the following steps to change the document disposition in the Retain Window.
To perform this task, you must have appropriate
user access rights.
Add the Disposition (BARR_DISPOSITION) column to the Retain Window so you can easily identify each document's disposition and change the disposition on screen using the menu.
Right-click the desired document, or use the Retain Window's Document menu.
Select the desired command.
Delete After Printing – Sets the document disposition to Delete, which will delete documents after they print.
Retain After Printing – Sets the document disposition to Retain, which will retain documents after they print.
You can also change a document's
disposition in these locations:
Override table –
Create
an override table using the NDHBNORD
field in the Data Set Internal Custom Section to preset the document disposition
field's value to -1 (Delete) or
0 (Retain).
Print Utility –
From the Print Utility's Manual Spooling
tab, click Settings and assign a document attribute
for the NDHBNORD field.
You can print a list of documents in the Retain folder or write the list to a file. The name of the active Retain Window configuration file and the column headings from the Retain Window are included at the top of the listing.
Before you print the retain list, you can use the Retain menu’s Print Setup option to set up the printer and then use the Print Preview option to see how the listing will print.
On the menu bar, select Retain | Print Spool Listing.
Select a printer from the Name drop-down list.
Click Properties to view or change printer properties such as paper size, paper source, page orientation, and duplex printing.
Specify the Print Range. You can print the entire document list, a range of pages, or a portion of the list that you have highlighted in the Retain Window.
Specify the number of Copies and whether to Collate them.
Click OK to start printing.
On the menu bar, select Retain | Print Spool Listing.
Under Printer, select Print to file.
Click OK.
You can reprint documents from the Viewer utility, which you display by changing the document state.
Right-click the document and select View.
Set the reprint range.
When using a reprint range to print multiple
copies of a document, make sure you set
both the reprint starting point and reprint stopping point. If the reprint
stopping point is not set, the first copy will start at the specified
reprint starting point, but the remaining copies will reprint as the entire
document.
Click either the Reprint Now or Reprint Later button.
When you are ready to print the file, set the printer state to Reprint.
Make sure the document's attributes match the spool printer’s attributes.
Complete the following steps to restore a document or group of documents from the Retain Window to the Spool Window.
To perform this task, you must have appropriate user access rights.
Right-click the document or group of documents, and select Ready or Hold.
When you restore
the document to the Spool Window, the state selected will be the state
in the Spool Window. Documents set to Ready
will begin printing immediately, if their routing criteria matches that
of a spool printer. Restoring a print job that contains multiple data
sets in the Ready state may cause
some of the data sets to print out of order. To avoid this, restore the
job to the Spool Window in the Hold
state.
Right-click the document, and select Restore. This will restore the document to the spool.
You can schedule documents to print at a specific time. For example, you can schedule certain jobs to print on a specific day of the week, or you can schedule large jobs to print at night. Jobs become eligible to print at the specified time. They might not actually print at the exact time, depending on how many other eligible jobs are ahead of them in the queue.
Select the document or group of documents you want to schedule.
On the menu bar, select
Document | Schedule (or right-click
and select Schedule). The Schedule
Print Date and Time dialog box displays. 
Use the calendar to select the print date.
In the Time box, specify the time of day (AM) or night (PM) you want the file to print.
Be sure the criteria of the documents matches the criteria of a spool printer, or the documents will not print as scheduled.
Set the document state to Ready so the document(s) can print as scheduled.
Select the document(s), and then click the Restore button to restore the document(s) to the Spool Window.
When you schedule a document to print and set the State field to Ready, the scheduled date and time displays in the State column after the word Ready.
Resize the State column
on the Retain Window so you can see the scheduled print date and time
or the ellipsis (...) that indicates
a scheduled date and time have been set.
You can select documents to include in the diagnostics file, the next time you run the Diagnostics Utility.
Select the documents to include in the diagnostics file.
Right-click and select Add to Diagnostics or, on the menu bar, select Document | Add to Diagnostics.
A list of the documents that will be included can be viewed from \\Temp\CustomDiag.txt. When the Diagnostics Utility is used, all of the documents listed in this file will be included, assuming they still reside in the directory specified.
The Diagnostics Utility must be run on the same computer where
the files reside.