Systems.Monitoring.ScheduledDocumentEvents Entity

Namespace: Systems.Monitoring

Contains postponed events, which will be executed later. Usually these are large number of recalculation events, resulting from other events. For example, releasing a cost correction, publishes postponed events for all affected documents. Entity: Gen_Scheduled_Document_Events

Renames

Old name: Systems.Core.ScheduledDocumentEvents
New name: Systems.Monitoring.ScheduledDocumentEvents
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Id}: {SourceDocumentId}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

Systems.Monitoring.ScheduledDocumentEvents

Attributes

Name	Type	Description
Cancelled	boolean	When true, specifies that this document event has been cancelled (either manually or in respect to another event) and will not be executed. `Required` `Default(false)` `Filter(eq)`
CreationTime	datetime	Date and time when the ScheduledDocumentEvent was created. `Required` `Default(Now)` `Filter(ge;le)` `ReadOnly`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DocumentEvent	string (254)	The type of the document event that is scheduled to be processed. `Required` `ReadOnly`
Id	guid
LastProcessStatus	string (max) nullable	Status/information of the last attemp to process the event. Usually shows the cause in case of failure. `ReadOnly`
LastProcessTime	datetime nullable	The time of the last attempt to process the event. `Filter(ge;le)` `ReadOnly`
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.
Processed	boolean	Indicates wheather the event is already processed or not. `Required` `Default(false)` `Filter(eq)` `ReadOnly`
State	State	The state of the document for which the event will be processed. `Required` `ReadOnly`

References

Name	Type	Description
Document	Documents	The document for which the event will be processed. `Required` `Filter(multi eq)` `ReadOnly`
SourceDocument	Documents	The document that has caused this event to be scheduled. `Required` `Filter(multi eq)` `ReadOnly`

Attribute Details

Cancelled

When true, specifies that this document event has been cancelled (either manually or in respect to another event) and will not be executed. Required Default(false) Filter(eq)

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

CreationTime

Date and time when the ScheduledDocumentEvent was created. Required Default(Now) Filter(ge;le) ReadOnly

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

DocumentEvent

The type of the document event that is scheduled to be processed. Required ReadOnly

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

Id

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

LastProcessStatus

Status/information of the last attemp to process the event. Usually shows the cause in case of failure. ReadOnly

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

LastProcessTime

The time of the last attempt to process the event. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
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

Processed

Indicates wheather the event is already processed or not. Required Default(false) Filter(eq) ReadOnly

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

State

The state of the document for which the event will be processed. Required ReadOnly

Type: State
Category: System
Allowed values for the State(Systems.Monitoring.ScheduledDocumentEvents.md#state) data attribute
Allowed Values (Systems.Monitoring.ScheduledDocumentEventsRepository.State Enum Members)

Value	Description
New	New value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'New'
Corrective	Corrective value. Stored as 5. Database Value: 5 Model Value: 5 Domain API Value: 'Corrective'
Planned	Planned value. Stored as 10. Database Value: 10 Model Value: 10 Domain API Value: 'Planned'
FirmPlanned	FirmPlanned value. Stored as 20. Database Value: 20 Model Value: 20 Domain API Value: 'FirmPlanned'
Released	Released value. Stored as 30. Database Value: 30 Model Value: 30 Domain API Value: 'Released'
Completed	Completed value. Stored as 40. Database Value: 40 Model Value: 40 Domain API Value: 'Completed'
Closed	Closed value. Stored as 50. Database Value: 50 Model Value: 50 Domain API Value: 'Closed'

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

Reference Details

Document

The document for which the event will be processed. Required Filter(multi eq) ReadOnly

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

SourceDocument

The document that has caused this event to be scheduled. Required Filter(multi eq) ReadOnly

Type: Documents
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

Process

Processes this ScheduledDocumentEvent(Systems.Monitoring.ScheduledDocumentEvents.md). The method returns true if the event is processed successfully and false if there is an error. In case of failure the error message is saved in LastProcessStatus attribute of the event object. The already processed or canceled events are not processed again but still the result value is true.
Return Type: boolean
Declaring Type: ScheduledDocumentEvents
Domain API Request: POST

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