Systems.Documents.Routes Entity

Namespace: Systems.Documents

Contains document routes, which specify which document generation procedures will be run upon document events. Entity: Wf_Routes

Renames

Old name: Systems.Workflow.Routes
New name: Systems.Documents.Routes
Version: 24.1.101.1
Case: 36967

Default Visualization

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

Track Changes

Min level: 0 - Do not track 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 Parent:
Systems.Documents.DocumentTypes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
ActivationDate	date	The date from which (including) the route is active. The date is matched against the document date of the generating document. Required Default(Today) Filter(ge;le)
Active	boolean	True if the route is active, otherwise 0. Required Default(true) Filter(eq)
AllowedGenerationTypes	AllowedGenerationTypes	Determines the possible types of the generation of the destination document: A=Auto, M=Manual, B=Both (Auto and Manual). Required Default("B") Filter(multi eq)
AllowObsoleteGeneration	boolean	Allows the usage of unsupported generation procedures (marked as obsolete). This is a user override of the system prohibition of the usage of obsolete procedures. Required Default(false)
ConditionFilterXML	dataaccessfilter nullable	Contains filter condition, which the document must match in order to execute the route.
ConditionStatesBitMask	DocumentStateFlags	The system states for which to execute the specified route. Required Default(0) Filter(like)
ConnectedPartyCondition	ConnectedPartyCondition	A - any party; C - connected party: to_party is enterprise company; U - unconnected party - not enterprise company;. Required Default("A")
DeactivationDate	date nullable	The date until (including) the route is active. The date is matched against the document date of the generating document. Null means the route does not have a deactivation date. Filter(ge;le)
DestinationState	DocumentState	0=New;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
NegativeConditionFilterXml	dataaccessfilter nullable	The negative condition should NOT be matched by the document in order to execute the route.
Notes	string (254) nullable	Notes for this Route.
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.
ParentDocument RelationshipType	ParentDocument RelationshipType	Determines the default relationship type between the generated document and the parent document. Required Default("S")
ProcedureName	string (254)	The system name of the generation procedure, which must be executed by the route. Required
ProcessEvent	string (254)	Event which triggers the route. Usually the event is change of state. Every document entity may define own custom events. Required Filter(eq)
ReadOnly	boolean	Indicates wheather the destination document shoul be read only. true - the destination document is read only. Required Default(false)
SchemaXML	string (max) nullable	OBSOLETE! Do not use! Not used. Obsolete Obsoleted in version 22.1.6.61

References

Name	Type	Description
ConditionEnterpriseCompany	EnterpriseCompanies (nullable)	The enterprise company for which this route is activated. Filter(multi eq)
ConditionUserStatus	DocumentTypeUserStatuses (nullable)	The user-defined status, for which the document route is activated. Filter(multi eq)
DestinationDocumentType	DocumentTypes (nullable)	The type of the document, that will be generated by executing the route. Filter(multi eq)
DestinationEnterprise Company	EnterpriseCompanies (nullable)	The enterprise company in which to generate the target document. Filter(multi eq)
DestinationEnterprise CompanyLocation	CompanyLocations (nullable)	The enterprise company location in which to generate the target document. Filter(multi eq)
DestinationUserStatus	DocumentTypeUserStatuses (nullable)	The user defined status to set to the generated document. Filter(multi eq)
DocumentType	DocumentTypes	The document type from which this route originates. Documents from this type generate sub-documents using this route. Required Filter(multi eq) Owner

Child Collections

