Installation and Setup Guide - Kofax · What is the global variables script class? ... Add a customer script to the Document_PreExtract and ... Perceptive Intelligent Capture Installation

Perceptive Intelligent Capture for Remittance Processing Installation and Setup Guide

Version: 1.0.x

Written by: Product Development Date: September 2016

© 2014 Perceptive Software. All rights reserved

Perceptive Software is a trademark of Lexmark International Technology S.A., registered in the U.S. and other countries. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known without the prior written permission of Lexmark.

Percept i ve In t e l l i gent Capture Ins ta l la t i on and Setup Guide

Page 3 of 78

Table of Contents

What is PIC for Remittance? ...................................................................................................................... 7

Install PIC for Remittance........................................................................................................................... 7

What is PIC for Remittance installation package? .................................................................................... 7

CedarDirectory directory ........................................................................................................................ 7

SDP directory ......................................................................................................................................... 7

SQL Scripts directory ............................................................................................................................. 7

Download the PIC for Remittance installation files ................................................................................ 7

Create the PIC for Remittance folder structure ......................................................................................... 7

Create the Pool directory ........................................................................................................................... 8

Install the PIC for Remittance project files ................................................................................................ 8

Run the database tables creation script .................................................................................................... 8

Configure the <project>.ini file .................................................................................................................. 9

Basic configuration settings ....................................................................................................................... 9

What is the <project>.ini file? .................................................................................................................. 10

Configure the PIC for Remittance registry settings .............................................................................. 11

Database settings ..................................................................................................................................... 11

What are the PIC for Remittance database settings? ............................................................................. 11

Configure the BRWSRC table ............................................................................................................. 13

Configure the BRWPAE table .............................................................................................................. 13

Configure the BRWMCR table ............................................................................................................. 13

Configure the BRWALS table .............................................................................................................. 14

Add a database entry in the BRWFLD table ........................................................................................ 14

Add a new row to the BRWEXPChecks or BRWEXPLines database tables ...................................... 15

Configure a database export ............................................................................................................... 15

Configure the Document Line Items table ........................................................................................... 15

Configure data export to the Document Header table ......................................................................... 15

Configure output to the Check table .................................................................................................... 16

Configure output to transactions .......................................................................................................... 16

About creating a user DSN for the Vendor Master table ..................................................................... 16

Create the Remitters pool .................................................................................................................... 17

Database tables ......................................................................................................................................... 18

BRWALS table ......................................................................................................................................... 18

BRWCUR................................................................................................................................................. 18


Page 4 of 78

BRWClient table ...................................................................................................................................... 19

BRWEXP table ........................................................................................................................................ 20

BRWEXPChecks ..................................................................................................................................... 25

BRWEXPLines table ................................................................................................................................ 25

BRWFLD table ......................................................................................................................................... 26

BRWINSTR table ..................................................................................................................................... 30

BRWIVR table ......................................................................................................................................... 30

BRWIVRType Table ................................................................................................................................ 31

BRWLBX table ......................................................................................................................................... 31

BRWMCR table ....................................................................................................................................... 33

BRWNUM table ....................................................................................................................................... 34

BRWNUM table ....................................................................................................................................... 34

BRWNUMFormats table .......................................................................................................................... 36

BRWPONFormats table .......................................................................................................................... 36

BRWPAE table ........................................................................................................................................ 37

BRWProfile table ..................................................................................................................................... 37

BRWRemittersPartition table ................................................................................................................... 38

BRWSRC table ........................................................................................................................................ 38

BRWSRC table ........................................................................................................................................ 39

BRWSubstition ........................................................................................................................................ 39

BRWUser table ........................................................................................................................................ 40

PICR_VersionHistory ............................................................................................................................... 40

Configure clients ....................................................................................................................................... 41

About configuring and adding clients ...................................................................................................... 41

Assigning documents to a client .......................................................................................................... 42

What are automatic user-import job errors? .......................................................................................... 42

Configure an automatic user-import job. ................................................................................................. 43

Customize scripts ..................................................................................................................................... 43

What is the project script class? .............................................................................................................. 43

What is script customization? .................................................................................................................. 43

What is the sequence of class dependencies? ................................................................................... 44

What is the project script organization? ............................................................................................... 44

What is the global variables script class? ............................................................................................ 44

About configuring the XML output file ................................................................................................... 52

Add a script to the XML export user exit ................................................................................................. 52


Page 5 of 78

Set up the remitters partition ................................................................................................................... 53

About setting up the Remitters partition .................................................................................................. 53

Register a partition ............................................................................................................................... 53

Activate partitioning .............................................................................................................................. 53

Assign a partition ID to the client ......................................................................................................... 53

About improving data extraction ............................................................................................................. 54

Export a TIFF image ................................................................................................................................ 54

Configure the DPI and compression type for TIFF images ..................................................................... 54

Configure zone properties ....................................................................................................................... 54

Switch off the analysis engine ................................................................................................................. 55

Work with Verifier forms ........................................................................................................................... 55

Turn off Verifier logging ........................................................................................................................... 55

Edit the Verifier form in Perceptive Intelligent Capture Designer ............................................................ 55

Create instructions for Verifier forms ....................................................................................................... 56

Configure dialog box settings for the Verifier thin client .......................................................................... 56

Force a field to appear in Verifier ............................................................................................................ 56

Map the field identification ....................................................................................................................... 56

About configuring fields ........................................................................................................................... 57

About configuring field types ................................................................................................................ 57

Set a field to be mandatory or optional ................................................................................................ 59

Set field default values ......................................................................................................................... 59

Turn fields on and off ........................................................................................................................... 60

Define field output ................................................................................................................................ 60

Label a field in Verifier ......................................................................................................................... 60

About configuring the Vendor ID field without using a partition ............................................................... 60

Configure a standard Customer ID field .............................................................................................. 60

About adding additional custom fields ..................................................................................................... 62

Create an additional field in Perceptive Intelligent Capture Designer module .................................... 62

Add a validation script to the class ...................................................................................................... 62

About using substitution rules ................................................................................................................ 62

Configure Verifier message settings ...................................................................................................... 63

Retrieve custom error messages ............................................................................................................ 63

Set a review state ...................................................................................................................................... 63

What are user exits? ................................................................................................................................. 64

What is the user exits script class? ......................................................................................................... 66


Page 6 of 78

About user exits for text fields ................................................................................................................. 66

About configuring the triggering of user exits in Dynamic Verifier........................................................... 66

General actions .................................................................................................................................... 66

Configure reporting and custom base classes .................................................................................... 66

Add a customer script to the Document_PreExtract and Document_Validate events ........................ 67

Delete the BW packaged / generic script classes ................................................................................. 67

What are the project data structures? .................................................................................................... 68

What is the address structure? ................................................................................................................ 68

What is the FieldSettings structure? ........................................................................................................ 69

What are client ID errors? ........................................................................................................................ 71

Configure late archiving with Perceptive Intelligent Capture Visibility ............................................... 71

About document splitting in Visibility .................................................................................................... 71

About configuring data export................................................................................................................. 72

Exporting data to database tables ........................................................................................................... 72

Output of line items .................................................................................................................................. 72

Data export to the Check table ................................................................................................................ 72

Output of transactions ............................................................................................................................. 72

Output to an XML file ............................................................................................................................... 73

Custom export of line item data ............................................................................................................... 73

Configure output of transactions ............................................................................................................. 73

About configuring the XML output file ................................................................................................... 74

Configure output to an XML file ............................................................................................................... 74

Activate output to an XML file .................................................................................................................. 75

Add a new client with new requirements ................................................................................................ 75

Add a new client that reuses an existing profile.................................................................................... 75

About assigning documents to a client .................................................................................................. 76

Activate document review for a client ...................................................................................................... 76

Assign a client ID using a document file name ..................................................................................... 76

Add a custom script to the Document_PreExtract and Document_Validate events ......................... 76

About checking for OCR problems on the field contextual information ................................................... 77

Index ........................................................................................................................................................... 78


Page 7 of 78

What is PIC for Remittance?

Perceptive Intelligent Capture (PIC) for Remittance is part of the Perceptive Intelligent Capture solution and automates processing for remittance document types.

PIC for Remittance is optimized to increase extraction rates for remittances that are written in English from US based companies.

PIC for Remittance can be integrated with almost any existing environment. Remittances are processed by the solution with the metadata and then are exported to Perceptive Content (optional). Perceptive Intelligent Capture Visibility is also included for auditing and reporting purposes. Perceptive Verifier workstations can be implemented for document quality assurance, if required. Perceptive Content can be used to escalate exceptions and other functions prior to the remittance being written to the database.

Install PIC for Remittance

What is PIC for Remittance installation package?

The PIC for Remittance installation package contains all of the files for installing the product.

The installation package contains the CedarDirectory, SDP, and SQL Scripts directories.

CedarDirectory directory

The CedarDirectory directory contains the register assemblies.

SDP directory

The SDP directory contains the Train, PICR.ini, and PICR.sdp files. You have the option of renaming the INI and SDP files during installation. Therefore, within the PIC for Remittance help, these files are referred to as the <project>.ini and <project>.sdp files.

SQL Scripts directory

The SQL Scripts directory contains the MS SQL and Oracle directories. Within these two directories are Create and Reporting directories. The Create directory contains the MasterICR.sql script for creating the PIC for Remittance database. The Reporting directory contains the Reporting DB.sql script for creating the Perceptive Visibility database.

Download the PIC for Remittance installation files

To obtain the PIC for Remittance Processing installation files, complete the following steps.

1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer Portal.

2. In the Product Downloads page, search for the Perceptive Intelligent Capture for Remittance1.0 zip file.

3. Download the file to a temporary directory on your computer.

Create the PIC for Remittance folder structure

Before installing PIC for Remittance Processing, create the underlying folder structure. To create the future structure, complete the following steps.


Page 8 of 78

1. Navigate to the directory that was created during the installation.

2. Within this directory, create four folders and name them as follows.

Import

Batch

Global

Export

Create the Pool directory

The pool directory stores the internal representation of the remitter master data, which is accessed by the system at runtime when determining the check document’s remitter. To create the pool directory, complete the following steps.

1. Navigate to the Global directory.

2. Create a new directory and name it Pool.

Install the PIC for Remittance project files

To install the PIC for Remittance Processing project files, complete the following steps.

1. Navigate to the temporary folder where the PIC-Remittance 1.0.1001.zip was downloaded and unzip the file to a temporary folder.

2. Copy the following files from the SDP folder to the Global directory.

3. Optional. Rename the SDP and INI files. The SDP and INI files should have the same name, but ensure that you retain the SDP and INI file extensions.

Note The INI file is referred to as the <project>.ini, the INI file, the <project>.sdp file, or the SDP file in the PIC for Remittance Processing documentation.

4. In the Remittance1.0.zip file, navigate to CedarDirectory.

5. Copy all of the files.

6. For a 32-bit system, place the files in %ProgramFiles%\Perceptive\Components\Cedar directory.

7. For a 64-bit system, place the files in %ProgramFiles(x86)%\Perceptive\Components\Cedar directory.

8. As an administrator, run RegAppDev.

9. To verify that all assemblies were copied from the CedarDirectory, review the Registering Results.txt file.

Run the database tables creation script

To create the database tables, complete the following steps. It is recommended that the tables exist in their own database.

1. On your server machine, create a new database.

2. Navigate to the temporary folder that contains the files from the Remittance1.0.zip file.

3. For an Oracle database, navigate to the SQL Scripts\Oracle\Create directory. For an MS SQL database, navigate to the SQL Script\MS SQL\Create directory.


Page 9 of 78

4. In the Create directory, run the MasterICR.sql script against the new database.

Configure the <project>.ini file When installing PIC for Remittance Processing, you perform a basic configuration of the <project>.ini file. There are other parameters in the INI file that you need to configure after you finish the installation process. To perform a basic configuration of the <project>.ini file, complete the following steps.

1. Navigate to the Global directory where the PIC for Remittance Processing project file is installed.

2. Open the <project>.ini file.

3. Configure the following settings.

GRL_VL_ProjectName

GRL_VL_Version (optional)

GRL_VL_ClientName (optional)

GRL_OP_ReadSettingsFromDB

GRL_OP_BatchInDatabase

GRL_VL_BatchSQLConnection Group

SQL_VL_1_ConnectionString


4. Save and close the INI file.

Basic configuration settings

The following settings are used in a basic configuration of PIC for Remittance Processing.

GRL_VL_ProjectName

This parameter represents the name of the project, which is recorded in the Visibility reporting database.

It is usually set this to the name of the end user. For example, GRL_VL_ProjectName=Perceptive.

GRL_VL_Version

Optional. This is the version number of the project, which is recorded in the Visibility reporting database. This can be set to 1, but can be left blank or changed to assign document records to different testing cycles.

GRL_VL_ClientName

This is the default client name that is recorded in the Visibility reporting database for each document that is processed. AS it is superseded by setting in the BRWClient table, it is not mandatory to populate this value.

GRL_OP_ReadSettingsFromDB

Set this to Yes. It controls whether the project reads configuration settings from the database created in the previous step.


Page 10 of 78

GRL_OP_BatchInDatabase

Set this to Yes. This specifies whether the document batches are held in the Perceptive_Database

database or if they are held as a batch root in the file system. It is recommended that document batches be held in the database.

Note File-based batch roots are not supported.

GRL_VL_BatchSQLConnection Group

Set this to 1. This is the reference to the SQL connection group in the SQL section of the INI file that

contains the connection string to the main Perceptive_Database database.

Note This number should not be preceded by a zero.


Set this to the connection string for the Perceptive_Database database that was created during the

installation. For example, SQL_VL_1_ ConnectionString=Provider=SQLOLEDB.1;Password=secret;Persist Security

Info=True;User ID=sa;Initial Catalog=PICR;Data Source=W2008-

JOHNSMITH\sqlexpress

Note This number should not be preceded by a zero


Set this to the connection string for the database that the MasterICR.sql script was run against. For

example, SQL_VL_2_ ConnectionString=Provider=SQLOLEDB.1;Password=secret;Persist Security

Info=True;User ID=sa;Initial Catalog= Perceptive_Database;Data Source=W2008-

JOHNSMITH\sqlexpress

Note This number should not be preceded by a zero.

What is the <project>.ini file?

The <project>.ini file contains settings that control the way in which PIC for Remittance Processing behaves.

The <project>.ini file resides in the same directory as the project SDP file and the PIC for Remittance Processing database.

The <project>.ini file is subdivided into the following sections that control different aspects of the project file behavior.

Note Connection strings in the INI file should not be preceded by a zero.

