Adding Your Report As A Menu Item

You must add information such as menu id, report name, report id, url, template and so on to your report as a menu item.

To define your custom report, perform the following:

  1. Open the custom-menu.json file from the following location: <VA-Install Drive>\Path of Visualization Server folder\conf\custom-menu.json.

    For example: C:\VoceraAnalytics\visualizationserver\conf\custom-menu.json.

    Note: You must add the custom report so that it is shows up as a sub-menu inside the main menu of the report.
  2. Define your custom report. For example, OutgoingCalls.
  3. Add the code for OutgoingCalls report to the custom-menu.json file.
    Note: By default the custom-menu.json file contains a sample report code. Ensure that you do not repeat the same values defined in the sample report code. All values that you enter for each report must be unique.
    The code for Outgoing Calls report in the custom-menu.json file appears as follows:
    [{
    "menuId" : "OutgoingCalls",
    "name" : "Outgoing Calls",
    "reportId" : "outgoing_calls",
    "url" : "/outgoing_calls",
    "templateUrl":"report/report.tpl.html",
    "parent":"custom",
    "description" : "This is the sample report which summarizes Outgoing Calls.",
    "params" : {
    "templateFileName" : "outgoingcalls.rp.tpl"
    },
    "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.
    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.
  4. Save and close the custom-menu.json file.