Table of Contents

Systems.Core.EntityAttributeDefaultValues

Contains user-specified default values for fields in data entry forms.

General

Namespace: Systems.Core
Repository: Systems.Core.EntityAttributeDefaultValues
Base Table: Sys_Entity_Attribute_Default_Values
Introduced In Version: 27.1.1.68
API access: ReadWrite

Visualization

Display Format: {RepositoryName}.{AttributeName}: {DefaultTextValue}
Search Members: AttributeName
Name Member: AttributeName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 1 - Track last changes only
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

Attributes

Name Type Description
AttributeName string (128) The name of the attribute in the specified repository for which the default value is defined.Required Filter(eq;like)
ConditionEntityCategory string (254) nullable When not NULL, the default value is applied only when the entity category attribute of the specified repository has this internal value. Stores the category attribute value in invariant text format; reference values are stored as GUIDs. NULL means that no entity category condition is specified.Filter(eq)
ConditionLanguage string (15) nullable When not NULL, the default value is applied only for the specified current language. Stores the language code, for example en or bg. NULL means that no language condition is specified.Filter(eq)
DefaultInternalValue string (254) nullable The internal value to be assigned to the specified attribute by default. For a reference attribute, stores the ID of the selected record. NULL specifies a NULL default value.
DefaultTextValue string (254) nullable The text displayed for the default value of the specified attribute. For a reference attribute, contains the display text of the selected record.
RepositoryName string (128) The repository containing the attribute for which the default value is specified.Required Filter(eq;like)

References

Name Type Description
ConditionEnterpriseCompany EnterpriseCompanies (nullable) When not NULL, the default value is applied only for the specified enterprise company. NULL means that no enterprise company condition is specified.
ConditionEnterprise
CompanyLocation		 CompanyLocations (nullable) When not NULL, the default value is applied only for the specified enterprise company location. NULL means that no enterprise company location condition is specified.
ConditionRole Roles (nullable) If not NULL, the default value is applied only when the current user has the specified role.
ConditionUser Users (nullable) When not null, the default value is applied only for the specified user.

System Attributes

Name Type Description
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.
ExternalId string The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem string The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
AggregateLastUpdateTimeUtc datetime The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]
AdditionalDataJson string Extensible JSON object for storing this entity's custom or optional attributes. Each application or service must store its data in a separate top-level object identified by the owning application, service, or functional domain. Applications must preserve top-level objects owned by other applications or services. Maximum length: 32,000 characters. [Introduced in version 26.3.100.4]
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

AttributeName

The name of the attribute in the specified repository for which the default value is defined.Required Filter(eq;like)

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

ConditionEntityCategory

When not NULL, the default value is applied only when the entity category attribute of the specified repository has this internal value. Stores the category attribute value in invariant text format; reference values are stored as GUIDs. NULL means that no entity category condition is specified.Filter(eq)

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

ConditionLanguage

When not NULL, the default value is applied only for the specified current language. Stores the language code, for example en or bg. NULL means that no language condition is specified.Filter(eq)

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

DefaultInternalValue

The internal value to be assigned to the specified attribute by default. For a reference attribute, stores the ID of the selected record. NULL specifies a NULL default value.

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

DefaultTextValue

The text displayed for the default value of the specified attribute. For a reference attribute, contains the display text of the selected record.

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

RepositoryName

The repository containing the attribute for which the default value is specified.Required Filter(eq;like)

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

Id

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

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

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

AggregateLastUpdateTimeUtc

The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. [Filter(ge;le)] [ORD] [Introduced in version 19.1]

Type: datetime
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

AdditionalDataJson

Extensible JSON object for storing this entity's custom or optional attributes. Each application or service must store its data in a separate top-level object identified by the owning application, service, or functional domain. Applications must preserve top-level objects owned by other applications or services. Maximum length: 32,000 characters. [Introduced in version 26.3.100.4]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

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

Reference Details

ConditionEnterpriseCompany

When not NULL, the default value is applied only for the specified enterprise company. NULL means that no enterprise company condition is specified.

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

ConditionEnterpriseCompanyLocation

When not NULL, the default value is applied only for the specified enterprise company location. NULL means that no enterprise company location condition is specified.

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

ConditionRole

If not NULL, the default value is applied only when the current user has the specified role.

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

ConditionUser

When not null, the default value is applied only for the specified user.

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

API Methods

Methods that can be invoked in public APIs.

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

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

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

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

GetOrCreateExtensibleDataObject

Gets an existing extensible data object associated with the specified entity, or creates a new one if none exists. The newly created extensible data object is immediately commited to the database.
Return Type: ExtensibleDataObjects
Declaring Type: EntityObject
Domain API Request: GET

GetPropertyAllowedValues

Gets the allowed values for the specified property for this entity object.
Return Type: Collection Of ErpNet.Model.OData.ValueTextPair
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • propertyName
    The name of the attribute or reference
    Type: string

  • search
    The search text - searches by display text. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • 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

Business Rules

None

Front-End Business Rules

None

API

Domain API Entity Set: Systems_Core_EntityAttributeDefaultValues

Domain API Entity Type: Systems_Core_EntityAttributeDefaultValue

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

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

Suggest improvement to this page