QPR ProcessAnalyzer Expressions: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
Line 47: Line 47:
* '''Leaf level''' is a level that doesn't have any sub levels.
* '''Leaf level''' is a level that doesn't have any sub levels.


== Type Specific Properties and Functions ==
== [[QPR_ProcessAnalyzer_Expressions:_Generic_Properties_and_Functions|Generic Properties and Functions]] ==


This chapter lists all the object types in the expresssion language and properties and functions that they support. After the property or function name there is the type of the returned object mentioned. Asterisk (*) after the type means that it returns an array of objects.
== [[QPR_ProcessAnalyzer_Expressions:_Type_Specific_Properties_and_Functions&action=edit|Type Specific Properties and Functions]] ==
 
=== Array ===
 
{| class="wikitable"
!'''Array functions'''
!'''Parameters'''
! '''Description'''
|-
||IndexOfSubArray (integer)
||
# Sub-array to search(array)
# Array from where to search the sub-array (array)
||Returns the indexes of given sub-array (1. parameter) within the given array (2. parameter). If not given, the array in the current context object is used. Returns starting indexes of all the occurrences of given sub-array within given array.
Examples:
<pre>
[[1,2,3,4,1,2,5]].IndexOfSubArray([1,2])
IndexOfSubArray([1,2], [1,2,3,4,1,2,5])
Return: [0, 4]
 
[[1,2,3,4,1,2,5]].IndexOfSubArray([1,2,3,4,5])
Returns: []
 
[[1,2,3,4,1,2,5],[3,4],[0,1,2,3]]:IndexOfSubArray([1,2])
Returns:
[
  HierarchicalArray([1,2,3,4,1,2,5], [0,4]),
  HierarchicalArray([0,1,2,3], [1])
]
</pre>
|}
 
=== AttributeType ===
 
{| class="wikitable"
!'''Case properties'''
! '''Description'''
|-
||Id (Integer)
||AttributeType Id.
|-
||Name (String)
||Attribute name.
|}
 
=== Case ===
 
{| class="wikitable"
!'''Case properties'''
! '''Description'''
|-
||Duration (TimeSpan)
||Case duration, i.e. duration between case start and case end time.
|-
||EndTime (DateTime)
||Case end time, i.e. timestamp of the last event.
|-
||Events (Event)
||All events of the case.
|-
||FlowOccurrences (FlowOccurrence)
||All flow occurrences the case contains.
|-
||Flows (Flow)
||All flows the case goes through.
|-
||Id (String)
||Case Id. Case id is generated by QPR ProcessAnalyzer when the model is loaded.
|-
||Name (String)
||Case name. The case name comes with the source data when data is imported to QPR ProcessAnalyzer.
|-
||StartTime (DateTime)
||Case start time, i.e. timestamp of the first event.
|-
||Variation (Variation)
||Variation the case belongs to.
|}
 
{| class="wikitable"
!'''Case&nbsp;functions'''
! '''Parameters'''
! '''Description'''
|-
|| Attribute (Object)
||
* attribute name (string)
||Returns case attribute value. Case attribute name is provided as a parameter. This function is needed when there are spaces in the case attribute name. If there are no spaces, syntax '''.attributeName''' can be used.
|-
|| EventsByType (Event*)
||
* EventType object or EventType name (string)
||
(Available in QPR ProcessAnalyzer 2018.1) Returns all Events of this case which are of given type. The parameter can be either EventType object or the name of the event as a string.
 
Examples:
<pre>
case.EventsByType("Invoice")
Returns: Array of events having event type named "Invoice".
 
case.EventsByType((EventLog.EventTypes.Where(Name=="Invoice"))[0])
Returns: Array of events having event type named "Invoice".
</pre>
|-
|| FlowOccurrencesByType (FlowOccurrence*)
||
* Flow object or id of FlowOccurrence(integer)
||
(Available in QPR ProcessAnalyzer 2018.1) Returns all FlowOccurrences of this case which are of given type. The parameter can be either a Flow object or an integer identifying the id of the flow occurrence.
 
Examples:
<pre>
case.FlowOccurrencesByType(EventLog.Flows[0])
Returns: All the flow occurrences in the case belonging to the first flow in event log.
 
case.FlowOccurrencesByType(EventLog.Flows[0].Id)
Returns: All the flow occurrences in the case belonging to the first flow in event log.
</pre>
|}
 
