Data Model
Tables
Logical Name | Physical Name | Description |
Activity Types | x_metl3_pme_activity_type | Refer ‘Terminology and Definitions’ for a description of Activity Types. Activity Types are maintained via the Models module. An Activity Type is associated with a model using the ‘Model Activity Types’ related list in the Models module. A given Activity Type relates to a task process and can be associated with multiple models (for a given task) |
Metrics | x_metl3_pme_metrics | Stores the definition of task metrics. A model can have 0 or more metrics |
Model Activities | x_metl3_pme_model_activity | Refer ‘Terminology and Definitions’ for a description of Activities. This table is populated by the ‘Process Model’ action and is updated after the ‘Model Events’ table is populated |
Model Activity Types | x_metl3_pme_model_activity_type | This is the table associated with the ‘Model Activity Types’ related list within the Models module. It stores the Activity Types associated with a model. A model must have at least 1 activity type in order to generate an event log. |
Model Arrays | x_metl3_pme_model_array | Stores the arrays required by the Metricus Process Explorer |
Model Events | x_metl3_pme_model_event_log | The ‘Model Events’ table is the core table of data generated by the |
Model Execution Log | x_metl3_pme_model_execution_log | Stores a summary of each generation of an event log for a given model. |
Model Execution Log Detail | x_metl3_pme_model_execution_log_detail | Stores details of each generation of an event log for a given process model. |
Model Metrics | x_metl3_pme_model_metric | For a given mode, stores the metrics that are to be generated for the related tasks. These are then available in the process explorer for filtering of variants and event log |
Model Steps | x_metl3_pme_model_step | Stores the steps created when processing the event log for a model. A step is the transition from the source activity for an event to the actual activity (referred to as Target). e.g., ‘State: New -> State – Work in Progress’ |
Model Task Metrics | x_metl3_pme_model_task_metric | For each of the tasks in a process model, this table stores the metrics generated, as per the Model Metrics table |
Model Tasks | x_metl3_pme_model_task | Stores the tasks for which a Model event log has been generated |
Model Variant Steps | x_metl3_pme_model_variant_step | An internal table used to store all variant/step combinations for a model |
Model Variants | x_metl3_pme_model_variant | Each model as 1 or more variants. A variant is a unique set of process steps related to a task. This table stores all variants for a given model, based on the event log for that model |
Models | x_metl3_pme_model | Stores the definition of a process model |
Activity Types
Field | Type | Source | Description |
Approval State | Choice | Module – Activity Types | The documentation related to the entry of activity types details the definitions of fields in this table |
Audit Conditions | Conditions | ||
Audit Table | Table Name | ||
Category | String (50) | ||
Description | String (255) | ||
Field | Reference (Dictionary Entry) | ||
Journal Conditions | Conditions | ||
Journal Table | Table Name | ||
Label | String (50) | ||
Name | String (100) | ||
Sequence Priority | Long | ||
SLA | Reference (SLA Definition) | ||
Stage | Choice | ||
Table | Reference (Table) | ||
Task User | Reference (Dictionary Entry) | ||
Type | Choice | ||
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Metrics
Field | Type | Source | Description |
Activity Condition | Conditions | Module – Metrics | The documentation related to the entry of metrics details the definitions of fields in this table |
Activity Table | String | ||
Description | String (255) | ||
Duration Unit | Choice | ||
Field | Reference (Dictionary Entry) | ||
Metric | String(100) | ||
Source | Choice | ||
Table | Table Name | ||
True/False Condition | Conditions | ||
Type | Choice | ||
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Activities
Field | Type | Source | Description |
Activity | String (200) | Process Model (Server Script Action) | The description of each unique activity within event log |
Events | Integer | The number of event log records associated with the activity. Note that this association can be with either the source or target activity in the event log | |
Model | Reference (Models) | The process model for which the activities are generated | |
Tasks | Integer | The number of tasks for which a given activity occurs | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Activity Types
Field | Type | Source | Description |
Activity Type | Reference (Activity Types) | Modules – Models – Model Activity Types related list | Reference table to store the activity types associated with a model |
Model | Reference (Models) | ||
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Arrays
Field | Type | Source | Description |
Model | Reference (Models) | Populated by the ‘Generate_Arrays’ script | The process model for which the event log is generated |
Type | String | The type of array stored (node, variant or event_log) | |
Sequence | Integer | If more than 1 array field is required to store the process model event log, then this field indicates the sequence of the field/file | |
Array | String | The array data | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Events
Field | Type | Source | Description |
Activity Source | Reference (Model Activities) | Process Model (Server Script Action) | The activity related to the previous event for a given activity type e.g., ‘State: New’ |
Activity Target | Reference (Model Activities) | The activity related to the event for a given activity type e.g., ‘State: Work in Progress’ | |
Array - Activity Source ID | String | The ‘Array -…’ fields are internal fields used when creating the arrays required for the Metricus Process Miner application. Having these arrays rapidly speeds up the generating of the required array strings | |
Array - Activity Target ID | String | ||
Array - Category | String | ||
Array - Task Number | String | ||
Array - User Name | String | ||
Array - Variant ID | String | ||
Compliant | Integer | Compliance is maintained at the process step level. A process step is the movement from a given Activity Source to a given Activity Target. If a process step is defined as ‘Non-Compliant’, this field is 0, if ‘Compliant’ then 1 | |
Duration | Duration | The duration (text) from the timestamp associated with the Activity Source event (‘Previous Timestamp’ field) to the Activity Target event (‘Timestamp’ field) | |
Duration (Seconds) | Integer | The duration in seconds from the timestamp associated with the Activity Source event (‘Previous Timestamp’ field) to the Activity Target event (‘Timestamp’ field) | |
Internal Source | String (30) | An internal field indicating what function within the Process Model script action generated the event log record | |
Loop | True/False | Indicates if the event was associated with a process loop (determined the Process Step level) | |
Model | Reference (Models) | The model for which the event log is generated | |
Previous Timestamp | Date/Time | The timestamp associated with the Activity Source event | |
Sequence Priority | Integer | The sequence priority associated with the Activity Type | |
Step | Reference (Model Steps) | The step (Activity Source to Activity Target) of the event | |
Sort_Key | int | Internal sort field | |
Task | Reference (Task) | The task for which the event is recorded | |
Timestamp | Date/Time | The timestamp associated with the Activity Target event | |
Step | Reference (Model Steps) |
| Related step for the from/to activities |
Variant | Reference (Variant) |
| Related variant for the event (as per the related task) |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Execution Log
Field | Type | Source | Description |
Duration | Duration | Process Model (Server Script Action) | The duration (text) representing the amount of time it took to process a given update of the event log |
End Time | Date/Time | The time when the event log generation completed | |
Model | Reference (Model) | The process model for which the event log is generated | |
Number | String (40) | System generated unique number for the event log execution | |
Start Time | Date/Time | The time when the event log generation started | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Execution Log Detail
Field | Type | Source | Description |
Duration | Duration | Process Model (Server Script Action) | The duration (text) representing the amount of time it took to process the given step in the event log generation |
End Time | Date/Time | The time when the processing of the event log step completed | |
Execution | Reference (Execution Log) | The execution log relating to the execution log detail record | |
Sequence | String (40) | The order of the step in the overall event log processing sequence | |
Start Time | Date/Time | The time when the processing of the event log step started | |
Step | String (200) | The name of the event log processing step | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Metrics
Field | Type | Source | Description |
Metric | Reference (Metrics) | Modules – Models – Model Metrics related list | Reference table to store the metrics associated with a model |
Model | Reference (Models) | ||
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Steps
Field | Type | Source | Description |
Activity Source | Reference (Model Activities) | Process Model (Server Script Action) | The activity related to the previous event for a given activity type e.g., ‘State: New’ |
Activity Target | Reference (Model Activities) | The activity related to the event for a given activity type e.g., ‘State: Work in Progress’ | |
Avg Duration | Duration | The Avg duration (text) of the process step within the event log | |
Calc Stats | String (1) | Internal field used by the Process Model script action | |
Compliant | True/False | Modules – Models – Model Steps related list – Edit step | A flag to indicate if the process step is compliant |
Events | Integer | Process Model (Server Script Action) | The number of event log records that exist with the process step |
Loop | True/False | An indicator for whether the process step is part of a loop within a process | |
Max Duration | Duration | The max duration (text) of an occurrence of the process step within the event log | |
Min Duration | Duration | The min duration (text) of an occurrence of the process step within the event log | |
Model | Reference (Models) | The process model for which the process steps are generated | |
Std Deviation |
| The std duration (text) of the process step within the event log | |
Step | String (200) | The name of the process step (derived from Activity Source + Model.Activity Separator + Activity Target) | |
Tasks | Integer | The number of unique tasks in the process mining event log that have 1 or more instances of the process step | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Task Metrics
Field | Type | Source | Description |
Metric | Reference (Metrics) | Process Metrics (Server Script Action) | Reference table to store the metric values for tasks associated with a model |
Model | Reference (Models) | ||
Task | Reference (Model Tasks) | ||
Value | Decimal(20) | ||
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Tasks
Field | Type | Source | Description |
Model | Reference (Model) | Process Model (Server Script Action) | The process model for which tasks are been saved for processing |
Task | Reference (Task) | A record for each task for which the event log records need to be generated | |
Activities | Int | Number of activities associated with the task | |
Attribute Array | String | Internal field used when generating the array’s required for the Metricus Process Miner application. Only populated if Models.Output_Array = true | |
Duration | Duration | The duration (text) of the task | |
Duration (Seconds) | Integer | The duration in seconds of the task | |
Events | Int | The number of generated events for the task | |
Loops | Int | The number of looks in the task process lifecycle | |
Number | String | The task number | |
Process | True/False | Internal field indicating if the task should be processed during the processing of the process model | |
Steps | Int | The number of steps in the task process lifecycle | |
Variant | Reference (Model Variant) | The variant associated with the task | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Model Variants
Field | Type | Source | Description |
Avg Duration | Duration | Process Model (Server Script Action) | The Avg duration (text) of tasks associated with the variant |
Compliant | True/False | A flag to indicate if the variant is compliant | |
Compliant Tasks | Integer | The number of tasks related to the variant (have the same sequence and set of steps) and that are compliant | |
Max Duration | Duration | The max duration (text) of a task associated with the variant | |
Min Duration | Duration | The min duration (text) of a task associated with the variant | |
Model | Reference (Models) | The model for which the process steps are generated | |
Std Deviation |
| The std deviation of the duration (text) of the tasks related to the variant | |
Steps | Integer | The number of steps in the variant | |
Tasks | Integer | The number oft tasks containing the variant | |
Variant | String (2000) |
| The derived variant name (consists of each process step) |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |
Models
Field | Type | Source | Description |
% Events Compliant | Percent Complete | Process Model (Server Script Action) | The % of events generated that are related to compliant steps |
% Steps Compliant | Percent Complete | The % of process steps in the model that are compliant | |
% Tasks Compliant | Percent Complete | The % of tasks where all related process steps compliant | |
% Variants Compliant | Percent Complete | The % of variants where all related process steps are complaint | |
Activities | Integer | The number of distinct activities generated for the model | |
Activity Separator | String (5) | The separator to be used between activities in a step i.e., State: New -> State: In Progress | |
Append Task Attributes to Event Log | True/False | Flag to indicate if the selected task attributes should be appended to the related event in the event log extract | |
Compliant Variants | Integer | The # of variants where all related process steps are complaint | |
Compliant Events | Integer | The # of events generated that are related to compliant steps | |
Compliant Steps | Integer | The # of process steps in the model that are compliant | |
Compliant Tasks | Integer | The # of tasks where all related process steps compliant | |
Description | String (255) | Detailed description of the model | |
End Timestamp | Date/Time | What timestamp represents the end of the task lifecycle e.g., for incidents, this is often the resolved timestamp as an incident typically closed automatically | |
Event Log Filename | String (30) | Name of the event log file to be created when exporting the CSV output | |
Events | Integer | The # of distinct events generated for the model | |
Export after Process | True/False | Flag to indicate if the defined export files will be created when processing of the process model is complete | |
Filter | Conditions | How to filter the task table (if applicable) | |
From Date | Date/Time | When the load type is ‘Full’, this is the from task timestamp to be used when generating the event log | |
Inherit Step Compliance | True/False | When processing the compliance of a model, if this option is selected any variant with one or more non-complaint steps will automatically be flagged as non-complaint | |
Load Type | Choice | The load type, full based on a date range or incremental (based on past x days) | |
Merge Occurrence Separator | String (5) | The separator to be used for the different activities occurring at the same time. Default is ‘;’ | |
Merge Occurrence Threshold (Seconds) | Integer | The threshold to be used to define Merge Occurrences | |
Merge Occurrences | True/False | Specifies if activities occurring on the same timestamp (or within the specified ‘Merge Occurrences Threshold (seconds)), are merged into a single activity | |
Minimum Variant Tasks | int | Specifies the minimum number of tasks that need to be related to a variant in order for the variant to be created. | |
Model ID | String (32) | The unique ID of the model (same as sys_id). Used by REST API extractors | |
Name | String (100) | A short name describing the model e.g., ‘Incidents – Assignment Group’ | |
Notification Users | List | A list of users to receive notifications when script actions are complete e.g., ‘Process Model’, ‘Export CSV’ | |
Number | String (20) | A system generated unique number for the model | |
Previous Days | Integer | The number of previous days to process event log data for if the load type is ‘Incremental’ | |
Process End Label | String (20) | The end activity to be used for the last process step in a variant i.e., ‘End | |
Process Start Label | String (20) | The start activity to be used for the first process step in a variant i.e., ‘Start’ | |
Steps | Integer | The # of distinct steps generated for the model | |
System User | Reference | The ServiceNow audit log records the user as ‘SYSTEM’ if an audit log entry is system generated. This field allows you to override this entry with a selected user. | |
Task Attributes | List | The task attributes to be exported to the ‘Task Attributes File’ | |
Task Table | Table Name | The task table to analyse e.g., incidents, change requests, request items, etc | |
Tasks | Integer | The # of distinct tasks generated for the model | |
To Date | Date | When the load type is ‘Full’, this is the to task timestamp to be used when generating the event log | |
Type | Choice | The type of process model (task, external or related model) | |
Update Arrays | True/False | Flag to indicate of the Model – Arrays table should be updated when a process model has completed processing | |
Variants | Integer | The # of distinct variants generated for the model | |
Created | Date/Time | System | |
Created By | String | ||
Sys ID | GUID | ||
Updated | Date/Time | ||
Updated By | String | ||
Updates | Integer |