Show TOC

Background documentationField Help for Rule Conditions and Actions Locate this document in the navigation structure

 

Field Name

Field Value

Description

Logic

Lists conditions or actions that are part of the business rules

if

Condition. Must be followed by then, and, or or row. Each if block must end with endif row.

and

Condition

or

Condition

then

endif

set

Predefined action. Assigns value of selected attribute in Attribute column.

clearField

Predefined action. Clears value in Attribute column.

changeOwner

Predefined action. Changes collaborative owner for business document.

addUserCollaborator

Predefined action. Adds user as collaborator with specified collaborator role.

addGroupCollaborator

Predefined action. Adds group as collaborator with specified collaborator role.

addCompanyCollaborator

Predefined action. Adds company as collaborator with specified collaborator role.

changePhase

Predefined action. Changes business document to next sequential phase.

generateError

Predefined action. Throws application exception with error message on the attribute selected in Attribute column.

(custom actions)

The business rule designer loads any available custom action names (by application) at run time to values in Logic column.

Attribute

Attribute values are dependent on the specified Logic.

If the value for Logic is a condition, the attribute values listed here are direct attributes of the business object for which the rule is defined. If the value for Logic is an action, the attribute can be the parameter value for the action. If there is no parameter for this action, the value is empty. The parameter can be in the same row as the specific logic for a predefined action. For custom actions, each parameter of the custom action occupies a separate row from the row for the selected logic.

Operator

Operator values are dependent on the specified Logic and Attribute.

If the value for Logic is an action, operator is empty. If the value for Logic is a condition, the operator values listed here depend on the data type of the value in Attribute.

contains

equals

not equals

is empty

has value

Value

This is the value for the specified Attribute. If the value of Logic is a condition or has the set action, then the value here is based on the data type of the Attribute value. If the value of Logic is a clearField action, the value here is empty. If the value of Operator is is empty or has value, this Value column is empty.

Required Fields Based on Logic

Logic Value

Required Fields

if

  • Attribute

  • Operator

  • Value

Note Note

Value is not required for operator is empty and has value.

End of the note.

and

  • Attribute

  • Operator

  • Value

Note Note

Value is not required for operator is empty and has value.

End of the note.

or

  • Attribute

  • Operator

  • Value

Note Note

Value is not required for operator is empty and has value.

End of the note.

change phase

Value

set

  • Attribute

  • Value

set owner

Value

clear field

Attribute

generateError

  • Attribute

  • Value

Logic Validation

Rule parameters that are entered through the rule definition must be validated before the script is generated. The following validation is performed:

  • Check for missing information

  • Every if statement has an endif

  • Deletion of row with additional rows for parameters

  • Order of logic as outlined in following table

Logic

Valid Next Logic

Valid Previous Logic

if

  • and

  • or

  • then

and

  • and

  • or

  • then

  • if

  • or

  • and

or

  • and

  • or

  • then

  • if

  • or

  • and

then

  • if

  • or

  • and

addUserCollaborator

User and role parameter rows inserted by UI

addGroupCollaborator

Group and role parameter rows inserted by UI

addCompanyCollaborator

Company and role parameter rows inserted by UI

addOrgUnitCollaborator

Organization unit and role parameter rows inserted by UI

Custom Action

All required parameters have to follow the Custom Action.