Administration Features and Functions > Configuring Dashboards
  
Configuring Dashboards
Dashboards bring together browses, web pages, business intelligence, and metrics within panels. Each panel offers a quick summary; to find out more, you click on the panel. As a user, you can create, edit, and delete dashboards directly in the QAD .NET UI. To create a new dashboard, you open Create Dashboard and then add content. You can also copy and edit an existing dashboard. (For more information on using dashboards, see the Introduction to Enterprise Applications User Guide.) As an administrator, you can also do the following:
Change the number of panels allowed in a dashboard.
Copy dashboards between systems.
Identify the data files associated with each dashboard.
Set dashboard characteristics in the client session configuration file (client-session.xml).
Configure access to the BI portal so you can include BI panels on dashboards.
Changing the Number of Panels Allowed in a Dashboard
By default, a dashboard can include up to 12 panels. As a system administrator, you can change the default setting of 12 to some other number by editing the MaxPanels setting in the client-session.xml file on the home server:
<!-- Maximum number of panels allowed in a Dashboard. Set to zero for unlimited. -->
<MaxPanels>12</MaxPanels>
Copying Dashboards Between Systems
Dashboard definitions are saved on the server in XML files. The XML files are located in user-data directories and in the system-level directory: dashboards created by users are stored in the user-data dashboard directories, while system-level dashboards (such as published dashboards and those downloaded from the QAD Store and installed on your system) are stored in the system-level dashboard directory. The XML files use a naming convention based on a key identifier (for example, 7c430916-1494-475e-b5a1-18f574e9708d.xml).
User-data Directories
Dashboard definitions for each user are saved on the server in XML files in the user-data dashboard storage directory:
TomcatInstallationDirectory/webapps/qadhome/configurations/EnvironmentName/storage/user-data/UserName/dashboards
System-level Directory
Dashboard definitions for the system can be placed in the system-level storage directory:
TomcatInstallationDirectory/webapps/qadhome/configurations/EnvironmentName/storage/dashboards
Copying the Dashboard Definitions
To copy dashboard definitions from one system to another, go to the various dashboards storage directories and copy the .xml files from there to the dashboard directories of the other system.
Note that the dashboard definitions can reference browses and metrics, so you also need to copy any referenced browse definitions and metric definitions not on the destination system.
Within a given system, the dashboard definition XML file names must be unique. For instance, if an XML file in a user-data dashboard directory has the same filename as a file in the system-level dashboard directory, the QAD .NET UI will not open properly.
Identifying Files Associated with Specific Dashboards
The XML files use a naming convention based on a unique key (for example, 7c430916-1494-475e-b5a1-18f574e9708d.xml). To find out which file is associated with which dashboard on the QAD .NET UI, from the QAD .NET UI menu, right-click on a dashboard menu item and choose Properties. In the General tab, the Key field indicates the unique key, with a DB_ prefix (for example: DB_7c430916-1494-475e-b5a1-18f574e9708d). You can then identify the filename associated with the dashboard. Note that if the dashboard was created by some user, the dashboard will be located in that user’s user-data directory rather than in the system-level directory.
Dashboard Settings in client-session.xml File
The dashboard settings section in the client session configuration file (client-session.xml) include:
<!-- Dashboard options-->
<Dashboard>
<!-- Comma separated list of roles with administration privileges
These users can manipulate system level dashboard templates -->
<AdminRoles>superuser,qadadmin</AdminRoles>
<Padding>10</Padding>
<!-- Maximum number of panels allowed in a Dashboard. Set to zero for unlimited. -->
<MaxPanels>12</MaxPanels>
<!-- Provider specific panel strip colors -->
<ProviderColors>
<QAD.OPMetrics.dashboard.OpMetricsDashboard>0xc0,0x39,0x2b</QAD.OPMetrics.dashboard.OpMetricsDashboard>
<QAD.RolePage.UrlRoleTarget>0x8e,0x44,0xad</QAD.RolePage.UrlRoleTarget>
<QAD.Plugin.BI.DashboardProvider>0x27,0xae,0x60</QAD.Plugin.BI.DashboardProvider>
<QAD.Browse.dashboard.BrowseDashboardTarget>0xf3,0x9c,0x12</QAD.Browse.dashboard.BrowseDashboardTarget>
</ProviderColors>
</Dashboard>
<AdminRoles>
Specifies a comma-separated list of roles with dashboard administration privileges. A dashboard administrator can associate dashboards with roles, publish dashboards, and edit or delete published dashboards.
In this example, the superuser and qadadmin roles have dashboard administration privileges:
<AdminRoles>superuser,qadadmin</AdminRoles>
<Padding>
Specifies the spacing between panels in pixels.
Example:
<Padding>10</Padding>
<MaxPanels>
Specifies the maximum number of panels allowed on a dashboard.
Example:
<MaxPanels>12</MaxPanels>
<ProviderColors>
Specifies the border colors for different types (browses, metrics, etc.) of panels in RGB Hex values. Under <ProviderColors>, we have settings for each type of panel content. The default settings for each type of panel are as follows:
 
Type
Setting
Default Color
RGB Hex Value
Browses
<QAD.Browse.dashboard.BrowseDashboardTarget>
Orange (#F39C12)
0xf3,0x9c,0x12
Operational Metrics
<QAD.OPMetrics.dashboard.OpMetricsDashboard>
Red (#C0392B)
0xc0,0x39,0x2b
Web Pages
<QAD.RolePage.UrlRoleTarget>
Purple (#8E44AD)
0x8e,0x44,0xad
BI
<QAD.Plugin.BI.DashboardProvider>
Green (#27AE60)
0x27,0xae,0x60
Example:
<QAD.OPMetrics.dashboard.OpMetricsDashboard>0xc0,0x39,0x2b</QAD.OPMetrics.dashboard.OpMetricsDashboard>
<QAD.RolePage.UrlRoleTarget>0x8e,0x44,0xad</QAD.RolePage.UrlRoleTarget>
<QAD.Plugin.BI.DashboardProvider>0x27,0xae,0x60</QAD.Plugin.BI.DashboardProvider>
<QAD.Browse.dashboard.BrowseDashboardTarget>0xf3,0x9c,0x12</QAD.Browse.dashboard.BrowseDashboardTarget>
Configuring Business Intelligence (BI) Portal for Dashboards
If you have the QAD Business Intelligence (BI) portal, you need to specify the URLfor accessing BI in the client session configuration (client-session.xml) file’s <BI.Dashboard.URL> setting so that the QAD .NET UI can locate and access the BI portal. The BI portal must be accessible for the availability of BI panels on dashboards. (If the BI portal is not accessible, the BI panel option will not be available on Create Dashboards.) The setting in client-session.xml is:
 
<BI.Dashboard.URL>http://ip_address_of_BI:port_number/qadbi</BI.Dashboard.URL>
 
In addition, to access the BI portal, the login / password for the QAD .NET UI client must match the login / password for the BI portal.