Event
note
Modifying this entity requires certain user authorization. For more information, see User Groups.
Events are the runtime links between Jobs and are also part of the tracking of a process flow as defined by Event configurations and Component definitions.
note
All Events except Events of System event type __iCore_SystemSessionEventCreated are created from a Job.
Properties
| Name | Type | Description |
|---|---|---|
| Arguments | IDictionary<String, Object> | The parameters carried by the Event. See remarks below for more information on arguments. |
| Bookmark | String | A unique identifier allowing the system to find and delete time-out Events. |
| Completed | DateTime | The date and time when the processing of the Event was completed. |
| Created | DateTime | The date and time when the Event was created and sent to the Event Queue. |
| Delayed until | DateTime | Date/time to which processing of the Event is delayed. The parameter is used to define the execution of scheduled Events. Events without a scheduled time will have the start time in this field. |
| Entity type | EntityType | Specifies the entity type. The property is Read-only and is only displayed in filter listings to identify the entity type. It can be used for example when filtering on entities with a filter containing an 'All' part. For more information, see Entity filters. |
| Event source | EventSourceType | The source of this Event. |
| Event type | IEventType | The name of the current Event. |
| Has cleaned children | Boolean | Specifies if the Event has had children that have been removed by the Workflow activity Clean-up Tracking |
| ID | Guid | The entity ID of the Event. Automatically generated by the system. |
| Match status | EventMatchStatus | The status of the Event configuration match of the Event. For more information see note below. |
| Parent Job | IJob | The Job that created the Event. |
| Priority | Byte | The priority of the Event. Priorities reach from 1-10, where 1 is the highest priority. |
| Reason | EventReason | The reason for the transition to the current state. |
| State | EventState | Displays the current status of the Event. |
| User | IUser | The User that created the Event. |
Remarks
User property
When interactively creating an Event while the system is running, for example via Administrator, the User of the Event will be the special user associated with the Server that received the Event creation request rather than the user that performed the action. If you need to track which User initiated the Event creation request under these circumstances, use the Audit Log.
Match status property
Possible statuses are:
- Unknown - The Event has not yet been matched with an Event configuration.
- Cascaded - The matched Event configuration is one of several matches in accordance with the Selection rule 'All match' in the Event type.
- Single - The matched Event configuration was found in accordance with Selection rule 'Single best match' in the Event type or the Event was a synchronous Event (which can only have single match)
- None - No matching Event configuration was found.
Event history
Every time an Event changes state, the following data is saved and recorded:
| Name | Type | Description |
|---|---|---|
| Date created | DateTime | Date and time for state transition. |
| Job | Guid | The ID of the Job that issued the transition. |
| Reason | EventReason | The reason for the transition. |
| State | EventState | The new state of the Event. |
Event arguments
The arguments of an Event, except for some System Event types, are always:
| Name | Type | Description |
|---|---|---|
| EventParam | String | The Event parameters set when the Event was created. |
| Node | Int64 | The ID of the Node set when Event was created. -1 if no Node was assigned. |
For other arguments, see System defined Event types.
Event at runtime
Events are created by Jobs at runtime and each Event is matched against the existing Event configurations. If a matching Event configuration is found, a Job of the Component configuration set in the Event configuration is created and scheduled for execution.
If no matching Event configuration is found, a System Event of __iCore_NoMatchingEventHandlerFound type is created.
See Also
Event type
Job
System defined Event types
Event configuration