Systems.Core.DocumentJobs Entity

Namespace: Systems.Core
Inherited From: Systems.Config.Jobs

Represents jobs, which change state of documents. Entity: Gen_Document_Jobs (Introduced in version 20.1)

Renames

Old name: General.DocumentJobs
New name: Systems.Core.DocumentJobs
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
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 Tree

Systems.Core.DocumentJobs

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FilterXml	dataaccessfilter	Specifies the documents, whose state will be changed. `Unit: obj.DocumentType.EntityName` `Required`
Id	guid
IsActive	boolean	Specifies whether the job is active and ready for running. `Required` `Default(true)` `Filter(eq)` (Inherited from Jobs)
JobType	JobType	The system type of the job. DOC=Document Change State, POS=Run Postponed Events, DNT=Delete Old Notifications, DPI=Delete Old Print Images, DDV=Delete Old Document Versions, DIM=Delete Old Information Messages. `Required` `Filter(multi eq)` (Inherited from Jobs)
Name	string (254)	The name of the job. `Required` `Filter(eq;like)` `ORD` (Inherited from Jobs)
NewState	DocumentState	Specifies the state, which should be set to the documents, matching the filter. `Required`
Notes	string (max) nullable	Notes for this Job. (Inherited from Jobs)
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.
RunOnIdle	boolean	Specifies whether to automatically run the job when the server is idle. `Required` `Default(true)` `Filter(eq)` (Inherited from Jobs)

References

Name	Type	Description
DocumentType	DocumentTypes	The type of the document, whose state will be changed. `Required` `Filter(multi eq)`
NewUserStatus	DocumentTypeUserStatuses (nullable)	Specifies the user status, which should be set to the documents, matching the filter. The user statuses are defined for the selected document type. `Filter(multi eq)`

Attribute Details

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

FilterXml

Specifies the documents, whose state will be changed. Unit: obj.DocumentType.EntityName Required

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

Id

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

IsActive

Specifies whether the job is active and ready for running. Required Default(true) Filter(eq) (Inherited from Jobs)

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

JobType

The system type of the job. DOC=Document Change State, POS=Run Postponed Events, DNT=Delete Old Notifications, DPI=Delete Old Print Images, DDV=Delete Old Document Versions, DIM=Delete Old Information Messages. Required Filter(multi eq) (Inherited from Jobs)

Type: JobType
Category: System
Allowed values for the JobType(Systems.Config.Jobs.md#jobtype) data attribute
Allowed Values (Systems.Config.JobsRepository.JobType Enum Members)

Value	Description
DocumentChangeState	DocumentChangeState value. Stored as 'DOC'. Database Value: 'DOC' Model Value: 0 Domain API Value: 'DocumentChangeState'
RunPostponedEvents	RunPostponedEvents value. Stored as 'POS'. Database Value: 'POS' Model Value: 1 Domain API Value: 'RunPostponedEvents'
DeleteOldNotifications	DeleteOldNotifications value. Stored as 'DNT'. Database Value: 'DNT' Model Value: 2 Domain API Value: 'DeleteOldNotifications'
DeleteOldPrintImages	DeleteOldPrintImages value. Stored as 'DPI'. Database Value: 'DPI' Model Value: 3 Domain API Value: 'DeleteOldPrintImages'
DeleteOldDocumentVersions	Delete old document versions. Stored as 'DDV'. Database Value: 'DDV' Model Value: 4 Domain API Value: 'DeleteOldDocumentVersions'
DeleteOldInformation Messages	Delete old information messages. Stored as 'DIM'. Database Value: 'DIM' Model Value: 5 Domain API Value: 'DeleteOldInformation Messages'
DeleteAttribute ChangesHistory	Delete attribute changes history. Stored as 'DAC'. Database Value: 'DAC' Model Value: 6 Domain API Value: 'DeleteAttribute ChangesHistory'

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

Name

The name of the job. Required Filter(eq;like) ORD (Inherited from Jobs)

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

NewState

Specifies the state, which should be set to the documents, matching the filter. 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

Notes

Notes for this Job. (Inherited from Jobs)

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

RunOnIdle

Specifies whether to automatically run the job when the server is idle. Required Default(true) Filter(eq) (Inherited from Jobs)

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

Reference Details

DocumentType

The type of the document, whose state will be changed. Required Filter(multi eq)

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

NewUserStatus

Specifies the user status, which should be set to the documents, matching the filter. The user statuses are defined for the selected document type. Filter(multi eq)

Type: DocumentTypeUserStatuses (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