=== DateTime ===
DateTime represents a timestamp.
 
{| class="wikitable"
!'''DateTime properties'''
! '''Description'''
|-
||Day
||The day of the calendar month represented by the DateTime. Number between 1 and 31.
|-
||Hour
||The hour component of the date represented by the DateTime. Number between 0 and 23.
|-
||Millisecond
||The millisecond component of the date represented by the DateTime. Number between 0 and 999.
|-
||Minute
||The minute component of the date represented by the DateTime. Number between 0 and 59.
|-
||Month
||The calendar month component of the date represented by the DateTime. Number between 1 and 12.
|-
||Second
||The second component of the date represented by the DateTime. Number between 0 and 59.
|-
||Year
||The year component of the date represented by the DateTime. Number between 1 and 9999.
|}
 
{| class="wikitable"
!'''DateTime functions'''
! '''Parameters'''
! '''Description'''
|-
|| Round (DateTime)
||
* attribute name (TimeSpan)
||
Rounds the DateTime to the defined TimeSpan.
 
Example:
<pre>
Round to the nearest hour:
Round(DateTime(2017, 1, 1, 14, 48), TimeSpan(0, 1))
</pre>
|}
 
=== Event ===
 
{| class="wikitable"
!'''Event properties'''
! '''Description'''
|-
||Case (Case)
||Case the event belongs to.
|-
||Id (Integer)
||Event id. It's generated by QPR ProcessAnalyzer when the model is loaded.
|-
||IndexInCase (Integer)
||Index (running) number of the event in the case (ordered temporally). The first event has index number 0.
|-
||IncomingFlowOccurrences (FlowOccurrence*)
||(Available in QPR ProcessAnalyzer 2018.1) All FlowOccurrencies that end to this Event.
|-
||Model (Model)
||Model the event belongs to.
|-
||NextInCase (Event)
||Temporally next event in the case. For the last event, return EMPTY.
|-
||PreviousInCase (Event)
||Temporally previous event in the case. For the first event, return EMPTY.
|-
||OutgoingFlowOccurrences (FlowOccurrence*)
||(Available in QPR ProcessAnalyzer 2018.1) All FlowOccurrencies that start from this Event.
|-
||TimeStamp (DateTime)
||Timestamp of the event.
|-
||Type (EvenType)
||Event type of the event.
|}
 
{| class="wikitable"
!'''Event&nbsp;functions'''
! '''Parameters'''
! '''Description'''
|-
|| Attribute (object)
||
* attribute name (string)
|| Return event attribute value. Event attribute name is provided as a parameter. This function is needed when there are spaces in the event attribute name. If there are no spaces, syntax '''.attributeName''' can be used.
|}
 
=== EventLog ===
 
EventLog is a list of events that is a result of a filtering operation. Also Model contain an EventLog composing of the whole model contents. i.e. filters have been applied yet. EventLogs can be fetched by the filter id using function '''EventLogById(filterId)'''.
 
{| class="wikitable"
!'''EventLog properties'''
! '''Description'''
|-
||CaseAttributes (AttributeType*)
||Used case attribute in the EventLog.
|-
||Cases (Case*)
||Cases that belong to the EventLog.
|-
||EventAttributes (AttributeType*)
||Used event attributes in the EventLog.
|-
||Events (Event*)
||Events that belong to the EventLog.
|-
||EventTypes (EventType*)
||EventTypes in the EventLog.
|-
||Flows (Flow*)
||Flows that the part of the EventLog.
|-
||Id
||EventLog Id.
|-
||Model (Model)
||Model where the EventLog belongs.
|-
||Name
||EventLog name.
|-
||Variations (Variation*)
||Variations that are in the EventLog
|}
 
=== EventType ===
 
{| class="wikitable"
!'''EventType properties'''
! '''Description'''
|-
||Cases (Case*)
||Cases that have events of this EventType.
|-
||Count (Integer)
||Number of Events that have this EventType.
|-
||Events (Event*)
||Events of that EventType.
|-
||Id (Integer)
||EventType Id. It's generated by QPR ProcessAnalyzer when the model is loaded.
|-
||IncomingFlows (Flow*)
||All Flows that start from the EventType.
|-
||Name (string)
||EventType name.
|-
||OutgoingFlows (Flow*)
||All Flows that end to the EventType.
|-
||UniqueCount (Integer)
||Number of Cases having events of this EventType.
|}
 
