How To Run Reports
Flow reports are configured in the Flow definition. The Akumina Flow User and Team widgets provide an easy to use reporting access. The Akumina Flow Owners Management Application also provides access to reports.
You can request reports directly by calling the API endpoint: POST: api/teamprocessinstance/metrics/run
Standard Parameters
The following parameters are available for all reports:
- ProcessId
- Required ID of process to query instances of
- InstanceStatus
- Optionally limit data to instances that have completed (2) or canceled (3). Note that only closed instances are available for reporting
- DateCol
- If filtering by date, which date do you want to use: ClosedDate or CreatedDate
- DateFromUtc
- Optionally filter by date range. This is the starting inclusive date range; provide in format yyyy-mm-ddThh:MM:ss.sssZ as in 2021-02-21T00:00:00.0000000Z
- DateToUtc
- Optionally filter by date range. This is the ending inclusive date range; provide in format yyyy-mm-ddThh:MM:ss.sssZ as in 2021-02-21T23:59:59.9999999Z
- IsInstanceOwner
- If set to true, will allow reporting when usage is restricted to Owners and will only return data where the current user is an instance owner
- UseCache
- Whether to use cached results (if exists) or force a refresh? Only report data which meets one of the checks below will be cached:
- ReportUsage = User
- ReportUsage = Owner and current user is a process owner (Instance owners are not supported)
- CacheTimeInMinutes
- If you want the report data to be cached, provide a value > 0. The number of minutes the fetched report data will be cached. The cache key ensures that only report requests that match will be returned.
Other Parameters
The following parameters are available on a report by report basis and are included under the “OptionalFilter” property:
- Key
- Required Property Name; this must match the property name as defined in the Flow definition.
- CreatedById
- Optionally limit data to instances created by this user; AAD ID for user
- CurrentSiteIdWebId
- Optionally limit data to instances created in the context of this site
- QueryProperties
- Optionally limit data by custom property values (Memo and File properties not supported). Use format: “PROPNAME1:propValue1,PROPNAME2:orValue1,PROPNAME2:orValue2”.
“propValue” can’t contain a “:” or a “,”. Use “*” for a wildcard search; e.g. “START_TIME:2022-09-16*” will return all instances with a START_TIME property value of September 16, 2022 (regardless of time of day) - PageIndex
- Which page of results to return? Paging starts at 1.
- PageSize
- How many results to return per page?
- OrderBy
- How should results be ordered? Typically its either “CreatedDate ASC” or “ClosedDate DESC”
- TaskId
- Set scope of report to a specific Task within the Process
Reports
| Report | Description | ID | Supported Other Parameters |
|---|---|---|---|
| Choice Property Usage | For each choice value found, returns Property Label (in requested language), Choice Value (in requested language) and Number of occurrences | PCVUR | Key (Required) The name of the choice property, CreatedById, CurrentSiteIdWebId, QueryProperties |
| Choice Score | Returns the average score for instances that match the provided filter. The data returned includes: TotalScore, TotalCount, Score (Avg Score), ScoreLabel (Avg Score Label in requested language), Color, BackgroundColor | PCSR | CreatedById, CurrentSiteIdWebId, QueryProperties |
| Count By Status | Returns the count of instances that match the provided filter grouped by instance status. The data returned includes: Status and TotalCount | PCR | CreatedById, CurrentSiteIdWebId, QueryProperties |
| Property Values | Returns a page of non-null values found for the provided property in the instances that match the provided filter | PPVR | Key (Required) The name of the property (File Type properties are not supported), PageIndex, PageSize, OrderBy, CreatedById, CurrentSiteIdWebId, QueryProperties |
| Properties Values | Returns a page of requested properties for instances that match the provided filter. Shares ReportUsage defined for Property Values report. The Akumina Flow Owners Page uses this report to implement the “Properties Export” report. | PPSVR | PageIndex, PageSize, OrderBy, CreatedById, CurrentSiteIdWebId, QueryProperties,
|
| Workflow Performance | Returns TaskId (if not included in filter), TotalCount of tasks, TotalOverdue tasks, AvgAssignentTime, AvgWorkTime | PWPR | TaskId, CreatedById, CurrentSiteIdWebId, QueryProperties |
| Assignee Workflow Performance | Returns TaskId (if not included in filter), AssigneeName (if not included in filter), TotalCount of tasks, TotalOverdue tasks, AvgAssignentTime, AvgWorkTime | PAWPR | TaskId, CreatedById, CurrentSiteIdWebId, QueryProperties,
|
| Role Workflow Performance | Returns RoleId (if not included in filter), TaskId, AssigneeName (if not included in filter), TotalCount of tasks, TotalOverdue tasks, AvgAssignentTime, AvgWorkTime | PRWPR | CreatedById, CurrentSiteIdWebId, QueryProperties,
|