Customizing the Retain Window view

The columns on the Retain Window display document attributes. The column display lets you control the document sort order and provides information about your retained documents. You can customize the view of the documents by filtering on values and sorting the columns. This is useful when trying to quickly find documents in the window. You can also change the attribute columns and the order in which the columns display. Your display choices can be saved to a settings file. If you want to switch between views, you can specify which settings file to use.

See also:


Adding columns

Complete the following steps to add new columns to the Retain Window.

  1. Open the Retain Window.

  2. On the menu bar, select View | Format Columns to display the Format Columns dialog box.

    Format Columns Dialog Box

  3. From the Available sections list, select the section that contains the fields you want to add. The fields for the selected section display in the Available columns list.

  4. Select a field in the Available columns list and click the arrow (>) to add it to the Visible columns list. You can also add fields by double-clicking entries in the Available columns list.

  1. When you finish adding and arranging columns, click OK to return to Retain Window.

Removing columns

Complete the following steps to remove columns from the Retain Window.

  1. Open the Retain Window.

  2. On the menu bar, select View | Format Columns to display the Format Columns dialog box.

    Format Columns Dialog Box

  3. Select a field in the Visible columns list and click the arrow (<) to remove the field from the display and return it to the Available columns list.

  4. When you finish removing and arranging columns, click OK to return to the Retain Window.

Changing the column order

Columns on the window display from left to right. To move a column to the left on the window, you need to move it up in the Visible columns list. To move a column to the right on the window, you need to move it down in the Visible columns list. To change the column order, complete the following steps.

  1. Open the Retain Window.

  2. On the menu bar, select View | Format Columns to display the Format Columns dialog box.

    Format Columns Dialog Box

  3. Select a field in the Visible columns list.

  4. Click Move Up to move the field up in the list (to the left on the window). Click Move Down to move the field down in the list (to the right on the window). Each click shifts the field by one column position.

  5. When you finish arranging columns, click OK to return to the Retain Window.

Renaming columns

You can rename the column headings that appear in the Retain Window. Usually, the field description displays as the column heading in the Spool Window. If a field does not have a description, the field name displays as the column heading. Complete the following steps to rename columns.

  1. Open the Retain Window.

  2. On the menu bar, select View | Format Columns to display the Format Columns dialog box.

    Format Columns Dialog Box

  3. Select a field in the Visible columns list.

  4. Click Rename. Removing the column from the Visible columns list will restore the default column name.

  5. When you finish renaming columns, click OK to return to the Retain Window.

Restoring window settings

You can restore the Retain Window settings to the default settings or the most recently saved settings.

To restore default settings

You can reapply the default settings or use them as the starting point for creating new settings.

  1. Open the Retain Window.

  2. On the menu bar, select View | Clear Settings.

To restore saved settings

While making changes to your window settings, you can abandon your changes and revert to the most recently saved settings.

  1. Open the Retain Window.

  2. On the menu bar, select View | Revert Settings.

To restore the display

You can remove the viewing sort order and the applied filters. This will restore the view to the current sort order defined by the Add Sort Criteria Wizard. If a custom sort order has not been defined the default order will be restored. Use one of the following methods to restore the display.

Saving window settings

You can save your Retain Window column settings to a settings file (.brt). This file contains custom settings such as the sort order, filters, column names, column order, etc. If you want to switch between views, you can specify which settings file to use. If you exit the Retain Window, the next time you display the window, your settings will be restored.

The steps you perform to save your settings depend on whether you are writing to a new file or updating an existing file.

You must be granted the Configure - Spool Window user access right to use this option. See the Using the User Rights Configuration utility topic for more information.

To save new settings

Complete the following steps to save your current column choice settings to a new file.

  1. Open the Retain Window.

  2. On the menu bar, select View | Save Settings As.

  3. Specify the file name and file folder. The file will be saved as a Retain Window settings (.brt) file.

  1. Click Save.

To save changes to existing settings

Complete the following steps to update a previously saved file with your changes.

  1. Open the Retain Window.

  2. On the menu bar, select View | Save Settings.

Opening window settings

Complete the following steps to apply column settings you saved to a file.

  1. Open the Retain Window.

  2. On the menu bar, select View | Open Settings.

  3. Select the appropriate settings file (.brt), and click Open. The most recent settings file opened in the Retain Window will automatically open by default, when the Retain Window is opened.

Matching window settings to the Spool Window

You can automatically or manually update the Retain Window settings to match the Spool Window settings.

To automatically update Retain Window settings to match Spool Window