=== Flow ===
 
Flow is a combination of two EventTypes where there are FlowOccurrences between them. Unlike FlowOccurrencies, a Flow is not related to a single case. Flowchart shows Flows and EventTypes (not FlowOccurences or Events). In a Case, the may be several FlowOccurrences of a single Flow.
 
{| class="wikitable"
!'''Flow properties'''
! '''Description'''
|-
||Cases (Case*)
||Cases that contain the flow, i.e. there is a flow occurrence between Flow's starting and ending events.
|-
||FlowOccurrences (FlowOccurrence*)
||Flow occurrences the flow belongs to.
|-
||From (EventType)
||EventType from which this Flow starts.
|-
||Id (Integer)
||Flow Id. It's generated by QPR ProcessAnalyzer when the model is loaded.
|-
||Name (String)
||Identifying name of the Flow.
|-
||To (EventType)
||EventType to which this Flow ends.
|}
 
=== FlowOccurrence ===
 
FlowOccurrence represents a transition from an event to another event in a case. Thus, FlowOccurrence is related to a single case. There is also a FlowOccurrence from the "start" of the case to the first event of the case, and a FlowOccurrence from the last event of the case to the "end" of the case. Corresponding flow is visible in BPMN kind of flowcharts showing separate start and event icons. Thus, there are one more FlowOccurrences in a case than the number of events.
 
{| class="wikitable"
!'''FlowOccurrence properties'''
! '''Description'''
|-
||Case (Case)
||Case the current FlowOccurrence belongs to.
|-
||Flow (Flow)
||Corresponding Flow of the current FlowOccurrence.
|-
||From (Event)
||Event where the current FlowOccurrence starts.
|-
||Id (Integer)
||FlowOccurrence Id. It's generated by QPR ProcessAnalyzer when the model is loaded.
|-
||Name (String)
||Identifying name of the current FlowOccurrence.
|-
||OccurrenceIndex (Integer)
||Number tells how many times the current FlowOccurrence has occurred in the case until that point.
|-
||To (Event)
||Event where the this FlowOccurrence ends.
|}
 
=== Model===
 
{| class="wikitable"
!'''Model properties'''
! '''Description'''
|-
||CaseAttributes (AttributeType*)
||CaseAttributes of the model.
|-
||DefaultFilterId (Integer)
||Id of the default filter for the model.
|-
||EventAttributes (AttributeType*)
||EventAttributes of the model.
|-
||EventLog (EventLog)
||EventLog of the model. Model EventLog contains all events of the model, i.e. no filters have been applied.
|-
||Id (Integer)
||Model Id. Model Id is generated by QPR ProcessAnalyzer when the model is created.
|-
||Name (String)
||Name of the model.
|-
||Project (Project)
||The Project the this model belongs to.
|}
 
=== TimeSpan ===
 
TimeSpan represents a temporal duration (for example: 5 hours or 8 days). TimeSpan is not bound to calendar time. Difference between two TimeStamps is TimeSpan. TimeStamp added by TimeSpan is TimeStamp.
 
{| class="wikitable"
!'''TimeSpan properties'''
! '''Description'''
|-
||TotalDays (Float)
||Timespan value in days (one day is 24 hours) (both whole and fractional).
|-
||TotalHours (Float)
||Timespan value in hours (both whole and fractional).
|-
||TotalMilliseconds (Float)
||Timespan value in milliseconds (both whole and fractional).
|-
||TotalMinutes (Float)
||Timespan value in minutes (both whole and fractional).
|-
||TotalSeconds (Float)
||Timespan value in seconds (both whole and fractional).
|}
 
=== Project ===
{| class="wikitable"
!'''Project properties'''
! '''Description'''
|-
||Id (Integer)
||Id of the Project.
|-
||Name (String)
||Name of the Project.
|-
||Models (Model*)
||Models that belong to this Project.
|}
 
