Systems.Bpm.CalculatedAttributes Entity

Namespace: Systems.Bpm

User-defined read-only calculated attribute. Entity: Sys_Calculated_Attributes

Default Visualization

Default Display Text Format:
_{Caption:T} _
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 3 - Track object and attribute 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 Tree

• Systems.Bpm.CalculatedAttributes
  • Systems.Bpm.CalculatedAttributeExpressions

Attributes

Name	Type	Description
Caption	MultilanguageString (512)	The multi-language caption, used to display the attribute. Required
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Hint	MultilanguageString (max) nullable	The hint, which is displayed alongside the attribute. Filter(multi eq;like) Introduced in version 21.1.3.53
Id	guid
IsActive	boolean	True if the attribute is activated and added to the repository. Required Default(false) Filter(eq)
Name	string (128)	The unique name of the attribute within the repository. Required Filter(eq;like)
Notes	string (max) nullable	Notes for this CalculatedAttribute.
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.
RepositoryName	string (128)	The repository, for which the attribute is defined. Required Filter(multi eq) ORD
StartingExpressionNo	int32	The expression, from which the calculation starts. The result of the expression gives the value of the calculated attribute. Required Default(10)

Child Collections

Name	Type	Description
Expressions	CalculatedAttributeExpressions	List of CalculatedAttribute<br />Expression(Systems.Bpm.CalculatedAttribute Expressions.md) child objects, based on the Systems.Bpm.CalculatedAttribute<br />Expression.CalculatedAttribute(Systems.Bpm.CalculatedAttribute Expressions.md#calculatedattribute) back reference

Attribute Details

Caption

The multi-language caption, used to display the attribute. Required

Type: MultilanguageString (512)
Category: System
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

Hint

The hint, which is displayed alongside the attribute. Filter(multi eq;like) Introduced in version 21.1.3.53

Type: MultilanguageString (max) nullable
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Id

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

IsActive

True if the attribute is activated and added to the repository. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Name

The unique name of the attribute within the repository. Required Filter(eq;like)

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

Notes

Notes for this CalculatedAttribute.

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

RepositoryName

The repository, for which the attribute is defined. Required Filter(multi eq) ORD

Type: string (128)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: True
Maximum Length: 128
Show in UI: ShownByDefault

StartingExpressionNo

The expression, from which the calculation starts. The result of the expression gives the value of the calculated attribute. Required Default(10)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 10
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

• R26996 CalculatedAttribute - Can Compile

Front-End Business Rules

None

API

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

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