Creating Dashboards

Dashboards are created using the Dashboard Designer interface. Each dashboard combines multiple widgets (reports, datagrids, charts, etc.) into a single view with configurable filters and layout.

Required Information

• Name: Unique identifier for the dashboard (required)
• Description: Optional description explaining the dashboard's purpose
• Widgets: At least one widget to display (required)

Configuration Steps

1. Open Dashboard Designer

Navigate to the Dashboards page and click the "Add Dashboard" button (or similar action) to open the Dashboard Designer.

2. Enter Dashboard Name

Provide a unique name for the dashboard. This name will be used to identify the dashboard throughout the system.

Required: Yes

Field: Dashboard Name

Description: This is the name displayed for the dashboard.

3. Enter Dashboard Description

Provide an optional description explaining the purpose or usage of the dashboard.

Required: No

Field: Dashboard Description

Description: This is the description used for the dashboard.

4. Select Folder (Optional)

Choose a folder to organize the dashboard. Folders help organize dashboards for better management and navigation.

Required: No

Field: Folder

Description: Choose the folder where this dashboard will be organized.

How to select: Use the dropdown to select from existing folders, or leave empty to place in the root or uncategorized folder.

5. Add Widgets

Add widgets to your dashboard by dragging and dropping them from the widget panel onto the dashboard grid.

Widget Types

Available widget types include:

Reports:

• Report Widgets: Display reports (charts, tables, KPIs) created in the Reports section
• Search: Use the search bar to find specific reports
• Pagination: Load more reports if available

Data Grids:

• Datagrid Widgets: Display datagrids created in the Datagrids section
• Search: Use the search bar to find specific datagrids
• Object Data: Show Object records in table format

Standard Widgets:

• Summary Ribbon: Display summary statistics or KPIs
• Webpage: Embed external web pages
• Image: Display images
• Quick Action: Provide quick action buttons
• Insight Card: Display insights or key information
• Layout: Display layouts created in the Layouts section
• Actionable Card: Display cards with action buttons

For detailed information about each widget type, including configuration options, size constraints, and use cases, see Dashboard Widget Types.

Adding Widgets

How to add:

1. In the left sidebar, browse available widgets by category (Standard, Reports, Data Grids)
2. Drag a widget from the widget panel
3. Drop it onto the dashboard grid at your desired position
4. The widget is automatically added with default size and position

Widget Positioning:

• Widgets are positioned using a grid system (x, y coordinates)
• Each widget has a default width (w) and height (h) in grid units
• Widgets can be repositioned by dragging after they're added

Widget Sizing:

• Each widget type has minimum and maximum size constraints
• Widgets can be resized by dragging their corners or edges
• Size constraints prevent widgets from becoming too small or too large

6. Configure Widget Properties

After adding a widget, configure its properties:

Report Widgets

• Select Report: Choose the specific report to display
• Widget Title: Customize the widget title (optional)
• Widget Settings: Configure report-specific settings

Datagrid Widgets

• Select Datagrid: Choose the specific datagrid to display
• Widget Title: Customize the widget title (optional)
• Widget Settings: Configure datagrid-specific settings

Standard Widgets

Each standard widget type has its own configuration options:

• Summary Ribbon: Configure summary fields and display options
• Webpage: Enter URL and configure display settings
• Image: Upload or link to image and configure display
• Quick Action: Configure action buttons and targets
• Insight Card: Configure card content and styling
• Layout: Select layout and configure display options
• Actionable Card: Configure card content and actions

7. Arrange Widget Layout

Organize widgets on the dashboard:

Repositioning Widgets:

• Drag widgets to different positions on the grid
• Widgets automatically snap to grid positions
• Multiple widgets can be arranged side by side or stacked

Resizing Widgets:

• Click and drag widget corners or edges to resize
• Widgets respect minimum and maximum size constraints
• Resize widgets to fit content or optimize space usage

