Systems.Bpm.UserBusinessRuleEvents Entity

Represents event registration of a business rule. Entity: Sys_User_Business_Rule_Events

Default Visualization

Default Display Text Format:
{UserBusinessRule.Name:T}
Default Search Members:
UserBusinessRule.Name
Name Data Member:
UserBusinessRule.Name
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
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EventParameter	string (128) nullable	Registration parameter. The meaning is determined by the event. Usually - attribute name, document state, etc.
EventType	EventType	The event for which to register the business rule. `Required`
ExecutionPriority	RuleExecutionPriority	Execution priority. Lower values indicate earlier priorities. Possible values - 30-Early, 50-Normal, 70-Late. `Required` `Default(50)`
Id	guid
Layer	Layer	Specifies the layer on which to register the event. Allowed values = FTE-FrontEnd, BKE-BackEnd. `Required` `Default("BKE")`
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.

References

Name	Type	Description
UserBusinessRule	UserBusinessRules	The rule, which will be registered for the event. `Required` `Filter(multi eq)` `Owner`

Attribute Details

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

EventParameter

Registration parameter. The meaning is determined by the event. Usually - attribute name, document state, etc.

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

EventType

The event for which to register the business rule. Required

Type: EventType
Category: System
Allowed values for the EventType(Systems.Bpm.UserBusinessRuleEvents.md#eventtype) data attribute
Allowed Values (Systems.Bpm.UserBusinessRuleEventsRepository.EventType Enum Members)

Value	Description
AGGREGATECLIENTCOMMIT	Occurs for the aggregate root when saving a change of an aggregate object, but only when the change is made by a client application. If the change is made by the server, the event will not be triggered.. Stored as 'AGGREGATECLIENTCOMMIT'. Database Value: 'AGGREGATECLIENTCOMMIT' Model Value: 0 Domain API Value: 'AGGREGATECLIENTCOMMIT'
ATTRIBUTECHANGED	Occurs after the attribute's value is changed. The attribute's name is specified in the 'Event Parameter' field.. Stored as 'ATTRIBUTECHANGED'. Database Value: 'ATTRIBUTECHANGED' Model Value: 1 Domain API Value: 'ATTRIBUTECHANGED'
ATTRIBUTECHANGING	Occurs before the attribute's value is changed. The attribute's name is specified in the 'Event Parameter' field.. Stored as 'ATTRIBUTECHANGING'. Database Value: 'ATTRIBUTECHANGING' Model Value: 2 Domain API Value: 'ATTRIBUTECHANGING'
CLIENTCOMMIT	Occurs when saving a change of the object, when the change is made by a client application. If the change is made by the server, the event will not be triggered.. Stored as 'CLIENTCOMMIT'. Database Value: 'CLIENTCOMMIT' Model Value: 3 Domain API Value: 'CLIENTCOMMIT'
COMMIT	Occurs when saving a change of the object.. Stored as 'COMMIT'. Database Value: 'COMMIT' Model Value: 4 Domain API Value: 'COMMIT'
STATECHANGED	Occurs when the document state is changed. The state is specified in the 'Event Parameter' field. Possible parameter values are 'PLANNED', 'FIRMPLANNED', 'RELEASED', 'COMPLETED' and 'CLOSED'.. Stored as 'STATECHANGED'. Database Value: 'STATECHANGED' Model Value: 5 Domain API Value: 'STATECHANGED'
STATECHANGING	Occurs during the document state change. The state is specified in the 'Event Parameter' field. Possible parameter values are 'PLANNING', 'FIRMPLANNING', 'RELEASING', 'COMPLETING' and 'CLOSING'.. Stored as 'STATECHANGING'. Database Value: 'STATECHANGING' Model Value: 6 Domain API Value: 'STATECHANGING'
VOIDING	Occurs during the voiding of a document.. Stored as 'VOIDING'. Database Value: 'VOIDING' Model Value: 7 Domain API Value: 'VOIDING'
CREATENEW	Occurs when a new object is created. Used to fill custom defaults.. Stored as 'CREATENEW'. Database Value: 'CREATENEW' Model Value: 8 Domain API Value: 'CREATENEW'
COMMITTED	COMMITTED value. Stored as 'COMMITTED'. Database Value: 'COMMITTED' Model Value: 9 Domain API Value: 'COMMITTED'
CLIENTCOMMITTED	CLIENTCOMMITTED value. Stored as 'CLIENTCOMMITTED'. Database Value: 'CLIENTCOMMITTED' Model Value: 10 Domain API Value: 'CLIENTCOMMITTED'
AGGREGATECLIENTCOMMITTED	AGGREGATECLIENTCOMMITTED value. Stored as 'AGGREGATECLIENTCOMMITTED'. Database Value: 'AGGREGATECLIENTCOMMITTED' Model Value: 11 Domain API Value: 'AGGREGATECLIENTCOMMITTED'
BEFORERECALCULATE	The event occurs before every recalculation of the amounts in the document for each object in the document aggregate. . Stored as 'BEFORERECALCULATE '. Database Value: 'BEFORERECALCULATE ' Model Value: 12 Domain API Value: 'BEFORERECALCULATE'

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

ExecutionPriority

Execution priority. Lower values indicate earlier priorities. Possible values - 30-Early, 50-Normal, 70-Late. Required Default(50)

Type: RuleExecutionPriority
Category: System
Allowed Values (Aloe.SystemFrameworks.Domain.BusinessLogic.RuleExecutionPriority Enum Members)

Value	Description
Early	Database Value: 30 Model Value: 30 Domain API Value: 'Early'
Normal	Database Value: 50 Model Value: 50 Domain API Value: 'Normal'
Late	Database Value: 70 Model Value: 70 Domain API Value: 'Late'
SystemLateUpdate	Database Value: 150 Model Value: 150 Domain API Value: 'SystemLateUpdate'
SystemLateValidate	Database Value: 200 Model Value: 200 Domain API Value: 'SystemLateValidate'

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

Id

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

Layer

Specifies the layer on which to register the event. Allowed values = FTE-FrontEnd, BKE-BackEnd. Required Default("BKE")

Type: Layer
Category: System
Allowed values for the Layer(Systems.Bpm.UserBusinessRuleEvents.md#layer) data attribute
Allowed Values (Systems.Bpm.UserBusinessRuleEventsRepository.Layer Enum Members)

Value	Description
FrontEnd	FrontEnd value. Stored as 'FTE'. Database Value: 'FTE' Model Value: 0 Domain API Value: 'FrontEnd'
BackEnd	BackEnd value. Stored as 'BKE'. Database Value: 'BKE' Model Value: 1 Domain API Value: 'BackEnd'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: BackEnd
Show in UI: CannotBeShown

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

Reference Details

UserBusinessRule

The rule, which will be registered for the event. 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