Table of Contents

Systems.Bpm.CalculatedAttributeExpressions Entity

Namespace: Systems.Bpm

Represent an expression within the calculation of a calculated attribute. Entity: Sys_Calculated_Attribute_Expressions

Default Visualization

Default Display Text Format:
{CalculatedAttribute.Name}
Default Search Members:
CalculatedAttribute.Name
Name Data Member:
CalculatedAttribute.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.CalculatedAttributes
Aggregate Root:
Systems.Bpm.CalculatedAttributes

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpressionNo int32 Unique number of the expression within the attribute. Expression No 0 is the default expression, which provides the result value of the attribute. Required
Id guid
Notes string (max) nullable Notes for this CalculatedAttribute
Expression.
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.
Operator ExpressionOperator The exprssion operator. Available operators are limited to a pre-selected list of operators. Required
Parameter1Type ExpressionParameterType nullable The type of the parameter specifies how to obtain the parameter value.
Parameter1Value string (256) nullable The actual value of parameter 1.
Parameter2Type ExpressionParameterType nullable The type of the parameter specifies how to obtain the parameter value.
Parameter2Value string (256) nullable The actual value of the parameter.
Parameter3Type ExpressionParameterType 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
CalculatedAttribute CalculatedAttributes The to which this CalculatedAttribute
Expression belongs. 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

ExpressionNo

Unique number of the expression within the attribute. Expression No 0 is the default expression, which provides the result value of the attribute. Required

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

