Reporting for K2 Applications

The Reporting for K2 Applications tutorials explain how to access and configure reports using the tools found in K2 Workspace. Topics include the statistical and analysis reports that are standard with K2 blackpearl installations, and custom reports that you can build using the Report Designer. K2 smartforms reporting controls are not covered in the Reporting for K2 Applications tutorials.

This tutorial can be completed in any environment that has K2 version 4.6.9 or later installed. K2-delivered training events normally include access to a Virtual Server environment provided by K2 which you will use for the exercises. The screenshots and users used in the tutorial reflect this K2-provided Virtual Environment. You can, however, complete this tutorial in any other environment as long as the necessary K2 components are installed and operational. You must have the necessary rights and permissions to create the K2 artifacts in the target environment.

We will be using the process instance data from the Leave Request (Extended) Workflow for our reporting content. If you have completed the Leave Request (Extended) application and have time, submit a few more forms to provide additional reporting content. (You do not need to action them.) If you are building this application in your own environment, the screen shots may be different, but the steps and terminology will be generic enough so that you may follow along, adjusting values as necessary for your own environment.

Tutorials Overview

There are two tutorials included in this guide. The first tutorial covers Standard Reports and the second tutorial covers Custom Reports.

In Standard Reports in K2, we will learn about the five Standard Reports available in K2 Workspace and how you might use them to help ensure your workflows run as efficiently as possible. We will take a closer look at the Activity Statistics, Process Overview and User Performance reports and see examples of how you might use these reports in your own environment. We will also take a look at the View Flow Report and how it paints a similar picture as the Process Overview Report, except in flowchart format. We will start a workflow and observe how the View Flow Report is updated in almost real time.

In Custom Reports in K2, we will use the SmartObject Service Tester tool to observe how K2 reports are actually exposed as SmartObjects. Because they are SmartObjects, K2 reports can be leveraged in a number of locations and artifacts. We will build a custom report using the Report Designer found in K2 Workspace. Last, we will import a data feed based on the Process Instance Workflow Reporting SmartObject into Excel as a PowerPivot table and chart.

Tutorial Level and Estimated Build Time Tutorial Overview Covered in Tutorial

Standard reports in K2

Reporting in K2 Workspace

Easy

15-20 min

This tutorial explains how to run the standard workflow reports available in K2 workspace such as the Activity Statistics report and Process Overview report.

  • Setting workflow permissions for reporting
  • Running reports in K2 workspace
  • Drilling down with the Process Overview Report
The View Flow Report

Easy

10 min

Using the View Flow Report to track the "path" of workflows, both for completed workflows and active workflows.

  • Launching the View Flow report from K2 Workspace
  • Drilling down with the View Flow Report
  • Seeing real-time workflow execution with the View Flow Report

Custom reports in K2

Exploring the Workflow Reporting SmartObjects

Easy

5 min

This tutorial explores the available Workflow Reporting SmartObjects.

  • What standard workflow reporting SmartObjects are available
  • Using the SmartObject Service Tester utility to explore and execute SmartObjects
Building custom reports in K2 Workspace

Easy

20 min

Using the Report designer in K2 Workspace to build a custom report against a SmartObject.
  • How to build a custom report using the K2 Workspace Report Designer
  • How to retrieve data from a SmartObject in a custom report
  • Exporting data from a custom report to Excel
Building a custom report in Excel with a Data Feed, PowerPivot and a PivotChart

Intermediate

20-30 min

How to use a third-party reporting tool (in this case, Microsoft Excel) to build a custom report against a SmartObject. In this tutorial, the data is retrieved from a REST Web Service Endpoint
  • How to expose and consume SmartObjects through the available REST Service Endpoints
  • Adding a Data Feed to a Excel spreadsheet
  • Building a PowerPivot using a Data Feed
  • Building a PivotChart from a PowerPIvot

Terminology

K2 has a number of terms which are important to understand, especially when working with reports. In K2, the term "workflow" is often generically used to describe the forms, workflow and all the bits and pieces contained that make up a process automation of some kind. A workflow is actually a Process (or the main container for forms, views and workflow elements). A Process Instance is a single occurrence of a Process. For example, you might have a Process called Leave Requests. If Neil submits a Leave Request, K2 will create a Process Instance of the Leave Request Process for Neil. If Jason submits another Leave Request, K2 will create a Process Instance for Jason, so forth and so on.

Breaking this down further, we know that workflows consist of Activities containing Events, connected by outcome lines. (A workflow created in K2 Designer has slightly different terms, the Activities are referred to as Steps and each step contains an Event.) For example, we might have an Activity called Manager Approval and it contains an Event (in this case, a User Task to action the request). In looking at reports, we will see the details and audit trails for these Activities referred to as Activity Instances. The Activity Instance will show us the details on the Events within the Process.

Getting Started

When you are ready to begin the reporting tutorials, continue on to the first section Standard Reports in K2 to get started.