==========================
Dashboard Designer
==========================

The **Dashboard Designer** page allows user to

.. hlist::
   :columns: 2

   -  select a preset layout
   -  add report parts to a dashboard
   -  customize dashboard layout
   -  edit dashboard description and background
   -  copy and move dashboard
   -  switch to presentation mode
   -  configure sharing access
   -  add subscriptions and scheduled delivery
   -  print dashboard
   -  email dashboard
   -  dashboard filters

.. _Create_a_New_Dashboard:

Create a New Dashboard
======================

#. Click the plus icon (+) next to Dashboards to create a new one.

#. Select a preset layout from the pop-up.

    User can always add and remove tiles in the preset layout
    afterwards.

    .. _Dashboard_Add_Icon_and_Preset_Layout:

    .. figure:: /_static/images/Dashboard_Add_Icon_and_Preset_Layout.png
       :align: right
       :width: 635px

       Dashboard Add Icon and Preset Layout |br|

#. Select to either create a "text" dashboard tile or include an existing report part in each one.

   .. _Dashboard_Tiles_Report_Part_or_Text:

   .. figure:: /_static/images/Dashboard_Tiles_Report_Part_or_Text.png
      :width: 600px

      Report Part or Text options |br|

#. For a "text" dashboard tile, click the Configuration mode (page flip)
   icon to input the content.

   .. _Text_Dashboard_Tile:

   .. figure:: /_static/images/Text_Dashboard_Tile.png
      :align: right
      :width: 600px

      "Text" Dashboard Tile |br|

   #. Optionally enter a title and description.
   #. Click the gear icons (⚙) to format the title and description.
   #. The title and description are limited to one paragraph of text and
      simple formatting:

      -  font face and font size.
      -  text effects bold, italic, underlined.
      -  font color and background color.
      -  text alignment.

   #. Enter the content into Body Text.
   #. This section supports unlimited amount of text and more formatting
      options:

      -  Bullet List and Numbering List.
      -  Indented text.

#. For existing report part option, use the Report Part Selection pop-up to search and use an existing report part:

   #. Optionally specify a report category or sub-category.
   #. Type a partial text in Report Name to search for the containing
      report first.
   #. Other search options include Created By, Created Date, Last Edited
      By and Last Edited Date.
   #. Click Search to see the list of matching reports.
   #. Select a report to display the list of child report parts.
   #. Select the right report part and click OK to use it.

   .. _Dashboard_Report_Part_Selection:

   .. figure:: /_static/images/Dashboard_Report_Part_Selection.png
      :align: right
      :width: 600px

      Report Part Search |br|

#. Repeat for other tiles then click Save at the top to save the dashboard.

Following is a sample dashboard with 3 tiles: a comparison column chart, detail grid and a text part for the summary:

.. _Dashboard_Sample:

.. figure:: /_static/images/Dashboard_Sample.png
   :align: right
   :width: 767px

   Sample Dashboard

Customize Dashboard Layout
==========================

The dashboard tiles can be added, copied, resized, moved around, swapped
in position and deleted.

#. .. _Dashboard_Tile_Title_Bar:

   .. figure:: /_static/images/Dashboard_Tile_Title_Bar.png
      :align: right
      :width: 405px

      Title Bar

   Move the cursor over the title bar to see Copy, Configuration/View mode, Fullscreen and Delete buttons.
#. Switch the tiles back to View mode to be able to change the layout.
#. Place the cursor over the edges of dashboard tiles then click and drag to resize them.
#. Move the cursor over the title bar then drag to move the tiles.
#. Drag a tile onto another to swap them.
#. Click the Add Dashboard Tile button at the top to insert a new tile
   at the end.

Edit Dashboard
==============

.. _Dashboard_Edit_Menu:

.. figure:: /_static/images/Dashboard_Edit_Menu.png
   :align: right
   :width: 182px

   Edit Menu

The Edit menu allows user to:

-  Set a description for the dashboard.
-  Set background color.
-  Set background image:

   #. Select Set Background Image to open Background Image Settings
      pop-up.
   #. Enter the url of the image.
   #. Choose to stretch or center the image.
   #. Click OK to close the pop-up.

-  Copy or Move dashboard, this is similar to Report (:ref:`Copy_a_Report` and :ref:`Move_a_Report`).
-  Hide or show report part filter descriptions in dashboard.



Switch to Presentation Mode
===========================



Click the Presentation button at the top to switch to Presentation mode.

   .. _Dashboard_Presentation_Mode:

   .. figure:: /_static/images/Dashboard_Presentation_Mode.png
      :width: 600px

      Presentation Mode |br|

-  In this mode, each dashboard tile takes turn being displayed for a
   configurable time.

-  The sub toolbar allows user to configure the slide transition time
   and switch to fullscreen.

.. note::

   Using report parts with short data refresh intervals together with presentation mode in fullscreen can effectively make up a live slide show dashboard.

Configure Sharing Access
========================

#. Click the Access button at the top to open Access screen.
#. Click the Add Sharing button to add a new sharing.
#. Select either Everyone, Role, or User from the Share With drop-down.
#. For Role or User, select a specific one from the drop-down.
#. Select a permission from Acces Right drop-down (See details in List
   of Access Rights table below).