Section Description

GRL This section contains global settings for the project that are used for the purposes of solution reporting.

IMP This section contains settings for document import, specifically the mapping of values contained within the image file name to fields in PIC for Remittance Processing. This provides a simple means to pass data to PIC for Remittance Processing from an upstream system.


Page 11 of 78

Section Description

REP This section contains the configuration settings for reporting.

SQL This section contains the SQL connection strings that are used by PIC for Remittance Processing. PIC for Remittance Processing supports Oracle and Microsoft SQL Server databases.

Configure the PIC for Remittance registry settings To configure the registry settings, complete the following steps.

1. Open the Windows registry editor.

2. For a 32-bit machine, in the left pane, expand HKEY_LOCAL_MACHINE > SOFTWARE > Perceptive. Or, for a 64-bit machine, in the left pane, expand HKEY_LOCAL_MACHINE > SOFTWARE > Work6432Node > Perceptive.

3. In the Perceptive directory, create a new key and name it Cedar.

4. In the new Cedar folder, create two DWORD keys and name them AnalyzeLinesOptionally and

ASEnginePoolAllowedCharDifference.

5. Assign the new keys a value of 1 and a hexadecimal base.

Database settings

What are the PIC for Remittance database settings?

The PIC for Remittance Processing database is subdivided into a series of tables, each containing settings that relate to various aspects of the solution.

The following table contains each database table and a brief description of its purposes.

Table Description

BRWALS This table includes configuration settings that determine whether a customer alias lookup should be performed and defines the table with the customer alias information.

BRWNUM This table contains the formatting and validation options available for the remittance number field.

BRWNUMFormats This table controls the extraction in this table, remittance number formats are defined for the purposes of extraction. The table is keyed by both the profile ID and the index column.

BRWSRC This table holds the mapping between columns in the master data a table and the values used internally within the PIC for Remittance Processing project. The table is global for the project and works independently of the client and profile. The table should only ever consist of a single row.

BRWIVR This table contains the default setting associated with the invalid reason field. This global table works independently of the client or profile.


Page 12 of 78

Table Description

BRWIVRType This table holds the invalid reasons that may be selected in Verifier. It a global table that is independent of the client or profile.

BRWEXP This table holds configuration settings that relate to the PIC for Remittance Processing data export options. It is keyed upon the export profile ID that can be assigned to individual clients.

BRWEXPLines This table is used to map the pic FOR Remittance Processing line item fields in the XML file or columns in a database.

BRWMCR This table contains settings that relate to MCIR.

BRWClient This table contains the parameters for setting up and configuring clients.

BWProfile This table contains a list of profiles within the project, along with a description. A profile must be registered within this table before it can be assigned to a client.

BRWRemitters This table contains a list of the vendor partitions active within the project. A remitter partition must be registered within this table before it can be assigned to a client.

BRWUser This table contains list of active users within the system, along with their corresponding authorizations. The table is keyed on a combination of a unique user name and a client group.

BRWFLD This table controls which fields are activated for a given profile, along with their corresponding types and validation settings.

BRWINSTR This table contains a list of instructions and their corresponding texts that are available to be assigned to clients. When using the dynamic verifier form, a button is available to deliver an instructional text to the user to help them with processing documents for a specific client.

BRWSubstitution This table contains a list of rules for substituting values in an extracted or user-entered text field. Substitution rules are assigned to text fields in the SubRule column in the BRWFLD table.

BRWCAR This table is used to map the PIC for Remittance Processing line item fields in the ML file or columns in a database.

PICI_VersionHistory This table is a reference table that contains version information for the PIC for Remittance Processing database, along with the date of install.

BRWPAE The PAE section in the BRWPAE table is where payee configuration settings are stored within the database.

BRWLBX This table contains a lockbox section where lockbox configuration settings are stored within the database

BRWEXPChecks This table is used to map the PIC for Remittance Processing header export fields into fields in the XML file or columns in a database.


Page 13 of 78

Configure the BRWSRC table

The BRWSRC table is used to tell the system which column in the remitters master pool corresponds to which internal field that is used during processing.

It is a global table and should only have a single row. If the BRWRemittersMaster table is used as a source for the remitters master table, configuration the BRWSRC table with the follows shown below.

Column Value

SRC_ID IndexNum

Name Name

Address1 Address 1

Address2q Address 2

City City

State State

Zip Zip

Country Country

Configure the BRWPAE table

To configure the BRWPAE table, complete the following steps.

1. Configure the BRWPAE table columns with the following values.

Column Value

ProfileID ID of the profile assigned to the client.

SQLConnectionGroup The connection group for the PIC for Remittance Processing database, as set in the <project>.ini file.

GLOBALPAYEES Set this to the list of possible internal payees.

CONFIDENCE Confidence weighting of payee candidate.

2. Save the changes.

Configure the BRWMCR table

To configure the BRWMCR table, complete the following steps.

1. Configure the BRWALS table columns with the following values. The table and columns you specify for the fields need to match an actual table with the columns that you use as the source for the MICR look up.


Page 14 of 78

Column Value

ProfileID Export profile ID

UpdateUponExport Export profile assigned to the client

SQLConnectionGroup SQL connection group that represents the external database in which the MICR tables have been created

MICRTable Name of the external MICR table where information is stored

CustIDColumn Name of the external column to store customer ID information

ABAColumn Name of the external column to store ABA information

AcctNumColumn Name of the external column to store Account Number


Configure the BRWALS table

To configure the BRWALS table, complete the following steps.

1. Configure the BRWALS table columns with the following values. The table and column names need to match the version of the CustomerAlias table.

Column Value

ProfileID Export profile ID

GetAliasFromDB True

SQLConnectionGroup SQL connection group specifying the connection string for the database containing the customer alias table.

AliasTable Name of the database table that contains the customer alias information

DBRemitterID Name of the database table field that holds the remitter ID.

DBAliasID Name of the database table field that holds the alias ID.


Add a database entry in the BRWFLD table

After you add a validation script to class, you must create a new entry in the BRWFLD database table for the profile ID. To add a database entry in the BRWFLD database table, complete the following steps.

1. Open the BRWFLD database table.

2. In the ProfileID column, enter a profile ID


Page 15 of 78

3. In the FieldName column, enter the name of the field you created in the Create an additional field in the Designer module section.

4. In the VerifierLabel column, enter the name of the Verifier label.

5. In the DocumentType column, enter the name of the class in which you created the additional field.

6. Set the Active column to True.

7. To make a field mandatory, set the RequiredInRTS and RequiredInVerifier columns to True. Or, to

make a field optional, set the RequiredInRTS and RequiredInVerifier columns to False.

8. In the FieldType column, set the field type, such as TEXT or DATE.

9. To force an invoice to be verified every time, set the ForceVerify column to True or False.


Add a new row to the BRWEXPChecks or BRWEXPLines database tables

To add a new row to the BRWEXPChecks or BRWEXPLines database tables, complete the following steps.

1. Open the BRWEXPChecks or BRWEXPLines table

2. Add a new row for the export profile ID that represents the new field. The name of the field should be unique for the export profile ID.


Configure a database export

To activate output to a database, complete the following steps.

1. Open the database table.

2. Set the DBOutput column to True.

3. Set the DBConnectionGroup column to point to the correct SQL ConnectionGroup in the <project>.ini file.


Configure the Document Line Items table

To configure the Document Line Items table, complete the following steps.

1. Open the BRWEXP table.

2. In the DBDOCLINESTableName column, enter a unique name for the database table.

3. To set the line item number field, in the DBDOCLINESSecondaryKey column, enter LineNumber.


Configure data export to the Document Header table

To configure the Document Header table, complete the following steps.

1. Open the table.

2. To set the name of the destination table, in the DBDOCHEADERTableName column, enter a unique name for the document header table.


Page 16 of 78

3. To set the name of the column in the table that represents the unique record identifier, in the DBDOCHEADERPrimaryKey column, enter a unique name for the header column.

4. To set whether document header information is written into the table as a new insert or as an update

to an existing record, in the DBDOCHEADERTransactionID column, enter either TransactionID.

5. In the DBDOCHEADERClassName column, enter the class name.

6. In the DBDOCHEADERDocumentStartTime column, enter the document start time.

7. Repeat the previous steps for all fields that require database output. Leave the parameters blank for any fields that are not relevant for database output


Configure output to the Check table

To configure the Check table, complete the following steps.


2. In the DBCHECKTableName column, enter the database table name.

3. In the DBCHECKPrimaryKey column, enter a unique document identifier.

4. In the DBCHECKMICR column, enter the name of the destination table.

5. In the DBCHECKBatchID column, enter BatchID.

6. In the DBCHECKImageID column, enter ImageID.

7. Repeat the previous steps for all fields that require database output. Leave the parameters blank for any fields that are not relevant for database output


Configure output to transactions

The output of transactions is optional. To configure the output of transactions, complete the following steps.


2. In the DBTRANSACTTableName column, enter the database table name.

3. In the DBTRANSACTPrimaryKey column, enter the name of the document identifier.

4. In the DBTRANSACTCheckAvailable column, enter CheckAvailable.

5. In the DBTRANSACTDocCount column, enter DocCount.

6. In the DBTRANSACTExportDocCount column, enter ExportDocCount.

7. Repeat the previous steps for all transaction fields that require database output. Leave the parameters blank for any fields that are not relevant for database output.


About creating a user DSN for the Vendor Master table

Perceptive Intelligent Capture Distiller requires a user DSN to be created that reflects a connection to the PIC for Remittance Processing database using SQL server-based authentication.


Page 17 of 78

You create the user DSN using Administrative Tools on a Windows machine. For more information about creating a user DSN, refer to Windows documentation.

Populate the BRWRemittersPartition table

To populate the BRWRemittersPartition table, complete the following steps.

1. Open the BRWRemittersPartition table.

2. Populate the columns listed in the following table.

Column Description

Index This is a unique identifier for the record in the table. Set this value to the partition ID followed by a hyphen, and then the remitter’s ID.

PartitionID This is the partition ID for the remitter as set in the BRWClient and BRWRemittersPartition tables.

ID This is the remitter’s ID.

Address1 This is the street address of the remitter.

City This is the city of the remitter.

Zip This is the zip code of the remitter.

Country This is the two character ISO-code that represents the remitters’ country of origin, such as GB = United Kingdom; US = United States; DE = Germany; CN = China.

3. Optional. Populate additional columns according to your business needs.


Create the Remitters pool

To create the Remitters pool, complete the following steps.

1. Open the project.ini file and navigate to the RemitName field in the Checks class.

2. Display the field settings.

3. On the File Import tab, to import the pool from the database table, click Import. A message stating that the pool was created is displayed. If an error message is displayed, the remittance table has not been configured correctly. Correct any configuration errors and reimport the pool.

4. On the General tab, complete the following substeps.

1. In the ID column, set the radio button to the field that is the unique identifier for the remitter row in the database.

2. In the Search column, only select those field values that are strong and unique criteria. Set the Filter column radio button to point to the PartitionID field. If this is not done, the remitters partition filtering does not function.

3. Select the Enable alphanumeric identifier check box

5. On the File import tab, complete the following substeps.


Page 18 of 78

1. Reimport the pool.

2. Set the class settings to the following settings: [Name]_[IndexNum]

3. Configure the following field settings, set the first line to the unique identifier for the record in the remittance extract. It is recommended that the field uses the following structure, but this is optional depending on what is appropriate for the client as long as the first line is the unique identifier.

[IndexNum]

[Name]

The remitter field configuration is complete, and a green light with the Engine Is Ready message displays in the field status box.

6. Repeat the steps for the ImpCustAssa field.

Database tables

BRWALS table

This table is used to specify words that may appear on an incoming document that would denote that the document is a credit memo. For example, CREDIT NOTE, CREDIT MEMO, AVOIR, or GUTSCHRIFT. The table is client and profile independent.

This table includes configuration settings that determine whether customer alias lookup should be performed and defines the table with the customer alias information.

You can set the parameters listed in the following table.

Parameter Type Description

ProfileID Integer This is the profile ID.

GetAliasFromDB Boolean If set to True, the system uses the table and columns specified in the other fields to look up the customer alias for the invoice number when validating line items.

SQLConnectionGroup Integer SQL connection group that specifies the customer alias database connection string as set in the SQL section. If no connection group is specified, the system uses group 1.

AliasTable Freetext Name of the database table that contains the customer alias information.

DBRemitterID Freetext Name of the database table field that holds the remitter ID.

DBAliasID Freetext Name of the database table field that holds the alias ID

BRWCUR

This table controls the CAR/LAR confidence threshold. You can set the parameters listed in the following table.


Page 19 of 78

Parameter Type Setting type Description

ProfileID Integer IAppSetting This is the profile ID.

Confidence Float IAppSetting This is the default confidence weighting of CAR field.

BRWClient table

This is where the clients are set up and configured.

Parameter Type Setting Type Description

ClientID Integer IAppSetting This is the unique ID of the client, which must always be set to an integer value.

ProfileID Integer IAppSetting This is the ID profile assigned to the client. The profile controls what fields are extracted and how they are validated. More than one client may share the same profile ID if the extraction and validation requirements are identical.

ExportProfileID Integer IAppSetting This is the ID of the export profile assigned to the client. The export profile ID controls how data is exported for a client. More than one client can share the same export profile ID if the export requirements are identical.

ClientName Freetext IAppSetting This free text string contains the name of the client. This data is written into the reporting database for each document assigned to a client.

InstructionsProfileID Integer IAppSetting PIC for Remittance Processing includes a button the Verifier form that, when pressed, display specific processing instructions for a particular client. The instructions profile ID is the ID assigned to a particular set of instructions that are held in the table.

ForceVerify Boolean IAppSetting This flag value controls whether all documents for this client should stop. If set to True, all documents stop. If set to False, only documents that require user attention stop.

ClientGroup Integer IAppSetting This is the ID of the client group to which the client belongs. It is an integer value that can be set freely by the system administrator. The client group is the means by which users are assigned to have access to documents that belong to specific clients.


Page 20 of 78

Parameter Type Setting Type Description

RequireReview Boolean IAppSetting This is a Boolean flag that indicates whether documents assigned to the client should always be subject to review post verification.

Priority Integer IAppSetting When documents are imported, they are placed into batches and each batch is assigned a priority. This priority controls the order by which the runtime server component processes the batches, and also the order in which the documents appear in the Verifier application.

The priority scale runs from 1 to 9, with 1 having the highest level of priority.

If this field is populated with 1, it means that all batches that contain documents from this client are accorded a priority of 1.

BRWEXP table

