Watch the video below for an introduction to Service Groups for Pulse Dashboards as well as an example scenario where Service Groups are used.
Configuring Service Groups and Categories
Service Groups define what is displayed on a Cyara Pulse Dashboard, using the generic or customized categories.
After the parameters for the Pulse Dashboard are defined, Dashboard Administrators need to configure one or more service (categories and groups) before any results can be aggregated and shown on the Dashboard.
A Service Group can represent the test results either in tabular form or real-time charts.
- Log in to the Cyara Portal as a Dashboard Admin user.
- From the main menu, click .
- From the list of available Dashboards, click Edit against the Dashboard for which you want to create a new Service Group.
Scroll down to Categories section and click
A service group configuration consists of the following settings:
- Service Group Details - General Service Group configuration
- Filter Test Results - Filter results based on specific rules
- Test Cases - Add or remove Test Cases from the Service Group
- Categories - Define monitoring categories, retries, and success criteria
- Select the communication Channel from the drop-down list.
- Select the display Type for the group. You can choose either Table or Chart as Type. By default, the Dashboard is displayed in a tabular format.
If you choose the Type as Table, specify the
The Spot Size for each Service Group. The
spot size can be chosen for either the number of Test Cases or the
time duration for which you want the spot to appear on the
Spot Size determines:
- The status of one or multiple Test Cases executed per Pulse Campaign run.
- The status of the Test Cases executed in a Pulse Campaign within a defined timeframe (in minutes)
The number of additional retries allowed for inbound Test Cases
after a Category failure. The count is applicable only if retries
are enabled for the Category.
Note: Retries are not applicable for outbound Test Cases.
- The Spot Size for each Service Group. The spot size can be chosen for either the number of Test Cases or the time duration for which you want the spot to appear on the Dashboard.
If you choose the Type as Chart, specify the
- Select the type of chart as Area, Column, or Line Charts.
- Specify the Maximum Data Points on the X-axis for the Chart.
- Select the Skip Empty Points checkbox to remove gaps betweeb data points when a Test Case does not run for the service.
- Enter a display Label and a Name for the Service Group.
You can now define the order in which Service Groups appear on the Dashboard.
Specify the Order number that determines the position for
this Service Group to appear in. Lower numbers will appear first.
Note: You can also drag the Service Group from the Edit Dashboard page and place it in the desired position.
- Turn on the Filter Test Results toggle and enter an SQL based filter rule to filter results from the Dashboard. If the expression is matched, the Test Result is excluded from the Dashboard.
- To associate Test Cases with this Service Group, select Test Cases from the folders under the Test Cases panel.
If you have chosen a Table display format, after you enter the Service
Group and Test Cases details, scroll down to select the
Categories as shown:
We provide a number of default categories that you can disable if needed.
The Answering Category exposes its underlying rule used to determine if this rule has been activated. This rule is expressed in a SQL like syntax. This rule should only be modified under advanced scenarios.
Answering Category Example
(Step = 0 AND Result = 'Failed') OR (Step = 1 AND Category IN ('NoResponseWithinThreshold', 'AbortedTestCaseDuringStep'))
The above Answering Category will activate if step 0 fails, or if step 1 doesn't respond or aborts during step 1.Note: If there are failures in the Answering Category, the additional Categories are not evaluated. The typical reason for an Answering Category failure is connectivity issue.
Additionally, you can set the number of consecutive failures allowed before a service reports the Category as failed. You can also turn on automated retries for the Category when a failure is identified.
Custom Categories are optional measurements that appear as additional rows within the service group, between the Responsive and Completed rows. Each Category has a Label, what metric to Monitor (Responsive, Correctness, or Both), and one or more Steps/Descriptions.
To create a new Category, click New Custom Category, and a pop-up appears:
Enter the Label, select Monitor, and enter the Steps:
Monitor provides a drop-down list of options,
Prompts, or Both. Select the
Responsive is to display "green (successful)", where the response time for the selected Step(s) was less than the Minor Threshold step values.
Correct Prompts is to display "green (successful)", where the speech recognition results in the selected Step(s) were equal to or above the Minor Confidence Threshold.
Both is to display "green", where both the speech recognition results and response times were classified as successful.
- Enter the partial Steps/Description(s) (separated by a comma) and then click Create.
- To delete a Custom Category, select the row and then click the red trash can icon that appears.
- The Monitor provides a drop-down list of options, Responsive, Correct Prompts, or Both. Select the appropriate option.
If you have chosen a Chart display format, after you enter the Service
Group and Test Cases details, scroll down to plot the Chart
Series. Click New Series to plot a
- Enter the Label for this New Series.
Choose from one of the predefined Fields to plot its value.
- Specify the Minor Threshold and the Major Threshold values. These Threshold values can be supplied to draw a horizontal plot line. If the most recent data point falls below the Major Threshold value, then the Service Group will be in a failed state.
- Enter the Steps, which is a pattern used to match against the Step descriptions.
- After entering all details, click the Create button.
- After you have defined the Services and Categories or Chart Series, click Save Details to save your groups.
- Click Reload in the Dashboards page to force the Dashboard session to reload and pick up the new configuration changes.