Batch Profile Properties

Batch Profiles are a combination of settings and a workflow process map that defines the processing rules for batch cases in the CAPSYS CAPTURE system.  A Batch Profile specifies properties for a batch including Batch Profile Name, Batch Naming Prefix and Batch Index Fields and their properties.  A Batch Profile also has an associated workflow map that defines the processing rules and queues for a batch case. Batch Profile Properties are configured from the Properties Panel on the Batch Profiles Panel in the Process Manager Application. See the topic Create a Batch Profile for more information on creating a new Batch Profile.

 


Figure 1 - Batch Profile Properties Panel

Name

A unique name for this Batch Profile.

Process Data Store

The Process Data Store is a location (local or network share) where document and data files are stored for the batch profile.  The location used for the Process Data Store can be unique to each Batch Profile or Document Type, or it can be shared between several, or even all Batch Profiles and Document Types.  The decision whether to use unique or shared locations for the Process Data Store is usually a function of storage space availability or a desire to segregate data for performance, security or both.

The Process Data Store field is a required field.  The Batch Profile cannot be activated unless the Process Data Store reflects a valid UNC share. The format for the Process Data Store field should be as a Windows UNC share name, even if the location is local to the machine the Server is running on. Local drive letter designation is not supported.

The Save as Default for all new Process setting will remember this Process Data Store setting and use it as the default for all future Batch Profiles.

The Process Data Store field is a required field. The format for the Process Data Store field should be as a Windows UNC share name, even if the location is local to the machine the Server is running on. Local drive letter designation is not supported.

The CAPSYS CAPTURE Server service account and the IIS Application Pool identity may need to be changed from the default to a dedicated service account, as they will require an account that is authorized to access the Process Data Store.  The Application's anonymous user account may also need to be set to use the Application Pool's identity.

Priority

Default Value: 0

Accepted Value Range: 0-100

The Priority property for a Batch Profile represents a way to specify "processing priority" on the CAPSYS CAPTURE Server among all Batch Profiles and Document Types.  The default value is "0" which is the lowest processing priority.  Assigning a value greater than "0" will cause all cases and processes in that Batch Profile to be processed by the CAPSYS CAPTURE Server with a greater priority than those with a "0" priority.

The Priority property is relative among all the Batch Profiles and Document Types in the CAPSYS CAPTURE System.  Batch Profiles and Document Types with higher values will be given processing priority over those with lower values.  However for example, setting all Batch Profiles and Document Types to a priority of "50" nullifies the prioritization effect since they would all have the same relative priority.

Batch Prefix

Every batch in a CAPSYS CAPTURE system is identified by a unique Batch ID. The Batch ID is a combination of a Batch Prefix with an incremental number. The Batch Prefix can be set to any value, but is most useful when set to a value that helps associate the Batch ID with its Batch Profile.  For example, if the Batch Profile name is "Accounting," an appropriate Batch Prefix might be ACCT_. The resulting Batch Prefix would be ACCT_nnn (ACCT_1, ACCT_2, etc.).

Default Document Type

A Default Document Type can be set for each Batch Profile in CAPSYS CAPTURE.

Setting a default document type eliminates the need for CAPSYS CAPTURE Web Client users to choose which document type to use when they are manually separating loose files in a batch into the "pages" of identified documents. For example, when a Web client user loads the files contained in a batch created using such a batch profile into his/her Web client application, the default document type will automatically show on the "Index" page and the document type's indexing form will display.

Additionally, a default document type can be used with an Assembly Event within a Batch Profile Process to group all remaining unindexed pages in a batch together as a document.

Figure 2 - Batch Profile Properties Panel

 

When Used in Manual Document Separation

CAPSYS CAPTURE Web Client Users that are currently logged on when you make the change to the batch profile must log off, and then log on, before they will see the default document type behavior on the "Index" page in the CAPSYS CAPTURE Web Client application.

Currently, the default document type feature works for the CAPSYS CAPTURE Web Client user only if he/she retrieves a batch from a capture workflow queue that is part of the batch profile's process. The default document type behavior does not work for local batches. Local batches are batches created in the CAPSYS CAPTURE Web Client that are not yet "released" and uploaded to the CAPSYS CAPTURE Server for processing. A default document type also does not work for assembled documents retrieved from a queue defined in a document type's process.

When Used To Automatically Create Documents from Un-indexed Pages

Refer to Using the Assembly Event to Create Documents from Un-indexed Pages to learn how to use a default document type with this Assembly Event feature.

 

Reports Retention Rules

Reports Log Retention Rules specify how the CAPSYS CAPTURE Server manages the purging of report records in the CAPSYS CAPTURE Database.  By default, this feature is turned off (meaning no records are ever purged and all audit records are kept in the database indefinitely).  For a system with some volume, this could cause the CAPSYS CAPTURE Database to grow quite large over time, as a single case could potentially generate hundreds of audit records in its lifetime.

Reports Retention Rules apply to batches created using the specified Batch Profile and to documents created from those batches.  For example, if the audit retention rule for the batch profile Accounting is set to delete entries after 90 days, the CAPSYS CAPTURE System will delete all audit entries for a batch and its child documents created using the Accounting profile 90 days after the last child document arrives at a stop event in its process map.

Figure 3 - Batch Profile Properties Panel

Number of Days to Keep Log

Default Value: 0 - Disables the Audit Log Purge Feature

Accepted Values: 1 - n - When a value greater than 0 is entered, enables the Audit Log Purge Feature.  Suggested minimum value is 90 days when enabled.

The Number of Days to Keep Log specifies an aging for Audit Records.  Records older than the "age" specified by this field are purged from the CAPSYS CAPTURE Database and either deleted, written to a file, or migrated to another database.

Delete Old Entries

When the "Delete Old Entries" option is selected, Audit Records are simply deleted from the CAPSYS CAPTURE Database when they become older than their date of entry plus the "Number of Days to Keep Log".

Archive Old Entries to a File

When the "Archive Old Entries to a File" option is selected, Audit Records are written to a CSV file in the location specified when they become older than their date of entry plus the "Number of Days to Keep Log".

Archive Old Entries to a Database:

When the "Archive Old Entries to a Database" option is selected, Audit Records are written into the specified Database when they become older than their date of entry plus the "Number of Days to Keep Log".