Systems.Bpm.PropertyValues Entity

The actual values of the user-defined properties for each actual entity. Entity: Gen_Property_Values

Renames

Old name: General.PropertyValues
New name: Systems.Bpm.PropertyValues
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Id}: {EntityItemId}
Default Search Members:
__
Category: Definitions
Show in UI: CannotBeShown

Track Changes

Min level: 0 - Do not track changes
Max level: 0 - Do not track changes

Aggregate

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

Aggregate Tree

Systems.Bpm.PropertyValues

Attributes

Name	Type	Description
Description	MultilanguageString (254) nullable	The actual description value of the property for the specified entity (the entity with the specified Id).
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityItemId	guid	The Id of the actual entity for which the value is specified. `Required` `Filter(multi eq)`
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.
Picture	byte[] nullable	The actual picture of the property for the specified entity (the entity with the specified Id).
PropertyValueField	string (254) nullable	The actual value of the property for the specified entity (the entity with the specified Id). `Filter(eq)`
ValueId	guid nullable	The internal Id of the value of the property for the specified entity (the entity with the specified Id). For choosable properties, this contains the id of the original "allowed value" row, from which the value was derived. null for non-choosable (free-text) properties, but also for old property values (before this id was available) or other unknown values. `Filter(multi eq)`

References

Name	Type	Description
Property	CustomProperties	The property, whose value is stored here. `Required` `Filter(multi eq)`

Attribute Details

Description

The actual description value of the property for the specified entity (the entity with the specified Id).

Type: MultilanguageString (254) nullable
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

EntityItemId

The Id of the actual entity for which the value is specified. Required Filter(multi eq)

Type: guid
Category: System
Supported Filters: Equals, EqualsIn
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

Picture

The actual picture of the property for the specified entity (the entity with the specified Id).

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

PropertyValueField

The actual value of the property for the specified entity (the entity with the specified Id). Filter(eq)

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

ValueId

The internal Id of the value of the property for the specified entity (the entity with the specified Id). For choosable properties, this contains the id of the original "allowed value" row, from which the value was derived. null for non-choosable (free-text) properties, but also for old property values (before this id was available) or other unknown values. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Reference Details

Property

The property, whose value is stored here. Required Filter(multi eq)

Type: CustomProperties
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
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