Skip to main content

Welcome to the Cyara Knowledge Center

Search

Custom Reporting

Updated: tech writers Edited:

The Custom Reports feature allows you to create your own report with optional filters that can be scheduled and the results emailed to you periodically.

Custom Pulse Reports

Watch the video below for more information on how to create a Custom Pulse Report that includes historical/trending data.

Viewing Reports

To view the reports, click the Report option from the main menu, then choose Pulse - Custom. The following screen appears and shows a list of all the current reports that have been created for your Account. They are ordered alphabetically by Name.


You can sort the page either by the Name, Next Run, or Last Run date fields. If you hover over the individual reports, it will display the trash icon; use this icon to delete a report.
Note: If a report is disabled, it appears as Schedule Disabled in the above screen and also in the individual report's page. If the schedule of a report is in an expired state, the report appears as Schedule Expired in the above screen and also in the individual report's page.

To run a new Custom Report, perform the following:

  1. Click the New Report button. A screen as shown below appears:

  2. To name the report, click the Enter report name link. Give the report a meaningful, unique name and press the Enter key to save.
    Note: If you do not name the report, it will be lost when you navigate away from the page.
  3. Select the media type from the Channel drop-down list.
  4. Select Period from the drop-down list. The options are as shown in the screen below:

  5. Choose a suitable date range option from the Period drop-down list. The Custom range allows you to specify explicit Date and Time from and To dates. Every other date option has rolling From and To dates which are calculated at the time of execution. These options would normally be used when scheduling a report. Click Apply. The following screen, which contains a summary of all Test Case runs, will be displayed:



On the report page, the details for all runs of all Test Cases that satisfy the report criteria over a period of time are displayed as a pie chart under Summary. The pie chart displays the number of Successful, Satisfactory, Failed, and Aborted calls.

To obtain a further breakdown of satisfactory, failed, or aborted calls, hover the mouse pointer over the related segment of the pie chart, and a second pie chart will be shown that provides a breakdown of the calls by detailed result description.

The Details contain the Test Case, Total Calls, Success, Satisfactory, Failed, Success %, and Severity information.

  1. To obtain even more detailed information about a call, click the Test Case link under the Details column. The Test Case Breakdown report is as shown:

  2. Click the link under the Date column to display the Test Call details of that particular call. The report is as shown:

Note: The Call Engine ID, Full Calling Party, Full Called Party, Ticket, and Recording Path are additional fields that are displayed only for Platform Level Users.

To obtain more detailed information about all the Test Cases, click the donut chart segment from the Summary page, and the status breakdown page as shown appears:

This view is available for all statuses such as Failed, Success, Aborted, and Internal error. You can change the time range and filters; this will update the report definition and the reports will be shown accordingly.

The Result Details screens displayed for each call and the Failed Results Breakdown results are similar to the information described in the Viewing Detailed Results topic. Refer to the Results Summary Details Reporting section for more information.

Severity Mapping

Severity Mapping defines the Account-wide mapping for the failure reasons to a severity level. When a Test Case fails, its failure is grouped into an existing failure reason category, for example:

"Step 0: Response time exceeded Minor Threshold Time of 5 seconds" would be recorded against the detailed result with a failure reason of "Exceeded Minor Threshold".

  1. Click Severity Mapping at the top right corner of the Custom Reports page to define the mapping.
  2. Based on the failure reason, the severity level can be set. To set the severity level, against the failure reason, select the drop-down under Severity and choose either Low, Medium, or High.

  3. After you set the severity level, click the Save Details button.

Change Report Filters

Campaign and Test Case filters show all the Pulse/Pulse Outbound Campaigns and their associated Test Cases. This filter allows you to restrict the report based on the chosen Campaigns and Test Cases.

  1. Click Change Report Filters and a screen as shown below appears:

  2. From the Campaigns & Test Cases tab, click the Campaigns or Test Cases folder and make your selections as shown:

    The following apply when you select Campaigns/Test Cases:
    1. You can select multiple Campaigns/Test Cases or individual Campaigns/Test Cases or a combination of both.
    2. When you select a Campaign, all the associated Test Cases with the Campaign will also be selected and the Test Cases will be hidden. Selecting a Campaign will ensure that all current Test Cases at the time of execution for the Campaign will be included.
    3. Selecting a Test Case ensures all instances of the Test Case in both the Campaigns and Test Cases are included.
    4. If a Campaign or Test Case you have filtered on is deleted or removed from a Pulse Campaign, it will appear in a special folder below the Test Cases labelled Deleted. From here, you can see these deleted items and remove them as necessary.
  3. To clear the selection, use the Clear selection button.
  4. Click the Save & Run button to run the report based on these selections.

Failure Reasons

