Note: This documentation gets updated only when necessary, as the product is in sustained mode. For product updates see the Release Notes.

Workflow Reporting

The Workflow Reporting Service Type provides the data used to generate K2 workflow reports and (optionally) exposes reporting SmartObjects for specific K2 workflow definitions (if the Create Workflow Reporting SmartObjects option was selected in the process properties). Process, activity and event reporting information and statistics are made available when workflow reporting SmartObjects are enabled for a process. A service instance of this service is normally registered automatically when you install K2. You do not normally need to register another instance unless you want to target a different K2 database to retrieve the reporting data, for example if you have archived data to another database.

Service Authentication

The following Authentication Modes may be used with the Service Type:

Impersonate
ServiceAccount
Single Single-on
Static

Service Keys (Service Instance Configuration Settings)

Key	Can be modified	Data Type	Sample Value	Notes
Workflow DB Connection String	Yes	Text	Data Source=[SqlServerName];Initial Catalog=K2;integrated security=sspi;Pooling=True	SQL connection string to the K2 database.
Workflow LogDB Connection String	Yes	Text	server=[SqlServerName];database=K2; uid=sa;pwd=k2pass;pooling=true; enlist=false;Min Pool Size=5	SQL connection string to the K2 database.
Identity DB Connection String	Yes	Text	Data Source=[SqlServerName];Initial Catalog=K2;integrated security=sspi;Pooling=True	SQL connection string to the K2 database.
Use Native SQL Execution	Yes	True/ False	True	Usually set to True to improve performance.
DifferentSQLServer	Yes	True/ False	False	Usually set to False unless the targeted database is on a different server than the primary K2 database.
DebuggingEnabled	Yes	True/ False	False	If True, more debugging information is provided, but this can affect performance.

Service Objects

The Workflow Reporting Service Instance exposes Service Objects that are categorized based on the type of reporting data returned by the Service Object.

In addition, if workflows are deployed with the Create Workflow Reporting SmartObjects option selected, the service will create Service Objects for the selected items in the configuration of the Create Workflow Reporting SmartObjects screen, as specified by the workflow designer, located in a category that reflects the workflow project structure.

SmartObjects

K2 automatically generates SmartObjects for these Service Objects. SmartObjects are automatically created when selecting the Generate SmartObjects for this Service Instance check box when creating a new Service Instance. Designers may use the available Service Objects in this service to create advanced SmartObjects using the available K2 SmartObject design tools. It is recommended to use the K2 Design tools to create SmartObjects rather than generating SmartObjects, since this allows better control over the naming, behavior and design of the SmartObject and its methods and properties.

Considerations

The Create Workflow Reporting SmartObjects property must be set to True on the process properties to create workflow-specific reporting SmartObjects when the process is deployed.
You may want to limit the number of processes that generate Workflow Reporting SmartObjects, as it can cause significant overhead on the SQL server if a high volume of processes or process instances are expected, and it can also increase the amount of time taken to deploy the workflow definition.