Standard SmartObjects: K2 Workflow Reports

The standard set of Workflow Reports use the following SmartObjects to retrieve reporting data about workflows. You can use these SmartObjects to create custom views of workflow reporting data.

  • Reporting SmartObjects execute asynchronously. We suggest you don't use these SmartObjects as part of a process in a workflow such as using it in a Task step, as it may not behave as expected.
  • Reporting SmartObjects are created by the system and may change or be removed in future releases of the product. The use of system SmartObjects is at your discretion and risk. Changes to system SmartObjects are documented, and if you are using it in applications, you must update those applications affected and test expected behavior. Backwards compatibility is not supported for system SmartObjects.
Workflow Analytics Workflow General Workflow General - Helper
The SmartObjects listed below are related to workflows created in the Workflow Designer.

The tables below display the methods and properties returned by workflow report SmartObjects. Note that not all properties are returned for all methods.

Activity Instance

(This section applies to the SmartObject with the system name com_K2_System_Reports_SmartObject_AnalyticsActivityInstance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Display Name (Text)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Duration (Number)
  • Expected Duration (Number)
  • Finish Date (DateTime)
  • Priority (Text)
  • Process Instance ID (Number)
  • Start Date (DateTime)
  • Status (Text)
  • Activity Instance ID
  • Activity Name
  • Duration
  • Expected Duration
  • Finish Date
  • Priority
  • Process Instance ID
  • Start Date
  • Status
 Returns data on workflow activities/steps.
If no workflow is specified (Process Instance ID), data from all processes is returned (including active and non-active instances).
If no activity is specified (Activity Instance ID), data from all activities is returned.

Properties

Name Type Example Notes
Activity Display Name Text Manager Tasks Activity/step name set by the workflow designer.
Activity Instance ID Number 1 Activity/step ID. This is a system value set by K2.
Activity Name Text Manager_Tasks System name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
Duration Number 0 The actual duration of the step.
Expected Duration Number 0 The expected duration of the step, as set by the workflow designer.
Finish Date DateTime 2019-10-11T12:14:42 The hour and minute the activity finished.
In some reports, the date format returned is: 10/11/2019 1:52 PM.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
Process Instance ID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
Start Date DateTime 2019-10-11T12:14:38 The hour and minute the activity started.
In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Activity Instance Destination

(This section applies to the SmartObject with the system name com_K2_System_Reports_SmartObject_AnalyticsActivityInstanceDestination.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Display Name (Text)
  • Activity ID (Number)
  • Activity Instance Destination ID (Number)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Destination (Text)
  • Duration (Number)
  • Expected Duration (Number)
  • Final Action (Text)
  • Finish Date (DateTime)
  • Folio (Text)
  • Process Folder (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Start Date (DateTime)
  • Status (Text)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Instance ID
  • Activity Name
  • Destination
  • Duration
  • Expected Duration
  • Final Action
  • Finish Date
  • Folio
  • Process Folder
  • Process Instance ID
  • Process Name
  • Start Date
  • Status
 Returns data on task activities/steps. Data includes the destination user and the final action.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Tasks Activity/step name set by the workflow designer.
ActivityID Number 1 Activity/step ID. This is a system value set by K2.
ActivityInstanceDestinationID Number 1 Unique identifier for the recipient and step. This is a system value set by K2.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Manager_Tasks System name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
Destination Text K2:Denallix\Administrator The task recipient's account name.
Duration Number 0 Actual duration of the step.
ExpectedDuration Number 0

The expected duration of the step, as set by the workflow designer.
Final_Action Text Approved Action selected by the task recipient. Action options are set by the workflow designer.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity finished.
In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcessFolder Text Denallix Travel Request The folder name of the workflow, as set by the workflow designer.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest System value for the workflow name.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started.
In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Event Instance

(This section applies to the SmartObject with the system name com_K2_System_Reports_SmartObject_AnalyticsEventInstance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Events
  • None
  • Activity Instance ID (Number)
  • Include Server Events (YesNo)
  • Process Instance ID (Number)
  • Range End Date (Date)
  • Range Start Date (Date)
  • Activity Instance ID
  • Activity Name
  • Destination User Display
  • Destination User
  • Duration
  • Escalation Count
  • Event Description
  • Event Instance ID
  • Event Name
  • Event Type
  • Finish Date
  • IPC Count
  • Priority
  • Process Instance ID
  • Start Date
  • Status
 Returns data on workflow events/steps. If no workflow is specified (Process Instance ID), data from all processes is returned (including active and non-active instances). If no event is specified (Event Instance ID), data from all events is returned.

Properties

Name Type Example Notes
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Approve Expense Claim The activity or step name that is set by the workflow designer.
DestinationUser Text K2:Denallix\Administrator The task recipient's account name.
DestinationUserDisplay Text Denallix Administrator The task recipient's display name.
Duration Number 1 The duration of the step.
EscalationCount Number 0 How many times the step has escalated.
EventDescription Text Descriptive name for the event, as specified by the workflow designer.
EventInstanceID Number 1 Event/step ID. This is a system value set by K2.
EventName Text Approve Expense Claim The activity or step name that is set by the workflow designer.
EventType Text
IncludeServerEvents YesNo True This option allows you to include server events (such as sending emails) in reports.
IPCCount Number 0
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
(Range)FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity (event) finished.
In some reports, the date format returned is: 10/11/2019 12:14 PM.
(Range)StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity (event) started.
In some reports, the date format returned is: 10/11/2019 12:14 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

IPC Details

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Process IDs (Text)
  • Process Instance ID (Number)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Average Duration
  • IPC Count
  • Process Instance ID
  • Process Set ID
  • Process Set Name
 Returns details about sub-workflows.

Properties

Name Type Example Notes
AverageDuration Number 1 Average duration of a set of sub-workflows.
IPCCount Number 1 Number of sub-workflows.
ProcessidList Text List of the workflow instance IDs of the sub-workflows.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessSetID Text The workflow definition ID of the sub-workflow.
ProcessSetName Text The workflow definition name of the sub-workflow.
RangeEndDate DateTime 2019-10-11T12:14:38 Returns workflows that started before this date ('To' date).
RangeStartDate DateTime 2019-10-11T12:14:38 Returns workflows that started after this date ('From' date).

Process Data Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Current Value (Text)
  • Data Name (Text)
  • Date Changed (DateTime)
  • Destination (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Current Value
  • Data Name
  • Data Type ID
  • Date Changed
  • Destination
  • Process Instance ID
  • Process Name
 Returns information about audited workflow instance data fields, if auditing is enabled for those fields.

Properties

Name Type Example Notes
Current_Value Text True, String Current value of the data field.
Data_Name Text Service Account Name of the account that changed the data.
DataTypeid Number 1 Indicated the data type of the field.
Date_Changed DateTime 10/11/2019 12:10 PM System value set by K2 for date and time the item was modified. This value is sometimes returned in the following format: 2019-10-11T14:42:35.
Destination Text K2Server Who the step was assigned to.
Process_Name Text DenallixTravelRequest. System value for the workflow name.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.

Process Instance

(This section applies to the SmartObject with the system name com_k2_System_Reports_SmartObject_AnalyticsProcessInstance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Duration (Number)
  • Finish Date (DateTime)
  • Folder (Text)
  • Folio (Text)
  • Include Deleted Status (YesNo)
  • Originator (Text)
  • Priority (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Process Set ID (Number)
  • Start Date (DateTime)
  • Status (Text)
  • ViewFlow (Text)
  • Duration
  • Finish Date
  • Folder
  • Folio
  • Originator
  • Priority
  • Process Instance ID
  • Process Name
  • Process Set ID
  • Start Date
  • Status
  • View Flow
 Returns data on processes/workflows. If no specific process is specified, data from all processes is returned.

Properties

Name Type Example Notes
Duration Number 1 Actual duration of the workflow instance.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the workflow instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request The folder name of the workflow as set by the workflow designer.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
Originator Text K2:Denallix\Administrator The workflow originator's account name.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessInstanceID Number 1 Workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest System value for the workflow name.
ProcessSetID Number 1 Unique value of the workflow definition used to start the workflow instance.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the workflow instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
ViewFlow Text https://k2.denallix.com/ViewFlow/ViewFlow.aspx?ProcessID=1 The URL of the associated View Flow report.

Process Overview

(This section applies to the SmartObject with the system name com_K2_System_Reports_SmartObject_AnalyticsProcessOverview.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Average Duration (Number)
  • Folder (Text)
  • Include Deleted Status (YesNo)
  • Number of Instances (Number)
  • Process Name (Text)
  • Process Set ID (Number)
  • Average Duration
  • Folder
  • Number of Instances
  • Process Name
  • Process Set ID
 Returns data from processes/workflows. This method returns limited data such as the number of instances started per process and the average duration. The Process Instance SmartObject List method returns more detailed data including start and finish dates and the URL for the associated View Flow report.

Properties

Name Type Example Notes
AverageDuration Number 1 Average duration of the workflow.
Folder Text IT Service Request The folder name of the workflow as set by the workflow designer.
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
NumberOfInstances Number 1 Number of process instances started.
ProcessName Text ITServiceRequest.Workflow.Approval System name of the workflow.

Process Set

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
GetUserParticipatingProcessSets
  • UserName (Text)
  • None
  • Description
  • DisplayName
  • Folder
  • FullName
  • ModifiedBy
  • ModifiedDate
  • Name
  • ProcID
  • ProcSetID
IsStartable
  • ProcSetID (Number)
  • None
  • Startable
 Returns a true or false response indicating if the user can start the workflow.
List
  • None
  • FolderName (Text)
  • Description
  • DisplayName
  • Folder
  • FullName
  • ModifiedBy
  • ModifiedDate
  • Name
  • ProcID
  • ProcSetID
 Returns system data for processes/workflows including the process system name (FullName), dates modified, and modifying system or user.
Read
  • FullName (Text)
  • None
  • Description
  • DisplayName
  • Folder
  • FullName
  • ModifiedBy
  • ModifiedDate
  • Name
  • ProcID
  • ProcSetID
 Returns the details for one workflow.
ReadByid
  • ProcSetID (Number)
  • None
  • Description
  • DisplayName
  • Folder
  • FullName
  • ModifiedBy
  • ModifiedDate
  • Name
  • ProcID
  • ProcSetID
 Returns the details for one workflow.
ReadByProcessinfoid
  • ProcessInfoID (Number)
  • None
  • None
 (Not Implemented)

Properties

Name Type Example Notes
Description Text
DisplayName Text Denallix Administrator The workflow designer's display name.
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
FullName Text Denallix Travel Request\DenallixTravelRequest.Workflow.Approval System name and folder for the workflow.
ModifiedBy Text K2:Denallix\Administrator The account name of the last person to modify the workflow.
ModifiedDate DateTime 10/11/2019 12:10 PM System value set by K2. This value is sometimes returned in the following format: 2019-10-11T14:42:35.
Name Text DenallixTravelRequest.Workflow.Approval System name for the workflow.
ProcID Number 1 Workflow ID. This is a system value set by K2.
ProcSetID Number 1 A unique value for the workflow definition. This is a system value set by K2.
Startable YesNo True

Returns a true or false response indicating if the user can start the workflow.

UserName Text K2:Denallix\Administrator The workflow designer's account name.

Task

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
DelegateWorklistItem
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • ActionName (Text)
  • ActionerName (Text)
  • ActionerType (Text)
  • Destination (Text)
  • EventID (Number)
  • Execute (YesNo)
  • ProcInstID (Number)
  • None
  • None
 (Not implemented)
Deserialize
  • None
  • Serialized Item (String) (Memo)
  • ActID
  • ActInstDestID
  • ActionName
  • Actioner
  • ActionerName
  • ActionerType
  • ActivityName
  • AssemblyName
  • Destination
  • EventID
  • EventName
  • FilterXML
  • Folio
  • ID
  • ProcInstID
  • ProcName
  • ProcessInstanceStatus
  • StartDate
  • Status
  • Users (WorklistUser[])
 Returns properties and values from a serialized string.
Deserialize Array
  • None
  • Serialized Array (Memo)
  • Serialized Item (String)
Deserialize Typed Array
  • None
  • Serialized Array (Memo)
  • ActID
  • ActInstDestID
  • ActInstID
  • ActionName
  • Actioner
  • ActionerName
  • ActionerType
  • ActivityName
  • Destination
  • EventID
  • EventName
  • FilterXML
  • Folio
  • ID
  • ProcInstID
  • ProcName
  • ProcessInstanceStatus
  • StartDate
  • Status
  • Users (WorklistUser [])
GetActionInstanceRights
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • EventID (Number)
  • EventID (Number)
  • ProcInstID (Number)
  • ActionName (Text)
  • ActionerName (Text)
  • Destination (Text)
  • ActID
  • ActInstDestID
  • ActInstID
  • ActionName
  • Actioner
  • ActionerName
  • ActionerType
  • EventID
  • Execute
  • ProcInstID
 Lists any action execution rights defined for the specified step.
GetWorklistItems
  • None
  • RegularFilters(RegularFilter[])
  • ActID
  • ActInstDestID
  • ActInstID
  • Destination
  • EventID
  • EventName
  • ProcInstID
 Returns data on active worklist items including the destination user and task status.
RedirectWorklistItem
  • ActInstDestID (Number)
  • ActionerName (Text)
  • Destination (Text)
  • ID (Number)
  • ProcInstID (Number)
  • None
  • None
ReleaseWorklistItem
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • Destination (Text)
  • EventID (Number)
  • ProcInstID (Number)
  • None
  • None
 Releases a previously-opened task.
Serialize
  • None
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • ActionName (Text)
  • Actioner (Actioner) (Memo)
  • ActionerName (Test)
  • ActionerType (Text)
  • ActivityName (Text)
  • AssemblyName (Text)
  • Destination (Text)
  • EventID (Number)
  • EventName (Text)
  • FilterXML (Text)
  • Folio (Text)
  • ID (Number)
  • ProcInstID (Number)
  • ProcName (Text)
  • ProcessInstanceStatus (Text)
  • StartDate (DateTime)
  • Status (Text)
  • Users (WorklistUser[]) (Memo)
  • Serialized Item (String)
 Returns a single serialized string.
Serialize Add Item To Array
  • None
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • ActionName (Text)
  • Actioner (Memo)
  • ActionerName (Text)
  • ActionerType (Text)
  • ActivityName (Text)
  • AssemblyName (Text)
  • Destination (Text)
  • EventID (Number)
  • EventName (Text)
  • FilterXML (Text)
  • Folio (Text)
  • ID (Number)
  • ProcInstID (Number)
  • ProcName (Text)
  • ProcessInstanceStatus (Text)
  • Serialized Array (Memo)
  • StartDate (DateTime)
  • Status (Text)
  • Users (WorklistUser[])
  • Serialized Array
Serialize Item To Array
  • None
  • ActID (Number)
  • ActInstDestID (Number)
  • ActInstID (Number)
  • ActionName (Text)
  • Actioner (Memo)
  • ActionerName (Text)
  • ActionerType (Ext
  • ActivityName (Text)
  • AssemblyName (Text)
  • Destination (Text)
  • EventID (Number)
  • EventName (Text)
  • FilterXML (Text)
  • Folio (Text)
  • ID (Number)
  • ProcInstID (Number)
  • ProcName (Text)
  • ProcessInstanceStatus (Text)
  • StartDate (DateTime)
  • Status (Text)
  • Users (WorklistUser[])
 Serialized Array

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInsDestID Number 1 Unique value for the activity/step and participant. This is a system value set by K2.
ActInstID Number 1 Activity/step ID. This is a system value set by K2.
Actioner Memo {"ActionerType":"User","Name":"K2:DENALLIX\\Administrator"} The entity that actioned the task.
ActionerName Text K2:Denallix\Administrator

The name of the person that actioned the task.

ActionerType Text User

The type of user that actioned the task.

ActionName Text

The action taken on the task.

ActivityName Text Manager_Tasks System name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
AssemblyName Text
Destination Text K2:Denallix\Administrator The original task recipient's account name. May or may not be the same as the actioner in cases where the task was delegated or redirected.
EventID Number 1 Activity/step ID. This is a system value set by K2.
EventName Text Task Activity/step name. This can be a system value set by K2 (such as Task or Send Email)/another value set by the workflow designer.
Execute YesNo True
FilterXML Text
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ID Number 1
ProcessInstanceStatus Text Active The current status of the process instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName Text IT Service Request\ITServiceRequest.Workflow.Approval System name for the workflow.
RegularFilters Memo
Serialized_Array Memo
Serialized_Item_String Memo {"ActID":0,"ActInstDestID":0,"ActInstID":0,"Actioner":null,"ActionerName":null,"ActionerType":null,"ActionName":null,"ActivityName":null,"ActivityDisplayName":null,"Destination":null,"EventID":0,"EventName":null,"Folio":null,"ID":0,"ProcessInstanceStatus":null,"ProcInstID":0,"ProcName":null,"StartDate":"0001-01-01T00:00:00","Status":null,"Users":null} The serialized string is used as an input property for deserialization methods.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Open Current status of the task.
Users (Worklist User[]) Memo List of users that the task is assigned to.

User Overview

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Active Task List
  • None
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Activity ID
  • Activity Instance Destination ID
  • Activity Instance ID
  • Activity Name
  • Process ID
  • Process Instance Folio
  • Process Instance ID
  • Process Instance Originator
  • Process Name
  • Process Set ID
  • Time Since Assigned
 Returns data on active tasks, including the workflow originator and time lapsed since the task was started.
Active Tasks by Activity
  • None
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Active Tasks
  • Activity Name
  • Process Set ID
 Returns a list of activities/steps with active tasks.
Active Tasks by Priority
  • None
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Active Tasks
  • Priority ID
  • Priority Name
 Returns a list of priorities and the number of active tasks for each priority.
Active Tasks by Process Type
  • None
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Active Tasks
  • Process Name
  • Process Set ID
 Returns a list of processes/workflows and the number of active tasks for each process.
Aggregate Stats
  • None
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Active Tasks
  • Completed Tasks
  • Escalated Tasks
 Returns the numbers of active, completed, and escalated tasks. If no input property is specified, returns data on all processes/workflows.
Assigned Tasks
  • Period Grouping (Text)
  • Process IDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Assigned Tasks Count
  • Period
 Returns the number of assigned tasks.
Average Task Duration
  • Period Grouping (Text)
  • ProcessIDs (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • User FQN List (Text)
  • Average Duration
  • Period
 Returns the average task duration.

Properties

Name Type Example Notes
ActivityID Number 1 Activity/step ID. This is a system value set by K2.
ActivityInstanceDestinationID Number 1 Unique value for the activity/step and recipient. This is a system value set by K2.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Initial Request Review Activity/step display name. This value can be set by K2 (Send Email, Task) or by the workflow designer.
ActiveTasks Number 1 Number of active workflow tasks.
AssignedTasks Number 1
AverageDuration Number 1 Average duration of process instance/workflow instance tasks.
CompletedTasks Number 1 Number of completed workflow tasks.
EscalatedTasks Number 1 Number of escalated workflow tasks.
Period Text
PeriodGrouping Text Year

Year, Quarter, Month, Week, Day, Hour.
PriorityID Number 1 Priority ID set by K2.
PriorityName Text Medium Priority name set by K2 or by the workflow designer.
Results can include: High, Medium, Low, Undefined.
ProcessID Number 1 Process instance/workflow instance ID.
ProcessidList Text
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
Process Instance Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcessInstanceOriginator Text Denallix Administrator The workflow originator's display name.
ProcessSetID Number 1 A unique value for the workflow definition. This is a system value set by K2.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
RangeEndDate DateTime 2019-10-11T12:14:38 'To' date.
RangeStartDate DateTime 2019-10-11T12:14:42 'From' date.
TimeSinceAssigned Number 1 Time elapsed since the task was assigned.
UserFQNList Text

Workflow Instance

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
All Process Instances
  • None
  • Process IDs (Text)
  • Process Instance ID List (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Status ID List (Text)
  • Duration
  • Finish Date
  • Is IPC Process
  • Priority
  • Process ID
  • Process Instance Folio
  • Process Instance ID
  • Process Instance Originator
  • Process Set ID
  • Process Set Name
  • Start Date
  • Status
  • View Flow
 Returns data on all workflow instances.
Get Process Instance Detail
  • None
  • Participation (Text)
  • Process Full Name (Text)
  • Process Version (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Selected Users (Text)
  • Status (Text)
  • Duration
  • Priority
  • Process Full Name
  • Process ID
  • Process Instance Folio
  • Process Instance ID
  • Process Instance Originator Display
  • Process Instance Originator
  • Process Set ID
  • Process Set Name
  • Process Version
  • Start Date
  • Status
 Returns workflow instance details. If no input properties are specified, data on all processes/workflows is returned.
Get Process Instance Detail Statistics
  • Process Instance ID (Number)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Active Tasks
  • Duration
  • Finish Date
  • Is IPC Process
  • Priority
  • Process Escalations
  • Process ID
  • Process Instance Folio
  • Process Instance ID
  • Process Instance Originator Display
  • Process Instance Originator
  • Process Set ID
  • Process Set Name
  • Range Start Date
  • Started
  • Status
  • Time Since Last Activity in Seconds
 Returns data on one process instance.
Get Process Instance Summary By Period
  • Period Grouping (Text)
  • Participation (Text)
  • Process Full Name (Text)
  • Process Version (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Selected Users (Text)
  • Status (Text)
  • Day
  • Duration
  • Hour
  • Instance Count
  • Month
  • Process Full Name
  • Process Set ID
  • Process Set Name
  • Process Version
  • Quarter
  • Week
  • Year
 Returns data on workflow instances falling within the specified interval range.
Get Process Instance Summary By Process
  • None
  • Participation (Text)
  • Process Full Name (Text)
  • Process Version (Text)
  • Range End Date (DateTime)
  • Range Start Date (DateTime)
  • Selected Users (Text)
  • Status (Text)
  • Duration
  • Instance Count
  • Process Full Name
  • Process Set ID
  • Process Set Name
  • Process Version
 Returns data on workflow instances. If no input property is specified, data for all processes is returned.

Properties

Name Type Example Notes
ActiveTasks Number 1 Number of active tasks.
Day DateTime
DisplayAllVersions YesNo True Include all versions of the workflow.
Duration Number 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the workflow finished. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Hour Number 1
InstanceCount Number 1
IPC Text
Month Number 1
Participation Text
PeriodGrouping Text Year

Year, Quarter, Month, Week, Day, Hour.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProccessSetID Number 1 A unique value for the workflow definition. This is a system value set by K2.
ProcessEscalations Number 1 Number of times the workflow has escalated.
ProcessFullName Text IT Service Request\ITServiceRequest.Workflow.Approval System name and path for the workflow.
ProcessID Number 1 Unique value for the workflow definition. This is a system value set by K2.
ProcessidList Text
ProcessInstanceFolio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessInstanceidList Text
ProcessInstanceOriginator Text K2:Denallix\Administrator The workflow originator's account name.
ProcessInstanceOriginatorDisplay Text Denallix Administrator The workflow originator's display name.
ProcessSetFolder Text IT Service Request Folder/category where the workflow is saved.
ProcessSetFullName Text ITServiceRequest.Workflow.Approval The full name of the workflow definition.
ProcessSetName Text The name of the workflow.
ProcessVersion Text 1 Workflow version number.
Quarter Number 1
RangeEndDate DateTime 2019-10-11T12:14:42 'To' date.
RangeStartDate DateTime 2019-10-11T12:14:38 'From' date.
SinceLastActDate Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the workflow instance started.
In some reports, the date format returned is: 10/11/2019 1:41 PM.
Started Number 1
Status Text Active The current status of the workflow instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
StatusidList Text
UserCsv Text
ViewFlow Text https://k2.denallix.com/ViewFlow/ViewFlow.aspx?ProcessID=10 The URL of the associated View Flow report.
Week Number 1
Year Number 1

Workflow Status

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Status
  • None
  • GroupName
  • Status
  • StatusID
 Returns a list of workflow status values.

Properties

Name Type Example Notes
GroupName Text
Status Text Active

Possible statuses of workflow instances.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
StatusID Number 1 Unique value for the Status ID.
  • This content applies to legacy design tools (such as K2 Studio or K2 for Visual Studio). If you have upgraded from K2 blackpearl 4.7, these tools may still be available in your environment. These legacy tools may not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.
  • The SmartObjects listed below are related to workflows created in the legacy designers.

The tables below display the methods and properties returned by workflow report SmartObjects. Note that not all properties are returned for all methods.

Activity Data

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Instance Destination ID (Number)
  • Activity Instance ID (Number)
  • Data Name (Text)
  • Data Value (Text)
  • Destination (Text)
  • Process Instance ID (Number)
  • Activity InstanceDestination ID
  • Activity Instance ID
  • Data Name
  • Data Value
  • Destination
  • Process Instance ID
 Returns activity-level datafields.

Properties

Name Type Example Notes
ActivityInstanceDestinationID Number 1 Unique value for the step and recipient for the step instance.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
DataName Text Name of the data field.
DataValue Text Value of the data field.
Destination Text The recipient of the step.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.

Activity Instance

(This section applies to the SmartObject with the system name Activity_Instance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Display Name (Text)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Duration ( Number)
  • Expected Duration (Number)
  • Finish Date (DateTime)
  • Priority (Text)
  • Process Instance ID (Number)
  • Start Date (DateTime)
  • Status (Text)
  • Activity Display Name
  • Activity Instance ID
  • Activity Name
  • Duration
  • Expected Duration
  • Finish Date
  • Priority
  • Process Instance ID
  • Start Date
  • Status
 Returns data on active and non-active activities/steps. If no input properties are specified, returns data on all activities.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Task Activity/step display name. This value can be set by K2 (Task, Send Email) or by the workflow designer.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text

Manager Task

 Activity/step name. This value can be set by K2 (Task, Send Email) or by the workflow designer.
Duration Number 1 Actual duration of the step.
ExpectedDuration Number 1 Expected duration of the step as defined by the workflow designer.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity finished.
In some reports, the date format returned is: 10/11/2019 1:52 PM.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Activity Instance Destination

(This section applies to the SmartObject with the system name Activity_Instance_Destination.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Display Name (Text)
  • Activity ID (Number)
  • Activity Instance Destination ID (Number)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Destination (Text)
  • Duration (Number)
  • Expected Duration (Number)
  • Final Action (Text)
  • Finish Date (DateTime)
  • Folio (Text)
  • Process Folder (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Start Date (DateTime)
  • Status (Text)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Instance ID
  • Activity Name
  • Destination
  • Duration
  • Expected Duration
  • Final Action
  • Finish Date
  • Folio
  • Process Folder
  • Process Instance ID
  • Process Name
  • Start Date
  • Status
 Returns data on active and non-active activity/step destinations including status, task recipient, and final action.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Task Activity/step display name. This value can be set by K2 (Task, Send Email) or by the workflow designer.
ActivityID Number 1 Activity/step ID. This is a system value set by K2.
ActivityInstanceDestinationID Number 1 Unique value for the step and recipient. This is a system value set by K2.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Manager_Tasks The system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
Destination Text Recipient of the step.
Duration Number 1 Actual duration of the step.
ExpectedDuration Number 1

Expected duration of the step as defined by the workflow designer.

Final_Action Text Approve Task action selected by the assigned task recipient.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcessFolder Text Denallix Travel Request Folder/category where the workflow is saved.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Activity Slot Data

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Instance ID (Number)
  • Activity Instance Slot ID (Number)
  • Data Name (Text)
  • Data Value (Text)
  • Destination (Text)
  • Process Instance ID (Number)
  • Activity Instance ID
  • Activity Instance Slot ID
  • Data Name
  • Data Value
  • Destination
  • Process Instance ID
 Returns data for activity/step instance data fields.

Properties

Name Type Example Notes
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityInstanceSlotID Number 1 Unique value of the step and recipient. This is a system value set by K2.
DataName Text Name of the activity data field.
DataValue Text Value of the activity data field.
Destination Text Recipient of the step.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.

Activity Slot XML

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Instance ID (Number)
  • Activity Instance Slot ID (Number)
  • Destination (Text)
  • Process Instance ID (Number)
  • XML Name (Text)
  • XML Value (Text)
  • Activity Instance ID
  • Activity Instance Slot ID
  • Destination
  • Process Instance ID
  • XML Name
  • XML Value

Properties

Name Type Example Notes
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityInstanceSlotID Number 1
Destination Text
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
XMLName Text Name of the XML datafield.
XMLValue Text Value of the XML datafield.

Activity XML

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Instance Destination ID (Number)
  • Activity Instance ID (Number)
  • Destination (Text)
  • Process Instance ID (Number)
  • XML Name (Text)
  • XML Value (Text)
  • Activity Instance Destination ID
  • Activity Instance ID
  • Destination
  • Process Instance ID
  • XML Value
  • XML Name

Returns data for activity/step instance XML data fields.

Properties

Name Type Example Notes
ActivityInstanceDestinationID Number 1 Unique value for the step and recipient. This is a system value set by K2.
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
Destination Text Recipient of the step.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
XMLName Text Name of the XML datafield.
XMLValue Text Value of the XML datafield.

Event Instance

(This section applies to the SmartObject with the system name Event_Instance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Display Name (Text)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Destination (Text)
  • Duration (Number)
  • Event Name (text)
  • Finish Date (DateTime)
  • Priority (Text)
  • Process Instance ID (Number)
  • Start Date (DateTime)
  • Status (text)
  • Activity Display Name
  • Activity Instance ID
  • Activity Name
  • Destination
  • Duration
  • Event Name
  • Finish Date
  • Priority
  • Process Instance ID
  • Start Date
  • Status
 Returns data on completed activities/steps.

Properties

Name Type Example Notes
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Manager_Tasks The system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces). This value can be set by K2 (Task, Send Email) or by the workflow designer.
Destination Text K2Server The destination/recipient of the step.
Duration Number

1

 Actual duration of the step.
EventName Text Set Status as Closed Name of the step.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Process Data

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Data Name (Text)
  • Data Value (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Data Name
  • Data Type ID
  • Data Value
  • Process Instance ID
  • Process Name
 Returns data on workflow data fields/variables.

Properties

Name Type Example Notes
DataName Text InstanceID Name of the data field/variable.
DataTypeid Number 1 Indicated the data type of the data field/variable.
DataValue Text ce2c6609-9d67-4224-8778-fa64d024454c Value of the data field/variable.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.

Process Definition

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Definitions
  • None
  • Business Owner (Text)
  • Change Date (DateTime)
  • Expected Duration (Number)
  • Full Name (Text)
  • Log Level (Number)
  • Priority (Text)
  • Process ID (Number)
  • Process Set ID (Number)
  • Technical Owner (Text)
  • Version (Number)
  • Business Owner
  • Change Date
  • Expected Duration
  • Full Name
  • Log Level
  • Priority
  • Process ID
  • Process Set ID
  • Technical Owner
  • Version
 Returns a list of workflow versions deployed (published) to the K2 server, including the deploy date and time.

Properties

Name Type Example Notes
BusinessOwner Text
ChangeDate DateTime 10/11/2019 12:10 PM System value set by K2 for date and time the item was modified. This value is sometimes returned in the following format: 2019-10-11T14:42:35.
ExpectedDuration Number 1 Expected duration of the workflow as defined by the workflow designer.
FullName Text com.K2.System.AppWizard\AppCatalog.Error.Workflow Folder and name of the workflow.
LogLevel Number 1
Priority Text High Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessID Number 1 Workflow ID. This value is set by K2.
ProcessSetID Number 1 Unique value for the workflow definition. This value is set by K2.
TechnicalOwner Text
Version Number 1 Version number of the workflow definition.

Process Instance

(This section applies to the SmartObject with the system name Process_Instance.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Duration (Number)
  • Finish Date (DateTime)
  • Folder (Text)
  • Folio (Text)
  • Include Deleted Status (YesNo)
  • Originator (Text)
  • Priority (Text)
  • Process Instance ID (Number)
  • Process Set ID (Number)
  • Start Date (DateTime)
  • Status (Text)
  • View Flow (Text)
  • Duration
  • Finish Date
  • Folder
  • Folio
  • Originator
  • Priority
  • Process Instance ID
  • Process Name
  • Process Set ID
  • Start Date
  • Status
  • View Flow
 Returns data on active and non-active workflow instances. Returns a single entry for each version deployed.

Properties

Name Type Example Notes
Duration Number 1 Actual duration of the workflow instance.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the workflow instance finished.
In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request Folder where the workflow definition is saved.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
IncludeDeletedStatus YesNo True Include workflows with 'Deleted' status, or not.
Originator Text K2:Denallix\Administrator The workflow originator's account name.
Priority Text Medium Typically, the workflow designer sets this value. If no value is set, the default is Medium.
Results can include: High, Medium, Low, Undefined.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcessSetID Number 1 Unique value for the workflow definition. This is a system value set by K2.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the workflow instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
ViewFlow Text https://k2.denallix.com/ViewFlow/ViewFlow.aspx?ProcessID=3 The URL for the associated View Flow report.

Process Overview

(This section applies to the SmartObject with the system name Process_Overview.)

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Average Duration (Number)
  • Folder (Text)
  • Include Deleted Status (YesNo)
  • Number of Instances (Number)
  • Process Name (Text)
  • Process Set ID (Number)
  • Average Duration
  • Folder
  • Number of Instances
  • Process Name
  • Process Set ID
 Returns a list of processes/workflows deployed to the K2 server.

Properties

Name Type Example Notes
AverageDuration Number 1 Average duration for instances of this workflow.
Folder Text IT Service Request Folder/category where the workflow is saved.
IncludeDeletedStatus YesNo True Include workflows with 'Deleted' status, or not.
NumberOfInstances Number 1 Number of workflow instances started.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcessSetID Number 1

Unique value for the workflow definition. This is a system value set by K2.

Process XML

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Process Instance ID (Number)
  • Process Name (Text)
  • XML Value (Text)
  • XMLName (Text)
  • Process Instance ID
  • Process Name
  • XML Name
  • XML Value
 Retrieves workflow instance XML data.

Properties

Name Type Example Notes
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
XMLName Text ItemReferences Name of the XML datafield.
XMLValue Text <itemReferences><itemReference name="App_Wizard_Header"displayName="App Wizard Header" type="SmartObjectItem"primary="false"><settings><method><objectName>com_K2AppGenerationWizard_SmartObject_ApplicationHeader</objectName><objectTypes><type>Table</type></objectTypes><methodName>Load</methodName><methodType>read</methodType><filter /></method></settings><definition></definition><items lastId="1"><item id="1"><properties><property name="ApplicationHeaderID">7e4f90ef-0a20-4301-bbee-b97a9347c985</property></properties><parameters /></item></items></itemReference></itemReferences> Value of the XML datafield.

The tables below display the methods and properties returned by workflow report SmartObjects. Note that not all properties are returned for all methods.

Activity Data Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • Activity Instance Destination ID (Number)
  • Activity Instance ID (Number)
  • Current Value (Text)
  • Data Name (Text)
  • Date Changed (DateTime)
  • Destination (Text)
  • Process Instance ID (Number)
  • Activity Instance Destination ID
  • Activity Instance ID
  • Current Value
  • Data Name
  • Date Changed
  • Destination
  • Process Instance ID
 Returns audit data for activity data fields (if auditing is enabled for the activity data field).

Properties

Name Type Example Notes
ActDestID Number 1 ID of the destination/recipient of the step/activity.
ActInstID Number 1 Activity/step ID. This is a system value set by K2.
Current_Value Text Value of the data field.
Data_Name Text Name of the data field.
Date_Changed DateTime 10/11/2019 12:10 PM System value set by K2 for the date and time the item was modified. This value is sometimes returned in the following format: 2019-10-11T14:42:35.
Destination Text

Destination/recipient of the step/activity.

ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.

Activity Graph

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Activity Graph
  • Event Type (Number)
  • From Date (DateTime)
  • Proc Full Name (Text)
  • Process Status (Number)
  • To Date (Datetime)
  • None
  • Activity Display Name
  • Activity Name
  • Duration
  • Instance Count
  • Process Full Name
 Returns summarized activity instance reporting data.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Task Activity/step display name. This value can be set by K2 (Task, Send Email) or by the workflow designer.
ActName Text Manager_Tasks The system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
InstanceCount Number 1 Number of instances for the activity.

Activity Instance Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Activity Instance Audit
  • None
  • Activity Display Name (Text)
  • Activity Instance ID (Number)
  • Activity Name (Text)
  • Audit Description (Text)
  • Date (DateTime)
  • Folio (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • User Name (text)
  • Activity Display Name
  • Activity Instance ID
  • Activity Name
  • Audit Description
  • Date
  • Folio
  • Process Instance ID
  • Process Name
  • User Name
 Returns a list of audit results for each activity/step. If no input property is specified, data for all activities is returned.

Properties

Name Type Example Notes
ActInstID Number 1 Activity/step instance ID. This is a system value set by K2.
ActivityDisplayName Text Name Create Header Reference Display name of the step.
ActName Text CreateHeaderReference System name for the activity/step.
AuditDescription Text Event Create Header Reference finished Descriptive name for the audit entry.
Date DateTime 2019-10-11T12:14:38 Timestamp for the audit entry.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName Text CustomerResponseSurvey.Workflow.SurveyMaintenance System name for the workflow.
UserName Text K2Server The user name that interacted with the step instance.

Activity Instance XML Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Activity Instance XML Audit
  • None
  • Activity Instance ID (Number)
  • Current Value (Text)
  • Data Name (Text)
  • Date Changed (DateTime)
  • Destination (Text)
  • Folio (Text)
  • Location (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • Activity Instance ID
  • Current Value
  • Data Name
  • Date Changed
  • Destination
  • Folio
  • Location
  • Process Instance ID
  • Process Name
 Returns audit data for activity XML fields (if auditing is enabled for those fields).

Properties

Name Type Example Notes
ActInstID Number 1 Activity/step ID. This is a system value set by K2.
Date DateTime 2019-10-11T12:14:38 Timestamp of the audit event.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Location Text
Name Text
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName Text System name for the workflow.
UserName Text Name of the user who edited the data.
Value Text Value of the data field.

Activity Statistics

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
ListActivityStatistics
  • None
  • Include Delete Status (YesNo)
  • AvgTime
  • BestFolder
  • BestName
  • BestTime
  • Duration
  • Folder
  • Instances
  • ProcessName
  • WorstFolder
  • WorstName
  • WorstTime
 Returns data on activities/steps including number of activity instances and duration for each instance.

Properties

Name Type Example Notes

AvgTime

 Number 1 Average time for the activity.
BestFolder Text  
BestName Text

 
BestTime Text

 
Duration Number 1
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
NumberInstances Number 1 Number of workflow instances started.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
WorstFolder Text

 
WorstName Text

 
WorstTime Number 1

 

Activity Statistics Graph

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Activity Statistics Graph
  • Activity Status (Number)
  • Every Type (Number)
  • From Date (DateTime)
  • Include Deleted Status (YesNo)
  • Process Full Name (Text)
  • To Date (DateTime)
  • Value Type (Number)
  • Version (Text)
  • Include Deleted Status (YesNo)
  • Activity Display Name
  • Activity Name
  • Duration
  • Full Name
  • Instances
 Returns summarized data about activity instances.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActivityName Text System name for the activity/step. This value can be set by K2 (Task, Send Email) or by the workflow designer.
Duration Number Actual duration of the activity.
FullName Text
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
Instances Number Number of activity/step instances started.

Interval Graph

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Interval Graph
  • From Date (DateTime)
  • Period (Number)
  • Proc Full Name (Text)
  • Process Status (Number)
  • To Date (DateTime)
  • None
  • Duration
  • Instance Count
  • Period1
  • Period2
 Returns summarized data about process instances in a given interval.

Properties

Name Type Example Notes
Duration Number 1 Average duration of workflow instances in the specified interval.
InstanceCount Number 1 Number of workflow instances in the specified interval.
Period1 Text
Period2 Text

Process Activities

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • Process ID (Number)
  • None
  • Activity Display Name
  • Activity Name
  • Process ID
 Returns a list of activities/steps from a single workflow.

Properties

Name Type Example Notes
Activity_Name Text Manager_Tasks This is the system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
Process_ID Number 1

Process Activity Instances

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Activity Instances
  • From Date (DateTime)
  • Proc Full Name (Text)
  • Process Count (Number)
  • Process Status (Number)
  • Started Only (YesNo)
  • To Date (DateTime)
  • None
  • Activity Name
  • Duration
  • Folio
  • Full Name
  • Process ID
  • Process Instance ID
  • Process Name
  • Start Date
  • Status
 Returns data about activity/step instances in a workflow.

Properties

Name Type Example Notes
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActName Text Manager_Tasks This is the system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
Duration Number 1 Actual duration of the activity/step instances.
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcFullName Text  
ProcID Number 1 Workflow ID. This is a system value set by K2.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName Text System name for the workflow.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Process Graph

Methods

Name Required Input Properties Optional Input Properties Returned Properties Notes
Process Graph
  • Event Type (Number)
  • From Date (DateTime)
  • Proc Full Name (Text)
  • Process Count (Number)
  • Process Status (Number)
  • To Date (DateTime)
  • None
  • Duration
  • Full Name
  • Instance Count
  • Process Name

Returns summarized data about workflow instances in a given interval.

Properties

Name Type Example Notes
Duration Number 1 Average duration of workflow instances in the specified interval.
InstanceCount Number 1 Number of workflow instances in the specified interval.
ProcFullName Text Display name for the workflow.
ProcName Text System name for the workflow.

Process Information

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Information
  • Event Type (Text)
  • From Date (DateTime)
  • Full Name (Text)
  • Process Count (Number)
  • Status (Text)
  • To Date (DateTime)
  • Value Type (Number)
  • None
  • Duration
  • Folder
  • Full Name
  • Instances
  • Process Name

Properties

Name Type Example Notes
Duration Number 1 Average duration for the specified interval.
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
FullName Text
Instances Number 1 Number of instances for the specified interval.
ProcessName

Text

 DenallixTravelRequest.Workflow.Approval System value for the workflow name.

Process Instance Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Instance Audit
  • None
  • Audit Description (Text)
  • Date (DateTime)
  • Folio (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • User Name (Text)
  • Audit Description
  • Date
  • Folio
  • Process Instance ID
  • Process Name
  • User Name

Properties

Name Type Example Notes
AuditDescription Text Process started
Date DateTime 10/16/2019 3:16 PM
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName Text DenallixTravelRequest.Workflow.Approval System name for the workflow.
UserName Text K2:DENALLIX\Administrator

Process Instance XML Audit

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Instance XML Audit
  • None
  • Date (DateTime)
  • Folio (Text)
  • Location (Text)
  • Name (Text)
  • Process Instance ID (Number)
  • Process Name (Text)
  • User Name (Text)
  • Value (Text)
  • Date
  • Folio
  • Location
  • Name
  • Process Instance ID
  • Process Name
  • User Name
  • Value

Properties

Name Type Example Notes
Date DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Location Text
Name Text Name of the XML datafield.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
ProcName

Text
UserName Text Name of the user that changed the data.
Value Text Value of the XML datafield.

Process Sets

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Sets
  • None
  • Folder (Text)
  • Folder
  • Process Full Name
  • Process Name
  • Process Set ID
 Returns a list of workflow definitions.

Properties

Name Type Example Notes
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
FullName Text Denallix Travel Request\DenallixTravelRequest.Workflow.Approval System value including path for the workflow.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow.
ProcSetID Number 1 Unique value for the workflow definition. This is a system value set by K2.

Process Statistics

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
ListProcessStatistics
  • None
  • Include Deleted Status (YesNo)
  • BestName
  • BestTime
  • Duration
  • Folder
  • Instances
  • ProcessName
  • WorstName
  • WorstTime
 Returns data on processes/workflows. Data returned includes best and worst times, and the number of instances.

Properties

Name Type Example Notes
AvgTime Text Average time for the workflow instances.
BestName Text  
BestTime Text  
Duration Number 1 Average duration of the workflows.
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
Instances Number 1 Number of workflow instances started.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
WorstName

Text

 
WorstTime Text

 

Process Statistics Graph

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
ListProcessStatisticsGraph
  • FromDate (DateTime)
  • FromMonth (Number)
  • FromYear (Number)
  • Period (Text)
  • ProcFolder (Text)
  • ProcName (Text)
  • ToDate (DateTime)
  • TotalMonths (Number)
  • ValueType (Number)
  • None
  • Date Value
  • Duration
  • Instances
  • Max Value
  • Status
 Returns summarized data about workflow instances.

Properties

Name Type Example Notes
DateValue Text
Duration Number 1
Instances Number 1
MaxValue Number 1
Status Number 1

Process Version Count

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • Process Set ID (Number)
  • None
  • Process Count
 Returns the number of versions deployed for a specific workflow.

Properties

Name Type Example Notes
Process_Count Number 1 Number of versions.
Process_ID Number 1 Unique ID of the workflow definition.

ProcessPerformanceDayOnDay

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Day On Day
  • Month (Text)
  • Week (Text)
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Average Duration
  • Day
  • Expected Duration
  • Folder
  • Maximum Duration
  • Minimum Duration
  • Process Full Name
  • Process Set ID
  • Status
 Returns a list of process instance statistics including duration and status. Results are returned for the week, month, and year specified.

Properties

Name Type Example Notes
AvgDuration Decimal 1
DataLevel Number 1
Day DateTime 10/11/2019 8:23 AM
ExpectedDuration Decimal 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
Proc Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status

Text

 Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceDayOnDayActivity

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Day On Day Activity
  • Day (Text)
  • Month (Text)
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Name
  • Average Duration
  • Destination
  • Expected Duration
  • Maximum Duration
  • Minimum Duration
  • Process Name
  • Process Set ID

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActivityName Text Manager_Tasks This is the system name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
AvgDuration Decimal 1 Average duration.
DataLevel Number 1
Day Text 1 Day number, 1 through 31.
Destination Text
ExpectedDuration Decimal 1
Folder Text Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceDayOnDayDetail

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Day On Day Detail
  • None
  • Activity ID (Number)
  • Process Set ID (Number)
  • StartDate (DateTime)
  • User (Text)
  • None

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActInstDestUser Text User/participant associated with the step.
DataLevel Number 1
Duration Number 1
EventName Text
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Month Text
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text
Year Text

ProcessPerformanceMonthOnMonth

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Month On Month
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Average Duration
  • Expected Duration
  • Folder
  • Maximum Duration
  • Minimum Duration
  • Month
  • Process Full Name
  • Process Set ID
  • Status
 Returns a list of process instance statistics including duration and status. Results are returned for the year specified.

Properties

Name Type Example Notes
AvgDuration Decimal 1
DataLevel Number 1
Day DateTime 10/11/2019 8:23 AM
ExpectedDuration Decimal 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
Proc Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status

Text

 Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceMonthOnMonthActivity

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Month On Month Activity
  • Month (Text)
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Name
  • Average Duration
  • Destination
  • Expected Duration
  • Maximum Duration
  • Minimum Duration
  • Process Name
  • Process Set ID

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActivityName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
AvgDuration Decimal 1
DataLevel Number 1
Day Text 1 Day number, 1 through 31.
Destination Text
ExpectedDuration Decimal 1
Folder Text
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceMonthOnMonthDetail

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Month On Month Detail
  • None
  • Activity ID (Number)
  • Month (Text)
  • Process Set ID (Number)
  • User (Text)
  • Year (Text)
  • None

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActInstDestUser Text Participant/user associated with the step.
DataLevel Number 1
Duration Number 1
EventName Text Name of the step/event.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Month Text
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text
Year Text

ProcessPerformanceWeekOnWeek

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Week On Week
  • Month (Text)
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Proc (Number)
  • Average Duration
  • Expected Duration
  • Folder
  • Maximum Duration
  • Minimum Duration
  • Process Full Name
  • Process Set ID
  • Status
  • Week
 Returns a list of process instance statistics including duration and status. Results are returned for the month and year specified.

Properties

Name Type Example Notes
AvgDuration Decimal 1
DataLevel Number 1
Day DateTime 10/11/2019 8:23 AM
ExpectedDuration Decimal 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
Proc Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status

Text

 Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceWeekOnWeekActivity

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Week On Week Activity
  • Month (Text)
  • Week (Text)
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Name
  • Average Duration
  • Destination
  • Expected Duration
  • Maximum Duration
  • Minimum Duration
  • Process Name
  • Process Set ID

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1 Unique ID for the activity instance and recipient. This is a system value set by K2.
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActivityName Text Manager Tasks Activity/step display name. This value is set by the workflow designer.
AvgDuration Decimal 1
DataLevel Number 1
Day Text 1 Day number, 1 through 31.
Destination Text
ExpectedDuration Decimal 1
Folder Text Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceWeekOnWeekDetail

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Week On Week Detail
  • None
  • Activity ID (Number)
  • Month (Text)
  • Process Set ID (Number)
  • User (Text)
  • Week (Text)
  • Year (Text)
  • None

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActInstDestUser Text Participant/user for the activity instance.
DataLevel Number 1
Duration Number 1
EventName Text System name for the activity/step. This value is set by K2.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Month Text
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text
Year Text

ProcessPerformanceYearOnYear

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Year On Year
  • None
  • Finish Date (DateTime)
  • Folder (Text)
  • Start Date (DateTime)
  • Status (Text)
  • Average Duration
  • Expected Duration
  • Folder
  • Maximum Duration
  • Minimum Duration
  • Process Full Name
  • Process Set ID
  • Status
  • Year

Properties

Name Type Example Notes
AvgDuration Decimal 1
DataLevel Number 1
Day DateTime 10/11/2019 8:23 AM
ExpectedDuration Decimal 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folder Text IT Service Request Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
Proc Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status

Text

 Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceYearOnYearActivity

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Year On Year Activity
  • Year (Text)
  • DataLevel (Number)
  • Folder (Text)
  • Process Set ID (Number)
  • Activity Display Name
  • Activity ID
  • Activity Instance Destination ID
  • Activity Name
  • Average Duration
  • Destination
  • Expected Duration
  • Maximum Duration
  • Minimum Duration
  • Process Name
  • Process Set ID

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1 Unique number for the activity instance and participant. This is a system value set by K2.
ActivityDisplayName Text Manager Tasks Activity/step name. This value is set by the workflow designer.
ActivityName Text Manager Tasks Activity/step display name. This value is set by the workflow designer.
AvgDuration Decimal 1
DataLevel Number 1
Day Text 1 Day number, 1 through 31.
Destination Text
ExpectedDuration Decimal 1
Folder Text Denallix Travel Request Folder/category where the workflow is saved.
MaxDuration Decimal 1
MinDuration Decimal 1
Month Text 1 Month number, 1 through 12.
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
Week Text 1 Week number, 1 through 52.
Year Text 2019 Year number.

ProcessPerformanceYearOnYearDetail

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Process Performance Year On Year Detail
  • None
  • Activity ID (Number)
  • Activity Instance Destination ID (Number)
  • Process Set ID (Number)
  • User (Text)
  • Year (Text)
  • None

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActInstDestID Number 1

Unique value for the activity/step and participant. This is a system value set by K2.
ActInstDestUser Text Participant/user associated with the step.
DataLevel Number 1
Duration Number 1
EventName Text System name for the activity/step. This value is set by K2.
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the process instance finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
Month Text
ProcSetID Number 1
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the process instance started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
Week Text
Year Text

User Performance

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
ListUserPerformance
  • None
  • Include Deleted Status (YesNo)
  • AvgTime
  • BestFolder
  • BestName
  • BestTime
  • Duration
  • Folder
  • Instances
  • ProcessName
  • WorstFolder
  • WorstName
  • WorstTime
 Returns a list of processes/workflows including the duration.

Properties

Name Type Example Notes
AvgTime Number 1
BestFolder Text
BestName Text
BestTime Number 1
Duration Number 1
Folder Text IT Service Request Folder/category where the workflow is saved.
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
Instances Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
WorstFolder Text
WorstName Text
WorstTime Number 1

User Performance Graph

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
ListUserPerformanceGraph
  • ActName (Text)
  • FromDate (DateTime)
  • ProcFolder (Text)
  • ProcName (Text)
  • ToDate (DateTime)
  • ValueType (Number)
  • Include Deleted Status (YesNo)
  • Activity Display Name
  • Destination User
  • Duration
  • Instances
  • Max Value
 Returns summarized information about user performance.

Properties

Name Type Example Notes
Activity_Display_Name Text Manager Tasks Activity/step name. This value is set by the workflow designer.
Destination_User Text K2:Denallix\Administrator
Duration Number 1
IncludeDeletedStatus YesNo True Whether to include workflows that were deleted, or not.
Instances Number 1 Number of workflow instances started.
Max_Value Number 1

UserWorkload

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List User Workload
  • None
  • Folder (Text)
  • Activity ID
  • Activity Name
  • Process Full Name
  • Process Instance Count
  • User Name
 Returns a list of users and activities/steps associated with the users.

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
ActivityName Text Manager_Tasks System name for the activity. It is often the same value as the Activity Display Name (but typically without spaces).
Folder Text IT Service Request Folder/category where the workflow is saved.
InstanceCount Number 1
ProcessName Text DenallixTravelRequest.Workflow.Approval System value for the workflow name.
ProcSetID Number 1
UserName Text K2:Denallix\Administrator

UserWorkloadDetail

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List User Workload Detail
  • None
  • Activity ID (Number)
  • Date Diff
  • Finish Date
  • Folio
  • Process Instance ID
  • Start Date
  • Status
  • User Name
  • Worklist Item
 Returns a list of workflow instances for a specific activity.

Properties

Name Type Example Notes
ActID Number 1 Activity/step ID. This is a system value set by K2.
DateDiff Decimal 1
FinishDate DateTime 2019-10-11T12:14:42 The hour and minute the activity finished. In some reports, the date format returned is: 10/11/2019 1:52 PM.
Folio Text Request Ref Number: 1276 Typically a unique, human-readable identifier for the workflow instance.
ProcInstID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
StartDate DateTime 2019-10-11T12:14:38 The hour and minute the activity started. In some reports, the date format returned is: 10/11/2019 1:41 PM.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
UserName Text K2:Denallix\Administrator
WorklistItem Number 1

UserWorkloadMeasure

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List User Workload Measure
  • Activity Instance ID (Number)
  • Direction (Number)
  • Destination
  • Direction
  • Instance Count
 Returns a list of destination users and the number of instances for a specific activity/step.

Properties

Name Type Example Notes
ActInstID Number 1 Activity/step ID. This is a system value set by K2.
Destination Text K2Server The recipient/user associated with the task.
Direction Number 1
InstanceCount Number 1 Number of workflow instances started.

Workflow Participant

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • None
  • Activity Instance Destination ID
  • Activity Instance ID
  • Destination User
  • Process Instance ID
  • Status
 Returns a list of all destination users and the activities/steps associated with the user.

Properties

Name Type Example Notes
ActivityInstanceDestinationID Number 1
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
DestinationUser Text K2:Denallix\Administrator The participant/user associated with the step/task.
ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

Workflow_Activity_Destination

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List
  • None
  • None
  • Activity Description
  • Activity Instance ID
  • Destination User
  • Process Instance ID
  • Status
 Returns a list of destination users and the Process Instance IDs and Activity Instance IDs associated with the user.

Properties

Name Type Example Notes
ActivityDescription Text AssignedTo
ActivityInstanceID Number 1 Activity/step ID. This is a system value set by K2.
DestinationUser Text K2Server

The participant/user associated with the step/task.

ProcessInstanceID Number 1 Process instance/workflow instance ID. This is a system value set by K2.
Status Text Active The current status of the activity instance. both active and non-active status results.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.

WorkflowActivityStatus

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Activity Status
  • None
  • GroupName (Text)
  • Status
  • StatusID
 Returns a list of activity/step status options.

Properties

Name Type Example Notes
GroupName Text
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Expired, Waiting.
StatusID Number 1

WorkflowDestinationStatus

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Destination Status
  • None
  • GroupName (Text)
  • Status
  • StatusID
 Returns a list of destination status options.

Properties

Name Type Example Notes
GroupName Text
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Expired.
StatusID Number 1

WorkflowEventStatus

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Event Status
  • None
  • GroupName (Text)
  • Status
  • StatusID
 Returns a list of event/step status options.

Properties

Name Type Example Notes
GroupName Text
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Empty, Error, Expired.
StatusID Number 1

WorkflowPriority

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Priority
  • None
  • None
  • ID
  • Priority
 Returns a list of workflow priority options.

Properties

Name Type Example Notes
ID Number 1
Priority Text Medium Typically, the workflow designer sets this value during the workflow build. If the value is not set, the default is Medium.
Results can include: High, Low, Medium, Undefined.

WorkflowProcessStatus

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Process Status
  • None
 Group Name (Text)
  • Status
  • StatusID
 Returns a list of workflow status options.

Properties

Name Type Example Notes
GroupName Text
Status Text Active The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
StatusID Number 1

WorkflowStatus

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Workflow Status
  • None
  • Group Name (Text)
  • Status
  • StatusID
 Returns a list of workflow status options.

Properties

Name Type Example Notes
GroupName Text
Status Text Active

The current status of the activity instance.
Results can include: Active, Completed, Deleted, Empty, Error, Expired, Running, Stopped, Terminated, Waiting.
StatusID Number 1

WorklistStatistics

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Worklist Statistics
  • Compare (Text)
  • GroupBy (Text)
  • Measure (Text)
  • Count (Decimal)
  • Folder (Text)
  • Column1
  • Column1 ID
  • Column2
  • Column2 ID
  • Count

Properties

Name Type Example Notes
Column1 Text
Column1ID Text
Column2 Text
Column2ID Text
Compare Text
Count Decimal 1
Folder Text
GroupBy Text
Measure Text

WorklistStatisticsItems

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
List Worklist Statistics Items
  • Compare (Text)
  • GroupBy (Text)
  • Param1 (Text)
  • Param2 (Text)
  • None
  • None

Properties

Name Type Example Notes
GroupBy Text
Param1 Text
Param2 Text