Initiating a COLD Process Format Manually - AFP Input Filter - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Premier - Standard

AFP Input Filter
Platform
OnBase
Product
AFP Input Filter
Release
Foundation 24.1
License
Essential
Premier
Standard
  1. In the Client module, select Processing | COLD/ERM. The COLD Queue window is displayed.
  2. Select the COLD Process queue.
  3. Within the COLD Process queue, select the desired Process Format name.
  4. Right-click on the Process Format name and select COLD Processor. The COLD dialog box is displayed.
    The options specified at this dialog box control the way data is processed and archived into the database. The options are explained in the table below.

    Process Format Option

    Description

    Store Document Indices

    Stores the processed documents in the database, along with their Keyword Values and document name. This option is enabled by default.

    Store Document Data Files

    Moves the data file to the configured Disk Group at the completion of processing. This option is enabled by default.

    This option must be selected for COLD processing to occur.

    Store Import File

    This option is not supported for use with AFP.

    Create Auto Folder

    Stores the files in the auto folder currently assigned to the Document Type, as the files are processed.

    Note:

    This option is only functional when foldering has been configured. For more information, see the Folders Module Reference Guide or Help file.

    Test Only

    Processing only occurs in memory, and displays a Verification Report. This option will not create any documents within OnBase, and the processing file is not deleted.

    Default Document Date

    Allows entry of a date that will store for the documents as the Document Date. This option will override the actual document date, unless pulling from the file.

    Default Keywords

    Allows for selection of Keyword Types (and associated values) to be added to each document processed, in addition to the Keyword Types detected per the COLD configuration.

    Process

    Initiates the selected COLD process.
  5. To add one or more default Keyword Values to each document processed, in addition to the Keyword Values detected by the AFP process, click Default Keywords. The Auto Assign Keywords dialog box is displayed.
    Select a Keyword Type from the Keyword Types list and enter a value for it in the Keyword field. Click Add>> to move the Keyword Type and the value to the Assigned Keywords list.
    To remove a Keyword Type and its associated value from the Assigned Keywords list, select the Keyword Type and click <<Remove.
    Note:

    In order for the default Keyword Value(s) to be added to the documents imported by the AFP process, the Keyword Type(s) associated with the value(s) must be assigned to the Document Type.

  6. Enter a date in the Default Document Date field or click the calendar icon to select a date to assign a default Document Date to all documents imported by the AFP process. This option will override the actual document date, unless pulling from the file.
  7. After the desired options are set, click Process.
    The process will begin, and a status bar will display as the process is completing.
  8. The processed batch is placed in one of several data queues, depending upon the success of the process and whether it has been committed. Each queue is explained more fully in the table below.

    Queue

    Description

    COLD Process

    Displays the currently configured COLD Process Formats for selection. COLD processing is initiated from this queue.

    Process Jobs

    Displays the currently configured Process Jobs (configured in any of the import processors). Process jobs are initiated from this queue.

    Incomplete Process

    Lists all batches that were not successfully processed. This queue is displayed only when processes are incomplete. Batches will be displayed in this queue if an error occurred during the process. For more information on batches in this queue, see Incomplete Process and Incomplete Commit Queues.

    Awaiting Commit

    Lists all the batches that were processed into the database, and are in an uncommitted state. Batches in this queue can be committed or purged from OnBase. This queue will only be displayed if batches are uncommitted.

    Incomplete Commit

    Lists all the batches that began the commit process, but were not successfully committed. This queue is displayed only when you have processes that are incomplete. Batches will be displayed in this queue if an error occurred during commit. For more information on batches in this queue, see Incomplete Process and Incomplete Commit Queues.

    Committed

    Lists all the batches that were processed and committed. Batches in this queue cannot be purged from OnBase.
    Each batch is given a batch number, starting at 101. The batch number is available when viewing a document's Properties.
    Note:

    If you double click the Process Format, the Parse File pane will display the text file(s) that will be processed. The Parse File pane displays all files that will be processed. It will vary based on the process setup and the files that exist in the process directory. If the file(s) to process are not in the directory, nothing will be displayed. (Multiple parse files appear if a wildcard was used to identify the data in the COLD Processor.)