Skip to main content

# Dashboards

note

Dashboards in Avantra are only available in the new User Interface.

Dashboards are a way in Avantra to view and analyze data in a visual way. You can customize dashboards to your liking and add different types of dashlets to them.

By default, dashboards are private to the user who created them. They can be shared with customers using the customer hierachy. If you select a customer with child customers, the dashboard will be shared with all child customers as well. To identify the access of a dashboard, the left-hand navigation menu will display icons next to the dashboard name:

- for dashboards that have a Global link (available externally). Global links are created with custom links.
- for dashboards that are shared with customers. This is set via the access field when sharing a dashboard.
- for dashboards that are private to the user who created them. This is the default setting.

Dashboards have a component hierarchy of:

1. Dashboards, which contain one section by default but can have multiple.
2. Sections, which can contain one or more dashlets.
3. Dashlets, which are the actual data visualizations. A dashboard can have many dashlets, both of the same type or different types. Dashlets exist in a section.

## Dashboard management​

There are several actions that can be performed at dashboard level. To access the dashboards in Avantra:

1. Navigate to Monitoring > Dashboards from the top-level menu.

note

There are three user permissions associated with dashboards:

- Create dashboards: allows a user to create new dashboards.
- Create shared dashboards: allows a user to create dashboards that are shared with other Avantra users.
- Edit shared dashboards: allows a user to edit dashboards that are shared with other Avantra users.

### Adding a dashboard​

To add a dashboard:

1. In the left-hand navigation menu, at the bottom, click Add Dashboard > Create New.
   An dashboard will be created with an empty section, ready for editing.
2. Fill in a Name for the dashboard in the field labelled New Dashboard.
   The name must be unique and cannot be empty. Attempting to repeat a name will display an error message.

If you click Cancel before saving, the created dashboard will be discarded.

### Importing a dashboard​

To import a dashboard:

1. In the left-hand navigation menu, at the bottom, click Add Dashboard > Import.
2. Either click and browse locally to find the JSON file, or drop a single JSON file into the drop zone of the dialog box.
   If you need to remove it, click Remove.
3. Click Import.
   If there is an issue with the JSON file, an error icon will be displayed above the file name.
4. The dashboard will be imported and will be opened ready for editing.

If you click Cancel before saving, the import will be discarded.

### Dashboard actions​

There are three actions available in the left-hand navigation menu for a dashboard:

- Duplicating
- Editing
- Deleting

To duplicate a dashboard:

1. In the left-hand navigation menu, locate the dashboard you wish to locate and hover over it.
2. Click the menu icon.
3. Click Duplicate.
4. A new dashboard is created with the same name as the original dashboard, but with a suffix -copy.
5. The new dashboard is ready for editing.

To edit a dashboard:

1. In the left-hand navigation menu, locate the dashboard you wish to edit and hover over it.
2. Click the menu icon.

OR

1. In the left-hand navigation menu, locate the dashboard you wish to edit.
2. Click to open it.
3. Click Edit.
4. The dashboard is ready for editing.
5. After you have finished editing, click Save.

See Section management and Dashlet management for information on editing and interacting with a these components of a dashboard.

To delete a dashboard:

1. In the left-hand navigation menu, locate the dashboard you wish to delete and hover over it.
2. Click the menu icon.
3. Click Delete.
4. Click Delete in the confirmation dialog box.
5. The dashboard will be deleted.

### Dashboard settings​

When a dashboard is opened, there a customization settings available for the dashboard.

1. In the bottom right corner of the dashboard, click Settings.

You are able to select the layout type for the dashboard:

- A Fixed layout imposes some restrictions on dashlet sizes and position for optimal display across different displays.
- A Flexible layout allows full customization, but can cause issues when switching between different displays.

You can change the colors and background of the dashboard and section:

- The Background colour is a color picker that will change the background of the entire dashboard. Alternatively, you can pick from a preset of colors or enter the color hex code, for example `#FFFFFF` for white.
- The Background image allows you to upload an image that will be displayed as the background of the dashboard. The image will be scaled to fit the dashboard. You can delete an applied background image by clicking the Delete icon.
- The Section color is a color picker that will change the background of all sections in the dashboard. Alternatively, you can pick from a preset of colors or enter the color hex code, for example `#FFFFFF` for white.

