General.DocumentTypeProperties Entity

Namespace: General

Default user-defined properties, which should be added to new documents. Entity: Gen_Document_Type_Properties

Default Visualization

Default Display Text Format:
{DocumentType.EntityName}
Default Search Members:
DocumentType.EntityName
Name Data Member:
DocumentType.EntityName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
General.DocumentTypes
Aggregate Root:
General.DocumentTypes

Attributes

Name	Type	Description
DefaultPropertyValue	string (254) nullable	The default value of the property when creating new documents.
DefaultProperty ValueDescription	MultilanguageString (254) nullable	Default description value of the property when creating new documents.
DefaultValueId	guid nullable	Internal Id of the default value of the property. `Filter(multi eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LineNo	int32	Line number, unique within the document type. `Required` `Filter(ge;le)` `ORD`
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.
Required	boolean	True if the property is required when creating documents of this type. `Required` `Default(false)` `Filter(eq)`
RequiredFromDate	datetime nullable	When not null, specifies a date, after which the property becomes required for the current document type. The date is compared against the document date. `Filter(ge;le)`
RequiredThruDate	datetime nullable	When not null, specifies a date, up to which the property is required for the current document type. The date is compared against the document date. `Filter(ge;le)`

References

Name	Type	Description
DocumentType	DocumentTypes	The document type, for which to add user-defined properties. `Required` `Filter(multi eq)` `Owner`
EnterpriseCompany	EnterpriseCompanies (nullable)	When not null, specifies that the current rule is valid only for the specified company. `Filter(multi eq)`
Property	CustomProperties	The user-defined property, which should be added. `Required` `Filter(multi eq)`

Attribute Details

DefaultPropertyValue

The default value of the property when creating new documents.

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

DefaultPropertyValueDescription

Default description value of the property when creating new documents.

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

DefaultValueId

Internal Id of the default value of the property. Filter(multi eq)

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

Id

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

LineNo

Line number, unique within the document type. Required Filter(ge;le) ORD

Type: int32
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.DocumentType.DocumentTypeProperties.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.DocumentType.DocumentTypeProperties.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

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

Required

True if the property is required when creating documents of this type. Required Default(false) Filter(eq)

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

RequiredFromDate

When not null, specifies a date, after which the property becomes required for the current document type. The date is compared against the document date. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

RequiredThruDate

When not null, specifies a date, up to which the property is required for the current document type. The date is compared against the document date. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

DocumentType

The document type, for which to add user-defined properties. Required Filter(multi eq) Owner

Type: DocumentTypes
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

EnterpriseCompany

When not null, specifies that the current rule is valid only for the specified company. Filter(multi eq)

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

Property

The user-defined property, which should be added. Required Filter(multi eq)

Type: CustomProperties
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