This table holds configuration settings that relate to the PIC for Remittance Processing data export options. It is keyed upon the export profile ID that can be assigned to individual clients.


EXPProfileID Integer IAppSetting This is the export profile ID.

DefaultExportPath Freetext IAppSetting This is the UNC path to the export directory that is used as the default should no export directory be set in RTS.

EnableCustomExport Boolean IAppSetting If set to True, this activates the

UserExitCustomExport so that users can create custom export scripts.

OutputTiffFile Boolean IAppSetting If set to True, the system outputs a TIFF file of

the document image in the export directory.

TiffName Freetext IAppSetting This setting controls the name of the output TIFF file. If set to URN, this names the file according to the component of the image file name mapped in the IMP section. If left blank or set to anything else, the file name is set to the same name as the document file name.

TiffDPI Number IAppSetting This specifies the DPI of the outgoing TIFF image, such as 300. The default TIFF resolution is 300 DPI.


Page 21 of 78


TiffFormat Freetext IAppSetting This is the compression format of the outputted TIFF file.

The following options are available.

G$FAX = Grade 4 compression

G3FAX = Grade 3 compression

LZWFAX = LZW Compression

HUFFAX = HUF Compression

The default compression is G4FAX.

SQLConnectionGroup N IAppSetting Set this to the database where the EXP_tables were set up. If no connection group is specified, the system uses group 01. The header and line item tables must exist in the same address.

XMLOutput Boolean IAppSetting If set to True, the system outputs an XML file to the export directory configured on the RTS export instance. If no directory is configured, then the default export path parameter is used. If this is not configured either, then the XML fails and the batch is set to status 750.

XMLEncoding Freetext IAppSetting This is the XML file coding header that forms the first line in the XML file. For example, setting the value as <xml version=”1.0”encoding=”UFT-16”?> produces and XML file that supports non-western characters, such as letters from Russian, Greek, and Chinese alphabets. This is defaulted to uft-8.

XMLNamespace Freetext IAppSetting This is the encoding instruction for XML header. This is defaulted to d1p1.

DBOutput Boolean IAppSetting This is the flag to denote whether the extracted data should be written to a database upon document export.

DBConnectionGroup N IAppSetting Set this to be the database where the EXP_tables were set up. If no connection group is specified, the system uses group 1.

DBTRANSACTTableName Freetext IAppSetting This is the name of the table in the database where the complete transaction information is exported

DBTRANSACTPrimaryKey Freetext IAppSetting This is the name of the column in the export transaction database table that represents the key field for each transaction record. The BatchId that contains all the documents of a transaction is used as value.


Page 22 of 78


DBTRANSACTCheckAvailable

Freetext IAppSetting This is the name of the column in the export transactions database table that represents the CheckAvailable field.

DBTRANSACTDocCount Freetext IAppSetting This is the name of the column in the export transactions database table that represents the document count field.

DBTRANSACTExportDocCount

Freetext IAppSetting This is the name of the column in the export transactions database table that represents the exported document count field.

DBTRANSACTTransactionStatus

Freetext IAppSetting Name of the column in the export transactions database table that represents the transaction status.

DBTRANSACTHasRejects Freetext IAppSetting This is the name of the column in the export transactions database table that represents the Has rejects field.

DBCHECKTableName Boolean IAppSetting This is the name of the table in the database where the check in the transaction information is to be exported.

DBCHECKPrimaryKey URN [blank] IAppSetting This is the name of the column in the export check database table that represents the key field for each transaction record.

DBCHECKMICR Freetext IAppSetting This is the name of the column in the export check database table that represents the MICR field

DBCHECKBatchID Freetext IAppSetting This is the name of the column in the export check database table that represents the Batch ID field.

DBCHECKImageID Freetext IAppSetting This is the name of the column in the export check database table that represents the Image ID field.

DBCHECKUserID Freetext IAppSetting This is the name of the column in the export check database table that represents the user ID field.

DBCHECKDocumentStartTime

Freetext IAppSetting This is the name of the column in the export check database table that represents the document start time field.

DBCHECKDocumentEndTime

Freetext IAppSetting This is the name of the column in the export check database table that represents the document end time field.

DBCHECKDate Freetext IAppSetting This is the name of the column in the export check database table that represents the date field.


Page 23 of 78


DBCHECKAccountNumber Freetext IAppSetting This is the name of the column in the export check database table that represents the account number field.

DBCHECKRoutingCode Freetext IAppSetting This is the name of the column in the export check database table that represents the routing number field.

DBECHECKCheckNumber Freetext IAppSetting This is the name of the column in the export check database table that represents the check number field.

DBECHECKCheckNumberMICR

Freetext IAppSetting This is the name of the column in the export check database table that represents the check number MICR field.

DBCHECKRemitName Boolean IAppSetting This is the name of the column in the export check database table that represents the check remit name field.

DBCHECKCustomerNumber

Freetext IAppSetting This is the name of the column in the export check database table that represents the check customer number field.

DBCHECKCAR Freetext IAppSetting This is the name of the column in the export check database table that represents the check CAR field.

DBCHECKLAR Freetext IAppSetting This is the name of the column in the export check database table that represents the check LAR field.

DBCHECKPayee Freetext IAppSetting This is the name of the column in the export check database table that represents the check payee field.

DBCHECKRejectReason Freetext IAppSetting This is the name of the column in the export check database table that represents the check reject reason field

DBCHECKRejectReasonCode

Freetext IAppSetting This is the name of the column in the export check database table that represents the check reject reason code field.

DBDOCHEADERTableName

Freetext IAppSetting This is the name of the table in the database where the other documents in the transaction information is to be exported.

DBDOCHEADERPrimaryKey

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the key field for each transaction record.


Page 24 of 78


DBDOCHEADERTransactionID

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the transaction ID field.

DBDOCHEADERClassName

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the class name field.

DBDOCHEADERDocumentStartTime

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the document start time field.

DBDOCHEADERDocumentEndTime

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the document end time field.

DBDOCHEADERAmountDue

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the amount due field.

DBDOCHEADERHasLines Freetext IAppSetting This is the name of the column in the export doc header database table that represents the has lines field.

DBDOCHEADERRejectReason

Freetext IAppSetting This is the name of the column in the export doc header database table that represents the reject reason field.

DBDOCHEADERRejectReasonCode

Freetext IAppSetting This is the name of the column in the export docheader database table that represents the reject reason code field.

DBDOCLINESTableName Freetext IAppSetting This is the name of the table in the database where the invoice details in the transaction information is to be exported.

DBDOCLINESSecondaryKey

Freetext IAppSetting This is the name of the column in the export doc lines database table that represents the key field for each invoice line.

DBDOCLINESInvoiceNumber

Freetext IAppSetting This is the name of the column in the export doc lines database table that represents the invoice number field.

DBDOCLINESGrossAmount Freetext IAppSetting This is the name of the column in the export doc lines database table that represents the gross amount field.

DBDOCLINESDiscount Freetext IAppSetting This is the name of the column in the export doc lines database table that represents the discount field.


Page 25 of 78


DBDOCLINESNetAmount Freetext IAppSetting This is the name of the column in the export doc lines database table that represents the net amount field.

DBDOCLINESException Freetext IAppSetting This is the name of the column in the export doc lines database table that represents field.

LogExportDetails Freetext IAppSetting This turns detailed logging for export on or off.

BRWEXPChecks

This table is used to map the PICR header export fields for check documents into fields in the XML file or columns in a database.



FieldName Freetext IAppSetting This is the name of the field.

XMLTag Boolean IAppSetting This column represents the tag for the field in an exported XML file. If left blank, the field is not exported.

DBColumnName Boolean IAppSetting This is the technical name of the target field in the export database.

BRWEXPLines table

This table is used to map the line item fields in the XML file or columns in a database.



FieldName Freetext IAppSetting This is the name of the field.

XMLTag Boolean IAppSetting This column represents the tag for the field in an exported XML file. If left blank, the field is not exported.

DBColumnName Boolean IAppSetting This is the technical name of the target field in the export database.


Page 26 of 78

BRWFLD table

This table controls which fields are activated for a given profile along with their corresponding types and validation settings.


DocumentType Integer Dictionaries Key = The count when addedValue = The name of the parameter.

The name of the document type class for which this validation is executed.

ProfileID Integer Dictionaries Key = The count when added Value = The name of the parameter.

This is the profile ID.

FieldName Freetext Dictionaries Key = the count when addedValue = The name of the parameter.

This is the name of the field. Do not change the standard field names.

VerifierLabel Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This text indicates how to label the field on the Verifier form.

Active Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This flag indicates whether the field is activated for the profile.

RequiredInRTS Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This flag indicates whether the field is mandatory in RTS.

RequiredInVerifier Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This flag indicates whether the field is mandatory in Verifier.

CountryFilter Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the comma-separated list of country ISO-codes that allow fields to be mandatory for specific countries.

This setting is used in conjunction with RequriedInRTS and RequriedInVerifier. If a field is set for mandatory for either of them and the vendor country or origin is not specified in the list, then the field reverts to being optional.


Page 27 of 78


FieldType Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the field type.

ForceVerify Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This is the flag that indicates whether the field must always be marked as invalid and sent to a Verifier for review.

DefaultValue Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the default value field.

DefaultIfNothingExtr Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the default value if the system does not automatically capture a value from the document

SubRule Integer DictionariesKey = The count when addedValue = The name of the parameter.

This is the field substitution rule for text fields as registered in the BRWSUBSTITUTION table.

MinLength Integer DictionariesKey = The count when addedValue = The name of the parameter.

This is the field minimum permitted length for text fields

MaxLength Integer DictionariesKey = The count when addedValue = The name of the parameter.

This is the field maximum permitted length for text fields.

RightJustify Boolean DictionariesKey = The count when addedValue = The name of the parameter.

If a value is entered in PadChar, and this parameter is set to TRUE, the system pads the field value with that character from the left until the length specified in MaxLength is reached.

If a value is entered in PadChar, and this parameter is set to FALSE, the system pads the field value with that character to the right until the length specified in MaxLength is reached.

PadChar Single character

DictionariesKey = The count when addedValue = The name of the parameter.

This is the padding character for a text field.


Page 28 of 78


RemoveAllSpecials Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This is the flag that indicates whether to remove all special characters from a text field.

RemoveBlanks Boolean DictionariesKey = The count when addedValue = The name of the parameter.

This flag indicates whether to remove spaces from a text field.

KeepCertainSpecials Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is a non-delimited list of special characters that are retained if RemoveAllSpecials is set to TRUE.

RemoveStartEnd Boolean DictionariesKey = The count when addedValue = The name of the parameter.

Is set to TRUE< PIC for Remittance Processing removes all special characters at the beginning and at the end of an extracted text value.

SubstringStartPos Integer DictionariesKey = The count when addedValue = The name of the parameter.

The starting character used in conjunction with SubstringLength when trimming an extracted value. Positive numbers start from the left while negative numbers start from the right.

As an example, suppose the invoice number should only be five characters, but the extracted value is 123456789. SubstringStartPosition of 1 and SubstringLength of 5 equal 12345. SubstringStart Position of 5 and SubstringLength of 5 equal 456789.

SubstringLength Integer DictionariesKey = The count when addedValue = The name of the parameter.

This is the substring length.

RemoveLeadingZeros Boolean DictionariesKey = The count when addedValue = The name of the parameter.

If set to TRUE, PIC for Remittance Processing remove any leading zeroes from an extracted text value.

DecimalPlaces Integer DictionariesKey = The count when addedValue = The name of the parameter.

This is the number of decimal places for an amount field.


Page 29 of 78


NegativeType Integer DictionariesKey = The count when addedValue = The name of the parameter.

This Setting controls the output during export if the extracted value for an amount field is less than zero.

Choose one of the following settings. If set to 1, the minus sign appears after the amount , such as 100.00. If set to 2, the minus sign appears before the amount, such as 1 -100.00. If set to 3, the value appears in parentheses, such as 1 (100.00)

OutputForZero Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the output value during export for an amount value if it is zero.

SubstituteValueIfOverZero Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is the output value during export for an amount value if it is greater than zero.

FutureDays Integer DictionariesKey = The count when addedValue = The name of the parameter.

This value indicates the number of days in the future from the present date that an extracted date may be considered valid. For example, if today’s date is March 20 and a date is extracted as march 31, and the value is set to 10, then the system marks the field invalid as the extracted date is 11 days in the future. If future dates are not permitted, then set the column value to zero. To disable the check, set the column value to -1.

In, the user can pass any value as long as it is a valid date.

NoDaysInPast Integer DictionariesKey = The count when addedValue = The name of the parameter.

This numerical value indicates the number of days in the past from the present date that can extract date is considered valid.

For example, if today’s date is March 20 and a date is extracted as march 9, and the value is set to 10, the system marks the field invalid as the extracted date is 11 days in the past.

If past dates are not permitted, then set the column value to zero. To disable the check entirely, set the column value to -1. In Verifier, the user can pass any value as long as it is a valid date.


Page 30 of 78


DateOnlyInCurrentMonth Boolean DictionariesKey = The count when addedValue = The name of the parameter.

If this column is set to TRUE, then an extracted date stops in Verifier if the date is not in the current month. In Verifier, the user can pass any value as long as it is a valid date.

FieldMask Freetext DictionariesKey = The count when addedValue = The name of the parameter.

This is a comma-separated list of valid entries for the extracted or user-entered value.

For example, if the content of this column is set to ABCD,KWZYZ, only ABCD or WZYZ appear.

