Utilities Activity

The Utilities activity handles functionality related to document and error summarization in the Transaction Insight® database.

Utilities is typically used as a regularly scheduled (timer-driven) process that performs multiple operations on the Transaction Insight database. The primary operations that should be implemented (alone and separate) are:

  • Summarize Documents
  • Summarize Errors
  • Assign Tasks.
Note: Parameters entered into BusinessWorks will be passed directly along to the Utilities executable installed with Transaction Insight.

General

The General tab contains the following fields.

Field Datatype Description
Name No (Required) The name to be displayed as the label for the activity in the process.
TI Binaries Directory string (Required) Directory where the TIUtilities.exe file is located.
Utilities INI File string Directory where the Utilities' ini file is located.

Example: -ini "C:\inifiles\TIUtilities41.ini"

Dynamic Filters boolean Generate dynamic partner filters?

Checked = Yes

Unchecked = No

Note: If you have large volumes of data being processed in a time frame, consider limiting this to once or twice a day, at a time when the database is not being used heavily.
Summarize All boolean Update all Statistical Summary Tables?

Checked = Yes

Unchecked = No

Summarize Documents boolean Update the summary statistics on the Transaction Insight Documents, Document Volumes, and Success Rate pages?

Checked = Yes

Unchecked = No

Summarize Errors boolean Update the top error counts on the Transaction Insight Errors page?

Checked = Yes

Unchecked = No

Assign Tasks boolean Assign tasks to teams and send the team owner an e-mail.
Note: Requires Task URL, Task SMTP, and Task From.

Checked = Yes

Unchecked = No

Confidential Identifiers string Load confidential identifiers into the database?

If desired, enter the location (path, including filename) in quotation marks indicating the location of the confidential Identifiers file.

Task URL string Specifies the URL to be used for task emails.

Example "http://ourcompany/TIportal"

Task SMTP string Specifies the SMTP server to be used for task emails.

Example: "www.ourcompany.com"

Note: Required for Assign Tasks
Task From string Specifies the "<from address>" to be used for task emails.

Example "doNotReply@ourcompany.com"

Note: Required for Assign Tasks.
Match 997 boolean Match 997 responses to a GS?

Checked = Yes

Unchecked = No

Match 997 Date string Date to start search for 997s.
Match 997 Days Spent integer Number of days prior to the start date to include in Search 997s.

Default = 0

Match 997 Days Past integer Number of days prior to a given 997 to include in search for a GS match.

Default = 0

Match 997 Days Future integer Number of days after a given 997 to include in search for a GS match.

Default = 0

Document No Trans Filter string Controls processing of Day/Week/Month for no filters.
Document Single Trans Filter string Controls processing of Day/Week/Month for single transaction filters.
Document Multi Trans Filter string Controls processing of Day/Week/Month for multiple transaction filters.

Description

The Description tab is used to provide a short description for the activity.

Advanced

The Advanced tab contains the following fields.

Input Item Datatype Description
Trace Level integer A number from 0 to 4 that controls the level of trace information generated by Utilities:

0 – Off (Default)

1 – Errors

2 – Warnings (includes errors)

3 – Informational (includes errors and warnings)

4 – Verbose/Debug (includes errors, warnings, and informational)

Trace Directory string Specifies the output directory for trace files. Do not include a trailing slash.

(Defaults to the current directory).

Trace to Console boolean Send trace messages to the console?

Checked = Yes

Unchecked = No

Monitor Timeout integer Number of minutes for Monitor thread timeout.

0 = Disable

30=Default

Encrypt INI string Encrypts database information by modifying the ini file. ini specifes the location of your ini file.

Example: C:\example\Importer.ini

Filter Value Hint string Sets hint for getElementvalue() of Dynamic Filters option.

Input

The Input tab contains the following fields.

Input Item Datatype Description
DatabaseType string Database type: oracle or odbc.
DatabaseConnectString string

Connection string for the Transaction Insight database:

Example: Oracle

jdbc:oracle:thin:username/password@dbserver:port:instance

Example: SqlServer

jdbc:sqlserver://dbserver:port;databaseName=dbname;user=myuser;password=mypass;

TestMode boolean Not currently supported.
FullUsage boolean Not currently supported.

Output

The Output tab contains the following fields.

Output Item Datatype Description
ReturnCode string The Utilities return code.

Refer to Error Codes.

Fault

The Fault tab lists errors that might occur when you use this activity.

Error Schema Element Datatype Description
msg string Error message description.
msgCode string The error code.