=== Variation ===
{| class="wikitable"
!'''Variation properties'''
! '''Description'''
|-
||CaseCount (Integer)
||Number of cases in the variation.
|-
||Cases (Case*)
||Cases that belong to the variation.
|-
||EventTypeCount (Integer)
||Number of events in the variation.
|-
||EventTypes (EventType*)
||Event types belonging to the variation.
|-
||Flows (Flow*)
||(Available in QPR ProcessAnalyzer 2018.1) Flows that belong to the variation.
|-
||Id (Integer)
||Variation Id. It's generated by QPR ProcessAnalyzer when the model is loaded.
|-
||UniqueEventTypeCount (Integer)
||Number of different (unique) event types in the variation.
|}


== Expression Examples ==
== Expression Examples ==
See expression examples: [[QPR ProcessAnalyzer Expression Examples]].
See expression examples: [[QPR ProcessAnalyzer Expression Examples]].
[[Category: QPR UI]]
[[Category: QPR UI]]

Revision as of 15:12, 29 December 2017

Expression and Evaluation Context

An expression is a text to be evaluated that has a result. Result can be any of the supported object types or empty. An expression may consist of multiple expressions, called sub-expressions.

Expression evaluation is always performed within some context. This context and its type defines which kind of functionalities are available. Current context is implicitly accessible in all the expressions. Whenever a function or property is called, functions and properties accessible in the current context are searched first. If function or property is not found in the current context, then more generic context is tried. Error is returned only if the requested functionality is not available in the current context or a generic context. Current context can be accessed explicitly by using variable named _ (underscore).

Expression Chaining and Hierarchies using . and :

Expressions can be chained together two ways:

  • Contextless chaining: When . character is used to chain expressions, the resulting objects will not have context information.
  • Hierarchical chaining: When : character is used to chain expressions, only the result of the whole chained expression will consist of hierarchical arrays (#29290#) where all the values in the first expression (=context object) will be bound to the arrays those values generated. If the second expression does not return an array, the result will be changed to be an array.

The second expression chained to the first one will be evaluated using the following rules:

  • If the result of the first expression is not an array, the second expression will be evaluated with the result of the first expression as its context object.
  • If the result of the first expression is an array, for every element in the array, the second expression will be evaluated with the array item as its context object. The result of the evaluation will be an array of evaluation results (one for each element in the array).
  • If any of the second expression evaluations returns an array, the resulting object will be an array of arrays. If the first expression evaluation returns a typed array, the result will be hierarchic in a way that first level results are objects that contain the information about the actual object as well as the results generated by the second level expressions.

These rules apply also when chaining more than two expressions together. For example, it is possible to generate three level hierarchy with nodes of type: event log -> case -> event: EventLogById(1).Cases.Events or EventLogById(1):Cases:Events.

Examples:

Contextless chaining: First expression not an array, second expression not an array:
"1".("Number is " + _)
Returns:
"Number is 1"

Contextless chaining: First expression is an array, second expression not an array:
[1,2,3].("Number is " + _)
Returns:
["Number is 1", "Number is 2", "Number is 3"]

Contextless chaining: First expression is an array, second expression is an array:
[1,2,3].["Number is " + _, "" + _ + ". number"]
Returns:
[ ["Number is 1", "1. number"], ["Number is 2", "2. number"], ["Number is 3", "3. number"] ]

Hierarchical chaining: First expression is an array, second expression is an array:
[1,2,3]:["Number is " + _, "" + _ + ". number"]
Returns:
[ HierarchicalArray(1, ["Number is 1", "1. number"]), HierarchicalArray(2, ["Number is 2", "2. number"]), HierarchicalArray(3, ["Number is 3", "3. number"]) ]

  • Hierarchical arrays: Whenever traversing a relation in expression language using hierarchical chaining operator ':' for chaining expressions, a hierarchical array will be returned. It is an object which behaves just like a normal array except it stores also context/root/key/label object which usually represents the object from which the array originated from, for example the original case object when querying events of a case.
  • Hierarchical objects: Arrays where at least one object in the array is itself an array is considered to be a hierarchical object. Hierarchical arrays are treated in similar way as normal arrays in hierarchical objects.
  • Depth of a hierarchical object is the number of inner arrays that there are in the object, i.e. how deep is the hierarchy.
  • Level in hierarchical object consists of all the nodes that are at specific depth in object's array hierarchy. 0 is the level at the root of the object, consisting only of the object itself as single item. Levels increase when moving towards leaves.
  • Leaf level is a level that doesn't have any sub levels.

Generic Properties and Functions

Type Specific Properties and Functions

Expression Examples

See expression examples: QPR ProcessAnalyzer Expression Examples.