Skip to content

Workspace

Screenshot

The Workspace is comprised of three sections:

  • on the left is a component listing
  • in the center is the canvas where components are added and arranged
  • to the right are the properties associated with the selected component or dashboard

The user menu displays your user name in the top right. Here you can pick a theme, timezone, log level and the base language for the dashboard: English, German or Japanese.

Dashboard theme

The Dashboard Builder theme is independent of the dashboard style. Pick the dashboard theme from the dashboard’s Style menu.

Component listing

Add components by click-and-drag into the workspace, e.g. Data Grid.

Screenshot

Central canvas

Arrange and resize components on the central canvas by dragging the resize handles on the edges.

Screenshot
A simple dashboard

Component properties

Selecting a dashboard component displays its properties on the right.

Screenshot
A new Data Grid, with its properties displayed

Properties vary from component to component, but almost all have a Data Source

Dashboard properties

Screenshot

Search for a property within a selected component

Basics

Screenshot

Name
A name for the dashboard
Link
The URL for sharing access to the dashboard. (The link is not editable. Clicking on it will open the dashboard in a new browser tab.)
Enable "Share Dashboard"
Adds a share icon to generate a link which stores the viewed states (e.g. pivot drill down position) which can be shared with others.
Unsaved Viewer Prompt

When checked, user will be prompted on any unsaved changes before switching to another dashboard.

Screenshot

Fill height
When checked, the dashboard fills the height of the browser. (Dashboards always fill the browser width.)

Row height

If Fill Height is disabled, Row Count becomes Row Height; Row Height is the height, in pixels, between each grid row. The number of grid rows used is defined by the prior Row Count value; e.g. if Row Count is 30 and Row Height is set to 30; then the distance from top to bottom - in the absence of Fill Height is 900 pixels. If the pixel height is greater than the browser height, a scroll bar will appear. In addition, some components may be positioned off-screen.

Save your dashboard frequently

This can be done from the header menu; a blue marker notifies you of unsaved changes. Use the Export feature, available from a long-click save, to create an .json backup of your dashboard.

Screenshot

Floatable
Column Count
Row Count / Row Height
See Layout Panel for further details

Style

Screenshot

Dashboard Theme
Theme Switchable
Sets Light or Dark theme for dashboard and define if theme can be switched. This should be disabled (theme-locked) if the dashboard uses custom styling which would not update on global theme switch.
Widgets Spacing
Widget Shadow
Define distance in pixels between components and add optional shadow
Border Size
Border Color
Border Rounding
Border Spacing
Define border criteria of components
Show Loading Indicators
When checked, indicates when dashboard is loading data. If your dashboard uses streaming, managed or polling data, leave this unchecked

Style for common style properties

Popups

Screenshot

Create a popup then edit to add content into the popup element

Screenshot

Screenshot

Visible
Assign a boolean viewstate. The viewstate can be triggered by an Action. If no view state assigned and box checked, popup will appear when the dashboard loads.
Dialog Title
Header name of popup
Dialog Height
Dialog Width
Dimension area of popup in pixels.
Modal
Make Popup modal
Resizable
Allow user resizing of popup window.

Notifications

Screenshot

Enabled
Notification messages, e.g. a failed login attempt, will appear on screen.
In Browser

When enabled, notification will be forced to display in the browser, location set by Position. Native notifications will trigger when disabled.

Screenshot native notification

Screenshot browser notification

Position
Location of notification message, select from: Top Left, Top Center, Top Right, Center Left, Center Right, Bottom Left, Bottom Center, Bottom Right
Max Count
Maximum number of messages displayed at once
FadeOut (s)
Length of time in seconds notification remains on screen
Icon
Select from bell-o, flag-o, bullhorn, clock-o, comment-o, commenting-o, exclamation-circle, exclamation-triangle, none if an icon is required as part of the notification
Sound
Select from beep, beepbeep, none if an aural notification is required
Grouping
Enable Group Notifications for notifications to be grouped as a single message within an interval defined by Grouping Interval defined in seconds.

Set Trigger

Screenshot

Datasource
Defines the conditions for the trigger. The data source has to use streaming, managed or polling data

Screenshot

Notification Template
This determines the information displayed in the notification popup
Sound
What sound to associate with the defined trigger
Icon
What icon to associate with defined trigger

Configure browser to allow popups

For popups to appear in the browser it may be necessary to change browser settings to allow popups in addition to building the required configurations in your dashboard.

Permissions

Screenshot

Permissions are granted to groups of users, as defined in Kx Control.

Read Access is permission to view the dashboard; Write Access is permission to edit it.

Screens

Each dashboard has a main screen; other screens can be added, then linked using Navigation or Button components.

Screenshot

button action
Delete screen Delete screen
Duplicate screen Duplicate screen
Set as default Set screen as default on dashboard load
Edit screen Edit screen
Screen snapshot Take snapshot image of screen: used by Navigation Component tooltip

Document Graph

Screenshot

Screenshot

Shows relationships between data sources and view states for the underlying dashboard

Linking components

Components with a common Data Source can be linked so that changes to one are reflected in the other.

Queries using input variables can have values passed to them using Data Form or Drop Down List components.

A set of buttons are found to the right of the dashboard dropdown selector in the header bar:

button function
New icon New dashboard
Save icon Save dashboard.
Undo Icon Undo Icon
Redo Icon Redo Icon
Share icon Share Dashboard Link; available in quickview
PDF icon Export as PDF

To export a dashboard as a JSON file, long click on the Save icon

Screenshot

Long click on the Undo Icon to reverse actions beyond the most recent event.

Screenshot

Dashboard Manager

Dashboard Manager is available from the Dashboard Dropdown:

Screenshot

Clicking the Manage icon will open the Manage menu.

Screenshot

Select a dashboard, then choose from:

Open
Opens a Dashboard for editing
View on web
Opens the quickview (end-user) Link listed in Basics dashboard properties.
Delete
Deletes selected dashboard

Importing and exporting dashboards

Dashboards can be exported and imported in JSON format.

Screenshot Export and Import buttons. Selecting a dashboard will activate the Export button

Imported dashboards appear in the Dashboard Builder‘s dropdown list:

Screenshot

Import XML dashboards

Some dashboards may be in XML format. This format dashboard can be imported, but all exported dashboards are in JSON format.

Duplicate a dashboard

Creating a duplicate of the currently viewed dashboard can be done from the New dashboard menu; click New icon

Screenshot

Keyboard shortcuts

Dashboards support keyboard shortcuts

shortcut result
Ctrl + C Copy component
Ctrl + V Paste component
Ctrl + O Open manage dashboard dialog
Ctrl + S Save dashboard
Ctrl + X Cut component
Ctrl + Z Undo feature
Ctrl + Y Redo feature
F1 Show help documentation for selected component

Custom component

This is for Dashboards component developers, who will need the Software Development Kit and documentation of the API; contact your First Derivatives representative for more information.

Once your Javascript component is built, add it into Dashboards:

Screenshot