Configuring Data Service Loading in Dashboard Designer

Overview

In Dashboard Designer, data is retrieved through Data Services, which serve as the bridge between datasets and visual components such as charts, grids, and filters. These services can be configured to determine when and how data is fetched — either during the initial dashboard load or dynamically based on user interactions.

Proper configuration of data service loading ensures that dashboards are efficient, responsive, and optimized for performance.

This section explains how to configure data service loading using both built-in options and SDK scripting methods.

Initial Data Service Loading

Description

By default, each data service in the Dashboard Designer can be configured to load automatically when the dashboard first opens. This setting is useful for independent data services that do not rely on filters, charts, or other data interactions.

Use Case

Use the Load on initial dashboard load option for data services that:

• Do not depend on user-driven interactions or other components.

• Provide static or default data required immediately upon dashboard load (e.g., summary KPIs, global totals).

How to Configure

1. Navigate to the Data Service Settings of the selected connection in Dashboard Designer.

2. Enable the checkbox “Load on initial dashboard load.”

3. Save the configuration.

Once enabled, the data service will fetch data immediately when the dashboard is opened.

Conditional & Dynamic Data Loading

Certain data services depend on the output or filters applied by other components, such as charts, grids, or dropdowns. In such cases, these services should not be loaded during the initial dashboard load. Instead, they should be triggered dynamically based on user interactions or conditional logic using SDK scripting methods.

The following SDK methods are available to manually or automatically trigger data reloads:

SDK Methods for Data Reloading

1. sdk.reload()

Description

The sdk.reload() method allows developers to manually reload one or more data services by specifying their connection IDs.

Syntax

sdk.reload(["C_1", "C_2"]);

Parameters

Parameter	Type	Description
["C_1", "C_2"]	Array	The IDs of one or more data service connections to be reloaded.

Usage Notes

• Use this method when you need precise control over when and which data services are refreshed.

• It can be called from:

  • Component scripts (e.g., filters, charts).

  • Connection scripts.

• Ideal for reloading data after specific events or user interactions, such as:

  • Filter selection.

  • Chart clicks.

  • Button submissions.

Example

// Reload multiple data services when a filter value changes
sdk.reload(["C_1", "C_3"]);

2. sdk.autoReload()

Description

The sdk.autoReload() method automatically reloads all dependent data services based on the component’s output. It eliminates the need to manually specify connection IDs.

Syntax

sdk.autoReload();

Usage Notes:

• Should be written only inside component scripts (e.g., filters, grids, charts).

• Automatically identifies all dependent data services that use the component’s values as input parameters.

• Provides a cleaner and more scalable approach for dynamic dashboards.

• Reduces manual maintenance, as new dependent services are automatically included in future reloads.

Example

// Automatically reload all dependent services when a filter value changes
sdk.autoReload();

• Result: All charts, grids, or KPIs linked to this filter will update automatically when the filter value is changed.

Best Practices

Scenario	Recommended Approach
Independent data services that load static or default data	Enable “Load on initial dashboard load” in the Data Service configuration.
Data services requiring explicit reloads after certain events	Use sdk.reload() with the specified connection IDs.
Components (filters, charts, grids) that should automatically refresh linked data	Use sdk.autoReload() within component scripts.

Performance Optimization Tips:

• Avoid loading all data services on initial load — this can increase dashboard load times.

• Use conditional loading for dependent datasets to improve performance.

• Combine sdk.reload() with filter change events for precise control.

• Use sdk.autoReload() in interactive dashboards for simplified maintenance.

Example Scenarios

Example 1: Reloading a Specific Data Service

// Reloads only the data service connected with ID C_2
sdk.reload(["C_2"]);

Example 2: Reloading Multiple Services After Interaction

// Reloads two data services (C_1 and C_3) after a button click
sdk.reload(["C_1", "C_3"]);

Example 3: Automatic Reload Triggered by Filter

// Automatically reloads all dependent data services when a filter changes
sdk.autoReload();

Summary

By correctly configuring Data Service Loading and leveraging SDK scripting methods, developers can:

• Ensure that dashboards load efficiently.

• Improve interactivity with dynamic and conditional data loading.

• Maintain data accuracy across all components.

Key takeaway: Use a mix of built-in configuration and SDK scripting to balance performance, accuracy, and responsiveness in Dashboard Designer.