Custom Reports

[Data Source: Engage, VCS, Vina, VMI, Voice Server] Specific custom created reports are viewed from this folder. Using Crystal Reports, you can customize your own reports for Vocera Analytics and add it to the Report Console.

To access the Vocera Analytics Server database, you must install Crystal Reports 2016 and the MySQL Connector/ODBC 3.51 driver on a computer other than the one on which the Vocera Analytics Server is installed. You must also set up an ODBC data source.

The information displayed on screen is determined by the filters that you apply. The filters included with this sample report are:

Filter Name	Filter Description
Date Range	The date range to include in the results. By default, the value is the current date; however, you can select from a list of options. For example, you can select the option "Last 7 days" or "Last 30 days."
Facilities	Used to filter data based on user facilities (common facility name) specified while mapping Vocera Voice Server User Site and Engage Facility.
Departments	Used to filter data based on user departments (common unit name). Common unit names are referenced from a crosswalk table cwunit that are mapped from Vocera Voice Server User Department and Engage Units. Note: The displayed departments drop-down filter may be constrained due to the Facilities filter. Unknown Department display data for all users that are not part of any department selected within the Facilities filter.

To create a custom report, you must add your report as a menu item and create a report template file.

Adding your report as a menu item

Open the custom-menu.json file from the following location: <Install Drive>\Path of Visualization Server folder\ conf\custom-menu.json.
For example: C:\Analytics\visualizationserver\conf\custom-menu.json.

Note: You must add the custom report so that it shows as a sub-menu inside the main menu of the report.

Define your custom report as shown below:

[{
"menuId" : "custom_report",
"name" : "Sample Custom Report",
"reportId" : "sample_custom_report",
"url" : "/sample_custom_report",
"templateUrl":"report/report.tpl.html",
"parent":"custom",
"params" : {
"templateFileName" : "samplecustomreport.rp.tpl",
"description" : "This is the sample report which summarizes Outgoing Calls."
},
"items" : []
}
]

The following table lists the menu item and its description:

Property	Description
menuId	An unique identifier for the menu.
name	Name of the report that will be displayed under menu.
reportId	An unique identifier for the report.
url	An unique relative URL that would be displayed on the address bar of the browser.
templateUrl	The templateUrl for reports is `report/report.tpl.html`. Refer the section for information on how to create a report template file.
parent	Name of the parent menu.
params > template_file_name	The name of the report template file created under `conf\Report Template` in Visualization Server.
params > description	A short description of the report.

Note: The Sample Custom Report displays the result based on the calling user. For example, if a user does a broadcast call to a group that is received by 10 participants, then the Sample Custom Report considers it as 10 complete calls rather than 1 complete call.