LiveCompare Usage Report

This workflow generates an Excel report which documents the usage of LiveCompare over the last month, and emails the report to the Tricentis LiveCompare team. While the use of this workflow is optional, it is hoped that is will provide us with an idea of the overall use of LiveCompare. The report may also be useful during support engagements to monitor the success and performance of Apps and workflows.

Note that the report does not include any user details from your LiveCompare server. LiveCompare users are referred to anonymously as User1. User2, ...

Configuring LiveCompare to Send Emails

Before you begin, you will need to make sure that LiveCompare is configured to send emails. See the Integrating LiveCompare with your Email System section of the LiveCompare Installation and Configuration Guide for details.

Preparing the Workflow

To prepare the LiveCompare Usage Report workflow, drag its workflow template from the Templates folder into your own workspace, then modify the workflow as follows:

To specify the sender of the report:

  1. Select the From parameter in the LiveCompare Usage Report workflow and view its details in the Property Editor.

  2. Set the String property to the EmailFromAddress value set in the Configuration - Email screen. You may need to check this with a LiveCompare Administrator.

Scheduling the Workflow

The workflow should be scheduled to run on the first day of each month at a time that is convenient.

  1. Select the LiveCompare Usage Report workflow in the hierarchy and choose ‘Schedule Run’ from the context menu.

  2. Complete the Run Workflow screen, specifying a monthly schedule for the first day of each month.

  3. Click ‘Schedule Run’ to set the schedule.

Workflow Results

The workflow generates an Excel report which includes the following spreadsheets. To open the report, select the App Usage Details dataset and choose ‘View Details’ from the context menu.

Dashboard

This spreadsheet includes the following charts.

  • The App Status summary pie chart summarizes the execution status for each App that has been run.

  • The Workflow Status summary pie chart summarizes the execution status for each workflow that has been run.

  • The Top App Runs bar chart summarizes the top 10 Apps that have been run, showing the number of times each App has been executed.

  • The Top Workflow Runs bar chart summarizes the top 10 workflows that have been run, showing the number of times each workflow has been executed.

  • The Top App Users bar chart summarizes the top 10 App users, showing the number of Apps each user has run.

  • The Top Workflow Users bar chart summarizes the top 10 App users, showing the number of workflow each user has run.

  • The Top 10 Fastest Apps bar chart displays the execution time (in milliseconds) for the top 10 fastest Apps.

  • The Top 10 Fastest Workflows bar chart displays the execution time (in milliseconds) for the top 10 fastest workflows.

  • The Top 10 Slowest Apps bar chart displays the execution time (in milliseconds) for the top 10 slowest Apps.

  • The Top 10 Slowest Workflows bar chart the execution time (in milliseconds) for the top 10 slowest workflows.

  • The Apps Year Summary column chart displays a summary of the of App runs by year, showing the number of successful and failed executions.

  • The Workflows Year Summary column chart This column chart displays a summary of the of workflow runs by year, showing the number of successful and failed executions.

  • The Apps Month Summary column chart displays a summary of the of App runs by month, showing the number of successful and failed executions.

  • The Workflows Month Summary column chart This column chart displays a summary of the of workflow runs by month, showing the number of successful and failed executions.

  • The Apps Day Summary column chart This column chart displays a summary of the of App runs by day, showing the number of successful and failed executions.

  • The Workflows Day Summary column chart This column chart displays a summary of the of workflow runs by day, showing the number of successful and failed executions.

  • The Apps Hour Summary column chart displays a summary of the of App runs by hour, showing the number of successful and failed executions.

  • The Workflows Hour Summary column chart his column chart displays a summary of the of workflow runs by hour, showing the number of successful and failed executions.

Help

This spreadsheet provides help for each of the spreadsheet reports.

Apps

This spreadsheet provides details for the executed Apps, including the App’s workspace and workflow details, the name of the user who executed the App, and the App’s status and execution details.

Workflows

This spreadsheet provides details for the executed workflows, including the workflow’s workspace, the name of the user who executed the workflow, and the workflow’s status and execution details.