LiveCompare Usage Report

This workflow generates two Dashboard reports which document your usage of LiveCompare over the last month.

  • The named usage report includes actual usernames and email addresses.

  • The anonymous usage report includes anonymized usernames and email addresses.

The workflow sends the anonymous usage report to the Tricentis LiveCompare team if you have turned off the Do Not Send Anonymous Usage Data to Tricentis switch in the Configuration - Email screen.

Configure LiveCompare to send emails

Before you begin, you will need to make sure you have configured LiveCompare to send emails. See the Get started with LiveCompare help topic for details.

Prepare the workflow

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

  • To specify the recipients of the named usage report, set the Usage Email String List parameter to a list of email recipients. You should store each email address as separate string entry.

  • To specify the recipients of the anonymous usage report, set the Tricentis Usage Email String List parameter to a list of email recipients. You should store each email address as separate string entry. Clear the entries if you don’t want the workflow to send an anonymous usage report.

  • To specify the number of categories used in some of the reports, set a value for the Number of Categories String parameter.

Schedule the workflow

You should schedule the workflow 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 LiveCompare Usage Report generates the following results:

Dashboard reports

The named and anonymous usage reports each generate a Dashboard report with the following charts. In the anonymous usage report, LiveCompare replaces usernames with user1, user2, …, and email addresses with user1@example.com, user2@example.com, ....

  • The Top 10 Report Viewers column chart displays the top N users who have viewed or downloaded reports, showing the number of times each user has viewed or downloaded a report.

  • The Top 10 Reports column chart displays the top <Number of Categories> workspaces from which users viewed or downloaded reports.

  • The Report Views Year Summary column chart shows the number of reports viewed or downloaded, grouped by year.

  • The Report Views Month Summary column chart shows the number of reports viewed or downloaded, grouped by month.

  • The Top App Users bar chart displays the top <Number of Categories> app users, showing the number of apps each user has run.

  • The Top Workflow Users bar chart displays the top <Number of Categories> workflow users, showing the number of workflows each user has run.

  • The Apps Status Summary pie chart displays the execution status of each app.

  • The Workflows Status Summary pie chart displays the execution status of each workflow.

  • The Top App Runs bar chart displays the top <Number of Categories> app runs, showing the number of times users ran each app.

  • The Top Workflow Runs bar chart displays the top <Number of Categories> app runs, showing the number of times users ran each workflow.

  • The Apps Year Summary column chart displays the execution status of each app run, grouped by year.

  • The Workflow Year Summary column chart displays the execution status of each workflow run, grouped by year.

  • The Apps Month Summary column chart displays the execution status of each app run, grouped by month.

  • The Workflow Month Summary column chart displays the execution status of each workflow run, grouped by month.

  • The Apps Day Summary column chart displays the execution status of each app run, grouped by day.

  • The Workflow Day Summary column chart displays the execution status of each workflow run, grouped by day.

  • The Report Views Day Summary column chart displays the number of times users viewed or downloaded a report, grouped by the month when the users viewed or downloaded the report.

  • The Report Views Hour Summary column chart displays the number of times users viewed or downloaded a report, grouped by the month when the users viewed or downloaded the report.

Excel reports

The named and anonymous usage reports each generate an Excel report with the following spreadsheets. In the anonymous usage report, LiveCompare replaces usernames with user1, user2, …, and email addresses with user1@example.com, user2@example.com, …

Dashboard

This spreadsheet includes the charts listed in the Dashboard reports section.

Reports

This spreadsheet list details for each of the reports that users viewed or downloaded. It includes each user’s username and email address; users who accessed reports via a shared URL have usernames of the form Viewer_<browser cookie name>. It also includes the date and time when a user accessed the report, the report’s workspace, the report’s type, and the report’s URL.

Apps

This spreadsheet lists 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.

Help

This spreadsheet provides help for each of the spreadsheet reports.

Emails

The named usage report sends an email with the following format to the recipients set in the Usage Email String List parameter.

LiveCompare Usage Report for <Month> is here: <Report URL>

The anonymous usage report sends an email with the following format to the recipients set in the Tricentis Email String List parameter.

LiveCompare Anonymous Usage Report for <Report> is here: <Report URL>

Commit configuration

LiveCompare schedules the LiveCompare Usage Report to run each month as part of the Commit Configuration process. In this case, the workflow emails the named usage report to the Usage email addresses set in the Configuration - Email screen. The workflow emails the anonymous usage report to the Tricentis LiveCompare team if you have turned off the Do Not Send Anonymous Usage Data to Tricentis switch in the Configuration - Email screen.