Systems.Bpm.UserBusinessRuleConditions Entity

Represents one condition for the execution of a business rule. Entity: Sys_User_Business_Rule_Conditions

Default Visualization

Default Display Text Format:
{AttributeName}
Default Search Members:
AttributeName
Name Data Member:
AttributeName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Systems.Bpm.UserBusinessRules
Aggregate Root:
Systems.Bpm.UserBusinessRules

Attributes

Name	Type	Description
AttributeName	string (64)	The attribute, which will be tested. `Required`
ComparisonType	ComparisonType	How to compare the attribute and the value of the condition - e.g. Attribute-Comparison-Value. `Required` `Default("Equals")`
ConditionNo	int32	Unique consecutive number of the condition within the business rule. `Required`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Notes	string (max) nullable	Notes for this UserBusinessRuleCondition. `Introduced in version 20.1`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Value	string (254) nullable	The value against which the data attribute will be tested.

References

Name	Type	Description
UserBusinessRule	UserBusinessRules	The business rule, for which the condition is defined. `Required` `Filter(multi eq)` `Owner`

Attribute Details

AttributeName

The attribute, which will be tested. Required

Type: string (64)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

ComparisonType

How to compare the attribute and the value of the condition - e.g. Attribute-Comparison-Value. Required Default("Equals")

Type: ComparisonType
Category: System
Allowed values for the ComparisonType(Systems.Bpm.UserBusinessRuleConditions.md#comparisontype) data attribute
Allowed Values (Systems.Bpm.UserBusinessRuleConditionsRepository.ComparisonType Enum Members)

Value	Description
Equals	Equals. Stored as 'Equals'. Database Value: 'Equals' Model Value: 0 Domain API Value: 'Equals'
Greater_Than	Greater Than Or Equal. Stored as 'Greater_Than'. Database Value: 'Greater_Than' Model Value: 1 Domain API Value: 'Greater_Than'
Less_Than	Less Than Or Equal. Stored as 'Less_Than'. Database Value: 'Less_Than' Model Value: 2 Domain API Value: 'Less_Than'
Like	Compare by mask. Use * (asterisk) as wildcard char.. Stored as 'Like'. Database Value: 'Like' Model Value: 3 Domain API Value: 'Like'
IsNull	Field is null.. Stored as 'IsNull'. Database Value: 'IsNull' Model Value: 4 Domain API Value: 'IsNull'
Not_Equals	Not Equals. Stored as 'Not_Equals'. Database Value: 'Not_Equals' Model Value: 5 Domain API Value: 'Not_Equals'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Equals
Show in UI: ShownByDefault

ConditionNo

Unique consecutive number of the condition within the business rule. Required

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.UserBusinessRule.Conditions.Select( c => c.ConditionNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.UserBusinessRule.Conditions.Select( c => c.ConditionNo).DefaultIfEmpty( 0).Max( ) + 10)

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Notes

Notes for this UserBusinessRuleCondition. Introduced in version 20.1

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Value

The value against which the data attribute will be tested.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Reference Details

UserBusinessRule

The business rule, for which the condition is defined. Required Filter(multi eq) Owner

Type: UserBusinessRules
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST