Updating the customconfig.xml File

The customconfig.xml file, which is located in the \vocera\reports\Reports\custom folder, specifies the custom reports that appear in the Report Console. To add a custom report to the Report Console, you must update customconfig.xml. You can use any XML editor to modify the file.

When you specify a custom report configuration in customconfig.xml, you must select one of the valid report types. If you specify a report type other than “CUSTOM” (for example, “SYSTEM” or “EXPORT”), the report is added to end of the corresponding list of standard reports in the Report Console. You cannot create new report types or subtypes.

The customconfig.xml file has the following XML structure:

Figure 1. XML structure for customconfig.xml
  <REPORT ID="reportId">

The customconfig.xml file uses the same XML schema as the reportconfig.xml located in the \vocera\reports folder. The best way to become familiar with the reportconfig.xml schema is to open the file and see how existing reports have been configured. You can copy and paste an existing report configuration from reportconfig.xml into customconfig.xml, and then modify the configuration to add a new report.

The following table describes the XML elements of customconfig.xml.

Table 1. customconfig.xml schema elements




Root element.


A report definition.


  • ID = report ID. The ID can be identical to the value of the NAME element. Its purpose is merely to make the XML more readable.


Name of the report. The NAME value appears in the Vocera Report Console.


Description of the report. The DESCRIPTION value appears below the name of the report in the Vocera Report Console.


Report definition file. The file must be placed in the \vocera\reports\Reports directory.


Type of report. TYPE can be any of the following values:
  • SYSTEM = Summary reports

  • CALL = Call reports

  • DIAG = Diagnostics reports

  • ASSET = Asset Tracking reports

  • EXPORT = Export Data reports

  • DEVICEMANAGEMENT = Device reports

  • SCHEDULERDIAGNOSTICS = Scheduler Diagnostics reports

  • CUSTOM = Custom reports that you create with Crystal Reports Designer.

Note: You cannot define new report types.


Parent element containing the report's parameters.


A report parameter, which appears in the Report Parameters page when you generate the report from Vocera Report Console. Subelements include: DISPLAYNAME, BINDNAME, TYPE, DEFAULT, DBLOOKUP, and LOOKUP.


The name of the parameter as it appears in Vocera Report Console.


The name of the parameter in the RPT file to which this parameter is bound.


Type of parameter (for example, TEXT or DATE).


Default value of the parameter.


Database lookup query for the parameter's values.


Defines a static lookup table for the parameter's values.