#. Click Save button at the top to save the list.

.. _Dashboard_Sharing_Access:

.. figure:: /_static/images/Dashboard_Sharing_Access.png
   :width: 600px

   Sharing Access |br|

.. list-table:: List of Access Rights
   :class: apitable
   :header-rows: 1

   *  - Interact with shared report
      - Full Access
      - Save As
      - Locked
      - View Only
      - No Access
   *  - **View the dashboard with filter interaction**
      - ✔
      - ✔
      - ✖
      - ✔
      - ✖
   *  - **View the dashboard with NO filter interaction**
      - ✖
      - ✖
      - ✔
      - ✖
      - ✖
   *  - **Save changes in the dashboard**
      - ✔
      - ✖
      - ✖
      - ✖
      - ✖
   *  - **Save As changes in the dashboard**
      - ✔
      - ✔
      - ✖
      - ✖
      - ✖

.. list-table:: Access Rights Precendence (Higher Right covers lower ones)
   :header-rows: 1
   :widths: 50

   *  - **Access Right**
   *  - Full Access
   *  - Save As
   *  - Locked
   *  - View Only
   *  - No Access

Another function of this screen is to change the Dashboard Owner (next
to the dashboard name):

#. Click the plus icon to open All Users pop-up.
#. Select either User Name, Email Address or Role to search for. Select All to search for all fields.
#. Type a partial name into the search box and click the search icon (🔍).
#. Only matching users will be displayed.
#. Select the user then click OK to close the pop-up.
#. Click Save button at the top to save the dashboard together with the owner.

Add Subscriptions
=================

#. Click the Subscribe button at the top to open Subscription screen.
#. Dashboard Subscription is similar to :ref:`Report
   List <Add_Report_Subscriptions_for_Current_User>`.
#. Click the Subscribe button again to close Subscription screen.

Add Scheduled Delivery
======================

#. Click the Schedule button at the top to open Schedule screen.
#. Dashboard Schedule is similar to :doc:`Report
   Schedule <doc_report_designer_schedule>`.
#. Click the Schedule button again to close Schedule screen.

.. _Print_Dashboard:

Print Dashboard
===============

#. .. _Dashboard_Print_Options:

   .. figure:: /_static/images/Dashboard_Print_Options.png
      :align: right
      :width: 233px

      Print Options

   Click the Print button at the top and select either HTML or PDF format to open Print pop-up.
#. Select print options in the left menu while the print preview is
   reflected on the right:

   -  Select a target printer using Change button.
   -  Select specific pages to print.
   -  Increase the number of copies, then tick the Collate check-box to
      have the pages of each copy printed separately, instead of being
      mixed together.
   -  Select a page layout Portrait or Landscape.
   -  Select a paper size. |br|
   -  Select a margin option. In Custom mode, the margins in preview
      pane can be resized interactively.
   -  .. _Dashboard_Print_Custom_Margins.png:

      .. figure:: /_static/images/Dashboard_Print_Custom_Margins.png
         :align: right
         :width: 500px

         Custom Print Margins

      Select a print resolution in Quality drop-down: the higher the
      number of dpi, the clearer and more detailed output.
   -  Select to print headers and footers or not.
   -  Select to print background images or not. |br|

#. For more advanced options, click the link Print using system
   dialog... to use the system Print dialog.

.. _Email_Dashboard:

Email Dashboard
===============

The dashboard can be delivered via email on-demand (instead of Scheduled
Delivery) using the Email button:

#. Choose a delivery method Link or Embedded HTML to open Compose Email pop-up with the email template already populated.
#. Fill in the To, Subject and optionally CC boxes.
#. Optionally select the delivery method Link, Attachment or Embedded HTML.
#. Click OK to close the pop-up and send the email.

.. _Dashboard_Filters:

Dashboard Filters
=================
#. The filter section on the dashboard will only show common filters between all report parts used in the dashboard.
#. By default, common filters are defined as the same field from the same table in the same schema of the database utilizing the same filter operator.
#. Common filter definitions can be altered in Settings > Data Setup > Advanced Settings > Others > Determine common filter for the same field based on. The following options are available:

   - Same field of the same data object from the same database schema (Default)
   - Same field name regardless of database schema or connection string
   - Same alias name regardless of database schema or connection string

   **Notes:** From version 2.15.0, the Use Lookup checkbox states are also considered when determining dashboard common filter.

#. Stored procedures used in reports follow the same logic as above.
#. Any filters which are not common between all report parts are available on the back of the report part tile. The user can flip the tile and update results to change the filters for the specific report part.
#. Common filters query only one instance of a common filter (the first one in the dashboard), for data driven filters (checkbox, selection, tree, popup style filters where the user is presented data for selection). This means when Field A is common, based on rules set above, only the first instance of the field which is common will be queried to pull results for common filter data.
#. Common filter order in the dashboard is set by the top most left dashboard tile. The filters associated with this report will be used to set the order. This order will update when a new tile is added, a tile is removed, and on saving the dashboard. The order is not recalcualted as tiles are moved around on the dashboard.