Creating reports for raw events in the Telemetry service
As an administrator, you can create reports for your chatbot application based on the raw events in the Telemetry service by using BMC Helix ITSM: Smart Reporting. You can either use the Telemetry service events that BMC Helix Innovation Suite provides out of the box or you can create new events. Using these reports, application business analysts can understand how end users are using the chatbot application, derive statistics about a successful or unsuccessful event, monitor the chatbot metrics, and so on.
Before you begin
Before you start creating reports, ensure that you have completed the following tasks:
- Ensure that you have access to BMC Helix ITSM: Smart Reporting.
- Instead of using out-of-the-box events, if you want to create reports for custom events, ensure that you have created the events.
Process for creating a report
The following image illustrates the different stages involved in creating a report:
The following table describes the different tasks that are involved in the process to create a report:
Note
Tasks 1-6 are optional because instead of performing these actions, you can leverage the out-of-the-box connections and definitions provided by BMC Helix Innovation Suite. If you leverage the out-of-the-box connections and definitions, you can directly create a report in BMC Helix ITSM: Smart Reporting.
Task | Action | Reference |
---|---|---|
Establish a connection between BMC Helix Virtual Agent and a local or remote system | ||
(Optional) 1 | Create a web API connection to access the Telemetry service data on a local or remote system. | To create a web API connection |
(Optional) 2 | Create a data source by using the web API connection to leverage external data. | To create a data source connection |
(Optional) 3 | Create a data source mapping to map the data source with its alias. | To create a data source connection mapping |
Define the data to be displayed in a report | ||
(Optional) 4 | Create a document definition to define the structure in which you want to get the external data. | To create a document definition |
(Optional) 5 | Create a REST API web request service definition to get data over a REST API call. | To create a web API request service definition |
(Optional) 6 | Create an external or a join record definition to access the external data. | To create an external or a join record definition |
Create a report by using the data defined | ||
7 | Create a report to analyze the chatbot usage. | To create a report |
Out-of-the-box definitions and connections
The following table lists the out-of-the-box definitions and connections that BMC Helix Innovation Suite provides to create reports for the Telemetry service raw data:
Type of definition or connection | Out-of-the-box data |
---|---|
Web API connection | Remote Web API Connection |
Data source | Telemetry Data Source |
Data source mapping | BMC Helix Innovation Suite maps the Telemetry Data Source with its alias as shown in the following image: |
Document definitions | BMC Helix Innovation Suite provides the following out-of-the-box document definitions:
|
Web API request service definition | BMC Helix Innovation Suite provides the following out-of-the-box web API request service definitions:
|
External record definitions | BMC Helix Innovation Suite provides the following out-of-the-box external record definitions:
|
(Optional) Task 1: To create a web API connection
If you do not want to use the out-of-the-box web API connection, you can create a web API connection for the Telemetry service.
To create a web API connection, see
Configuring the authentication credentials of REST API web services
.
(Optional) Task 2: To create a data source
If you do not want to use the out-of-the-box data source, you can create a data source for the Telemetry service to leverage the raw data.
(Optional) Task 3: To create a data source mapping
If you do not want to use the out-of-the-box data source mapping, you can create a new mapping for your data source. You map an alias (a placeholder for tenant-specific data source configuration) with the appropriate data source so that the appropriate data source configuration is used when you access data by using external record definitions.
(Optional) Task 4: To create a document definition
If you do not want to use the out-of-the-box document definition, you can create a new definition to define the structure in which you want to receive data from the web API call.
To perform the steps to create a document definition, see
Defining a document schema
.
(Optional) Task 5: To create a web API request service definition
If you do not want to use the out-of-the-box web API request service definition, you can create a service definition to receive data over a REST API call.
(Optional) Task 6: To create an external or a join record definition
If you do not want to use the out-of-the-box record definitions, you can create an external record definition to access the Telemetry service data.
To create an external record definition, see
Creating external record definitions
.
Notes
- When you create an external record definition for a web API, the system generates the fields for header, query parameters, path parameters, and body in the web API. For a system generated field, if you give a default value, at run time, the default value is used. If you want to override this value, you can define different values at run time.
In BMC Helix ITSM: Smart Reporting, while creating a report, you can define values for system generated fields by using filters. - If you are creating a report for a custom event statistics, a regular record definition is automatically created. However, if you are creating a report for a custom event, you need to create an external record definition.
If you want to combine data from multiple external record definitions, you can create a join record definition.
To perform the steps to create a join record definition, see
Creating join record definitions
.
Note
While creating a join record definition, on the Field Selection tab, ensure that you select the fields that the system generates for the web API header, query parameters, path parameters, and body.
Task 6: To create a report
You must first create a view for a report and then add the data that you want to display in the report.
The following image shows the fields from an external record definition in the report as filters, rows, or columns:
Comments
Log in or register to comment.