Systems.Documents.SequenceGenerators Entity

Namespace: Systems.Documents

Contains one or more sequence generators for each sequence. Many sequence generators for one sequence are used when the generators must be selected conditionally or when more generators are needed for parallel numbering. Entity: Gen_Sequence_Generators

Renames

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

Default Visualization

Default Display Text Format:
{Sequence.Name}
Default Search Members:
Sequence.Name
Name Data Member:
Sequence.Name
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.Sequences
Aggregate Root:
Systems.Documents.Sequences

Attributes

Name	Type	Description
AllowExplicitNumbering	boolean	Allows to assign numbers explicitely regardless of the Next_Value of the generator (Next_Value is updated if needed). `Required` `Default(false)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
NextValue	string (16)	The next number that will be issued by the sequence. `Required` `Default("0000000001")`
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.
SequencePriority	int32	The priority in which the sequence is used, compared to other similar sequences. Used only for sequences, for which Simultaneous Transactions=True. `Required` `Default(1)`

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies	The Enterprise Company to which this SequenceGenerator applies. `Required` `Filter(multi eq)`
EnterpriseCompanyLocation	CompanyLocations (nullable)	The Enterprise Company Location to which this SequenceGenerator applies, or null if it is for all enterprise company locations. `Filter(multi eq)`
ResponsiblePerson	Persons (nullable)	If specified then the generator is designated for use only in documents with that Responsible_Person_Id. `Filter(multi eq)`
Sequence	Sequences	The to which this SequenceGenerator belongs. `Required` `Filter(multi eq)` `Owner`

Attribute Details

AllowExplicitNumbering

Allows to assign numbers explicitely regardless of the Next_Value of the generator (Next_Value is updated if needed). 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

Id

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

NextValue

The next number that will be issued by the sequence. Required Default("0000000001")

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

SequencePriority

The priority in which the sequence is used, compared to other similar sequences. Used only for sequences, for which Simultaneous Transactions=True. Required Default(1)

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

Reference Details

EnterpriseCompany

The Enterprise Company to which this SequenceGenerator applies. Required Filter(multi eq)

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

EnterpriseCompanyLocation

The Enterprise Company Location to which this SequenceGenerator applies, or null if it is for all enterprise company locations. Filter(multi eq)

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

ResponsiblePerson

If specified then the generator is designated for use only in documents with that Responsible_Person_Id. Filter(multi eq)

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

Sequence

The to which this SequenceGenerator belongs. Required Filter(multi eq) Owner

Type: Sequences
Indexed: True
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