Systems.Bpm.UserBusinessRuleActions Entity

Represents an action within a business rule. Entity: Sys_User_Business_Rule_Actions

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
ActionNo	int32	Consecutive number of the action, unique within the business rule. `Required`
ActionType	ActionType	Specifies the type of action to perform. `Required`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
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.
Parameter1Type	ActionParameterType nullable	The type of the parameter specifies how to obtain the parameter value.
Parameter1Value	string (256) nullable	The actual value of the parameter.
Parameter2Type	ActionParameterType nullable	The type of the parameter specifies how to obtain the parameter value.
Parameter2Value	string (256) nullable	The actual value of the parameter.
Parameter3Type	ActionParameterType nullable	The type of the parameter specifies how to obtain the parameter value.
Parameter3Value	string (256) nullable	The actual value of the parameter.

References

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

Attribute Details

ActionNo

Consecutive number of the action, unique 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.Actions.Select( c => c.ActionNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.UserBusinessRule.Actions.Select( c => c.ActionNo).DefaultIfEmpty( 0).Max( ) + 1)

ActionType

Specifies the type of action to perform. Required

Type: ActionType
Category: System
Allowed values for the ActionType(Systems.Bpm.UserBusinessRuleActions.md#actiontype) data attribute
Allowed Values (Systems.Bpm.UserBusinessRuleActionsRepository.ActionType Enum Members)

Value	Description
SETVALUE	SETVALUE value. Stored as 'SETVALUE'. Database Value: 'SETVALUE' Model Value: 0 Domain API Value: 'SETVALUE'
FAIL	FAIL value. Stored as 'FAIL'. Database Value: 'FAIL' Model Value: 1 Domain API Value: 'FAIL'
SENDMAIL	SENDMAIL value. Stored as 'SENDMAIL'. Database Value: 'SENDMAIL' Model Value: 2 Domain API Value: 'SENDMAIL'
WARNING	WARNING value. Stored as 'WARNING'. Database Value: 'WARNING' Model Value: 3 Domain API Value: 'WARNING'
NOTIFYUSER	NOTIFYUSER value. Stored as 'NOTIFYUSER'. Database Value: 'NOTIFYUSER' Model Value: 4 Domain API Value: 'NOTIFYUSER'
WEBHOOK	WEBHOOK value. Stored as 'WEBHOOK'. Database Value: 'WEBHOOK' Model Value: 5 Domain API Value: 'WEBHOOK'
AISET	AISET value. Stored as 'AISET'. Database Value: 'AISET' Model Value: 6 Domain API Value: 'AISET'
AIVALIDATE	AIVALIDATE value. Stored as 'AIVALIDATE'. Database Value: 'AIVALIDATE' Model Value: 7 Domain API Value: 'AIVALIDATE'
AIWARNING	AIWARNING value. Stored as 'AIWARNING'. Database Value: 'AIWARNING' Model Value: 8 Domain API Value: 'AIWARNING'

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

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

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

Parameter1Type

The type of the parameter specifies how to obtain the parameter value.

Type: ActionParameterType nullable
Category: System
Generic enum type for ActionParameterType properties
Allowed Values (Systems.Bpm.ActionParameterType Enum Members)

Value	Description
Constant	Constant value. Stored as 'CONST'. Database Value: 'CONST' Model Value: 0 Domain API Value: 'Constant'
Attribute	Attribute value. Stored as 'ATTRIB'. Database Value: 'ATTRIB' Model Value: 1 Domain API Value: 'Attribute'
Reference	Reference value. Stored as 'REF'. Database Value: 'REF' Model Value: 2 Domain API Value: 'Reference'
ChildList	ChildList value. Stored as 'CHILD'. Database Value: 'CHILD' Model Value: 3 Domain API Value: 'ChildList'
FormattedString	FormattedString value. Stored as 'FMTSTR'. Database Value: 'FMTSTR' Model Value: 4 Domain API Value: 'FormattedString'
Interpolate	Interpolate value. Stored as 'INTERPOLATE'. Database Value: 'INTERPOLATE' Model Value: 5 Domain API Value: 'Interpolate'

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

Parameter1Value

The actual value of the parameter.

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

Parameter2Type

The type of the parameter specifies how to obtain the parameter value.

Type: ActionParameterType nullable
Category: System
Generic enum type for ActionParameterType properties
Allowed Values (Systems.Bpm.ActionParameterType Enum Members)

Value	Description
Constant	Constant value. Stored as 'CONST'. Database Value: 'CONST' Model Value: 0 Domain API Value: 'Constant'
Attribute	Attribute value. Stored as 'ATTRIB'. Database Value: 'ATTRIB' Model Value: 1 Domain API Value: 'Attribute'
Reference	Reference value. Stored as 'REF'. Database Value: 'REF' Model Value: 2 Domain API Value: 'Reference'
ChildList	ChildList value. Stored as 'CHILD'. Database Value: 'CHILD' Model Value: 3 Domain API Value: 'ChildList'
FormattedString	FormattedString value. Stored as 'FMTSTR'. Database Value: 'FMTSTR' Model Value: 4 Domain API Value: 'FormattedString'
Interpolate	Interpolate value. Stored as 'INTERPOLATE'. Database Value: 'INTERPOLATE' Model Value: 5 Domain API Value: 'Interpolate'

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

Parameter2Value

The actual value of the parameter.

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

Parameter3Type

The type of the parameter specifies how to obtain the parameter value.

Type: ActionParameterType nullable
Category: System
Generic enum type for ActionParameterType properties
Allowed Values (Systems.Bpm.ActionParameterType Enum Members)

Value	Description
Constant	Constant value. Stored as 'CONST'. Database Value: 'CONST' Model Value: 0 Domain API Value: 'Constant'
Attribute	Attribute value. Stored as 'ATTRIB'. Database Value: 'ATTRIB' Model Value: 1 Domain API Value: 'Attribute'
Reference	Reference value. Stored as 'REF'. Database Value: 'REF' Model Value: 2 Domain API Value: 'Reference'
ChildList	ChildList value. Stored as 'CHILD'. Database Value: 'CHILD' Model Value: 3 Domain API Value: 'ChildList'
FormattedString	FormattedString value. Stored as 'FMTSTR'. Database Value: 'FMTSTR' Model Value: 4 Domain API Value: 'FormattedString'
Interpolate	Interpolate value. Stored as 'INTERPOLATE'. Database Value: 'INTERPOLATE' Model Value: 5 Domain API Value: 'Interpolate'

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

Parameter3Value

The actual value of the parameter.

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

Reference Details

UserBusinessRule

The business rule, for which the action 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

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Bpm_UserBusinessRuleActions?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Bpm_UserBusinessRuleActions?$top=10

Table of Contents

Systems.Bpm.UserBusinessRuleActions Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

ActionNo

ActionType

DisplayText

Id

ObjectVersion

Parameter1Type

Parameter1Value

Parameter2Type

Parameter2Value

Parameter3Type

Parameter3Value

Reference Details

UserBusinessRule

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API