Overview

Dashboard Settings allows you to customize, edit, and delete dashboards.

Getting Here

To access an existing dashboard's Settings page, you must Edit the dashboad by using the following steps.

1. From the main menu, navigate to Dashboards > All.
2. Click the row options icon at the beginning of the row that includes the custom dashboard.
3. Click Edit.
4. Click the Settings button.
5. View or modify the form fields.
6. When done, click SAVE, or CANCEL, or DELETE DASHBOARD.

Form Fields

Name

• Description: A required field where you input the name of the new dashboard.
• Usage: Enter a unique and descriptive name for the dashboard. This name will be used to identify the dashboard in the system.

Description

• Description: An optional field to provide a brief description of the dashboard.
• Usage: Use this field to describe the purpose or contents of the dashboard, helping others understand its focus.

Collection

• Description: A dropdown menu where you can select the collection to which this dashboard belongs.
• Usage: Choose an appropriate collection to organize the dashboard within the system. Collections help in categorizing and retrieving dashboards.

Date & Time

• Options:
  • INHERIT: Inherits the date and time settings from a global or default configuration.
  • CUSTOM: Allows customization of the date and time settings for this dashboard.
• Usage: Select the appropriate setting based on whether the dashboard should use inherited settings or require a custom date and time configuration.

NQL Mode

• Options:
  • GLOBAL: Uses the global NQL (Network Query Language) settings.
  • OVERRIDE: Overrides the global NQL settings with those specific to this dashboard.
  • APPEND: Appends additional NQL settings to the global configuration.
• Usage: Choose the NQL mode depending on how you want the dashboard to interact with global NQL configurations.

Color Palette

• Description: A selection of color palettes that can be applied to the dashboard's visual elements.
• Usage: Choose a color palette that best fits the visual style or branding requirements of the dashboard.

Options (Blank Dashboards)

Theses options display when the existing dashboard is blank (empty) and has no embedded widgets.

• Public Visibility
  • Description: A checkbox to make the dashboard publicly visible.
  • Usage: Check this option if the dashboard should be accessible to users outside of your immediate team or organization.
• Prevent Auto Loading (requires NQL search)
  • Description: A checkbox to prevent the dashboard from automatically loading data without an NQL search.
  • Usage: Use this option if you want to restrict data loading until specific queries are made.
• Add to Favorites (greyed out)
  • Description: A checkbox to add the dashboard to your favorites list.
  • Usage: This option becomes available after adding elements to the dashboard.
• Set as Your Homepage (greyed out)
  • Description: A checkbox to set this dashboard as your homepage within the system.
  • Usage: This option becomes available after adding elements to the dashboard.
• Set as Company Homepage (greyed out)
  • Description: A checkbox to set this dashboard as the company-wide homepage.
  • Usage: This option becomes available after adding elements to the dashboard and may require administrative privileges.
• Set as Event Template (greyed out)
  • Description: A checkbox to set this dashboard as a template for events.
  • Usage: This option becomes available after adding elements to the dashboard.

Save Button

• Description: A button to save the dashboard.
• Usage: Click this button to save the new dashboard with the configurations specified in the form.

Cancel Button

• Description: A button to cancel the creation of the dashboard.
• Usage: Click this button to discard the form and not create the dashboard.

Populated Dashboard Options

Theses options display when the existing dashboard includes embedded widgets.

Public Visibility: Check this option to make the dashboard publicly visible to all users.

• Prevent Auto Loading: Select this option to prevent the dashboard from auto-loading, which requires an NQL search to be performed before displaying data.

• Add to Favorites: Mark this dashboard as a favorite for quick access from your favorites list.

• Set as Your Homepage: Set this dashboard as your personal homepage within the platform.

• Set as Company Homepage: Set this dashboard as the company-wide homepage (this option may require admin privileges).

• Set as Event Template: Use this dashboard as a template for events, making it easier to create similar dashboards in the future.

Actions

• Save: Click this button to save the changes made to the dashboard.

• Cancel: Click this button to cancel the edit process and return to the previous screen without making any changes.

• Delete Dashboard: Permanently delete the dashboard from the system. Use this option with caution, as it cannot be undone.