The work area for business logic

When you access business logic, the work area is divided into four panes: Document types, Business logic, Business logic details, and Parameters. These are described below.

The toolbar buttons are described here.

Document types

All of the document types, fields, field groups, tables, and table cells of the selected process are displayed here.

Available options:

Hide unused	Hides items that do not have business rules.
Filter	Hides all items whose names do not contain the text you type in the box.

Right-click any item for these additional options:

Business logic

This panel shows all business rules of the item(s) you selected in the left pane, in processing order.

Select one or more business rules to display their details under Business logic details.

Available options:

Hide deactivated rules

Hides rules that are not active.

All rules active

Activates or deactivates all of the rules that are displayed in the list.

Filter

In the Filter box you can type part of a name to filter the list.

Columns

Right-click column headers to adjust which columns are displayed. (Some are always displayed.) You can then drag and drop the columns into the desired order.

These columns are available:

Display name	The name of the business rule. Can be edited by clicking. (Always displayed.)
Parameters	The rule's configuration settings. Can be edited under Business logic details (see below).
Index	The number of the rule in execution order – in other words the business rule sequence. Can be edited by clicking. (Always displayed.) For more information see Defining the processing order of business rules.
Active	Whether or not the rule is activated. Can be edited by clicking. (Always displayed.)
Validated fields	Fields that the business rule applies to. The validation status of those fields is set to Valid or Invalid according to the result of the validation. It is also possible to use fields more passively, to simply supply data. In such cases do not select Validated. Example: A CheckLength comparison has three parameters: pValue, pMinLength, and pMaxLength. The pValue parameter is typically set to a field, for example PostCode. This field should be validated, so we select the box in the Validated column. When something changes in the PostCode field, we want to reapply the rule. Therefore, we select Trigger. The pMinLength parameter is a constant and is set to 3. Triggering and validation are not relevant here. The pMaxLength parameter is extracted from the PostCode Length field. However, this field is only for dynamic data transmission; the value for pMaxLength is not fixed but comes live from the field. This field is not validated, so Validated is not selected. However, when PostCode Length changes, we want to reapply the rule, so we select Trigger.
Trigger fields	If selected, validation is triggered when the field, table, or table column is changed.
Condition	The condition(s) that determine whether or not the rule is executed. Optional.
Assembly	The file (DLL) that contains the rule.
Method name	The function that implements the rule.

Add rule

Opens the Choose business logic template dialog, where you can select a business rule template.

For more information see Adding and configuring a business rule.

Delete rule

Deletes the selected business rules.

Moves the selected rule(s) to the top, one step up, one step down, or to the end of the list.

Tip: You can also drag and drop the rules to the desired position.

Right-click any business rule for these additional options:

Business logic details

Displays the configuration details of the selected business rule(s). You can edit them here.

Available options:

The name of the business rule is displayed at the top.

– the rule is active.

– the rule is inactive.

Rule activated

If selected (which it is by default), the business rule is executed (active).

If the business rule belongs to two or more business rule groups, it says for example Rule activated – used in 3 business rule groups. You can disconnect the rule from other business rule groups by selecting Edit > Disconnect business rule, after which any changes apply only in the current business rule group.

A two-line read-only description of the rule is visible. If the text is truncated, click it to read more.

Condition

The condition(s) that determine whether or not the rule is executed. Optional.

Execute when false

Reverses the condition, and executes the rule if the condition is false instead of true.

Opens the Execution condition dialog, where you can add a condition. Use a procedure similar to the one described in Adding a condition to a business rule or Adding a condition to a business rule group.

Opens the Execution condition dialog, where you can edit the condition.

Note: Your changes will impact all business rules and business rule groups that use the condition.

Trigger fields

Fields that trigger validation when they are changed.

Validated fields

Right-click column headers to adjust which columns are displayed. (Some are always displayed.) You can then drag and drop the columns into the desired order.

These columns are available:

Display name	The name of the business rule. Can be edited by clicking. (Always displayed.)
Parameters	The rule's configuration settings. Can be edited under Business logic details (see below).
Index	The number of the rule in execution order – in other words the business rule sequence. Can be edited by clicking. (Always displayed.) For more information see Defining the processing order of business rules.
Active	Whether or not the rule is activated. Can be edited by clicking. (Always displayed.)
Validated fields	Fields that the business rule applies to. The validation status of those fields is set to Valid or Invalid according to the result of the validation. It is also possible to use fields more passively, to simply supply data. In such cases do not select Validated. Example: A CheckLength comparison has three parameters: pValue, pMinLength, and pMaxLength. The pValue parameter is typically set to a field, for example PostCode. This field should be validated, so we select the box in the Validated column. When something changes in the PostCode field, we want to reapply the rule. Therefore, we select Trigger. The pMinLength parameter is a constant and is set to 3. Triggering and validation are not relevant here. The pMaxLength parameter is extracted from the PostCode Length field. However, this field is only for dynamic data transmission; the value for pMaxLength is not fixed but comes live from the field. This field is not validated, so Validated is not selected. However, when PostCode Length changes, we want to reapply the rule, so we select Trigger.
Trigger fields	If selected, validation is triggered when the field, table, or table column is changed.
Condition	The condition(s) that determine whether or not the rule is executed. Optional.
Assembly	The file (DLL) that contains the rule.
Method name	The function that implements the rule.

Message

Optional: A custom message about the business rule (shown in Verification); for example, a description of what the business rule is used for. If nothing is specified here, the system's standard validation message is displayed.

Parameters

Displays the parameters and values of the selected business rule. You can edit them here.

Tip: Here it is possible to change the parameters of multiple occurrences of the same business rule.

Conditional business logic

Symbol	Description
	Document type (with and without business rules).
	Field or field group (with and without business rules).
	Table (with and without business rules).
	Table column (with and without business rules).

Add business rule	Opens the Choose business logic template dialog, where you can select a business rule template. For more information see Adding and configuring a business rule.
Copy to fields	Pastes the selected business rule into the selected fields or table columns of the document type. For instructions, see Copying a business rule to specified fields. You can filter field names for a specified text, or you can select/deselect all fields using Copy to all fields.
Copy to all fields	Pastes the selected business rule into all fields or table columns of the document type.
Copy to business rule group	Opens the Choose business rule group dialog, where you can copy business rules to other business rule groups. All business rules below the selected node are copied to other (selectable) business rule groups.
Paste	Pastes a business rule that you copied (from the Business logic pane) into the selected field.
Delete business rules	Deletes all business rules in the current node and its sub-nodes.
Expand all	Expands all nodes in the tree.
Collapse all	Collapses all nodes except the currently selected node.

Add rule above Add rule below	Opens the Choose business logic template dialog, where you can select a business rule template. For more information see Adding and configuring a business rule. The new rule is then inserted above/below the selected rule.
Cut	Cuts the selected items. You can paste them into another position.
Copy	Copies the selected business rule. (Only available for one-field rules – rules with only one validated field, one trigger field and one field parameter.)
Paste	Pastes the copied business rule to the cursor's position.
Delete	Deletes the selected business rules.
Copy to fields	Pastes the selected business rule into the selected fields or table columns of the document type. For instructions, see Copying a business rule to specified fields. You can filter field names for a specified text, or you can select/deselect all fields using Copy to all fields.
Copy to all fields	Pastes the selected business rule into all fields or table columns of the document type.
Copy to business rule group	Opens the Choose business rule group dialog, where you can copy business rules to other business rule groups. All business rules below the selected node are copied to other (selectable) business rule groups.