We've moved! Visit and bookmark catalyst.avaya.cx to see current content. This site is outdated.

Overview: Report settings (App)

App > Analytics > Overview: Report settings (App)

This article provides an overview of report settings in App.

Overview

In App, the settings panel of a report is where you configure various report-wide parameters.

The Settings panel of a report

The settings panel controls report-wide parameters. Each report has its own unique settings panel, so you’ll need to configure the settings for each report you create.

The settings available in the report settings panel include:

Report Timezone
Report merging
Display Query Dropdowns
SFTP settings (used when exporting a report via SFTP)
- - SFTP Host
  - SFTP Port
  - SFTP Upload Path Destination
  - SFTP Username
  - SFTP Private Key

Continue reading this article to learn more about these settings.

Accessing the Settings panel

To access the Settings panel, open the Editor workspace for a report. Then, click the tri-dot icon in the top-right corner of the report. Select Settings to see the Settings panel.

While in the Editor view of the report, click the tri-dot icon and select Settings

Visual breakdown

Report Timezone

The Report Timezone field controls the date format for all date fields on the report. By default, all time values on a report are displayed in UTC. You can use this field to change the timezone of date columns on the report. Click the menu to reveal a list of time zones. Scroll / search through the list to find your desired time zone.

Merge report settings

The Add Report to Merge button lets you merge a report into the current report. You can merge any report that shares a common column with the current report.

To learn more, see: Tutorial: Merging reports (App)

Display Query Dropdowns

The Display Query Dropdowns toggle sets whether a variable-based dropdown appears when viewing a report that has a variable filter applied to it.

When creating a filter for a report, you can add a variable filter to the report. With a variable filter applied, you can dynamically search for data with data you provide while viewing the report.

In this screenshot, the variable filter is using the variable {{userId}}. This adds a query dropdown menu to the report (in the screenshot above, the userId menu). This particular report shows the number of interactions handled by a particular user. So, the {{userId}} menu is used to select a specific user to show their interaction handling data.

The Display Query Dropdown toggle determines whether the dropdown menu appears when viewing the report. This feature is useful when you want to temporarily restrict access to viewing data in a report.

Display Query Dropdowns enabled

Display Query Dropdowns disabled

SFTP settings

You can configure a report for SFTP export with the settings below:

SFTP Host: The SFTP Host field is for exporting reports via SFTP. This field defines the server address of the server that will receive the exported report file once it’s exported.
SFTP Port: The SFTP Port field defines the specific port of the server that will receive the exported report file once it’s exported.
SFTP Upload Path Destination: The SFTP Upload Path Destination field defines the specific path to the directory on the server where the exported file will be saved when exporting the report.
SFTP User Name: The SFTP User Name field is used for authenticating against the SFTP server.
Use Private Key: The Use Private Key field specifies whether the Avaya system should provide a key to the authenticating SFTP server.
SFTP Private Key: The SFTP Private Key field is used for authenticating against the SFTP server.

Page updated

Report abuse

Overview: Report settings (App)

In this article