Complete the following steps to automatically update the Retain Window settings to match the Spool Window settings.

  1. In the Spool Window, customize the view as desired.

  2. Open the Configuration Utility.

  3. On the Spool and Retain tab, select Match Barr Retain settings to Spool Window, and then click OK.

    Spool and Retain Tab

  4. On the Spool Window menu bar, select View | Save Settings As. The Save As dialog box displays.

  1. Specify the file name and folder, and then click Save. The default location is \\BHCS\Settings, unless an alternate path was specified during installation. The file will be saved as both a Spool Window settings (.bsp) file and a Retain Window settings (.brt) file. For example, if you save the Spool Window settings file as settings.bsp, the Retain Window settings file will be named settings.brt.

  1. Open the Retain Window.

  2. On the menu bar, select View | Open Settings.

  3. Select the appropriate settings file (.brt), and click Open. The default location for the file is \\BHCS\Settings, unless an alternate path was specified during installation. The most recent settings file opened in the Retain Window will automatically open by default, when the Retain Window is opened.

If you make changes to the Spool Window settings and save those changes to the Spool Window settings file, the Retain Window settings file will automatically be updated with those changes. If the Retain Window is open when the Retain Window settings file is updated, you will need to close and open the Retain Window for the new settings to be applied.

To manually update the Retain Window settings to match Spool Window

Complete the following steps to manually update the Retain Window settings to match the Spool Window settings.

  1. In the Spool Window, customize the view as desired.

  2. On the Spool Window menu bar, select View | Save As Retain Settings .

  3. Specify the file name and file folder, and then click Save. The default location is \\BHCS\Settings, unless an alternate path was specified during installation. The file will be saved as a Retain Window settings (.brt) file.

  4. Open the Retain Window.

  5. On the menu bar, select View | Open Settings.

  6. Select the appropriate settings file (.brt), and click Open. The default location for the file is \\BHCS\Settings, unless an alternate path was specified during installation.

If you make changes to the Spool Window settings and save those changes to the Spool Window settings file, you will need to repeat this procedure to update the Retain Window settings file and Retain Window settings with those changes.

Filtering documents from the window

You can customize the view of the documents by filtering on values. This is useful when trying to quickly find documents in the Retain Window. You must restore the view for normal operation.

You can use filters to view only the documents that meet conditions you specify. You can filter documents based on the column and column value. For example, if you filter the Class column on value A and select to include this value in the view, only documents with a class value of A will display in the Retain Window. All of the other documents still exist and can be seen again by removing the filter. You can apply an unlimited number of filters to the view. To remove the filter and restore the view, click the Clear Custom View toolbar button.

Complete the following steps to filter values.

  1. On the menu bar, select Document | Custom Filter. The Custom Filter dialog box displays.

    Custom Filter Dialog Box

  2. From the Column name drop-down list, select the column you want filtered.

  3. Under Value, select a value from the list or type a value in the box. You can use wildcard characters (? and *) to filter values. For example, if you filter the Data set copies column on value 2??, all documents with a 3 digit copy count beginning with the number 2 will be filtered.

  1. Click the arrow (>) to add the column and value to the Filters list. To remove a filter, select the filter in the Filters list and click the arrow (<). You can also add and remove filters by double-clicking entries in the Value and Filters lists.

  1. Select if the filter should display in the view by right-clicking the filter in the Filters list and selecting Include or Exclude. By default, the filter will be included in the view.

  2. When you finish creating your filters list, click OK to return to the Spool Window. A blue arrow appears on the document column heading, and the status bar displays the word Filtered.

Right-click a value in the document list, and select Filter on Value. This will filter the view on the selected column and value. You can apply multiple filters by repeating this action.

Changing the viewing order

This will only affect the viewing sort order. You must use the Add Sort Criteria Wizard to modify the printing sort order.

You can customize the view of the documents by sorting the document columns. This is useful when trying to quickly find documents in the Retain Window. You must restore the view for normal operation.

To change the order in which documents display in the Retain Window, click the column heading. A yellow box with a number and arrow will appear to indicate the sort order and if the documents are being displayed in ascending or descending order. Click the column heading again to change the ascending descending order. You can sort on up to 15 columns. By default, the BARR_FOLDER field (Job's Folder column) is designated as the last sort criteria for the viewing sort order. This is necessary to keep multiple data sets with their associated print job. All data sets will be grouped together with its print job except under these circumstances:

SYSIN jobs: When sorting, all SYSIN jobs will stay intact and in sequential order, and the sort criteria is based only on the first data set in the job.

To remove individual sorting criteria, press the SHIFT key and click the appropriate column heading. To remove the viewing sort order entirely, click the Clear Custom View toolbar button.