The failure reasons for the Campaign run appear under the Failure Reasons tab. To select these reasons and run a report on them, perform the following:

  1. Click the Failure Reasons tab and a screen as shown below appears:

  2. Select the reasons from the Result Categories folder.

    You can select a combination of Failure Reasons for the report.

  3. To clear the selection, use the Clear selection button.
  4. Click the Save & Run button to run the report based on these selections.

Scheduling Reports

Reports can be run on a schedule and emailed to users. The report can be set to be distributed either in PDF or CSV format. To schedule a report, it must have a name.
Note: The schedule fails if the report file size exceeds 20MB.
  1. Click the Schedule Report button.
    Note: This button can also read Report Scheduled – Next report on... or Schedule Expired if the report is in an expired state or Schedule Disabled if the schedule is in a disabled state.
    The following dialog box appears:

  2. Select the Starts On date.
  3. Select the Repeats drop-down to define the frequency for this Report. By default, None is selected. This will run the report once.

    You can schedule the report for either of the following frequencies:

    1. Every Hour: If you select the frequency as Every Hour, you can specify the time window for hour(s).
      1. Specify the hour(s). The Summary field is updated as per your choice.
    2. Every Day: When you select the frequency as Every Day, the following dialog box appears:
      1. Specify the time frame for days in the Every field.
      2. You can also specify the Multiple Times option. If the Multiple Times option is not specified, it uses the time from the Starts on field time.
      3. Select the End Repeat field from the drop-down list. There are three options to choose from here: Never, After, and On Date. When you select the After option, a field appears to specify the number of runs/executions. So, if you have a schedule that ends repeating after 10 runs, it will run 10 times and then stop. When you select the On Date option, a field appears to specify the date from a calendar. The Summary field is updated as per your choice(s).
    3. Every Week: When you select the frequency as Every Week, the following dialog box appears:

      1. Specify the time frame for week(s) in the Every field and select the schedule for the day(s).
      2. Select the End Repeat field from the drop-down list. There are three options to choose from here: Never, After, and On Date. When you select the After option, a field appears to specify the number of runs/executions. So, if you have a schedule that ends repeating after 10 runs, it will run 10 times and then stop. When you select the On Date option, a field appears to specify the date from a calendar. The Summary field is updated as per your choice(s).
    4. Every Month: When you select the frequency as Every Month, the following dialog box appears:

      1. Specify the time frame for month(s) in the Every field.
      2. You can either choose the Each field and then select the date(s), or choose the On the field to specify the following criteria:



        Note: If you schedule a report to run on the 31st day of every month or the fifth Friday of all months (or any request for which the day does not exist), a dialog appears as shown:

        Make your choice and click Ok.

      3. Select the End Repeat field from the drop-down list. There are three options to choose from here: Never, After, and On Date. When you select the After option, a field appears to specify the number of runs/executions. So, if you have a schedule that ends repeating after 10 runs, it will run 10 times and then stop. When you select the On Date option, a field appears to specify the date from a calendar. The Summary field is updated as per your choice(s).
    5. Every Year: When you select the frequency as Every Year, the following dialog box appears:

      1. Specify the time frame for year(s) in the Every field.
      2. Select the month(s) and then choose the On the field to specify the following criteria:



        Note: If the On the field checkbox is not selected, the report is scheduled based on the year and month criteria. It will run on the day and time as per the Starts On setting. If On the checkbox is selected, then only Time from Starts On is used.
      3. Select the End Repeat field from the drop-down list. There are three options to choose from here: Never, After, and On Date. When you select the After option, a field appears to specify the number of runs/executions. So, if you have a schedule that ends repeating after 10 runs, it will run 10 times and then stop. When you select the On Date option, a field appears to specify the date from a calendar. The Summary field is updated as per your choice(s).
  4. Select the Format either as PDF or CSV. To view the report, click the Preview link.
  5. Enter the email address of the recipient/s in the Send to: field. You will not be able to save the report until this field value has an entry. You can enter one or more email addresses in this field.
  6. Click Save to save this schedule.
  7. To enable this report, choose the ENABLED option in the top right of the dialog box.
    Note: If a report is disabled, the report appears as Schedule Disabled in the Pulse Reports page and also in the individual report's page. If the schedule of a report is in an expired state, the report appears as Schedule Expired in the Pulse Reports page and also in the individual report's page.
Exporting a Report

You can export the report as a PDF or CSV file. To export the report, click the Export Report button.

The report will be exported as per the choice you made.

Editing a Report

You can edit the reports that are saved. To edit a report, perform the following:

  1. From the Pulse Reports main page, click the Name or Schedule link of the report you want to edit. A screen similar to the one you use for creating reports appears.
  2. Make your changes. You can edit the Report Name, Schedule, and Export Report options. Refer to the sections above for steps.

Custom Pulse Reports

Watch the video below for more information on how to create a Custom Pulse Report that includes historical/trending data.

Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.