Name	Type	Description
PaymentSlipPayment TransactionsTemplates	PaymentSlipPaymentTransactionsTemplates	List of PaymentSlipPayment<br />TransactionsTemplate(Finance.Payments.PaymentSlipPayment TransactionsTemplates.md) child objects, based on the Finance.Payments.PaymentSlipPayment<br />TransactionsTemplate.Route(Finance.Payments.PaymentSlipPayment TransactionsTemplates.md#route) back reference
SalesOrderPayment OrdersTemplates	SalesOrderPaymentOrdersTemplates	List of SalesOrderPayment<br />OrdersTemplate(Crm.Sales.SalesOrderPayment OrdersTemplates.md) child objects, based on the Crm.Sales.SalesOrderPayment<br />OrdersTemplate.Route(Crm.Sales.SalesOrderPayment OrdersTemplates.md#route) back reference
TemplateRouteLinks	TemplateRouteLinks	List of TemplateRouteLink(Finance.Accounting.TemplateRouteLinks.md) child objects, based on the Finance.Accounting.TemplateRouteLink.Route(Finance.Accounting.TemplateRouteLinks.md#route) back reference
Templates	Templates	List of Template(Finance.Accounting.Templates.md) child objects, based on the Finance.Accounting.Template.Route(Finance.Accounting.Templates.md#route) back reference
TransactionTemplates	TransactionTemplates	List of TransactionTemplate(Applications.Rental.TransactionTemplates.md) child objects, based on the Applications.Rental.TransactionTemplate.Route(Applications.Rental.TransactionTemplates.md#route) back reference

Attribute Details

ActivationDate

The date from which (including) the route is active. The date is matched against the document date of the generating document. Required Default(Today) Filter(ge;le)

Type: date
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: ShownByDefault

Active

True if the route is active, otherwise 0. Required Default(true) Filter(eq)

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

AllowedGenerationTypes

Determines the possible types of the generation of the destination document: A=Auto, M=Manual, B=Both (Auto and Manual). Required Default("B") Filter(multi eq)

Type: AllowedGenerationTypes
Category: System
Allowed values for the AllowedGenerationTypes(Systems.Documents.Routes.md#allowedgenerationtypes) data attribute
Allowed Values (Systems.Documents.RoutesRepository.AllowedGenerationTypes Enum Members)

Value	Description
Auto	Auto value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'Auto'
BothAutoAndManually	BothAutoAndManually value. Stored as 'B'. Database Value: 'B' Model Value: 1 Domain API Value: 'BothAutoAndManually'
Manually	Manually value. Stored as 'M'. Database Value: 'M' Model Value: 2 Domain API Value: 'Manually'

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

AllowObsoleteGeneration

Allows the usage of unsupported generation procedures (marked as obsolete). This is a user override of the system prohibition of the usage of obsolete procedures. Required Default(false)

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

ConditionFilterXML

Contains filter condition, which the document must match in order to execute the route.

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

ConditionStatesBitMask

The system states for which to execute the specified route. Required Default(0) Filter(like)

Type: DocumentStateFlags
Category: System
Enumeration of document system states that can be combined in bit mask
Allowed Values (General.Documents.DocumentStateFlags Enum Members)

Value	Description
New	New document, just created. Can be edited. (Stored as 1). Database Value: 1 Model Value: 1 Domain API Value: 'New'
Planned	Planned by the system for future releasing. (Stored as 2). Database Value: 2 Model Value: 2 Domain API Value: 'Planned'
FirmPlanned	Planned by operator for future releasing. (Stored as 4). Database Value: 4 Model Value: 4 Domain API Value: 'FirmPlanned'
Released	Released document. Changes can be applied only through adjustment documents. (Stored as 8). Database Value: 8 Model Value: 8 Domain API Value: 'Released'
Completed	Work has completed. (Stored as 16). Database Value: 16 Model Value: 16 Domain API Value: 'Completed'
Adjustment	Document which adjusts other released documents. (Stored as 32). Database Value: 32 Model Value: 32 Domain API Value: 'Adjustment'
Closed	The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 64). Database Value: 64 Model Value: 64 Domain API Value: 'Closed'

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

ConnectedPartyCondition

A - any party; C - connected party: to_party is enterprise company; U - unconnected party - not enterprise company;. Required Default("A")

Type: ConnectedPartyCondition
Category: System
Allowed values for the ConnectedPartyCondition(Systems.Documents.Routes.md#connectedpartycondition) data attribute
Allowed Values (Systems.Documents.RoutesRepository.ConnectedPartyCondition Enum Members)

Value	Description
AnyParty	AnyParty value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'AnyParty'
ConnectedParty	ConnectedParty value. Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'ConnectedParty'
UnconnectedParty	UnconnectedParty value. Stored as 'U'. Database Value: 'U' Model Value: 2 Domain API Value: 'UnconnectedParty'

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

DeactivationDate

The date until (including) the route is active. The date is matched against the document date of the generating document. Null means the route does not have a deactivation date. Filter(ge;le)

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

DestinationState

0=New;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required

Type: DocumentState
Category: System
Enumeration of document system states
Allowed Values (General.Documents.DocumentState Enum Members)

Value	Description
New	New document, just created. Can be edited. (Stored as 0). Database Value: 0 Model Value: 0 Domain API Value: 'New'
Adjustment	Document which adjusts other released documents. (Stored as 5). Database Value: 5 Model Value: 5 Domain API Value: 'Adjustment'
Planned	Planned by the system for future releasing. (Stored as 10). Database Value: 10 Model Value: 10 Domain API Value: 'Planned'
FirmPlanned	Planned by operator for future releasing. (Stored as 20). Database Value: 20 Model Value: 20 Domain API Value: 'FirmPlanned'
Released	Released document. Changes can be applied only through adjustment documents. (Stored as 30). Database Value: 30 Model Value: 30 Domain API Value: 'Released'
Completed	Work has completed. (Stored as 40). Database Value: 40 Model Value: 40 Domain API Value: 'Completed'
Closed	The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50). Database Value: 50 Model Value: 50 Domain API Value: 'Closed'

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

Id

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

NegativeConditionFilterXml

The negative condition should NOT be matched by the document in order to execute the route.

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

Notes

Notes for this Route.

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

ParentDocumentRelationshipType

Determines the default relationship type between the generated document and the parent document. Required Default("S")

Type: ParentDocument
RelationshipType
Category: System
Relationship between parent and child documents
Allowed Values (General.Documents.ParentDocumentRelationshipType Enum Members)

Value	Description
Subtask	The child document is a sub-task of the parent document. (Complete child to complete parent) Database Value: 'S' Model Value: 0 Domain API Value: 'Subtask'
NextTask	The child document is next task of the parent document. (Complete parent to complete child) Database Value: 'N' Model Value: 1 Domain API Value: 'NextTask'
IndependentTask	The document is not dependent of neither child nor parent document. Database Value: 'I' Model Value: 2 Domain API Value: 'IndependentTask'

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

ProcedureName

The system name of the generation procedure, which must be executed by the route. Required

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

ProcessEvent

Event which triggers the route. Usually the event is change of state. Every document entity may define own custom events. Required Filter(eq)

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

ReadOnly

Indicates wheather the destination document shoul be read only. true - the destination document is read only. Required Default(false)

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

SchemaXML

OBSOLETE! Do not use! Not used. Obsolete Obsoleted in version 22.1.6.61

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

Reference Details

ConditionEnterpriseCompany

The enterprise company for which this route is activated. Filter(multi eq)

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

ConditionUserStatus

The user-defined status, for which the document route is activated. Filter(multi eq)

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

DestinationDocumentType

The type of the document, that will be generated by executing the route. Filter(multi eq)

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

DestinationEnterpriseCompany

The enterprise company in which to generate the target document. Filter(multi eq)

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

DestinationEnterpriseCompanyLocation

The enterprise company location in which to generate the target document. Filter(multi eq)

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

DestinationUserStatus

The user defined status to set to the generated document. Filter(multi eq)

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

DocumentType

The document type from which this route originates. Documents from this type generate sub-documents using this route. Required Filter(multi eq) Owner

Type: DocumentTypes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

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/Systems_Documents_Routes?$top=10

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