Back-End Default Expression:
( obj.CalculatedAttribute.Expressions.Select( c => c.ExpressionNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.CalculatedAttribute.Expressions.Select( c => c.ExpressionNo).DefaultIfEmpty( 0).Max( ) + 10)

Id

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

Notes

Notes for this CalculatedAttributeExpression.

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

Operator

The exprssion operator. Available operators are limited to a pre-selected list of operators. Required

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

Value Description
ADD ADD(Number1, Number2) => Numer1 + Number2.. Stored as 'ADD'.
Database Value: 'ADD'
Model Value: 0
Domain API Value: 'ADD'
ADDDAYS ADDDAYS(Date, NumDays) => Adds the specified number of days to the date.. Stored as 'ADDDAYS'.
Database Value: 'ADDDAYS'
Model Value: 1
Domain API Value: 'ADDDAYS'
AND AND(Condition1, Condition2) => Condition1 AND Condition2.. Stored as 'AND'.
Database Value: 'AND'
Model Value: 2
Domain API Value: 'AND'
CAST CAST(Param, Type) => Casts the parameter to the specified type.. Stored as 'CAST'.
Database Value: 'CAST'
Model Value: 3
Domain API Value: 'CAST'
CEILING CEILING(Number) => Rounds the number up to the next integer.. Stored as 'CEILING'.
Database Value: 'CEILING'
Model Value: 4
Domain API Value: 'CEILING'
CONCAT CONCAT(String1, String2) => Concatenates the strings.. Stored as 'CONCAT'.
Database Value: 'CONCAT'
Model Value: 5
Domain API Value: 'CONCAT'
CONVERT CONVERT(Value, NewType) -> Converts a value in the specified new type.. Stored as 'CONVERT'.
Database Value: 'CONVERT'
Model Value: 6
Domain API Value: 'CONVERT'
COUNT COUNT(List) -> Gets the number of elements contained in the list. Stored as 'COUNT'.
Database Value: 'COUNT'
Model Value: 7
Domain API Value: 'COUNT'
DIVIDE DIVIDE(Number1, Number2) => Numer1 / Number2.. Stored as 'DIVIDE'.
Database Value: 'DIVIDE'
Model Value: 8
Domain API Value: 'DIVIDE'
IN IN(Input, List) => Returns whether the value of Input is among the specified in the list.. Stored as 'IN'.
Database Value: 'IN'
Model Value: 9
Domain API Value: 'IN'
IIF IIF(Condition, ResultTrue, ResultFalse) => Depending on Condition, returns the second or third argument.. Stored as 'IIF'.
Database Value: 'IIF'
Model Value: 10
Domain API Value: 'IIF'
INCNUM The INCNUM operator increases the value of its parameter by 1. The operator can be used only for String values whоose last character is a number.. Stored as 'INCNUM'.
Database Value: 'INCNUM'
Model Value: 11
Domain API Value: 'INCNUM'
EQUAL EQUAL(Value1, Value2) => Value1 = Value2.. Stored as 'EQUAL'.
Database Value: 'EQUAL'
Model Value: 12
Domain API Value: 'EQUAL'
FILTER FILTER(List, Condition) => Filters the list by the condition.. Stored as 'FILTER'.
Database Value: 'FILTER'
Model Value: 13
Domain API Value: 'FILTER'
FIRST FIRST(List) => Returns the first element in the list.. Stored as 'FIRST'.
Database Value: 'FIRST'
Model Value: 14
Domain API Value: 'FIRST'
FLOOR FLOOR(Number) => Rounds down to integer.. Stored as 'FLOOR'.
Database Value: 'FLOOR'
Model Value: 15
Domain API Value: 'FLOOR'
FORMATSTRING FORMATSTRING(Object, Format) => Returns String, formatted by the rules in Format.. Stored as 'FORMATSTRING'.
Database Value: 'FORMATSTRING'
Model Value: 16
Domain API Value: 'FORMATSTRING'
GETVALUE GETVALUE(Value) => Get the value from the current object.. Stored as 'GETVALUE'.
Database Value: 'GETVALUE'
Model Value: 17
Domain API Value: 'GETVALUE'
GETOBJVALUE GETOBJVALUE(Obj, Value) => obj.Value. Gets the specified value from the object.. Stored as 'GETOBJVALUE'.
Database Value: 'GETOBJVALUE'
Model Value: 18
Domain API Value: 'GETOBJVALUE'
GT GT(Value1, Value2) => Value1 > Value2.. Stored as 'GT'.
Database Value: 'GT'
Model Value: 19
Domain API Value: 'GT'
GTE GTE(Value1, Value2) => Value1 >= Value2.. Stored as 'GTE'.
Database Value: 'GTE'
Model Value: 20
Domain API Value: 'GTE'
LIKE LIKE(String, Mask) => String LIKE Mask (%-match any string. _-match 1 char).. Stored as 'LIKE'.
Database Value: 'LIKE'
Model Value: 21
Domain API Value: 'LIKE'
LIST LIST(List, Attribute, Separator) => Returns list with the string values of the specified attribute of the list of objects. The values are separated by the specified separator. Stored as 'LIST'.
Database Value: 'LIST'
Model Value: 22
Domain API Value: 'LIST'
LEFT LEFT(String, NumChars) => Gets the first characters of a string.. Stored as 'LEFT'.
Database Value: 'LEFT'
Model Value: 23
Domain API Value: 'LEFT'
LEN LEN(String) => Returns the length of the string.. Stored as 'LEN'.
Database Value: 'LEN'
Model Value: 24
Domain API Value: 'LEN'
LT LT(Value1, Value2) => Value1 < Value2.. Stored as 'LT'.
Database Value: 'LT'
Model Value: 25
Domain API Value: 'LT'
LTE LTE(Value1, Value2) => Value1 <= Value2.. Stored as 'LTE'.
Database Value: 'LTE'
Model Value: 26
Domain API Value: 'LTE'
MULTIPLY MULTIPLY(Number1, Number2) => Numer1 * Number2.. Stored as 'MULTIPLY'.
Database Value: 'MULTIPLY'
Model Value: 27
Domain API Value: 'MULTIPLY'
NOT NOT(Condition) => NOT Condition.. Stored as 'NOT'.
Database Value: 'NOT'
Model Value: 28
Domain API Value: 'NOT'
OR OR(Condition1, Condition2) => Condition1 OR Condition2.. Stored as 'OR'.
Database Value: 'OR'
Model Value: 29
Domain API Value: 'OR'
ORDERBY ORDERBY(Attribute, Order, Next_clause) => Clause, specifying a sort order according to Attribute and the specified order (ASC DESC).. Stored as 'ORDERBY'.
Database Value: 'ORDERBY'
Model Value: 30
Domain API Value: 'ORDERBY'
POS POS(Term, String) => Searches term in String, returns first position or -1 if not found.. Stored as 'POS'.
Database Value: 'POS'
Model Value: 31
Domain API Value: 'POS'
REGEX REGEX(String, Mask) => Returns whether the string matches the regex mask.. Stored as 'REGEX'.
Database Value: 'REGEX'
Model Value: 32
Domain API Value: 'REGEX'
REPLACE REPLACE(String, OldValue, NewValue) => Replaces old with new value in string.. Stored as 'REPLACE'.
Database Value: 'REPLACE'
Model Value: 33
Domain API Value: 'REPLACE'
RIGHT RIGHT(String, NumChars) => Gets the last characters of a string.. Stored as 'RIGHT'.
Database Value: 'RIGHT'
Model Value: 34
Domain API Value: 'RIGHT'
ROUND ROUND(Number, DecimalPlaces) => Rounds mathematically with the specified precision.. Stored as 'ROUND'.
Database Value: 'ROUND'
Model Value: 35
Domain API Value: 'ROUND'
SELECT SELECT(Repository, Clauses) => Gets the objects, matching the clauses.. Stored as 'SELECT'.
Database Value: 'SELECT'
Model Value: 36
Domain API Value: 'SELECT'
SORT SORT(List, Attribute, Order) => Sorts the list according to the attribute and the specified order (ASC DESC).. Stored as 'SORT'.
Database Value: 'SORT'
Model Value: 37
Domain API Value: 'SORT'
SUBSTRING SUBSTRING(String, Start, Len) => Returns a sub-string with the specified start and length.. Stored as 'SUBSTRING'.
Database Value: 'SUBSTRING'
Model Value: 38
Domain API Value: 'SUBSTRING'
SUM SUM(List, Value) => Returns the sum of Value for all elements in the list.. Stored as 'SUM'.
Database Value: 'SUM'
Model Value: 39
Domain API Value: 'SUM'
TODAY TODAY() => Returns the current date.. Stored as 'TODAY'.
Database Value: 'TODAY'
Model Value: 40
Domain API Value: 'TODAY'
TOLOWER TOLOWER(String) => Returns the string, converted to lower-case.. Stored as 'TOLOWER'.
Database Value: 'TOLOWER'
Model Value: 41
Domain API Value: 'TOLOWER'
TOP TOP(Number, Clauses) => Clause, returning only the first elements.. Stored as 'TOP'.
Database Value: 'TOP'
Model Value: 42
Domain API Value: 'TOP'
TOUPPER TOUPPER(String) => Returns the string, converted to upper-case.. Stored as 'TOUPPER'.
Database Value: 'TOUPPER'
Model Value: 43
Domain API Value: 'TOUPPER'
WHERE WHERE(Condition1, Condition2) => Clause, which filters by Condition1 AND Condition2.. Stored as 'WHERE'.
Database Value: 'WHERE'
Model Value: 44
Domain API Value: 'WHERE'
INTERPOLATE INTERPOLATE(Object?, InterpolatedString) => Performs string interpolation, according to the context of the passed object.. Stored as 'INTERPOLATE'.
Database Value: 'INTERPOLATE'
Model Value: 45
Domain API Value: 'INTERPOLATE'
DATEDIFF DATEDIFF(DateTime, DateTime, Interval?) => Returns the difference between dates as the date difference for the specified interval type.. Stored as 'DATEDIFF'.
Database Value: 'DATEDIFF'
Model Value: 46
Domain API Value: 'DATEDIFF'
DATESPAN DATESPAN(DateTime, DateTime, Interval?) => Returns the difference between dates as a duration in the specified interval type. The interval is fulfilled when the same date and time is reached in the next interval.. Stored as 'DATESPAN'.
Database Value: 'DATESPAN'
Model Value: 47
Domain API Value: 'DATESPAN'
IFERROR IFERROR(Value, ValueIfError) => Evaluates an expression and returns the value specified in the second parameter, if the expression returns an error. Otherwise returns the value of the expression itself.. Stored as 'IFERROR'.
Database Value: 'IFERROR'
Model Value: 48
Domain API Value: 'IFERROR'

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

Parameter1Type

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

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

Value Description
Constant Constant. Format: Date(yyyy-MM-dd), Decimal(9.9), Int(9), String('...'), True/False.. Stored as 'CONST'.
Database Value: 'CONST'
Model Value: 0
Domain API Value: 'Constant'
Attribute The value of system or user-defined attribute.. Stored as 'ATTRIB'.
Database Value: 'ATTRIB'
Model Value: 1
Domain API Value: 'Attribute'
Reference Reference to another object.. Stored as 'REF'.
Database Value: 'REF'
Model Value: 2
Domain API Value: 'Reference'
ChildList Child lists return detail objects, related to the current master object.. Stored as 'CHILD'.
Database Value: 'CHILD'
Model Value: 3
Domain API Value: 'ChildList'
Expression The value of the expression with the specified number.. Stored as 'EXP'.
Database Value: 'EXP'
Model Value: 4
Domain API Value: 'Expression'
Input The input parameter for the specified expression number.. Stored as 'INPUT'.
Database Value: 'INPUT'
Model Value: 5
Domain API Value: 'Input'
Repository A repository.. Stored as 'REPO'.
Database Value: 'REPO'
Model Value: 6
Domain API Value: 'Repository'
System A system value.. Stored as 'SYS'.
Database Value: 'SYS'
Model Value: 7
Domain API Value: 'System'

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

Parameter1Value

The actual value of parameter 1.

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: ExpressionParameterType nullable
Category: System
Generic enum type for ExpressionParameterType properties
Allowed Values (Systems.Bpm.ExpressionParameterType Enum Members)

Value Description
Constant Constant. Format: Date(yyyy-MM-dd), Decimal(9.9), Int(9), String('...'), True/False.. Stored as 'CONST'.
Database Value: 'CONST'
Model Value: 0
Domain API Value: 'Constant'
Attribute The value of system or user-defined attribute.. Stored as 'ATTRIB'.
Database Value: 'ATTRIB'
Model Value: 1
Domain API Value: 'Attribute'
Reference Reference to another object.. Stored as 'REF'.
Database Value: 'REF'
Model Value: 2
Domain API Value: 'Reference'
ChildList Child lists return detail objects, related to the current master object.. Stored as 'CHILD'.
Database Value: 'CHILD'
Model Value: 3
Domain API Value: 'ChildList'
Expression The value of the expression with the specified number.. Stored as 'EXP'.
Database Value: 'EXP'
Model Value: 4
Domain API Value: 'Expression'
Input The input parameter for the specified expression number.. Stored as 'INPUT'.
Database Value: 'INPUT'
Model Value: 5
Domain API Value: 'Input'
Repository A repository.. Stored as 'REPO'.
Database Value: 'REPO'
Model Value: 6
Domain API Value: 'Repository'
System A system value.. Stored as 'SYS'.
Database Value: 'SYS'
Model Value: 7
Domain API Value: 'System'

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: ExpressionParameterType nullable
Category: System
Generic enum type for ExpressionParameterType properties
Allowed Values (Systems.Bpm.ExpressionParameterType Enum Members)

Value Description
Constant Constant. Format: Date(yyyy-MM-dd), Decimal(9.9), Int(9), String('...'), True/False.. Stored as 'CONST'.
Database Value: 'CONST'
Model Value: 0
Domain API Value: 'Constant'
Attribute The value of system or user-defined attribute.. Stored as 'ATTRIB'.
Database Value: 'ATTRIB'
Model Value: 1
Domain API Value: 'Attribute'
Reference Reference to another object.. Stored as 'REF'.
Database Value: 'REF'
Model Value: 2
Domain API Value: 'Reference'
ChildList Child lists return detail objects, related to the current master object.. Stored as 'CHILD'.
Database Value: 'CHILD'
Model Value: 3
Domain API Value: 'ChildList'
Expression The value of the expression with the specified number.. Stored as 'EXP'.
Database Value: 'EXP'
Model Value: 4
Domain API Value: 'Expression'
Input The input parameter for the specified expression number.. Stored as 'INPUT'.
Database Value: 'INPUT'
Model Value: 5
Domain API Value: 'Input'
Repository A repository.. Stored as 'REPO'.
Database Value: 'REPO'
Model Value: 6
Domain API Value: 'Repository'
System A system value.. Stored as 'SYS'.
Database Value: 'SYS'
Model Value: 7
Domain API Value: 'System'

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

CalculatedAttribute

The to which this CalculatedAttributeExpression belongs. Required Filter(multi eq) Owner

Type: CalculatedAttributes
Indexed: True
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

Front-End Business Rules

None

API

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

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

Suggest improvement to this page