# Dashboards

A Dashboard in Avantra is a page in the UI you can customize to your liking. It features the positioning of the so-called Dashlets in either a fixed or a floating grid layout.

Dashboards may be private to a User or shared between all Users of a given Customer. There is also an option to open a Dashboard outside of the UI by a direct URL.

## Working with Dashboards

A Dashboard in Avantra is a page in the UI you can customize to your liking. It features the positioning of the so-called Dashlets in either a fixed or a floating grid layout.

Dashboards may be private to a User or shared between all Users of a given Customer. There is also an option to open a Dashboard outside of the UI by a direct URL.

As with all objects in Avantra, a Dashboard belongs to a specific Customer, and only Users with View Systems Permission for this Customer are able to access the Dashboard. Likewise, Users can only create Dashboards for Customers they have the View Systems Permission for.

Every Dashboard may contain multiple Sections in order to group the Dashlets.

| Starting with Avantra 21.11.0 we will successively roll out the new Avantra user experience. It currently supports to view all the dashboards created. Please use the Try our new UX in the upper right corner.

### Adding new Dashboards

To create a new Dashboard, perform the following steps:

Procedure: Creating a Dashboard

1. Select Monitoring Dashboards from the top-level menu and click New.

2. Fill in a Name and an optional Description. Select a Customer from the list and choose if the Dashboard is Shared, i.e. if other Users of the selected Customer shall be able to access the Dashboard as well.

   Push the Create button. A new tab opens with the title set to the name of the Dashboard.

3. Adding Dashlets

   1. Click on Add Dashlet. The Add new Dashlet window opens. Choose a Dashlet from the list. You can narrow down your selection if you choose one of the Categories first. Push the Add button of the Dashlet of your choice. The Configure page opens.

      | You can click on the Dashlet icon to see a preview of the Dashlet.

   2. There are options that depend on the particular Dashlet displayed in the upper part of the window. Usually, these options comprise some direct input or the definition of a Selector.

      The lower section consists of settings that are common for all Dashlets. You can choose the Grid Width and Grid Height of the Dashlet, or if it should Use the maximum window width. You can also Override Title and Override Subtitle which otherwise are selected automatically. Finally, you can choose a different Refresh Interval if the default is not suitable for you.

   3. Push the Apply button to save the Dashlet.

   4. Repeat the steps above to add further dashlets.

   5. Use your mouse and drag the Dashlets to re-arrange them.

   6. To configure a Dashlet you already have added, push the icon inside the Dashlet.

   7. To remove a Dashlet, push the icon inside the Dashlet.

4. Configuring the Dashboard

   1. Push Configure to open the Configure Dashboard window.

   2. You can change the Dashboard Name, Description, Customer, and the Shared flag if you are no longer happy with the values chosen initially.

   3. If you do not want to use the Floating Layout, which automatically adjusts the grid layout according to the browser window size, clear the corresponding flag.

   4. You can directly access the Dashboard using the URL defined in URL. If you do not want to allow direct access, clear the value in the field.

   5. By default, the page accessible by the URL defined above requires login. If you want to access this page automatically without a User to log in, choose an appropriate Auto Login User from the list.

   6. Managing Sections

      1. Push the Add New Section button to add a new section to the Dashboard. A new section row will be added. Click on the name of the new section and change it accordingly.

      2. You can click on to add a Dashlet from this dialogue directly.

      3. Choose and to re-arrange sections.

      4. Choose to remove a section.

   7. Managing Styles

      1. You can set a different background color or use a background image, either by uploading or by referencing to an online resource.

      2. You can change the Title Color as well.

      3. You can disable the Dashlets being animated during refresh: clear the Animate Dashlets on refresh flag.

      4. Finally, you can Override CSS Styles by defining valid CSS in the text box.

         | You should be familiar with web development and the usage of the appropriate tools.

         CSS classes involved are those starting with `z-xdashboard` and `z-xdashlet`.

   8. Push Apply to save your configuration settings.

5. Push Exit Edit Mode to finish the Dashboard creation.

### Modifying Dashboards

Modifying a Dashboard is similar to creating one.

1. Select Monitoring Dashboards from the top-level menu. Select the Dashboard in question and push Open.

2. Push Edit to switch into the edit mode.

3. Perform the desired steps described in Step 4 of Creating a Dashboard.

4. Push Exit Edit Mode to finish the Dashboard creation.

### System Dashboards

System Dashboards come pre-configured with Avantra and are read-only Dashboards.

Currently, there is only one System Dashboard, the RTM Control Center.

You can also access this Dashboard directly using URL `http[s]://[avantra-server][:port]/xn/dashboard/RTM%20Control%20Center`, and you can use the `rtmuser` property for a configuration option without login.

You cannot modify a System Dashboard, but you can make a copy of it and configure it as described in Modifying Dashboards.

Select Monitoring Dashboards from the top-level menu. Select the Dashboard in question and choose More Copy.

If you want to use the copied Dashboard as a replacement for the original RTM Control Center, i.e. to make it accessible through Monitoring RTM Control Center, define the Dashboard Name in RTMControlCenterDashboard.

### Using Dashboards

The main purpose of Dashboards is to display data. But there are few things worth knowing.

Every Dashboard features a Controller that allows you to further restrict or configure the amount of data displayed:

1. Select Monitoring Dashboards from the top-level menu. Select the Dashboard in question and push Open.

2. Push the icon. The Controller opens.

3. You can change the date range of the data displayed by the whole Dashboard. You can also restrict the data to a given Customer.

4. Push the  button to close the Controller again.

Many Dashlets feature in the upper right corner. If you click on this icon, the corresponding tab opens that provides the underlying data of the Dashlet.

### Deleting Dashboards

| Only the owner of a Dashboard can delete it.

Select Monitoring Dashboards from the top-level menu. Select the Dashboard in question and push the Delete button.