The Dashboard Object Definition window allows you to specify the appearance and behaviour of dashboard objects that have been added to your dashboard tabs.

 


The Dashboard Object Definition window consists of the following tabs;


Data

Allows you to define the data that will populate the dashboard object.

Totals

Allows you to behaviour of totals for Grids and Pivot Table objects.

Appearance

Allows you to specify settings that will govern the appearance of the dashboard object.

Numeric Format

Allows you to specify the numeric format used to display numbers in the dashboard object.

X Axis

Allows you to specify settings that govern the appearance of the X axis on the dashboard object.

Y Axis

Allows you to specify settings that govern the appearance of the Y axis on the dashboard object.

Drill Down

Allows you to add and define a drill down to the dashboard object

Alerts

Allows you to add and define alerts for this dashbaord object.

Advanced

Allows you to add advanced XML definitions to your dashboard object.



Dashboard Object Definition - Data


The Dashboard Object Definition window Data tab allows you to specify the data that will be used to render your dashboard object.

 

Follow the steps below to specify the data;


First select the Query data set that you wish to base your dashboard object;


Then Select a Calendar if required. ( see here for an explanation of Calendar's ) 

 

If you wish to, press the filter button to apply a filter to your data set. Next, decide how you want to group your data, and select the appropriate option;

 

 

The options are described below;

On Change of

Creates a record for each distinct combination of the group values selected.

For Each Record

Creates a record for each record in the source data set, regardless of the group values selected. The For Each Record option will only be offered if you are defining data for a data grid. If you select this option, you will not be able to specify any summary columns as the records are not summarised.

For All records

Creates a single record regardless of the group values selected.


Next, add the Dimension () group columns you require (some object types will only allow a single group column).

 


Select the Refrsh button , if you do not see a recently added Column, this will retrieve the available columns from inmydata.

If you wish to, you can change the way group values are grouped, sorted and displayed by selecting the group options button to open the group options window.

Next, select which Metric ( ) summary columns you require (some object types will only allow a single summary column).

 

For each summary column, select the summary operation you wish to be applied. Distinct count is the number of distinct values in the column for the group selected.


Note: The list of summary operations will be limited based on the type of Metric Summary Column that is selected

 

If you are defining a data grid, you can specify specific numeric formatting for each of the summary and group data columns. To override the default numeric format for a specific  column, select the Numeric Format Tab. This will open the Numeric Format tab to select a column and specify the format.



Dashboard Object Definition - Data - Group Options


The Group Options screen allows you to specify how group values are selected and sorted.

 

To specify your group options, first select the group you want to set properties for;

Next, specify the group selection and group sorting options.


Group Selection


The Group Options window Group Selection tab allows you control how group values are selected to be displayed in your dashboard object or drill down.

 

Follow the steps below to specify how group values are selected;

 

If the group is a date, or date-time value, select which time interval you want to be used to group the data;

 

 

 

 

 

 

 

Next, if there are too many group values to display on a single chart you can limit the number of groups shown by selecting one of the group limiting options, described below.

All

Shows all groups

Top N

Shows a specified number of groups with the highest summary value.

Bottom N

Shows a specified number of groups with the lowest summary value.

Top Percentage

Shows groups where a specified summary value is in the top percentage specified.

Bottom Percentage

Shows groups where a specified summary value is in the bottom percentage specified.


To limit the number of groups show, do the following;

 

1.Select one of the group limiting option (top n, bottom n, top percentage, bottom percentage)
2.Select the summary column the order or the groups are based on.
3.Enter a value for the number of groups (N) or percentage.
4.If you want to include all other groups in a single group on the chart, select Include Others and enter a label for the extra group.
5.If you want to include ties, select the include ties option. If you opt to include ties, and multiple groups have exactly the same summary value, all the equal groups will be included in the chart.

 


Group Options - Group Sorting


The Group Options window Group Sorting tab allows you control how group values are sorted in your dashboard object or drill down.

 

Follow the steps below to specify how group values are sorted;

 

First, select which column the group sorting is going to be based on. This may or may not be the same column that the group itself is based on.

Next, select how you want the sort column value to be applied to sort the group.

 

Ascending

Groups will be sorted in ascending order using the value of the column selected.

Descending

Groups will be sorted in descending order using the value of the column selected.

Original Order

Groups will be sorted in the original order the data is returned by the query.


Dashboard Object Definition - Data - Data Filter


The Define Data Filter window allows you to define a filter to be applied to a query data set before it is summarised to build a dashboard object or populate a filter parameter. You can define the data filter using the filter builder or using a tree view filter panel.

 

 

Follow the steps below to define a filter using the filter builder;

 

Select the Filter Builder tab.

 

Press Add to open the define filter condition window and create a new condition.

 

To delete a condition, select the condition and press Delete.

 

To Edit a condition, select the condition and press Edit to open the define filter condition to edit the condition.

 

To group or ungroup conditions, select the conditions and press group or ungroup.

 

To add a filter based on a tree view filter panel, you must first create a tree view filter panel that contains columns  with the same name and data type as those you wish to apply the filter to. Once you have created a suitable tree view filter panel, follow these steps to create a filter based on it;

 

First select the Tree View Selection Panel tab, then use the buttons to move the tree view(s) you want to apply to the filter across to the selected list.





Define Filter Condition


The Define Filter Conditions window allows you to define a filter condition as part of a data filter.

 

There are three types of filter condition you can define;

1.A simple fixed value condition
2.A list of fixed value conditions
3.A filter parameter condition

 

To define a simple fixed value condition select the column you want to apply the condition to, select the operator to use to compare the column, and finally select or enter the value to compare the column to.

 

To define a list of fixed values condition select the column you want to apply the condition to, select the operator to use to compare the column, press the list button, then repeatedly select or enter a value and press Add to add it to the list.

 

To remove a value from the list, select the value in the list and press Delete.

 

The list of fixed values condition is converted to a condition for each value in the list and grouped together.

 

A filter parameter condition filters the query data using a value set in a filter parameter set in a control panel.

 

To define a filter parameter condition select the column you want to apply the condition to, select the operator to use to compare the column, press the filter parameter button then select the filter parameter you want to use.

 


Dashboard Object Definition - Totals


The Dashboard Object Definitions editor window Totals tab allows you to specify if totals are included in a data grid, and how they are calculated.

 

Follow the steps below to define the totals for your data grid;

 

By default, a pivot table will include totals for each summary column you have selected. If you do not wish to include totals in your data grid, uncheck the Show Totals check box. You can also change the label used in the total row.

 

 

If you have opted to show totals, each total will by default use the same summary column as defined for the summary column itself. You may however wish to use an alternative summary operation for the totals. For instance, the summary column may be showing the sum of the quantity ordered, but you want the total to show the average quantity ordered.

 


The ability to amend the summary operation will be dependand on the type of metric/summary column. Some Summary Columns types fdo not allow the change of summary totals.


To change the summary operation used by the totals, select the summary column the total is based on, then select the summary operation you wish to apply to the totals.

 

The ability to amend the summary operation will be dependand on the type of metric/summary column. Some Summary Columns types fdo not allow the change of summary totals.

If the summary column and total both use the Average summary type, you may have a choice of how the average total is calculated. The two options are described below;

 

Average of the source data values
This option calculates the average by totalling the summary values for each row of data in the source table that make up the specific grouping, and dividing the total by the number of source data rows that make up the specific grouping.

 

Average of the pivot table values

This option calculates the average by totalling the average values displayed in the grid for the specific grouping, and dividing the total by the number of average values displayed in the grid for the specific grouping.


Dashboard Object Definition - Appearance


The Dashboard Object Definition window Appearance tab allows you to specify settings that will govern the appearance of the dashboard object.

 

Follow the steps below to specify the appearance of your dashboard object;

 

First if you want to change the type of object, select the new object type. Then enter a title, and, if you wish, second title (that will appear on a second line) for your Dashboard Object.

For some charts a 3D option can be selected.

 

Select whether you want to view point labels on your chart, whether those labels should (if possible) be drawn inside the chart, whether they should be shown with vertical text, whether to show a legend on the chart and whether to use the glass effect when rendering the chart.

 

 

For certain types of chart, you will be given the option to specify that zero values are not plotted. You can select one of three possible values in the drop down list, each described in the table below;

Plot zero values

All values will be plotted on the chart.

Do not plot leading zero values

Any zero values on lines, bars, areas or columns that appear in a series before the first non-zero value, will not be plotted on the chart, but the groups will still appear on the X Axis.

Do not plot any zero values

Any zero values on lines, bars, areas or columns will not be plotted on the chart, but the groups will still appear on the X Axis.

Hide groups with zero values

Any group that has zero values in all series will be omitted from the chart completely.

 


 

For certain chart types, you can also select whether to display a series as a line, bar or area, and if the object type has a dual Y axis, which Y axis to display the series on.



Dashboard Object Definition - Numeric Format

The Dashboard Object Definition window Numeric Format tab allows you to specify the numeric format used to display numbers in the dashboard object.

 

Follow the steps below to specify the numeric format on your dashboard object;

 

First, if you are configuring a dashboard object with a dual Y axis, you can specify a different numeric format for each Y axis. As such, you need to select which Y axis you are specifying the details for.

 

Next, if you want to format the numeric values, select the format option.

Select the maximum number of decimal places you want to show. If your values are currency values, select force trailing zeros.

 

You can apply scaling to your numeric values in a dashboard object. Scaling provides notation for large values, so for instance 1340 can be displayed as 1.34K, and 2345263 can be displayed as 2.35M. There are a number of scaling units pre-defined for you, however if these do not fit your requirements you can define your own.

 

 

To define your own scaling units, select other from the scaling units list. Next supply a comer separated list for the scaling units and the scaling values. Each entry in the scaling units list will be displayed as a suffix to your values. Each entry in the scaling values represents the amount the value will be divided by from the previous scaling unit to achieve the display value.

 

For instance, you could set your scaling units to "Thousands,Millions,Billions" and your scaling units to "1000,1000,1000". In this example, 1340 will be displayed as 1.34Thousands, and 2345263 will be displayed as 2.35Millions.

 

If the scaling units list has one more entry than the scaling values, units will be given the first entry in the list as a suffix. For instance, for time scaling units, you could set your scaling units to "minutes,hours,days,weeks,years" and your scaling values to "60,24,7,52".

 

If you require it select a currency symbol (value that will be displayed before your numeric values). If the value you want is not in the list, select other and enter your desired value. You can also enter a number suffix, a string that will be displayed after numeric values.


Finally, if you wish to suppress the thousand separator for numbers, select the Suppress thousand separator check box.



Dashboard Object Definition - X Axis

 

The Dashboard Object Definition window X Axis tab allows you to specify settings that govern the appearance of the X axis on the dashboard object.

Follow the steps below to specify the X Axis details on your dashboard object;

Enter a title for your x axis, and specify the orientation of the labels.


You can also limit the length of the labels used on the X axis. To limit the length of the labels, check the Limit the length of labels on the x axis check box, select the maximum length of the labels, and select whether you want extra characters trimmed from the start or end of the labels.


 

Dashboard Object Definition - Y Axis


The Dashboard Object Definition window Y Axis tab allows you to specify settings that govern the appearance of the Y axis on the dashboard object.

 

Follow the steps below to specify the Y Axis details on your dashboard object;

First, if you are configuring a dashboard object with a dual Y axis, you can specify a configuration for each Y axis. As such, you need to select which Y axis you are specifying the details for.

Next enter a title for your y axis. If you want, you can specify an alternative number of decimal places for this Y axis, that will override the value specified in the numeric format.

 

If all the values to be plotted on a Y Axis are either positive, or all negative, by default the Y Axis will always have a minimum value (or maximum if all your values are negative) of zero. If all your values are well above (or well below) zero if might be sensible to uncheck the fix minimum value as zero option so it is easier to differentiate values plotted against your Y Axis.

 

Alternatively, you can override that automatic calculation of the Y Axis range, by selecting that Y Axis values should be fixed, and specifying the minimum and maximum values. (NB. If the values in your chart cannot be plotted on the range you have given, the range will be extended to compensate).



Dashboard Object Definition - Drill Down


The Dashboard Object Definition window Drill Down tab allows you to specify what drill down is available when published, and if so, what the drill down will display.


The default behaviour is to allow freeform drilldows, so users are able to create their own inmydata Visualisations when the select an object on the dashbaord.

 

Follow the steps below to specify the drill down;

 

First, if you want the dashboard object to have a drill down, select the "Allow freeform drill downs from this object", 

If you do not want a drilldown then select "Define a specific drill down path from this object", selecting this and not adding a drill down will disable the default drill down position.

 


.

If you select "Define a specific drill down path from this object"  Select Add to select a drilldown that has been previously created on inmydata.




The list of available Visualisations can be refreshed by pressing the refresh () button. The order that the Child visualisations willbe seen when drilledinto is determined by the order in the lsit. This can be changed using the Up / Down buttons.

Press Add to Select a Visualisation to drill-into.

The list of visualisation is determined by the available saved Visualisation that the user has access to on inmydata that have the same subject as the source of the objects data.

The list of Visualisations can be limited by entering text inot the search box.

Choose the Visualisation to be added and press OK to select.


Dashboard Object Definition - Alerts


The Alerts window allows you to specify alerts associated with a dashboard object. Alerts will be shown and the user notified as described below.

 

clip775

 

The Alerts window consists of the following tabs;

Details

Allows you to define the alert details (text and conditions).

Email

Allows you to specify whether the alert will trigger an email when raised on the server.

Twitter

Allows you to specify whether the alert will trigger a tweet when raised on the server.

Users will be made aware of alert conditions with the following;

 

1. Alerts will be highlighted by the alert icon, and can be opened from the alert menu when the Dashboard is opened and the alert conditions resolve to true

clip769

 

2. An alert can be sent by email when the dashboard refreshes and the resulting data causes the alert conditions to resolve to true.

clip771

 

3. If the dashboard is set to refresh automatically on the server, a message can be tweeted when the dashboard refreshes and the resulting data causes the alert conditions to resolve to true.

 

4. If the dashboard is set to refresh automatically on the server, a notification will be raised on any mobile or wearable device with access to that dashboard through the relevant DataPA app when the dashboard refreshes and the resulting data causes the alert conditions to resolve to true

clip770


Dashboard Object Definition - Alerts - Details


The Alerts window details tab allows you to define the alert text and conditions that will determine when the alert will be raised

 

Follow the steps below to define the details for your alert;

clip779

 

First, enter the text that will appear in titles and notifications for this alert.

 

Next, you may wish to ensure the alert is not raised too often. For instance, if a dashboard was scheduled to refresh automatically every minute and the alert conditions remained true, the alert would send notifications, (and tweets and emails if so configured) every minute. To prevent this without reducing the refresh interval of the dashboard, you can set a minimum time interval before which a repeat alert will be raised.

 

Next you need to define the conditions that will determine when this alert is raised. To add a condition, press the Add button. This will open the Alert Condition window to allow you to define the condition.

clip780

To delete a condition, select the condition and press Delete.To edit a condition, select the condition and press Edit. This will open the Alert Condition window to allow you to edit the condition.

clip781


Alert Conditions


The Alerts Condition dialog allows you to specify a single condition for an alert. The available options will change based on the object you are adding an alert for.

 

Select the series values, group values, operator and value as appropriate.

clip786


Dashboard Object Definition - Alerts - Email


The Alerts window Email tab allows you to specify whether the alert will trigger an email when raised on the server, and if so, the details of that email.

 

If a dashboard is scheduled to refresh automatically and you would like an email sent if the new data results in the alert conditions resolving to true, follow the steps below;

 

First ensure the checkbox labeled Send an email when this alert is raised is checked, then enter the email address or addresses you want the email to be sent to. Add the text you want in the body of the email, and finally choose whether to include an image of the chart by selecting whether or not the checkbox labeled Attach an image of the object to the email is checked.

clip782


Dashboard Object Definition - Alerts - Twitter


The Alerts window Twitter tab allows you to specify whether the alert will trigger a tweet when raised on the server, and if so, the details of that tweet.

 

If a dashboard is scheduled to refresh automatically and you would like a tweet sent if the new data results in the alert conditions resolving to true, follow the steps below;

 

First ensure the checkbox next to each Twitter account you want the tweet to appear on is checked (see below for details on adding Twitter accounts), then enter the text for the tweet. Choose whether to include an image of the chart by selecting whether or not the checkbox labeled Include image with tweet is checked, and finally choose whether to add a link to the dashboard to the tweet by selecting whether the checkbox labelled Include link to dashboard with tweet is checked.

clip784

 

If you are a member of a group that has permission to manage the server you can add, edit and remove Twitter accounts by pressing the button to the top left of the list of Twitter accounts.

clip785


Dashboard Object Definition - Advanced


The Dashboard Object Definition window Advanced tab allows you to specify advanced settings for your dashboard object using XML.

 

 

Dashboard Objects are rendered using Fusion Charts objects. Fusion Charts are configured using XML. The DataPA Enterprise Dashboard builds an XML document to render the chart, which can be viewed by turning on the debug dashboard objects option. If you want to control behaviour of the object that is not facilitated through the Enterprise Dashboard interface, you can append your own XML to the document produced by the application. For details on the XML definitions expected by the particular object you are using, please see http://docs.fusioncharts.com/charts/.