Wildcard characters are also permitted where a harsh symbol (#) is used to represent any number, an at symbol (@) is used to represent any letter, and a question mark (?) is used to represent either a number or a letter.

For example, if an entry was restricted to being 10 followed by a letter, then a hyphen, then five digits, the value 10?-##### is entered into the field.

BRWINSTR table

This table contains a list of instructions and their corresponding texts that can be assigned to clients. When using the Verifier form, a button is available to deliver an instructional text to the user to help them with processing documents for a specific client.


ProfileID Integer IAppSetting This is the instructions profile ID.

ProfileName Freetext IAppSetting The name of the profile.

Instructions Freetext IAppSetting This is the instructions text.

BRWIVR table

This section contains the default setting associated with the invalid reason field. This is a global table that works independently of the client or profile.




Page 31 of 78


DefaultText Freetext This the default invalid reason, such as None.

DefaultExportCode Freetext This is the export code associated with the default invalid reason, such 0.

BRWIVRType Table

This table holds the invalid reasons that may be selected in Verifier. It is a global table that is independent of the client or profile.



Index Integer This is the invalid reason index.

Rule Freetext This is the rule ID for the invalid reason. The rule governs how Verifier behaves as a result of a particular invalid reason being selected. The following rule is available.

SETALLTOVALID. This allows all fields to be passed as valid.

VerifierDisplay Freetext This is the invalid reason message displayed in Verifier.

ExportCode Freetext This is the invalid reason code exported by PIC for Remittance Processing if the Invalid Reason field is set.

DocType Freetext This is the current document type that determines which invalid reasons are displayed for a given document in Verifier. The available types are as follows.

CHECK Only invalid reasons for documents classified into Checks class display in Verifier.

MATERIAL Any document that is not classified as a Check uses the DocType to determine which invalid reasons display in Verifier.

CHECK, MATERIAL applies to both doc types. The list can be comma delimited.

BRWLBX table

The lockbox section table BRWLBX is where lockbox configuration settings are stored within the database.


Page 32 of 78


UseLockboxFile Boolean IAppSetting This flags whether a lookup into the lockbox transaction table is initiated, if there is no check in the transaction batch

UseLockboxOnly Boolean IAppSetting This flags whether to use only the documents in the Lockbox Transaction table. If set to True, any check documents in the transaction batch are not classified correctly. If set to False, any check documents in the transaction batch are classified correctly. This parameter only has an affect if UseLockboxFile is set to True.

DBConnectionGroup Number IAppSetting This is the SQL connection group that specifies the lockbox database connection string. If no connection group is specified, the system uses group 1.

DBLBXTableName Freetext IAppSetting This is the name of the table in the database where the lockbox transaction information is held.

DBLBXTransactionIdentifier Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the transaction ID.

DBLBXSequenceIdentifier Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the sequence ID.

DBLBXDocumentType Freetext IAppSetting This is the name of the column in the lockbox transaction database tale that represents the document type.

DBLBXProcessDate Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the process date.

DBLBXBankBatchNumber Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represent the bank batch number.

DBLBXDocumentNumber Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the document number.

DBLBXCheckAmount Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the check amount.

DBLBXCustomerNumber Freetext IAppSetting


Page 33 of 78


RequirePODetailsForMultiMartrl

Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the customer number.

DBLBXRouteCode Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the routing number.

DBLBXRouteCode Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the routing number.

DBLBXBankAcount Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the bank account number.

DBLBXCaptureBatchNumber Freetext IAppSetting This is the name of the column in the lockbox transaction database table that represents the batch number

BRWMCR table

This table is where clients are set up and configured.


ProfileID Integer IAppSetting This is the profile ID

UpdateUponExport Boolean IAppSetting Set to True to export MICR information to external DB during export, or set to False to do nothing

SQLConnectionGroup Number IAppSetting This is the numeric reference to the SQL connection group that represents the external database in which the MICR tables have been created.

MICRTable Freetext IAppSetting This is the name of the external MICR table where information is stored.

CustIDColumn Freetext IAppSetting This is the name of the external column to store customer ID information.

ABAColumn Freetext IAppSetting This is the name of the external column to store ABA information.

AcctNumColumn Freetext IAppSetting This is the name of the external column to store Account Number.


Page 34 of 78

BRWNUM table

This table contains the formatting and validation options available for the invoice number field.




ValidateFromDB Boolean This flag denotes whether the invoice number should be validated against previous invoice numbers from the same vendor in a database table.

SQLConnection Integer This is the SQL connection group that specifies the customer alias database connection string as set in the SQL section. If no connection group is specified, the system uses group 1.

Distance Numeric This is a value between 0 and 1 that represents the fuzzy tolerance that should be applied when finding a match to the formats set in BRWNUMFormats.

MaxWords Integer This value should be set to the maximum number of OCR words that are permitted to form a candidate for the invoice number. It is recommended that this value be set to 3. This would allow the following 45 0000 0020 and 12345 – OP to be recognized as possible invoice numbers, where each value separated by a space is recognized as an individual OCR word. A hyphen (0) will always be considered by the system to be a separate OCR word, irrespective of the geometric distance to neighboring values on either side.

MaxGap Integer This value should be set to the maximum amount of space permitted between OCR words that form a candidate for the invoice number.

ARTable Freetext Name of the invoice number history database table.

InvNumColumn Freetext This is a column in the database table that holds the invoice number. This setting is mandatory.

CustIDColumn Freetext This is a column in the database table that holds the customer id number. This setting is mandatory.

AmountColumn Freetext This is a column in the database table that holds the amount. This setting is mandatory.

BRWNUM table

This table contains the formatting and validation options available for the remittance number field. The table and column names need to match the version of the OpenAR table.


Page 35 of 78


ProfileID Integer IAppSetting This is the profile ID

SkipForUtilityVendor Boolean IAppSetting If set to True and the vendor is identified as being a utility vendor if the column is mapped in the BRWSRC table, then the invoice number is set to valid and an account number is required instead.

ValidateFromDB Boolean IAppSetting This is the flag that denotes whether the invoice number should be validated against previous invoice numbers from the same vendor in a database table.

SQLConnectionGroup NN IAppSetting Set this to the database where the OpenAR table was set up. If no connection group is specified, the system uses group 01.

Distance Freetext IAppSetting This is the value between 0 and 1 that represents the fuzzy tolerance that should be applied when finding a match to the formats set in BRWNUMFormats. 1 is the most fuzzy and 0 requires a precise match.

MaxWords Freetext IAppSetting Set this to 3, or set it to the maximum number of OCR words that are permitted to form a candidate for the invoice number. This allows for the following: 45 000 0020 and 12345 – OP to be recognized as possible invoice numbers, where each value separated by a space is recognized as an individual OCR word. A hyphen (-) will always be considered by the system to be a separate OCR word, irrespective of the geometric distance to neighboring values on either side.

MaxGap Freetext IAppSetting Set this value to the maximum amount of space permitted between OCR words that form a candidate for the invoice number.

ARTable Freetext IAppSetting This is the name of the invoice number history database table.

InvNumColumn Freetext IAppSetting This is the column in the database table that holds the invoice number. This setting is mandatory.

CustIdColumn Freetext This is the column in the database table that holds the customer id number. This setting is mandatory.

AmountColumn Freetext This is the column in the database table that holds the amount. This setting is mandatory.


Page 36 of 78

BRWNUMFormats table

This table controls the extraction. In this table, invoice number formats are defined for the purposes of extraction. The table is keyed by both the profile ID and the index column.




Index Integer This is the index of the invoice number format. This must be unique per profile ID.

Format Freetext This is the format string for a possible invoice number. Multiple formats can be entered per profile ID, one per index. # is a wildcard character that represents any number and @ represents any alpha character. For example, 45######## would denote a possible invoice number as a ten digit number beginning with 45. @@###### would denote a possible invoice number as being 2 alpha characters followed by 5 digits. It is recommended that you define these strings as tightly as possible to optimize the system being able to home in onto the correct value.

Ignore Freetext List of characters that may appear in an invoice number in any position, such as a hyphen or a period/full stop, that the system should be tolerant of in the corresponding format string specified. This list does not need to be comma separated.

BRWPONFormats table

In this table, the purchase order number formats are defined for the purposes of extraction. The table is keyed by both the profile ID and the index column. You can set the parameters listed in the following table.



Index Integer IappSettingDictionary Key = Index

This is the index of the number format. This must be unique per profile ID.


Page 37 of 78


Format Freetext IappSettingDictionary Value = Value

This is the format string for a possible invoice number. Multiple formats can be entered per profile ID and one per index. # is a wildcard character that represents any number and @ represents any alpha character. For example, 45######## would denote a possible invoice number as a ten digit number beginning with 45. @@###### would denote a possible invoice number as being 2 alpha characters followed by 5 digits. It is recommended that you define these strings as tightly as possible to optimize the system being able to home in onto the correct value.

Ignore Freetext IappSettingDictionary Value = Ignore

This is a list of characters that may appear in a purchase order number in any position, such as a hyphen or a period/full stop that the system should be tolerant of in the corresponding format string specified.

This list does not need to be comma-separated.

BRWPAE table

This table contains the payee configuration settings that are stored within the database.



SQLConnectionGroup N IAppSetting This is the SQL connection group that specifies the reporting database connection string as set in the SQL section. If no connection group is specified, the system uses group 1.

GLOBALPAYEES Freetext IAppSetting This stores the comma-delimited list of names of all valid payees for validation.

CONFIDENCE Integer IAppSetting This is the confidence weighting of Payee candidate.

BRWProfile table

This table contains a list of profiles within the project, along with a description. A profile must be registered within this table before it can be assigned to a client.


Page 38 of 78


ProfileID Integer IAppSetting This is the unique ID of the profile, which must always be set to an integer value.

ProfileName Freetext IAppSetting This is the name of the profile.

ProfileDescription Freetext IAppSetting This is the description of the profile

BRWRemittersPartition table

This table contains a list of the remitters’ partitions active within the project. However, it is not used in this release.

BRWSRC table

This section contains the mapping between columns in the remitter’s master data table and the values used internally. It is also used for the mapping of columns form the employee master data table, so these columns should have the same technical name as those in the remitter’s master table. BRWSCR is a global table and works independently of the client and profile. The table must consist of a single row.


SRC_ID Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the customer’s ID.

Name Freetext IAppSetting This is the PIC for Remittance ASSA column name that denotes the remitter’s name.

Address1 Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the first line of the remitter’s address.

Address2 Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the second line of the remitter’s address.

City Freetext IAppSetting This is the PIC for Remittance Processing column name that denotes the remitter’s city of origin.

Zip Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the remitter’s zip/postal code.

State Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the remitter’s state/region.

Country Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the remitter’s country of origin.


Page 39 of 78


POBox Freetext IAppSetting This is the PIC for Remittance Processing ASSA column name that denotes the remitter’s PO Box.

BRWSRC table

This table holds the mapping between columns in the master data table and the values used internally within the PIC for Remittance project. The table is global for the project and works independently of the client and porile. The table should only consist of a single row.

You set the parameters listing the following table.


SRC_ID Freetext This is the PIC for Remittance ASSA column name that denotes the customer’s ID.

Name Freetext This is the PIC for Remittance ASSA column name that denotes the customer’s name.

Address1 Freetext This is the PIC for Remittance ASSA column name that denotes the first line of the customer’s address.

Address2 Freetext This is the PIC for Remittance ASSA column name that denotes the second line of the customer’s address.

City Freetext This is the PIC for Remittance ASSA column name that denotes the customer’s city of origin.

Zip Freetext This is the PIC for Remittance Processing ASSA column name that denotes the remitter’s zip/postal code.

State Freetext This is the PIC for Remittance ASSA column name that denotes the customer’s state/region.

Country Freetext This is the PIC for Remittance ASSA column name that denotes the customer’s country of origin.

BRWSubstition

This table contains a list of rules for substituting value in an extracted or user-entered text field. Substitution rules are assigned to text fields in the SubRule column in the BRWFLD table.


SubstitutionRule Integer IAppSettingDictionary Index = SUBSTITUTIONRULE

This is the substitution rule ID.

Original Freetext IAppSetting This is the segment of a text string that should be replaced.


Page 40 of 78


Replace Freetext IAppSettingDictionary Value = Replace

This is the text string that should be used to replace the original value entered in Original if present in the string.

BRWUser table

The BRWUser table contains a list of active users within the system, along with their corresponding authorizations. The table is keyed on a combination of a unique user name and client group.


UserID Freetext IAppSetting This is the user ID.

PrimaryGroupName Freetext IAppSetting This is the group name of the setting as a string.

ClientGroup Integer IAppSetting This is the client group to which the user has been assigned.

Authority Level @@@ IAppSetting This is the standard role assigned to the user.

VER. The standard Verifier user.

SET. The standard Verifier user with permission to change verifier settings.

SLV. The SET + ability to use the supervised learning function.

SLM. The SLV + ability to review and promote vendor learnsets to the global project. ADM = Administrator

RequiresReview Boolean IAppSetting If set to True, all documents verified by the user move to a review state for quality control.

Domain Freetext IAppSetting This is the user Windows domain for Windows based authentication.

Password Freetext IAppSetting If Windows authentication is not being used, this contains a string for the user password.

PICR_VersionHistory

This table is a reference table that contains version information for the PIC for Remittance database, along with the date of installation.


ID Integer IAppSetting This is the ID of the version entry.


Page 41 of 78


Version Integer IAppSetting This is the database version, such as 2.2.2100, which is version 2.1, build 2100.

InstallDate Date IAppSetting This is the date on which the database was installed.

Configure clients

About configuring and adding clients

PIC for Remittance Processing permits multiple configuration types to operate within a single installation. A single configuration type is referred to as a client.

Each document that passes through the system is preassigned to a client, and it is the client that controls the following features.

The overall document flow.

The fields that are extracted.

Those fields that are mandatory and those that are optional and their corresponding validation rules.

How data is exported.

When you are designing a PIC for Remittance Processing client, consideration should be given to how the client is utilized for your business needs, for example.

A client can represent a single customer of a BPO or a division.

If you have one user working in multiple regions or with multiple divisions with their own requirements, a client can represent each region or division.

If you have one user working with multiple ERP systems, each ERP system can be set up as an individual client for the different ERP-system connections and processing rules.

Client settings and properties are contained in the BRWClient table in the PIC for Remittance Processing database. A basic installation creates a single client with a client ID of 0 (zero), and this is the default client the system uses.

The columns contained in the BRWClient table and their uses are described in the following table.

Column Usage

ClientID This is the unique ID of the client and must always be set to an integer value.

ProfileID This is ID of the profile assigned to the client. The profile controls field extraction and validation. More than one client may share the same profile ID if the extraction and validation requirements are identical.

ExportProfileID This is the ID of the export profile assigned to the client. The export profile ID controls how data is exported for a client. More than one client may share the same export profile ID if the export requirements are identical.


Page 42 of 78

Column Usage

ClientName This is a free text string containing the name of the client. This data is written to the Visibility reporting database for each document assigned to a client.

InstructionsProfileID PIC for Remittance Processing contains a button on the Verifier form which, when clicked, displays specific processing instructions for a particular client. The instructions profile ID is the ID assigned to a particular set of instructions that are held in the BRWINSTR table.

ForceVerify This is a flag that controls whether all documents for a client should be routed to the Verifier. If this column is set to True, all documents are routed to the verifier. If it is set to False, only documents requiring review by a user are routed to the verifier.

ClientGroup This is the ID of the client group to which the client belongs. It is an integer value that can be set by the system administrator. You use this group to give users access to documents belonging to specific clients.

RequiresReview This is a flag that indicates whether documents assigned to a client should always be subject to review by a user after the document has been routed through the Verifier.

RemittersPartition This is the ID of the remitter master data partition for the client.

Priority When documents are imported, they are placed in batches and each batch is assigned a priority. This priority controls the order by which the runtime server component processes the batches, and the order in which the documents appear in the Verifier. The priority scale runs from 1 to 9, and 1 is the highest level of priority. If you set this to 1, all batches from this client have a priority of 1.

Assigning documents to a client

Documents must be preassigned to clients prior to being captured by Intelligent Capture. Documents are assigned to a client using a component of the document file name.

Intelligent Capture uses a parameter in the image file name to identify which client a document should be assigned. Therefore, a client ID must be embedded within the image file name and separated by an underscore. The part of the file name that represents the client ID is specified in the IMP section in the <project>.ini file in the IMP_VL_ClientID parameter with the word COMPONENT followed by a number that indicates the client ID’s position in the file name.

What are automatic user-import job errors? An error displays and the import fails if any of the following conditions are met. Error messages are located in the Intelligent Capture log file for the RTS instance performing the user import job.

You do not supply a connection string for the Intelligent Capture database referenced by the SQL connection group in the GRL section of the <project>.ini file.

The system is unable to connect to the Intelligent Capture database.

The BRWUser table is empty.

A user name column is blank.

The Client Group column is blank and the user is not an administrator.


Page 43 of 78

The Client Group column does not contain a numeric value.

The primary Group ID column is not populated.

You have not allocated clients to the Client group in the BRWClient table.

Error messages are located in the Intelligent Capture log file for the RTS instance performing the user import job.

Configure an automatic user-import job.

To configure an automatic user-import job, complete the following steps.

1. Open the RTS Management Console.

2. Select the General tab and complete the following substeps.

1. In the Every field, enter the number of minutes, hours, or days that PIC for Remittance imp-orts users form the table.

2. From the Time list, select minutes, hours, or days.

3. In the Starting at field, enter the date and time that PIC for Remittance should start importing users.

4. To update system security during an import, select Update system security.

5. To update the pool automatically, select Automatic pool update.

3. On the General tab, click OK.

Customize scripts

What is the project script class?

The project script class contains a script associated with standard system events, which are known as the ScriptModule events.

These ScriptModule events are called at specific points within the workflow. For example, pre- and post-import, pre- and post-OCR, pre- and post-classification, and at time of document export.

Do not make any changes to the code on this class level. Doing so may cause the solution to stop responding.

What is script customization?

Project setting customizations includes such things as changing tolerances and thresholds within the project, adding new fields and classes, configuring existing ASSA fields, changing or creating Verifier forms, and setting up new users.

The following script customization options are available.

Project setting customizations

Script customizations

You can also add script customizations to the project. For custom fields and classes, scripts should be added to the appropriate custom field event and class windows. For customizations to the existing document classes, this must be done on the UserExits class script window.


Page 44 of 78

Existing fields or classes should not be deleted or renamed under any circumstances. Doing so will cause the solution to stop responding.

What is the sequence of class dependencies?

When making changes to the script, you should remember that dependencies exist between the various script layers, so it is not possible to execute one script if there is a dependency on a script, which is not being executed.

Executing a script will also perform a syntax check. For this reason, the scripts must be executed in the following sequence.

GlobalVariables > UserExits > Project

What is the project script organization?

The application script is organized logically across several classes.

The script classes include the following classes.

Project script classes

Global variables script classes

User exits script class

Invoices script class

BW packaged / generic script classes

What is the global variables script class?

The global variables script class contains all global variables that are used in PIC for Remittance Processing.

These data definitions are exposed so that you can elect to use them within custom code if appropriate, and also so that the developer can see the definition of the custom structures and arrays as a point of reference.

In addition to global variables, this script class also houses a series of common functions and subroutines used throughout the solution. You have the option to use these common functions within custom code placed on the user exit script class, or within code for any additional classes that are created.

The common functions, along with a description of their potential uses, are described in the following table.

Function/subroutine Description


Page 45 of 78


GetAppSetting This function returns the value of any parameter contained within the system configuration INI file or database. The function parameters are as follows.

gropuName This is the group name of the settings, as a string

settingName This is the name of the setting as a string.

Neither groupName nor settingName are case-sensitive. There is no difference in syntax when retrieving settings form the database or the system configuration INI file. The return value is a string. For example, Dim strOutputDateFormat as String

strOutputDateFormat = GetAppSetting(“EXP”, “OutputDateFormat”)

For INI file parameters that have a Boolean type of OP, the function returns a value of True or False, as opposed to the value defined in the INI as Yes or No.

If the given setting is not found, the method returns an empty string and logs a warning to the log file.

GetDictionarySetting This function returns the IappSettingDictionary that contains the dictionary of settings for the given group and setting name contained within the system configuration INI file or database.

The function parameters are as follows.

groupName This is the group name of the settings as a string.


Neither groupName nor settingName are case-sensitive. There is no difference in syntax when retrieving settings from the database or from the system configuration INI file.

The return value is an IAppSettingDictionary, which can be used to retrieve indexed IAppSettings or check for existence of settings.

Example usage, Dim numFormatDict As IAppSettingDictionary Set numFormatDict = GetDictionarySetting("NUM", "FORMAT") If Not numFormatDict is Nothing

Then If numFormatDict.ContainsKey(CStr(lngItem)) then … End If End If Note If the given dictionary does not exist, then Nothing will be returned and log a warning in the log file. Add checks for return value to avoid null reference errors.


Page 46 of 78


GetDictionarySettingByIndex This function returns the value of a dictionary setting for the given group name, setting name, and index contained within the system configuration INI file or database. The function parameters are as follows:



settingIndex This is the index of the setting as a string.

None of the parameters is case-sensitive. There is no difference in syntax when retrieving settings from the database or from the system configuration INI file. The return value is a string.

Example usage, Dim connectionSring as String connectionString = GetDictionarySettingByIndex("SQL", "ConnectionString", “2”)

Note For INI file parameters that have a Boolean type of OP, the function will return a value of True or False, as opposed to the value defined in the INI as Yes or No. If the given setting is not found, the method will return an empty string and log a warning to the log file.

GetList Setting This function returns the IappSettingList that contains the list of settings for the given groupName and setting aName contained within the system configuration INI file or database. The function parameters are as follows.

groupName This is the group name of the setting as a string.


None of the parameters is case-sensitive. There is no difference in syntax when retrieving settings from the database or from the system configuration INI file.

The return value is an IAppSettingList, which can be used to retrieve indexed IAppSettings or enumerate the list.

Example usage, Dim list As IappSettingList Set list = GetListSetting("PAE", "GlobalPayees") If Not list Is Nothing Then For Each appSetting In list … Next appSetting End If

Note If the given dictionary does not exist, then Nothing is returned and a warning is logged in the log file. Add checks for return value to be valid before using the IAppSettingList to avoid null reference errors.


Page 47 of 78


GetListSettingByIndex This function returns the value of a setting for the given groupName, settingName, and settingIndex contained within the system configuration INI file or database. The function parameters are as follows.



None of the parameters is casesensitive.

There is no difference in syntax when retrieving settings from the database or from the system configuration INI file. The return value is a string.

Example usage, Dim setting as String setting = GetListSettingByIndex(“PAE”, “GlobalPayees”, “0”)

In the example above, if the setting PAE GlobalPayees is defined as Payee1,Payee2,Payee3, then Payee1 is returned.

Note For INI file parameters that have a Boolean type of OP, the function will return a value of True or False, as opposed to the value defined in the INI as Yes or No. If the given setting is not found, the method will return an empty string and log a warning to the log file.

fnConvertToInternal This function is used to convert a date with a specified format into the date format used internally within PIC for Remittance, such as DD/MM/YYYY.

The interface is as follows.

strDate The is the date to be formatted to DD/MM/YYYY.

strFormat The is the current format of strDate, either YYYYMMDD or MMDDYYYY. Any other entry returns DDMMYYYY.

strSeparator The is the separator currently used in strDate.

For example, the following sets myDate as 12/08/2009. Dim myDate as String myDate = “2009- 08-12” 12th August 2009 myDate = fnConvertToInternal(myDate, “YYYYMMDD”, “-“)

fnConvertToExternal This function will convert a date in the date format used internally within PIC for Remittance, such as DD/MM/YYYY into a specified format. The interface parameters are as follows.

strDate The date to be formatted strFormat The format of date (either MMDDYYYY, YYYYMMDD – any other entry will return DDMMYYYY)

strSeparator The is the separator to use when converting the date For example, the following sets myDate as 08-12-2009. Dim myDate as string myDate = “12/08/2009” 12th August 2009 myDate = fnConvertToExternal (myDate, “MMDDYYYY”, “-“)

fnConvertToDouble This function takes an amount represented as a string value and converts it to a double value taking into account the locale settings of the machine.

fnGetClientDataaForWorkdoc This function retrieves the ClientData for the client id associated with the given Workdoc.

fnGetFieldSettings The function loads the field settings for the given field name and profile id from the BRWFLD table and returns a FieldSettings object with that info.


Page 48 of 78


fnGetObject The function creates and returns an object of the type specified in the className parameter. The object is returned from the function and is set in the the Object parameter. If the Object is of type IFieldEventsHandler, IDocumentEventsHandler, or IScriptModuleEventsHandler, then the Project and Settings properties for those objects will be assigned within this method. After calling fnGetObject, the caller can use object assigned to the Object or the return value directly to call supported methods and properties for that given class type.

For example, to call the PostEvaluate method of the Checks class Define these objects Private AccountNoHandler As IFieldEventsHandler Private Const AccountNoHandlerName = "AppDevRemit.ProjectFields.Checks.Checks_ AccountNo" then call fnGetObject (AccountNoHandlerName, AccountNoHandler) AccountNo

fnGetUserDecimalSeparator Function returns the decimal separator sued on the machine that execute the script.

fnIsValueInList This function takes a comma-separated list in input parameter ‘strList’ and a value ‘strValuePreserve’ and returns ‘true’ if the value is contained within the list

GetPathToAssembly When given a COM registered namespace will return the path to the assembly that contains the namespace. .

GetRegKeyValue Returns the value of the provided registry key name.

GetRejectReasons Returns a list of invalid reasons for a class from settings.

ReadSettings Reads settings from the INI and DB and populates them into the RemitStore and also tempSettings table.

RedimFSGlobals Initializes the g_FS array to an empty array if not initialized

UpdateSettings Reloads settings into the RmitStore.

exportXML_getFieldText This function returns the text value for a Check field.

exportXML_getCellText This function returns the text value for a Line item field.

exportXML_CreateElement This function creates a node element for XML export.

exportXML_SetAttribute This function sets the attributes for XML export

fnAddCustomXMLField This function is called form UserExits UserExitOutputXMLFile() to allow overriding of XML Export field settings for XML export.

exportXML_AddNode This function adds an XML node to XML export.

exportXML_RemoveNodeIfExist This function checks for duplicate nodes in the XML export and removes duplicates if any exist.

exportXML_UpdateAttribute This function updates XML attributes to a new value if it exists.


Page 49 of 78


fnGetFieldValue This function returns the current field setting value.

fnGetLineFiedlValue This function returns the current line item field setting value.

SplitString This subroutine performs a split on a given string based on a nominated separator, and returns the components of the string back to the calling function in an array, along with the number of values in the array. The interface parameters are as follows.

strSource The input string to be split.

strSplitArray The array that contains the split results passed back to the calling module.

strDesignator The delimiter to be used when performing the split.

ArrayLineCount The number of array elements in the returned strSplitArray.

For example: Dim myString As String Dim Words() As StringDim intWordCount As Integer myString = “MARY HAD A LITTLE LAMB”

A space is set as the delimiter Call SplitString(myString, Words(), “”, intWordCount)

The returned words array would contain the following: Word(1) = “MARY” Word(2) = “HAD” Words (3) = “A” Words($) = “LITTLE” Words(5) = “LAMB”

The returned intWordCount parameter would be set to 5.

fnGetFileName This function receives a full file name, which includes the file path and file extension, and returns the name of the file itself.

fnlsVerifier This function returns a Boolean true value if the current PIC module that executes the script is the Verifier module.

fnGetBatchID This function receives the path to a document in the batch directory (strWorkfile), parses the file path, and returns the batch ID number as a string.

The interface is strWorkfile.

fnlsAlpha This function returns a Boolean true value if the string passed with the parameter strString is made up entirely of alpha characters (upper or lower case).

The interface is strString.


Page 50 of 78


fnSetDBConnection This function can be called from a user exit to connect to a database.

The function takes in a database connection string with the strConnection input parameter. If the connection is already available, the index of the connection in global database connection array objDBConn will be returned If it is not available or not open, the function initializes the connection and returns the relevant index of the objDBConn object.

If the connection cannot be made, the function will return -1 and an appropriate error message will be written into the standard log file.

For example, the following code will instantiate a database connection and execute an SQL call where variable myDBConnection represents the connection string, and my SCL represents the SQL statement (both string variables): DimIngConnection As Long Dim myConnection As ADODB. Connection

IngConnection = fnSetDBConnection (myDBConnection)

If IngConnection = -1, then ‘ Connection could not be made – error handling Else ‘ Execute SQL using connection Set myconnection = ojbDBConn (IngConnection) myConnection.Execute(mySQL) End If

objDBConn is a global database object available for use in any user exit.

The interface is strDBConnection.

fnMatchDBComponents This is a supporting function used by fnSetDBConnection.

fnCheckDBArray This is a utility function that checks to see whether a passed database connection array of type ADODB. Connection is initialized. If it is not, the function will then initialize it.

The interface is myArray()

fnExtractDBComponents This is a supporting function sued by fnSetDBConnection.

fnGetFieldAnalysisSettings This function returns an instantiated AnalysisSettings object for given associative search engine file ASA and document class strClass.

The interface is strClass, ASA.

fnCheckNull This function receives a field component for a database record set and returns the value as a string to the calling routine through the function name. If the field component has a null value, an empty string is returned. Thee interface is strString.

fnlsNumeric This utility function returns a Boolean true value if all characters passed in the input parameter strTemp are numeric, such as 0-9.

The interface is strTemp.

fnCheckForNull This function receives a field component of a database record set and returns the value as a string to the calling routine through the function name. If the field component has a null value, an empty string is returned.

The interface is strString


Page 51 of 78


fnConvertBoolean This function receives a Boolean field component from a database record set and returns YES if the value is positive (an NO if the value is negative) back to the calling routine through the function name.

fnSetFromFileName This function takes the name of a parameter in the IMP section of the <project>ini file, along with the document file name, and parses out the

corresponding value from the file name, passing it back to the calling routine using the function name.

If the field is a date, it will be formatted in accordance with the VerifierOutputFormat setting in the BRWDAT table.

The interface is strFieldName, strFile.

RedimClientGolobals This function takes the global client buffer array and initializes it if it has not already been done.

fnGetClientData This function receives a client ID and returns its corresponding settings from the BRWClient table using the ClientData structure.

The example usage (to retrieve details for client zero) is as follows.

Dim Client As ClientData

Client = fnGetClientData(“0”)

Interface: strClientID

fnReadSubRule This function receives a substitution rule ID as a string and populates the SubRule object with the rule details, which is then passed back to the calling routine using the function name.

The interface is strRule.

fnGetVlueForIR This function receives the text for an invalid reason as displayed in the field in Verifier through the parameter strIR and returns a corresponding property (specified by strValue) belonging to that rule back to the calling routine using the function name.

Possible values for strValue are RULE and EXPORTCODE.

The interface is strValue, strIR.

LogError This function logs errors to log file found in C:\Program Files (x86)\Perceptive\Perceptive Intelligent Capture\bin\Log.

LogDiagnostic This function logs errors to log file found in C:\Progream\Files (X86)\Perceptive\Perceptive Intelligent Capture\bin\Log.

fnFormatTextForExport This function receives a string value and the name of a field registered in the BRWFLD table and applies the corresponding format for exporting. The formatted field is then passed back to the calling.

The interface is strText, strFieldName.


Page 52 of 78


fnFormatDateForExport This function converts a date in the Verifier output format, as configured in the DAT section of the system configuration, into a date in the export output format, as configured in the EXP section. For example, an invoice data can potentially appear in any format, but the system converts it to the format specified in the DAT section. If that format is MMDDYYYY, then 12th August 2009 displays in Verifier as 08/12/2009, which is also the technical content of the field object text property, such as the contents of pField.Text or pWorkdoc.Fields (“MyDate”).Text. The fnFormatDataeForExpreot function takes the technical contents of the field and converts it into the date format as specified in the EXP section. Therefore, if the export format is YYYMMDD with a hyphen (-) as the separator, then the following command populates the strDate string variable as 2009-08-12. strDate fnFormatDataeForExport(pWordkoc.Fields (“MyDate”).Text)

The interface is strDate and is the date to be converted.

About configuring the XML output file Adding custom scripts should always be the last resort to correct issues related to extractions.

However, each individual vendor learnset has its own script class, which means that code can be added without interfering with the operation of any other part of the project.

Examples of custom scripts include the following.

Correcting OCR problems where the correct results are known for a given vendor.

Defaulting mandatory field values which the vendor does not actually state on the invoice.

Improving line item extraction for vendors who present the information in a way that is not one-hundred.

Add a script to the XML export user exit

To add a script to the XML export user exit, complete the following steps.

1. With the Perceptive Intelligent Capture Designer module, open the <project>.ini file.

2. In the Definition mode section, highlight the UserExits class.

3. Right-click the class and select Show Script.

4. Navigate to the UserExitOutputXMLfile user exit subroutine.

5. Add the following line into the sub-routine in the invoice header section of the sub-routine’s select case structure.

fnAddCustomXMLField(pWorkdoc, rootElement, strNamespace, tagName, verifiedFlag,

verifiedValue, fieldName, lineNumber)

6. Close the script and save the file.


Page 53 of 78

Set up the remitters partition

About setting up the Remitters partition

The following is a high-level overview of the steps for implementing the Remitters partition.

1. Activate partitioning within the <project>.ini file.

2. Register the Remitters partition in the Remitters Partition table.

3. Assign the partition ID to the client.

4. Populate the RemittersMaster table.

5. Create a user DSN for the BRWRemittersPartition table.

6. Configure the ASA sections in the <project>.ini file.

7. Create the Remitters pool.

8. Configure the BRWSRC table.

Register a partition

To register a partition, complete the following steps.

1. Open the BRWRemittersPartition table.

2. Populate a row with a partition ID. This must be an integer.

3. Optional. Add a description. Its naming should be indicative of what it represents.


Activate partitioning

To activate partitioning, complete the following steps.


2. Set the GRL_OP_ActivateRemittersFiltering parameter to Yes.

3. Set the GRL_VL_RemittersFilterColumn parameter to PartitionID.


Assign a partition ID to the client

To assign the partition ID to the client, complete the following steps.

1. Open the BRWClient table.

2. In the corresponding RemittersPartition column, enter the ID of the newly registered partition for the appropriate client.

3. If a different client needs to support a different set of customers, it can be accomplished by creating different MCIR tables. To do this, map the ClientID in the BRWClient table to point to the ProfileID that would then be used in the BRWMCR table to point to the corresponding MICR table for the client.


Page 54 of 78

About improving data extraction PIC for Remittance Processing comes preconfigured with a generic learnset for the extraction of data from remittance transactoins.

The system is already able to deliver high-extraction results from remittance transaction documents of any format without any special configuration.

However, for those documents that stop in the Verifier application due to missing or incorrectly read fields, it is possible to take additional measures to build upon the system’s existing extraction capability, thsu ensuring that these problemtaic documents pass through the system untouched.

Export a TIFF image

To export a TIFF image, complete the following steps.

1. Open the BRWEXP database table.

2. Set the OutputTiffFile column to True.

3. To set the name of the TIFF file to match the document URN in the <project>.file, set the TiffName

column to URN. Otherwise, the name will be the same as the original imported document.


Configure the DPI and compression type for TIFF images

To change the TIFF image DPI and compression type, complete the following steps.


2. Set the TiffDPI column to the DPI of your choice. The default image compression is 300 dots-per-inch (DPI).

3. In the TiffFormat column, set the image compression to one of the following options. The default is standard Grade 4 compression.

G4FAX for Grade 4 compression.

G3FAX for Grade 3 compression.

LZWFAX for LZW compression.

HUFFAX for HUF compression.


Configure zone properties

To configure zone properties, complete the following steps.

1. Open the Zone Properties dialog box.

2. Select the General tab.

3. In the Name field, enter MICR2.

4. In the Units list, select pixel.

5. In the Size area, select Fit to image width.

6. In the Position/Size area, complete the following substeps.


Page 55 of 78

1. Set the Left parameter of 0 (zero).

2. Set the Width parameter to 1715.

3. Set the Top parameter to 645.

4. Set the Height parameter to 63.

7. In the Automatic zone fitting area, complete the following substeps.

1. Set the Left parameter to 27

2. Set the Right parameter to 27.

3. Set the Top parameter to 27.

4. Set the Bottom parameter to 7.

8. Click OK.

Switch off the analysis engine To switch off the analysis engine, complete the following steps.

1. Open the <project>.ini file using the Perceptive Intelligent Capture Designer module.

2. Navigate to the class that holds the definition of the field, and then to the field.

3. Display the field properties.

4. In the Available analysis engine list, select No Analysis Engine.

5. Save the changes and close the file.

Work with Verifier forms

Turn off Verifier logging

To turn off Verifier logging, complete the following steps.

Note Diagnostic logging for Verifier is on by default and exports logging information to an Intelligent Capture V_log file.


2. Set the GRL_OP_DynamicDebug parameter to No.

3. Save the changes and close the INI file.

Edit the Verifier form in Perceptive Intelligent Capture Designer

To edit the Verifier form in the Perceptive Intelligent Capture Designer, complete the following steps.

1. Using Perceptive Intelligent Capture Designer mode, open the request.

2. Navigate to Verifier Design Mode.

3. On the left side of the screen, in the Class view, click the Class node to which you want to add the field.

4. Drag the new field from the Field list onto the Verifier form.


Page 56 of 78

5. Create a new label for the field.

6. Save the project.

Create instructions for Verifier forms

To create a set of processing instructions for a Verifier form, complete the following steps.

1. Open the BRWINSTR table.

2. In the ProfileID column, add the profile ID. This integer must be unique within the table.

3. In the Instructions column, enter the instructions that you want to display when a user clicks the Instruction button on the Verifier form.


Configure dialog box settings for the Verifier thin client

If you are deploying the Verifier thin client, then the web.config file needs to be updated so that the optional dialog boxes and information are activated within the Verifier interface. To configure the web.config file, complete the following steps.

1. Navigate to <InstallDir>\Perceptive\Perceptive Intelligent Capture Web Server.

2. Open the web.config file.

3. Set the following parameters to True.

<mouseClicked enabled=”True”?>

<tabPressed enabled=”True”/>

4. Save and close the file.

Force a field to appear in Verifier

To configure a field so it is always marked invalid and then reviewed by a user in Verifier, complete the following steps.

1. Open the BRWFLD table.

2. To make a field mandatory, set the ForceVerify column to True.


Map the field identification

To map the identification of each field in the customer master extract to the relevant fields in the BRWSRC table, complete the following step.

1. In the BRWSCR column, complete the following substeps.

1. Set the ID parameter to SupplierID.

2. Set the Name parameter to SupplierName.

3. Set the Address 1 parameter to Field5.

4. Set the City parameter for Field6.

5. Set the Zip parameter to Field7


Page 57 of 78

6. Set the State parameter to Field8.

7. Set the Country parameter to Field9.

About configuring fields

Each row in the database represents a field, and the table is keyed by the profile ID and the technical name of the field.

The extraction and validation of fields is controlled in the PIC for Remittance Processing database in the BRWFLD table. Extraction and validation rules are set at the profile ID level and assigned to clients. During installation, the table is populated with a full list of the fields available within the project for Profile 0 (zero).

The entries in the BRWFLD table allow you to perform the following actions.

Switch fields on and off.

Set fields to mandatory or optional.

Set default field values.

Set a field type, such as date, amount, table, text, and corresponding validation rules.

Allocate usage of custom fields.

The name of the field displays in the FieldName column. This name should not be changed.

If a standard field in the project is not listed in the BRWFLD table for a profile, it is considered inactive.

There are two default settings for every field, and the field usage depends upon how the default is applied.

Whether a field is mandatory or optional is controlled using the RequiredInRTS and RequiredInVerifier columns in the BRWFLD table. The following table provides information about the effect of setting these columns to True and False in isolation and in tandem.

RequiredInRTS RequiredInVerifier Description

False False The population of the field is option within the project.

True False If the system does not extract a value into this field automatically, the field is marked invalid and the document is sent to the Verifier. The user is permitted to leave a blank value in the Verifier.

True True If the system does not extract a value into this field automatically, the field is marked invalid and the document is sent to the Verifier. The user must enter a value in the Verifier.

False True If the system does not extract a value into this field automatically, the field is marked invalid and the document is sent to the Verifier. The user must enter a value in the Verifier.

About configuring field types

The field type governs which of the additional settings in the table affect the validation of the field.

You can assign the following field types to each field.


Page 58 of 78

Date

Amount

Text

Table

Text fields can contain numeric and alphanumeric characters.

Configure date fields

To configure date fields, complete the following steps.

1. Open the BRWDAT table.

2. In the FutureDays column, enter a numerical value that indicates the number of days in the future from the present date that an extracted date is considered valid. If future dates are not permitted, then

this should be set to 0 (zero).

3. In the NoDaysInPast column, enter a numerical value that indicates the number of days in the past from the present date that an extracted date is considered valid. If days in past are not permitted,

then this should be set to 0 (zero).

4. To force an extracted date to stop in Verifier if the displayed date is not in the current month, set the

DateOnlyInCurrentMonth column to True.

5. To have date in the Verifier display as MM/DD/YYYY, in the VerifierFormat column, enter

MMDDYYYY, or to display the date as DD/MM/YYYY, enter DDMMYYYY.

Note You set the date output format settings for each profile ID, so a different configuration is permitted for each client.


Configure amount fields

To configure amount fields, complete the following steps.


2. Set the FieldType column to NetAmount.

3. To control the number of decimal places assigned to the amount during data export, in the DecimalPlaces column, enter a numeric value.

4. To set the output of an extracted value that is less than zero, in the NegativeType column, enter one of the following integers.

Integer Description

1 This forces a minus sign to appear after an amount, such as 100.00-.

2 This forces a minus sign to appear before an amount, such as -100.00.

3 This forces a value to appear in parentheses, such as (100.00).

5. If an alternative value should be displayed if the extracted value is either empty or zero, in the OutputForZero column, enter the alternate value. Or, it an alternative value should display if the


Page 59 of 78

extracted value is greater than zero, in the SubstituteValueIfOver0 column, enter the alternate value.


Configure text fields

To configure text fields, complete the following steps.


2. In the MinLength column, enter a numeric value that represents the minimum permitted length of the field.

3. In the MaxLength column, enter a numeric value that represents the maximum permitted length of the field.

4. In the PadChar column, enter a numeric value that is the length a field is padded to the right when a maximum field length is not met, such as 123400000.

5. To have a value padded by the character entered on the left, such as 000001234, set the

RightJustify column to True.

6. To remove all special characters from a value, set the RemoveAllSpecials column to True.

7. To remove all spaces from a value, set the RemoveBlanks column to True.

8. To retain non-comma separated lists of special characters that are retained when the

RemoveAllSpecials column is set to True, set the KeepCertainSpecials column to True.

9. To have positive numbers start from the left side of a field and negative numbers start from the right side, set the SubstringStartPos column to an integer.

10. To have a starting character used in conjunction with SubstringLength when trimming an extracted value, set the SubstringLength column to an integer.

11. To remove any leading zeroes from an extracted or user-entered value, set the

RemoveLeadingZeros column to True.

12. To enable a field to have a comma separated list of valid entries that contains only approved characters for an extracted or user entered value, in the FieldMask column, enter any letter, number, or wildcard character. For example, if the content of this column is set to ABCD,WZYZ, then no value is permitted in this field unless it is equal to either ABCD or WXYZ.


Set a field to be mandatory or optional

To make a field mandatory or optional, complete the following steps.


2. To make a field mandatory, set the RequiredInRTS and RequiredInVerifier columns to True.

3. To make a field optional, set the RequiredInRTS and RequiredInVerifier columns to False.


Set field default values

To set the default values for a field, complete the following steps.



Page 60 of 78

2. If a field should always be set to a fixed value irrespective of extraction, set the DefaultValue column to the default value.

3. If a field should default to a value because the system has not extracted anything into that field, set the DefaultIfNothingExtr column to the default value.

4. Save the changes

Turn fields on and off

To turn a field on or off, complete the following steps.


2. To turn a field on, set the Active column to True.

3. To turn a field off, set the Active column to False.


Define field output

To define a field in the XML file, complete the following steps.

1. Depending on the field you are defining, open the BRWEXPChecks or BRWEXPLines table.

2. Populate the XMLTag column with the desired XML tag parameter for the given field.

3. Optional. Repeat the first step in this procedure for all fields in the XML section.


Label a field in Verifier

To control how a field is labeled in Verifier, complete the following steps.


2. In the VerifierLabel column, enter the text for the filed that you want to appear in Verifier.


About configuring the Vendor ID field without using a partition

You can configure the Vendor ID field without using a partition.

The system determines the Vendor ID field with the Intelligent Capture Associative Search engine. Each institution or applicant at a single address must have a unique identifier. This unique identifier can be either numeric or alphanumeric.

Configure a standard Customer ID field

This is the most basic configuration option for configuring a customer ID field without using a partition. To configure a standard customer ID field, complete the following steps.

You should use this configuration when the ERP system provides a single field identifier for a single customer at a single address. In this scenario, each customer extract supplied by the client, whether it is provided as a CSV file or within a database table, and it should represent a single customer at a single address. Additionally, one column in the record needs to be a unique identifier. The generation of the customer pool based upon the customer extract fails if more than one record shares the same unique identifier.


Page 61 of 78

1. Navigate to the directory that contains the Global project file.

Note If you are using UNC paths, the relevant directories should have the appropriate shares, which is usually full control, so that the system can perform the required read-write operations.

2. Create a new directory and name it Pool.

3. Open the <project>.ini file, locate the ASA section, and set the following parameters. If the unique identifier for each row in the customer extract is numeric, then the AlphaNum parameter should be

set to No.

ASA_VL_01_Class=Checks

ASA_VL_01_Fieldname=RemitName

ASA_OP_01_AlphaNum=0

ASA_OP_01_PoolRelative=No

ASA_VL_01_PoolPath=\\MyComputer\Projects\Global\Pool

ASA_VL_01_PoolDirecotry=Pool

ASA_VL_01_PoolName=customer ASA_OP_01_FileRelative=No

ASA_VL_01_ImportPathFilename=\\MyComputer\Projects\Global\remitter.csv

ASA_VL_01_ImportFilename=remitter.csv

4. If the Pool directory with the UNC path, and set the PoolRelative parameter to No. If you are using

supervised learning, and the pool directory is located in the same directory as the project file, then the

PoolPath can be left empty, but set the PoolRelativ parameter to Yes, and set the PoolDirectory

parameter to the name of the pool directory.

5. If you are using UNC paths, ensure that the relevant directories have the appropriate shares (usually full control) so that the system can perform the required read-write operations.

6. If the customer extract file is not in the same directory as the project file, set the FileRelative

parameter to No, and populate the ImportPathFileName with the UNC path to the customer extract file. If the customer extract file is located in the same directory as the project file, set the FileRelative

parameter to Yes, and populate the ImportFileName with the name of the customer extract file.

7. In the Checks class, navigate to the RemitName field, display the field settings, and complete the following substeps. The names of the columns shown in the field display are system-assigned names. These names may not be indicative of the contents of the fields in the CustomerExtract file. SupplierID is always the first column, SupplierIndex is the second column, SupplierName is the third column, and so on. When using a CSV file as the customer extract source, we recommend that the first line of the CSV file contain the column names as they appear in the Customer Extract file, and that you enable the Importfieldnames from the first row option for the RemitName field in the designer. This configuration eases Verifier searches through the Details option within Verifier search.

1. To import the pool, on the File Import tab, click Import.

2. To configure the search fields to identify the customer, on the Analysis tab, in the Search column, select the customer name, Street address, City, Zip/postal code, and customer telephone number boxes.

8. To reimport the pool, on the File Import tab, click Import.

9. Set the Class settings to [*customer name*] + underscore + [*customer ID*]. However, if

the Supplier_ID column contains the unique customer ID, and the SupplierName column contains


Page 62 of 78

the customer name, which varies depending on the column order in the actual customer extract, then

set the class to [SupplierName]_[SupplierID].

10. The field settings control how the customer’s address displays on the Verifier form. It is a multi-line field, and the first line must be set to the unique identifier for the record in the customer extract. The file should have the following structure, but the structure may vary depending on your business needs. However, the first line must be set to the unique identifier.

[*Unique ID*] [*customer Name*]

11. If the SupplierID represents the unique record identifier, SupplierName represents the customer name, then configure the following parameters.

[SupplierId] [SupplierName]

12. The configuration of the RemitName field is complete. A green light with the message Engine Is Ready should display in the filed status box. Save and close the project file.

About adding additional custom fields

You can add additional custom fields in the Designer module.

Create an additional field in Perceptive Intelligent Capture Designer module

To create a new field in Perceptive Intelligent Capture Designer module, complete the following steps.

1. Using the Perceptive Intelligent Capture Designer module, open the <project>.ini file.

2. To reveal the field view list for the class, in the class list on the right side of the screen, select the desired class and click the Fields tab.

3. Scroll to the bottom of the field list, and then right-click and select Insert field definition.

4. Enter a name for the new field and click OK.


Add a validation script to the class

To add a validation script to the class, complete the following steps.

1. Using the Perceptive Intelligent Capture Designer module, open the <project>.ini file.

2. Click the Spanner icon.

3. To reveal the field view list for the class, in the list on the right side of the screen, select the desired class, right-click and select Show Script.

4. Scroll to the bottom of the script and paste the following code, substituting the technical field name.

Private Sub Custom6_Validation (pField As SCBCdrPROLib.ISCBCdrField, pWorkdoc As

SCBCdrPROJLib.ISCBCdrWorkdoc, pValid As Boolean)


About using substitution rules Within the BRWFLD table, a text field can be assigned a substitution rule that permits an extracted value to be substituted in part, or as a whole, with another value. This works in a similar way to the standard VB replace command.


Page 63 of 78

One substitution rule can be assigned per field.

Substitution rules are held in the BRWSubstitution table, which has the following structure.

Column Usage

SubstitutionRule Substitution rule index

Original String value to be replaced

Replace String value to be substituted

Configure Verifier message settings If you are deploying the thin client Verifier, then you need to update the web.config file so that the dialog box information and optional messages are activated within the Verifier intervace. To configure the Verifier message settings, complete the following steps.

1. Navigate to Program Files > Perceptive > Perceptive Intelligent Capture Web Server and open the web.config file.

2. In the web.config file, set the mouseClicked enabled and tabPressed enabled properrties to True.

3. Save and close the file.

Retrieve custom error messages You can include custom error messages as entries in the BRWERR table, rather than hard coding them within the script. To configure the retrieval of custom error messages, complete the following steps.

The error message number range assigned for customeer suage is 900-999, which should be adhered to to prevent any conflicts in the event of an upgrade.

1. Open the BRWERR table.

2. Add the following code

Dim myError As String

myError = GetDictionarySettingByIndex (“ERR”, “ErrorMessage”, “900”)


Set a review state To set a review state, complete the following steps.


2. Navigate to the GRL section.

3. Set the GRL_VL_ReviewState parameter to the following.

GRL_VL_ReviewState=699


Page 64 of 78

Note It is recommended that you use 699 for the parameter, but you can use any values between 650 to 699 or 701 to 749.

What are user exits? A user exit is a dedicated public subroutine or function on the UserExits class script level where custom code can be inserted.

Each user exit is called form a relevant point in the application layer baseline code and provides you with a window to perform a custom activity as is appropriate for your implementation.

Customization should be implemented in a modular fashion within the user exits. If any ancillary functions are required to support these modules, then these should be created as public functions. These ancillary functions can be placed on the UserExits script class if they are only to be used locally. If they need to be accessed by custom scripts on other classes, they can be placed at the end of the existing script on the GlobalVariables class in the marked area.

The user exits that are available, along with their calling points and suggested uses, can be bound in the following table.

User exit Calling routine Parameters Description

UserExitCustomExport

ScripModule_ExportDocument

The interface parameters is pCancel.

This user exit enables an end user to make a custom export. It is called from ScriptModule_ExportDocument if it is activated in the BRWEXP table with EnableCustomExport. If there is a failure in the export, set

pCancel to True to stop processing.

UserExitRouteDoucment

ScriptModule_RouteDocument

The interface parameters are pWorkdoc, State. pWorkdoc is the standard Workdoc object that provides access to all document field information (including the originally extracted line item data), the document classname, the document OCR text, and the document file name.

This is the user exit for performing any custom activity connected to the Perceptive Intelligent Capture workflow state of each document. For example, changing the state based on a property of the workdoc or document file name so it can be filtered on a user-by-user basis.


Page 65 of 78


UserExitOutputXMLFile

Internal application

The interface parameters are pWorkdoc. This standard Workdoc object provides access to all document filed information (including the originally extracted line item data), the document classname, the document OCR text, and the document file name.

The rootElement is the XML element of the Export XML document to be modified.

The strNamespace is XMLNameSpace defined in the BRWEXP table.

pCancel is the flag that indicates whether an export process has been canceled.

This user exit is available to add any custom fields into the XML output file. The XML output file is divided into the following sections. It is called by the core application code once for the document header, once for the invoice header, once for each standard line item, and once for each general ledger coding line item.

TableData section contains line item details for the documents.

DocFields section contains information for individual check fields.

Custom fields can be entered into any of these sections by use of the public fnWriteXMLField and fnWriteXMLDateField functions.

UserExitSetReportingLoginname

Internal application

The interface parameters are pWorkdoc, strUserName. pWorkdoc is the standard Workdoc object that provides access to all document filed information (including the originally extracted line item data), the document classname, the document OCR text, and the document file name.

The strUserName input parameter contains the user name that the system is currently using.

This user exit allows a developer to change the name of the user as reported in the Visibility reporting database.

This is used in Perceptive Intelligent Capture 5.2 and higher where the Web Verifier is in use. Otherwise, the system always populates the Thick Verifier user column in the reporting database with the Perceptive Intelligent Capture service user.

It is no longer necessary to insert code into this user exit for Thick Verifier implementations. The system always uses the Thick Verifier logon ID as the user name.


Page 66 of 78


UserExitPostImportBatch

ScriptModule_PostImportBatch

The interface is pWordoc. This is the standard Workdoc object that provides access to all document filed information (including the originally extracted line item data), the document class name, the document OCR text, and the document file name.

This user exit allows additional processing to be performed at the end of the PostImprtBatch event.

It is called at the end of ScriptModule_PostImportBatch.

What is the user exits script class?

The user exits script class contains the project user exit script points.

You should not remove or change the definitions of the provided user exits.

About user exits for text fields

To permit specific formatting and validation coding that cannot be achieved using the regular configuration options, configure the UserExitTextFieldFormatting parameter that is available in the project user exit events.

For more information, see the example script provided in the user exit.

About configuring the triggering of user exits in Dynamic Verifier

User exits are triggered when a user is working a problem document in Verifier.

General actions

The following information provides a list of general user exit calls that apply to all fields in Verifier.

Verifier action User exits

User presses Enter on any field set to type TEXT in the BRWFLD table UserExitTextFieldFormatting

Configure reporting and custom base classes

If the project requires an addition of a new class, the class can be added under the Documents base class to inherit the reporting fields and functions required, automatically. If the project involves adding a new base class, then the standard reporting trail as written into the Visibility tables will not complete without the following steps being performed.

To configure the reporting and custom base classes, complete the following steps.

1. On the custom base class, add a script to the Document_PreExtract and Document_Validate events.

2. On the bass class, create a custom tmpCLSRES field.


Page 67 of 78

Add a customer script to the Document_PreExtract and Document_Validate events

To insert a custom script to the Document_PreExtract and Document_Validate events, complete the following steps.

1. Open Perceptive Intelligent Capture Designer.

2. In the Class view in Definition mode, highlight the custom base class, then right-click and select Show script.

3. Copy the following script into the script window.

Private Sub Document_PreExtract (pWorkdoc AS SCBCdrPROJLib.ISCBCdrWorkdoc)

If InStr(Ucase(ScriptModule.ModuleName), cVerifier) Then gblVerifierAsServer = True

Else

gblVerifierAsServer = False

End If

fnGetClassResultsMatrix (pWorkdoc)

fnReporting (pWorkdoc, “DOCUMENTPREEXTRACT”)

End Sub

Private Sub Document_Validate (pWorkdoc As SCBCdrPROJLib.ISCBCdrWorkdoc, pValid As

Boolean)


If Ucase (ScriptModule.ModuleName) <> cVerifier Then fnReporting (pWorkdoc,

“DOCUMENTVALIDATESERVER”)

Else

fnReporting (pWorkdoc, “DOCUMENTVALIDATEVERIFIER”)

End If

End Sub

4. Save the script and close Perceptive Intelligent Capture Designer.

Add the tmpCLSRES field

The tmpCLSRES field is used to store the full classification results and weightings before they are written to the reporting database. To create the tmpCLSRES field, complete the following steps.

1. In the custom base class, change to the Fields view mode.

2. Right-click in the gray space and select Insert Field Definition.

3. Enter tmpCLSRES. This is case sensitive.

4. Right-click the new field and select Show Properties.

5. In the pane on the right side, select the Validation tab, and then select the Always Valid flag.


Delete the BW packaged / generic script classes Do not delete, change, or rename the BW packaged / generic script classes.


Page 68 of 78

The <project>.ini file may not be recoverable if you delete, change, or rename these script classes.

What are the project data structures? PIC for Remittance uses internal data structures to pass data between functions and subroutines.

It is impossible to use some data structures in the user exit script, and in some cases, these structures are defined as formal parameters in the interface.

What is the address structure?

The Address structure contains data elements associated with a particular remitter, such as the customer ID, the customer name, and address details, along with additional information. The extent to which the data is populated depends on the extent to which the data is available in the remitter extract, and mapped in the BRWSRC table.

The extent to which the data is populated depends on the availability of the data in the customer extract and mapping in the BRWSRC table.

The structure consists of the parameters listed in the following table.

Structure Element Type Description

CustName String This is the name of the customer.

ADDRESS1 String This is the customer street address line 1.


ZIP String This is the customer zip code or postal code.

ID String This is the unique customer ID. This is the unique ID from the point of view of the data extract, where each row must have a unique reference. This is not the unique customer ID from the point of view of the ERP system if a site ID is also used.

City String This is the customer city.

State String This is the customer state. For U.S. addresses, the state code is expected here, such as CA = California, or VA = Virginia.

Country String This is the customer country. This should be the two character ISO-code for the country, such as US = United States of America, DE = Germany, GB = United Kingdom.

What is the address structure?

The Address structure contains data elements associaated with a particular remitter, such as the customer ID, the customer name, and address details, along with additional information. The extent to which the data is populted depends on the extent to which the data is available in the remitter extract, and mapped in the BRWSRC table.


Page 69 of 78

The extent to which the data is populated depends on the availability of the data in the customere extract and mapping in the BRWSCR table.

The structure consists of the parameters listed in the following table.

Structure Element Type Description

CustName String This is the name of the customer.


ADDRESS2 String This is the customerr street address line 2.

ZIP String This is the customer zip code or postal code.

ID String This is the unique customer ID. This is the unique ID from the point of view of the data extract, where each row must have a unique reference. This is not the unique customer ID from the point of view of the ERP system if a site ID is also used.

City String This is the customer city.

State String This is the customer state. For U.S. Addresses, the state code is expected here, such as CA + California, or VA = Virginia.

Country String This is the customer country. This should be the two character ISO-code for the country, such as US = United States of America, DE = Germany, GB = United Kingdom.

What is the FieldSettings structure?

The FieldSettings structure holds details associated with a given field as read from the BRWFLD table.

The structure is used as a parameter in the UserExitTextFieldFormatting user exit. The components of the structure are listed in the following table.

Structure element Type Description

FieldName String This is the field name.

ProfileID String This is the profile ID.

VerfierLabel String This is the field verifier label.

Active Boolean This is the field active flag.

RequiredInRTS Boolean This denotes whether the field is required in RTS.

RequiredInRTS Boolean This is denotes whether the field entry is mandatory in Verifier.


Page 70 of 78


CountryFilter String This is the comma-separated list of countries that control whether the field is mandatory .

FieldType String This is the field type.

ForceVerify Boolean This is the force verify indicator.

DefaultValue String This is the field default value.

DefaultIfNothingExtr String This is the filed default if no value is extracted automatically.

SubRule String This is the field substitution rule.

MinLength Integer This is the field minimum length.

MaxLength Integer This is the field maximum length.

RightJustify Boolean This indicates whether the field should be right-justified if a pad character is used.

PadChar String This is the padding character.

RemoveAllSpecials Boolean This is indicates whether special characters should be removed.

RemoveBlanks Boolean This is indicates whether blank spaces should be removed.

KeepCertainSpecials String This is a list of special characters that should be retained.

RemoveStartEnd Boolean This indicates whether special characters should be removed from the start and end of the string.

SubstringStartPos Integer This is the substring start position.

SubstringLength Integer This is the substring length.

RemoveLeadingZeros Boolean This is the flag that indicates whether leading zeroes should be removed from a string.

DecimalPlaces Integer This is the number of decimal places for an exported amount.

NegativeType Integer This is the negative type code.

OutputForZero String This is the export value if an amount field is zero.

SubstituteValueIfOver0 String This is the export value if an amount is greater than zero.

FutureData Long This is the number of days that an extracted date is permitted to be in the future.


Page 71 of 78


NoDaysInPast Long This is the number of days that an extracted date is permitted to be in the past.

DateOnlyInCurrentMonth Boolean This indicates whether the date should only be in the current month.

FieldMask String This is the list of valid field masks for text fields.

DocumentType String This is the type of document.

What are client ID errors? The system displays an error if any of the following conditions occur.

The column names for the URN and client ID have not been mapped or are incorrect.

The ClientKey parameter has been set to URN, but IMP_VL_URN has no component assigned or the component does not exist in the file name.

Configure late archiving with Perceptive Intelligent Capture Visibility The Visibility reporting tool provides functionality to store image data within its underlying database, which allows Visibility to serve as an image archive. To archive the image into the Visibility reporting database, complete the following steps.

1. Set the REP_OP_StoreImageInReportingTables parameter to Yes.

2. To specify the table in which the image is to be stored, set the REP_VL_Reporting DBImageTable

parameter to BRWDOCIMAGE.

3. To configure the archive URL, which is the template of a web address that will bring up the image, set

the REP_VL_ArchiveURL=http://myarchivesystem.com?ID parameter to XXXXX.

Note The system automatically substitutes the XXXXX component of the URL with the unique image ID in

the archive.

About document splitting in Visibility Within the Verifier application, a user has the ability to split a single document image into two or more document images.

The system creates these new records when the user manually reclassifies the new individual documents, which initially have a status of unclassified in the workflow. Before manual reclassification, the user should ensure that all necessary splits have taken place for a given original image file, otherwise orphan Visibility records will remain in the database, which would skew processing statistics.

If usage of the document splitting capability is required, and the system is configured to export data using the standard database, XML methods, or the file is to be archived into the Visibility database, it will not be possible to use the URN as mapped to a component of the document file name as the document key for


Page 72 of 78

those exports. This is because the RUN will remain constant for multiple documents, hence database conflicts will occur, and export files may overwrite one another.

About configuring data export Data export is controlled by settings in the BRWEXP table.

Each of the table sections are keyed by an export profile ID that can be assigned to a client.

Note PIC for Remittance Processing only supports the output of strings to external database tables.

You can configure and use the following exports in PIC for Remittance Processing.

Exporting data to an XML file.

Creating a custom export.

Exporting a TIFF image.

Exporting data to database tables

Data exports can be written to the following types of tables.

Document header data table

Document line-items data table

Check table

Transaction table

Document Header table information includes data that is applied to the document as a whole, such as the amount due and document class.

The structure of the Document Header destination table should have columns for image ID, transaction D, document start time, document end time, amount due, whether it has line items, reject reason, and the reject reason code.

Output of line items

The system expects the Destination Line Items table to have a composite key that consists of a document identifier that is populated with a value identical to that passed into the unique key field in the header table. It must have the same technical column name, and a line item number index column that the system sets from 1-n, where n is the number line items.

The line items fields to be outputted are controlled within the BRWEXP table, where there are five line-item fields available for mapping. To indicate that the filed should be outputted, the technical name of the destination database table column should be set against the DBDOCLINES column name parameter.

Data export to the Check table

The Check table contains information about checks in a transaction, and output is controlled within the BRWEXP table.

Output of transactions

You must configure the output for any transaction fields that require database output. Output is controlled within the BRWEXP table.


Page 73 of 78

Output to an XML file

The XML file is always written to the directory specified as the export directory on the Runtime Server instance settings for the instance that is carrying out the document export. If no export directory has been specified, the default export directory, C:\Export, is set in the DefaultExportPath column in the BRWEXP table is used.

Custom export of line item data

Line item data for export is contained within the LineData array, which is 1-based.

The contents of the LineData array vary depending on whether line pairing is switched on or off. If line pairing is switched on, the array contains the following information.

All material/service line items that the system was able to pair.

All material/service line items that the system was unable to pair.

All miscellaneous charges that the system was able to post against SAP planned conditions.

All miscellaneous charges that the system was unable to post against SAP planned conditions.

All miscellaneous changes that were set to post as a specific line type.

All miscellaneous changes where no processing option has been selected.

Paired line can be identified by checking the value of the PO_Number and PO_Item properties of the line item. If they are populated, the line was paired; if they are empty, it was not paired. Miscellaneous changes set to post as a specific line type can be identified by checking the value of the MiscCharge property of the line item. In this instance, that property will have a value of X.

For miscellaneous charges that were set to be booked against a general ledger account entry, these can be found in the GLData array; for miscellaneous charges that were set to be booked as unplanned costs, these can be found summed together in the global variable dblUnplannedDelCost.

If the line pairing is switched off, the array contains the following information.

All material/service line items captured from the invoice.

All miscellaneous charges captures at line item levels from the invoice.

Configure output of transactions

The output of transactions is optional. To configure thee output of transactions, complete the following steps.


2. In the DBTRANSACTTableName column, enter the database table name.

3. In the DBTRANSACTPrimaryKey column, enter the name of the document identifier.

4. In the DBTRANSACTCheckAvailable column, enter CheckAvailable.

5. In the DBRANSACTDocCount column enter DocCount.

6. In the DBTRANSACTExportDocCount column, enter ExportDocCount.

7. Repeat the previous steps for all transaction fields that require database output. Leave the parameters blank for any fields that are not relevant for database output.



Page 74 of 78

About configuring the XML output file The standard XML output file is divided into separate sections with XML tags and attributes beginning with a namespace that is configurable using the XMLNameSpace column in the BRWEXP table.

The XML sections include a Transaction section that contains an IsBalanced flag that indicates whether a transaction is balanced, and a Document section that contains invoice type documents and check/scannable coupon type documents.

The Document tag contains the following attributes.

RejectCode. This is the rejection code for a document if it is rejected by a verifier.

DocumentEndTime and DocumentStartTime. This is a time stamp for when a verifier opens a document for verification and when the verifier completes the verification.

DocType. This is the type of document, such as invoice, check, coupons, and so on.

ImageRotation. This flag indicates if a document image is rotated.

UserID. This is the user ID for the verifier that completed the verification.

ImageId. This is the ID of the image being processed.

Within each Document section, there is either a TableData section or DocFields sections.

The TableData section includes line items associated with remittance documents, such as invoice number, gross amount, discount and net amount. Each table row contains information for each line item within a document.

The DocFields section includes fields associated with a check or scannable coupons for each transaction, such as CAR, MICR, account number, and so on.

The XML tag names for the DocField fields are customizable in the BRWChecks table for checks and BRWLines table for remittance line items using the XML Tag column. Each DocField section contains the following attributes.

Verified. This is the flag that indicates if a document has gone through verification.

VerifiedValue. This is the value of the verified field.

FieldName. This is the name of the field.

Configure output to an XML file

To configure output to an XML file, complete the following steps.


2. Set the XMLOutput column to True.

3. Set the XMLFileName column to URN. Otherwise, the name is the same as the original imported

document.

4. If you want to use a different export directory than the default directory, enter it in the DefaultExportPath column.

Note The XML file is always written to the directory specified as the export directory on the runtime server instance settings for the instance that is carrying out the document export. If no export directory is specified, the default export directory C:\Export, which is set in the DefaultExportPath column in the BRWEXP table is used.


Page 75 of 78

5. Optional. To set the file extension to XML, set the XMLFileType column to True.

6. Optional. To support UTF-16 for non-western characters, such as Chinese, set the

XMLEncodingHeader column to UTF-16.

Note An XML file will not be generated if the output data contains non-western characters and the

encoding header is set to UTF-8.


Activate output to an XML file

To activate output to an XML file, complete the following steps.


2. Set the XMLOutput column to True.

3. In the DefaultExportPath column, enter the path to the output directory.

4. To set an export directory, enter the path in the DefaultExportPath column.

Note The default export directory is C:\DEMOS\PICR\Export.


Add a new client with new requirements To add a new client with new requirements, complete the following steps.

1. Navigate to the ClientSWL.sgl file that was included with the PIC for Remittance Processing installation.

2. Open the file and copy all of its contents to the clipboard.

3. Open SQL Server, right-click the DFIBPO database node and select New Query.

4. In the Query window, on the right side of the screen, paste the script and move to the top of the script.

5. Running the following script creates a new client with an ID of 1, which is assigned a newly created profile ID, vendor and employee partition, and an export profile ID of 1. Change these parameters according to your environment

SET @PROFILE_ID = 1

SET @CLIENT_ID = 1

SET @EXPORTPROFILE_ID = 1

SET @SWQLCONNECTIONGROUP = 1

SET @VendorPartition = 1

SET @EmployeePartition = 1

6. Click Execute. The script displays an error if it tries to create a client or any type of profile or partition that already exists in the database.

Add a new client that reuses an existing profile To add a client using an existing profile, complete the following steps.


Page 76 of 78

1. Navigate to the BRWClient table.

2. Right-click dbo.BRWClient and select Edit top 200 rows.

3. Enter the parameters for the new client.

About assigning documents to a client Documents must be preassigned to clients prior to being captured by Intelligent Capture.

There are two ways to assign documents to a client.

Using the document file name.

Using a database look-up.

Activate document review for a client

You can activate document reviews at the client level to send every processed document in a specific client to the review state prior to data export. To activate document review for a client, complete the following steps.

1. Open the BRWClient table.

2. Set the RequiresReview column to True.


Assign a client ID using a document file name To assign a client ID using a document file name, complete the following steps.

1. Open SQL Server and navigate to the BRWClient table.

2. Navigate to the IMP section.

3. Configure the following parameters.

Client ID

<project>.ini file setting

For example, the first component of the file name is 12345, the second component and client identifier is 2, and the third component is 20120901, which would be 1234_2_20120901.tif. If the file name for client 2 is 12345_20120901_2.tif, the <project>.ini file setting is IMP_VL_ClientID=COMPONENT2, because the client identifier is located in the file name’s third component. If the INI file parameter is not set or the file component does not exist, the system processes the document using the default configuration assigned to client 0 (zero).


Add a custom script to the Document_PreExtract and Document_Validate events

To insert a custom script to the Document_PreExtract and Document_Validate events, complete the following steps.


Page 77 of 78

1. Open Perceptive Intelligent Capture Designer.

2. In the Class view, in Definition mode, highlight the custom base class, then right-click and select Show script.

3. Copy the following script into the script window.

Private Sub Document_PreExtract (pWorkdoc As SCBCdrPROJLib.ISCBCdrWorkdoc)

If InStr(Ucase (ScriptModule.ModuleName), cVerifier) Then gblVerifierAsServer =

True

Else


End If

fnGetClassResultsMatrix (pWordoc)

fnReporting (pWorkdoc, “DOCUMENTPREEXTRACT”)

End Sub

Private Sub Document_Validate (pWorkdoc As SCBCdrPROJLib.ISCBCdrWorkdoc, pValid As

Boolean)


If Ucase (ScriptModule.ModuleName) <> cVerifier Then fnReporting (pWorkdoc,

“DOCUMENTVALIDATESERVER”)

Else

fnReporting (pWorkdoc, “DOCUMENTVALIDATEVERIFIER”)

End If

End Sub

4. Save the script and close Perceptive Intelligent Capture Designer.

About checking for OCR problems on the field contextual information

Generic field extraction can also be compromised by poor OCR on the contextual information surrounding the field, or no contextual information at all.

The extraction engine uses this context to assign confidence values to field candidates, so, if the context is not available or it cannot be read correctly, the correct candidate may not be accorded to requisite level of confidence to be extracted.

The OCR on the context does not need to be perfect as the system uses the fuzzy pattern-matching technologies to interpret the information that surrounds the field.

The absence of a meaningful context does not mean that extraction failure is guaranteed, as the system will also consider the value in relation to other fields, along with its general position on the document. However, missing contextual information will lead to the correct candidate being accorded a lower confidence value in comparison to documents where a context was provided.

Extraction issues that fall into this category can be remedied by creating a class using Designer.


Page 78 of 78

Index

No index entries found.