Table of Contents

Systems.Documents.DocumentTypes Entity

Namespace: Systems.Documents

List of user-defined document types. Each type has associated system entity (object class). Entity: Gen_Document_Types

Renames

Old name: General.DocumentTypes
New name: Systems.Documents.DocumentTypes
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{TypeName:T}
Default Search Members:
Code; TypeName
Code Data Member:
Code
Name Data Member:
TypeName
Category: Settings
Show in UI: ShownByDefault
API access: ReadWrite
Layout category attribute: EntityName

Track Changes

Min level: 4 - Track object attribute and blob 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 Tree

Attributes

Name Type Description
Code string (16) Unique descriptive code of the document type. Required Filter(eq;like) ORD
CreateFulfillments
OnCompletion		 boolean When document state is changed to Completed, creates completed document fulfillments for the parent document. Used only for logistic documents. Required Default(false) Introduced in version 23.1.2.9
CreateManully boolean False if documents with this document type only can be generated; true - the user can create documents with this type. Required Default(true) Filter(eq)
Description MultilanguageString (max) nullable The description of this DocumentType.
DisallowOpposite
ValuesGeneration		 boolean Disallow the generation of decreasing scalar values (values with opposite directions than the original values determined by the parent document) through this document type. Required Default(false)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityName string (64) System entity, which contains the documents. Required Filter(multi eq) ORD
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]
GenerateSingleDocument boolean Create maximum one document when documents from this type are generated by parent documents (usually from another document type). Required Default(false)
Id guid
Notes string (254) nullable Notes for this DocumentType.
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.
SchemaXML string (max) nullable Obsolete. Not used.
TrackAttributeChanges TrackAttributeChanges Enable/disable attributes change tracking for documents from this type. "Default" means that changes will be tracked for all documents, except transit and adjustment documents. Required Default("DEF") Filter(eq) Introduced in version 24.1.3.37
TrackPrintImages TrackPrintImages Enable/disable print images tracking for documents from this type. Required Default("SDC") Filter(eq) Introduced in version 24.1.3.95
TransitionalDocument boolean If checked determines that the documents from this type are automatically managed by the system and don't require management from the users. Required Default(false)
TypeName MultilanguageString (254) Description of the document type. Required Filter(like)

References

Name Type Description
AccessKey AccessKeys (nullable) The access key, containing the permissions for this DocumentType. An empty value means that all users have unlimited permissions. Filter(multi eq)
Sequence Sequences (nullable) The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq)

Child Collections