Grid Layout:

• The dashboard uses a responsive grid layout system
• Widgets are positioned using x, y coordinates
• Grid units determine widget sizes and spacing

8. Configure Global Filters (Optional)

Configure filters that apply to all widgets on the dashboard by clicking the "Add Filter" button in the filters section. Filters allow you to:

• Filter Multiple Widgets: Apply a single filter that affects multiple widgets simultaneously
• Cross-Object Filtering: Filter data across different Objects using relationships
• Widget Mapping: Map filter fields to widget-specific fields for flexible filtering
• Dynamic Updates: Change filter values to update all affected widgets in real-time

For detailed information about configuring filters, including filter criteria, widget mapping, join information, and best practices, see Configuring Dashboard Filters.

9. Preview Dashboard

Click the "Preview" button to view the dashboard with live data:

• Live Data: Widgets display actual data from Objects
• Filter Testing: Test global filters and their effects on widgets
• Layout Verification: Verify widget positioning and sizing
• Responsive Check: Check how the dashboard looks on different screen sizes

10. Save Dashboard

Click the "Save" button to save your dashboard configuration.

After Saving:

• The dashboard is created and appears in the Dashboards list
• The dashboard can be edited, cloned, or deleted as needed
• The dashboard can be embedded in Builder pages
• The dashboard can be shared with team members

Editing Existing Dashboards

To edit an existing dashboard:

1. Navigate to the Dashboards list
2. Click the "Edit" icon next to the dashboard (or click on the dashboard name)
3. The Dashboard Designer will open with the existing configuration loaded
4. Make your desired changes to widgets, filters, layout, or settings
5. Click "Save" to apply your updates

Cloning Dashboards

To clone an existing dashboard:

1. Navigate to the Dashboards list
2. Click the "Clone" icon next to the dashboard
3. A new dashboard will be created with the same configuration
4. Edit the cloned dashboard as needed

Deleting Dashboards

To delete a dashboard:

1. Navigate to the Dashboards list
2. Click the "Delete" icon next to the dashboard
3. Confirm the deletion in the confirmation dialog

Note: If a dashboard has filters that only map to widgets being deleted, those filters will also be deleted. You'll be notified about affected filters before deletion.

Best Practices

Widget Selection

• Relevant Widgets: Add only widgets that are relevant to the dashboard's purpose
• Widget Variety: Mix different widget types for comprehensive views
• Widget Count: Limit the number of widgets to avoid clutter (typically 4-8 widgets)

Layout Organization

• Logical Grouping: Group related widgets together
• Visual Hierarchy: Place important widgets in prominent positions
• Balanced Layout: Distribute widgets evenly across the dashboard
• Responsive Design: Consider how the layout works on different screen sizes

Filter Configuration

• Meaningful Filters: Configure filters that provide value to users
• Widget Mapping: Ensure filters are properly mapped to relevant widgets
• Filter Testing: Test filters to ensure they work correctly with all widgets
• Filter Documentation: Use clear filter names and descriptions

Performance

• Widget Count: Limit the number of widgets to maintain performance
• Data Volume: Consider data volume when configuring widgets
• Filter Efficiency: Use efficient filter conditions to improve performance

Organization

• Folders: Organize dashboards in folders for better management
• Naming Conventions: Use clear, descriptive names for dashboards
• Descriptions: Add descriptions to explain dashboard purpose
• Regular Updates: Update dashboards as data sources or requirements change

Related Introduction

• Dashboard Widget Types - Detailed guide to all widget types
• Configuring Dashboard Filters - Detailed guide to configuring dashboard filters
• Dashboard Introduction - Overview of dashboards
• Reports Introduction - Learn about reports used as dashboard widgets
• Datagrids Introduction - Understand datagrids used as dashboard widgets
• Layouts Introduction - Learn about layouts used as dashboard widgets
• Builder Introduction - Learn how to embed dashboards in Builder pages