Properties of a business rule

Name

A name for the new business rule.

Description

A description of the new business rule.

Type

A read-only property to indicate that the current process is a business rule.

Category

A category to store the business rule. By default, the business rule is stored in the working category of the resource.

Hit policy

The "Hit policy" and "Include else condition" properties are only available for a decision table.

A hit policy is the rule based on which the output is evaluated. Available options are: First found, Collect and Rule order. (Default: First found)

• First found: Multiple rows can evaluate to true, but evaluation stops at the first row that evaluates to true.

• Collect: The values of all rows that evaluate to true are collected.

  For the Collect hit policy, you must specify what you want to collect (Sum, Min, Max, Count, and Average) from the output columns. The operators supported for the Collect hit policy are Sum, Min, Max, Count, and Average.

  When using Collect hit policy, all outputs must be numeric. When switching between hit policies, a warning message appears if there are any non-numeric output types as they are not supported.

  When you execute the rule in a form or process, the output variables contain the combined value for all rows that evaluate to true.

  For example, two rows evaluate to true with values 10 and 20. Therefore, the output variable value should return the following values:

  • Sum: 30

  • Min: 10

  • Max: 20

  • Count: 2

  • Average: 15

• Rule order: Multiple rows can evaluate to true, and the output of the table contains the possible outputs from each row. For example, if people over 12 years of age can access film A and B and over 15 years of age can access Film C and D, then if you are 16 years old, you get A, B, C, and D as possible films

Include else condition

Allows adding an else condition row to the decision table. (Default: Clear)

Configure capture properties of a business rule.

Classification group

A classification group to associate with the business rule to help classify documents. You can dynamically set the classification group for the rule using a classification group, process or server variable of type String, or business data. The process variable holds the GUID of a classification group. You can copy the GUID from the General tab of the classification group.

See Create a classification group for more information.

Initialize from scan

If selected, creates a capture-enabled process so that the data within Kofax Analytics for TotalAgility reports can be used to filter the data returned.

A capture-enabled process lets you create the Scan create new job form and Device create new job form on the process. At runtime, TotalAgility automatically initiates (or restarts or awakens from a wait state) a process to which an inbound document is required. For example, initiating an instance of the "loan approval" process when a loan application document is received.

A capture-enabled process also allows you to save scanned images as rendition, and modifications of imported documents.

In a capture-enabled process, the initialization variables must include one (not multiple) variable of either Document or Folder type; otherwise, you cannot save the process.

You can set separation profile, scan/VRS profiles, Device (separation profile, scan/VRS profile), select scanned images as rendition, and allow modification of imported documents for business processes only. You cannot do this for case and case fragments.

PDF text extraction

Extraction mode

The mode of extracting text from PDF. Available options are:

• All text: Extracts both visible and invisible text (default).

• Visible text only: Extracts only visible text.

• Automatic: Extracts only visible text. If results are empty, then extracts by including invisible text in the results.

• Ignore all text layer: Extracts PDF through OCR and ignores the PDF text layer.

Word separation

The characters to use as word separators. When processing the PDF, text or strings of text containing these characters are treated as separate words. For example, "1234/56" is treated as three separate words, "1234", "/", and "56".

Default characters are: "/", ":", "(", ")", "-" and "#".

Available from and Available to

Allows the business rule to be activated or deactivated on a particular date.

If set, the rule expires as soon as the active period is over. Otherwise, it remains active.

For example, a garment retailer decides to implement a discount scheme for Christmas and creates a rule that applies at the start of the season and expires at the end of the season.

Max loop count

Continuous looping in a business rule can cause a high workload on the TotalAgility server. You can set the maximum loop count to define the number of times an activity can be executed in a business rule (default: 1000). When the loop count reaches the set limit, the job is suspended at runtime. By default, the maximum loop count set at the system level is available for all processes. However, you can override the server level setting to set the loop count at the process level.

.Net assemblies

The .NET assemblies to associate with the business rule so that the rule can use external assembly components.

• On exporting a process, the .NET assemblies associated with the process are also exported.

• On importing a process from a version earlier than TotalAgility 7.0, all the available .NET assemblies are imported. You can configure the assemblies that are required.

• When you view a system map, the process is updated with the associated .NET assemblies.

To add a .NET assembly, click Add, select the assembly, and click Done. See .NET assemblies for more information.

Configure the access permissions to maintain a business rule.

A resource with maintenance access permissions for a business rule can add or delete resources or change the access rights of resources to maintain the system depending on the access types. You can only assign maintenance access to one individual or group.

To configure access permissions to maintain a business rule, see Configure maintenance access.