Name Type Description
Amounts DocumentTypeAmounts List of DocumentTypeAmount(Systems.Documents.DocumentTypeAmounts.md) child objects, based on the Systems.Documents.DocumentTypeAmount.DocumentType(Systems.Documents.DocumentTypeAmounts.md#documenttype) back reference
CostCorrectionsOptions CostCorrectionsOptions List of CostCorrectionsOption(Logistics.Inventory.CostCorrectionsOptions.md) child objects, based on the Logistics.Inventory.CostCorrectionsOption.DocumentType(Logistics.Inventory.CostCorrectionsOptions.md#documenttype) back reference
DefaultSalesOrder
DocumentProperties		 DefaultSalesOrderDocumentProperties List of DefaultSalesOrder<br />DocumentProperty(Crm.Sales.DefaultSalesOrder
DocumentProperties.md) child objects, based on the Crm.Sales.DefaultSalesOrder<br />DocumentProperty.DocumentType(Crm.Sales.DefaultSalesOrder
DocumentProperties.md#documenttype) back reference
DefaultSalesOrder
PaymentPlans		 DefaultSalesOrderPaymentPlans List of DefaultSalesOrder<br />PaymentPlan(Crm.Sales.DefaultSalesOrder
PaymentPlans.md) child objects, based on the Crm.Sales.DefaultSalesOrder<br />PaymentPlan.DocumentType(Crm.Sales.DefaultSalesOrder
PaymentPlans.md#documenttype) back reference
DocumentTypeProperties DocumentTypeProperties List of DocumentTypeProperty(Systems.Documents.DocumentTypeProperties.md) child objects, based on the Systems.Documents.DocumentTypeProperty.DocumentType(Systems.Documents.DocumentTypeProperties.md#documenttype) back reference
EnterpriseCompanies DocumentTypeEnterpriseCompanies List of DocumentTypeEnterprise<br />Company(Systems.Documents.DocumentTypeEnterprise
Companies.md) child objects, based on the Systems.Documents.DocumentTypeEnterprise<br />Company.DocumentType(Systems.Documents.DocumentTypeEnterprise
Companies.md#documenttype) back reference
InvoicesOptions InvoicesOptions List of InvoicesOption(Crm.Invoicing.InvoicesOptions.md) child objects, based on the Crm.Invoicing.InvoicesOption.DocumentType(Crm.Invoicing.InvoicesOptions.md#documenttype) back reference
Notifications DocumentTypeNotifications List of DocumentTypeNotification(Systems.Documents.DocumentTypeNotifications.md) child objects, based on the Systems.Documents.DocumentTypeNotification.DocumentType(Systems.Documents.DocumentTypeNotifications.md#documenttype) back reference
OffersOptions OffersOptions List of OffersOption(Crm.Presales.OffersOptions.md) child objects, based on the Crm.Presales.OffersOption.DocumentType(Crm.Presales.OffersOptions.md#documenttype) back reference
PaymentOptions DocumentTypePaymentOptions List of DocumentTypePayment<br />Option(Crm.Sales.DocumentTypePaymentOptions.md) child objects, based on the Crm.Sales.DocumentTypePaymentOption.DocumentType(Crm.Sales.DocumentTypePaymentOptions.md#documenttype) back reference
Printouts Printouts List of Printout(Systems.Documents.Printouts.md) child objects, based on the Systems.Documents.Printout.DocumentType(Systems.Documents.Printouts.md#documenttype) back reference
PurchaseInvoicesOptions PurchaseInvoicesOptions List of PurchaseInvoicesOption(Logistics.Procurement.PurchaseInvoicesOptions.md) child objects, based on the Logistics.Procurement.PurchaseInvoicesOption.DocumentType(Logistics.Procurement.PurchaseInvoicesOptions.md#documenttype) back reference
Routes Routes List of Route(Systems.Documents.Routes.md) child objects, based on the Systems.Documents.Route.DocumentType(Systems.Documents.Routes.md#documenttype) back reference
SalesOrdersOptions SalesOrdersOptions List of SalesOrdersOption(Crm.Sales.SalesOrdersOptions.md) child objects, based on the Crm.Sales.SalesOrdersOption.DocumentType(Crm.Sales.SalesOrdersOptions.md#documenttype) back reference
SecurityConditions DocumentTypeSecurityConditions List of DocumentTypeSecurity<br />Condition(Systems.Documents.DocumentTypeSecurity
Conditions.md) child objects, based on the Systems.Documents.DocumentTypeSecurity<br />Condition.DocumentType(Systems.Documents.DocumentTypeSecurity
Conditions.md#documenttype) back reference
TransferOrdersOptions TransferOrdersOptions List of TransferOrdersOption(Logistics.Inventory.TransferOrdersOptions.md) child objects, based on the Logistics.Inventory.TransferOrdersOption.DocumentType(Logistics.Inventory.TransferOrdersOptions.md#documenttype) back reference
UserStatuses DocumentTypeUserStatuses List of DocumentTypeUserStatus(Systems.Documents.DocumentTypeUserStatuses.md) child objects, based on the Systems.Documents.DocumentTypeUserStatus.DocumentType(Systems.Documents.DocumentTypeUserStatuses.md#documenttype) back reference
WorkOrderDocument
TypesOptions		 WorkOrderDocumentTypesOptions List of WorkOrderDocument<br />TypesOption(Production.ShopFloor.WorkOrderDocument
TypesOptions.md) child objects, based on the Production.ShopFloor.WorkOrderDocument<br />TypesOption.DocumentType(Production.ShopFloor.WorkOrderDocument
TypesOptions.md#documenttype) back reference

Attribute Details

Code

Unique descriptive code of the document type. Required Filter(eq;like) ORD

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

CreateFulfillmentsOnCompletion

When document state is changed to Completed, creates completed document fulfillments for the parent document. Used only for logistic documents. Required Default(false) Introduced in version 23.1.2.9

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

CreateManully

False if documents with this document type only can be generated; true - the user can create documents with this type. Required Default(true) Filter(eq)

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

Front-End Recalc Expressions:
IIF( obj.TransitionalDocument, False, obj.CreateManully)

Description

The description of this DocumentType.

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

DisallowOppositeValuesGeneration

Disallow the generation of decreasing scalar values (values with opposite directions than the original values determined by the parent document) through this document type. Required Default(false)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
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

EntityName

System entity, which contains the documents. Required Filter(multi eq) ORD

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

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

GenerateSingleDocument

Create maximum one document when documents from this type are generated by parent documents (usually from another document type). Required Default(false)

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

Id

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

Notes

Notes for this DocumentType.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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

SchemaXML

Obsolete. Not used.

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

TrackAttributeChanges

Enable/disable attributes change tracking for documents from this type. "Default" means that changes will be tracked for all documents, except transit and adjustment documents. Required Default("DEF") Filter(eq) Introduced in version 24.1.3.37

Type: TrackAttributeChanges
Category: System
Allowed values for the TrackAttributeChanges(Systems.Documents.DocumentTypes.md#trackattributechanges) data attribute
Allowed Values (Systems.Documents.DocumentTypesRepository.TrackAttributeChanges Enum Members)

Value Description
Default Default. Stored as 'DEF'.
Database Value: 'DEF'
Model Value: 0
Domain API Value: 'Default'
ForceEnable Force Enable. Stored as 'ENA'.
Database Value: 'ENA'
Model Value: 1
Domain API Value: 'ForceEnable'
ForceDisable Force Disable. Stored as 'DIS'.
Database Value: 'DIS'
Model Value: 2
Domain API Value: 'ForceDisable'

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

TrackPrintImages

Enable/disable print images tracking for documents from this type. Required Default("SDC") Filter(eq) Introduced in version 24.1.3.95

Type: TrackPrintImages
Category: System
Allowed values for the TrackPrintImages(Systems.Documents.DocumentTypes.md#trackprintimages) data attribute
Allowed Values (Systems.Documents.DocumentTypesRepository.TrackPrintImages Enum Members)

Value Description
DoNotTrack DoNotTrack value. Stored as 'DNT'.
Database Value: 'DNT'
Model Value: 0
Domain API Value: 'DoNotTrack'
SaveSourceDataCompressed SaveSourceDataCompressed value. Stored as 'SDC'.
Database Value: 'SDC'
Model Value: 1
Domain API Value: 'SaveSourceDataCompressed'

Supported Filters: Equals
Supports Order By: False
Default Value: SaveSourceDataCompressed
Show in UI: ShownByDefault

TransitionalDocument

If checked determines that the documents from this type are automatically managed by the system and don't require management from the users. Required Default(false)

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

Front-End Recalc Expressions:
IIF( obj.CreateManully, False, obj.TransitionalDocument)

TypeName

Description of the document type. Required Filter(like)

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

Reference Details

AccessKey

The access key, containing the permissions for this DocumentType. An empty value means that all users have unlimited permissions. Filter(multi eq)

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

Remarks
Supported permissions

Permission Type
Update -
Delete -
Administer (manage security) -
Release Documents Permission1
Complete Documents Permission2
Return to Released State Permission3
Release Documents On Different Date Permission4
Correct Documents Permission5
Void Documents Permission6
Set To Exit User State For Firm Planned Documents Permission7
Set To Exit User State For Released Documents Permission8

Sequence

The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq)

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

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

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

API

Domain API Entity Set: Systems_Documents_DocumentTypes

Domain API Entity Type: Systems_Documents_DocumentType

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

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

Suggest improvement to this page