2. Click Apply to save the changes.

## Section management​

Sections are used to group dashlets on a dashboard. A dashboard will always have one section, but can have as many as you require. By default, sections will be empty.

### Adding a section​

1. With the dashboard open, click Add Section.
2. Fill in a Name for the section in the field labelled New Section. Names do not need to be unique.

The new section will be added to the bottom of the dashboard.

### Reordering sections​

1. With the dashboard open, hover over the section you wish to reorder.
2. Click and hold the section icon and move the section to the desired location.

### Deleting sections​

There are two ways to delete a section.

The first is to delete and section and any dashlets that are in a section:

1. On the section you wish to delete, click the Delete icon.
2. Select `-None-` from the dropdown menu.
3. Click Delete.
4. The section and any dashlets in it will be deleted.

The second is to delete a section and move dashlets within that section to the one above it:

1. On the section you wish to delete, click the Delete icon.
2. From the dropdown, select a section to move the dashlets to.
3. Click Delete.
4. The section will be deleted and the dashlets in it will be moved to the selected section.

If a section is empty, clicking Delete will delete the section.

## Dashlet management​

Dashlets are used to display data on a dashboard. You can have as many dashlets as you require in a section of a dashboard, as well as duplicate dashlets in the same section or across multiple sections.

### Adding a dashlet​

To add a dashlet to a section:

1. Click Add dashlet in a section.
2. Search for the dashlet you wish to add.
3. Click Add.
4. Each dashlet requires information to be applied to it, such as a title, a refresh interval and system selectors, for example. Fill in the fields that are required for the dashlet.
5. (Optional) If you have more than one section in your dashboard, you can select the section you wish to add the dashlet to from the dropdown menu if you want it to be in a section other than the one you started with.
6. Click Add to save the dashlet.

The dashlet will be added.

### Changing the layout of dashlets​

Within sections, it is possible to change layout and size of dashlets in a section. The amount of change is dependent on the layout type chosen in the dashboard settings.

You can resize a dashlet by hovering over the bottom right-hand corner and clicking and dragging the dashlet to the desired size.

To change the location of a dashlet, click and drag the top bar of the dashlet to the desired location.

### Dashlet actions​

There are three actions available for a dashlet:

- Duplicating
- Editing
- Deleting

To duplicate a dashlet:

1. Locate the dashlet you wish to duplicate.
2. Click the menu icon.
3. Click Duplicate. 4.The new dashlet screen will open, where you can define the new dashlet.
4. Click Add to save the dashlet.

Clicking Cancel will prevent the creation of the dashlet.

To edit a dashlet:

1. Locate the dashlet you wish to edit.
2. Click the menu icon.
3. Click Edit.
4. The dashlet is ready for editing.
5. After you have finished editing, click Apply.

To delete a dashlet:

1. Locate the dashlet you wish to delete.
2. Click the menu icon.
3. Click Delete.
4. Click Delete in the confirmation dialog box.
5. The dashlet will be deleted.

## RTM Control Center dashboard​

Avantra is supplied with one system dashboard called the RTM Control Center.

This dashboard is read-only and cannot be modified. It is only accessible from the classic UI.

To access this dashboard:

1. Select Monitoring > Dashboards from the top-level menu.
2. Select the RTM Control Center dashboard.

You can also access this dashboard directly using URL `http[s]://[avantra-server][:port]/xn/dashboard/RTM%20Control%20Center`.

While this dashboard is read-only, you can change the dashboard that is displayed when you select Monitoring > RTM Control Center. To do this, in Administration > Settings > Avantra UI, define the Dashboard Name in `RTMControlCenterDashboard`. Leaving this field blank will display the default RTM Control Center dashboard.

You can filter the data displayed in this dashbord by clicking the controller icon. Here you can filter the dashboard by date, customer and / or selection.