Table of Contents

General.CustomProperties Entity

Namespace: General

User-defined properties, which can supplement the system properties of almost all entities in the system. Entity: Gen_Properties

Default Visualization

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
AllowedValuesEntityName string (64) nullable When not null, specifies that the allowed values are retrieved from the specified entity. Filter(eq)
AllowedValuesFilterXML dataaccessfilter nullable When not null specifies the filter to apply when extracting allowed values from entity.
Code string (40) Unique property code. Required Filter(multi eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityName string (64) The entity for which the property is applicable. Required Filter(eq) ORD
Hint MultilanguageString (max) nullable The hint, which is displayed alongside the property. Filter(multi eq;like) Introduced in version 20.1
Id guid
IsActive boolean Indicates whether this custom property is active. Required Default(true) Filter(eq) Introduced in version 24.1.3.19
KeyOrder byte nullable When not null, indicates, that the property is a key property and contains the property consequtive position withing the entity. Used for BI and other analysis.
LimitToAllowedValues boolean When true, allows the property to be set only to allowed value. When false, the property can have any value. Required Default(false) Filter(eq)
MaskLength int16 nullable Limits te length of the property value to the specified number of characters. Null means no limitation.
Name MultilanguageString (254) The name of this CustomProperty. Required Filter(like)
Notes string (max) nullable Notes for this CustomProperty. Introduced in version 20.1
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.
PropertyType PropertyType Type of property values. 'T' - text; 'P' - picture; 'N' - number; 'D' - date. Required Default("T")

References

Name Type Description
AllowedValuesParent
Property
CustomProperties (nullable) Specifies the user defined property, which is used for filtering the allowed values by value of the parent property. Filter(multi eq)
AllowedValuesProperty CustomProperties (nullable) When not null, specifies that the current property can have the same allowed values as the specified property. Also, this makes the current and the specified property copy-compatible. Filter(multi eq)
PropertiesCategory PropertiesCategories (nullable) When not null, categorizes the property under a category. Filter(multi eq)

Child Collections

Name Type Description
AllowedValues CustomPropertyAllowedValues List of CustomProperty<br />AllowedValue(General.CustomProperty
AllowedValues.md) child objects, based on the General.CustomPropertyAllowedValue.Property(General.CustomProperty
AllowedValues.md#property) back reference
EnterpriseCompanyFilters PropertyEnterpriseCompanyFilters List of PropertyEnterprise<br />CompanyFilter(General.PropertyEnterprise
CompanyFilters.md) child objects, based on the General.PropertyEnterprise<br />CompanyFilter.Property(General.PropertyEnterprise
CompanyFilters.md#property) back reference

Attribute Details

AllowedValuesEntityName

When not null, specifies that the allowed values are retrieved from the specified entity. Filter(eq)

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

AllowedValuesFilterXML

When not null specifies the filter to apply when extracting allowed values from entity.

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

Code

Unique property code. Required Filter(multi eq;like) ORD

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

Back-End Default Expression:
obj.IncMax( o => o.Code, null, "00000")

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

EntityName

The entity for which the property is applicable. Required Filter(eq) ORD

Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: True
Maximum Length: 64
Show in UI: HiddenByDefault

Hint

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

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

Indicates whether this custom property is active. Required Default(true) Filter(eq) Introduced in version 24.1.3.19

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

KeyOrder

When not null, indicates, that the property is a key property and contains the property consequtive position withing the entity. Used for BI and other analysis.

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

LimitToAllowedValues

When true, allows the property to be set only to allowed value. When false, the property can have any value. Required Default(false) Filter(eq)

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

MaskLength

Limits te length of the property value to the specified number of characters. Null means no limitation.

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

Name

The name of this CustomProperty. Required Filter(like)

Type: MultilanguageString (254)
Indexed: True
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this CustomProperty. Introduced in version 20.1

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

PropertyType

Type of property values. 'T' - text; 'P' - picture; 'N' - number; 'D' - date. Required Default("T")

Type: PropertyType
Category: System
Allowed values for the PropertyType(General.CustomProperties.md#propertytype) data attribute
Allowed Values (General.CustomPropertiesRepository.PropertyType Enum Members)

Value Description
Text Text value. Stored as 'T'.
Database Value: 'T'
Model Value: 0
Domain API Value: 'Text'
Number Number value. Stored as 'N'.
Database Value: 'N'
Model Value: 1
Domain API Value: 'Number'
Picture Picture value. Stored as 'P'.
Database Value: 'P'
Model Value: 2
Domain API Value: 'Picture'
Date Date value. Stored as 'D'.
Database Value: 'D'
Model Value: 3
Domain API Value: 'Date'

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

Reference Details

AllowedValuesParentProperty

Specifies the user defined property, which is used for filtering the allowed values by value of the parent property. Filter(multi eq)

Type: CustomProperties (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

AllowedValuesProperty

When not null, specifies that the current property can have the same allowed values as the specified property. Also, this makes the current and the specified property copy-compatible. Filter(multi eq)

Type: CustomProperties (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PropertiesCategory

When not null, categorizes the property under a category. Filter(multi eq)

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

Creates a notification and sends 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 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/General_CustomProperties?$top=10

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