Splunk Cloud Platform

Splunk Dashboard Studio

About conversion from Simple XML to Dashboard Studio

Optimize your dashboard building time by converting Simple XML dashboards to Dashboard Studio instead of rebuilding dashboards from the beginning. The conversion process makes a copy of your original Simple XML dashboard to provide the ability to maintain the original while making updates to the Dashboard Studio version.

Reconvert your dashboards with each new version of the Splunk platform to benefit from new functionalities, such as additional automatic conversions from Simple XML to Dashboard Studio.

For more details about starting the conversion process, see Convert a Simple XML dashboard to a Dashboard Studio dashboard.

Inspect changes with the conversion report

The conversion process also includes a conversion report that lists configurations that Dashboard Studio does not automatically convert and offers alternative suggestions that use Dashboard Studio functionality. For example, the conversion report lists visualizations that automatically convert and additional context for visualizations that need manual updates.

Compare conversion for different dashboard components

The Simple XML to Dashboard Studio conversion attempts to convert all dashboard components automatically. However, different components convert to varying extents of fully converted, semi-converted, and unsupported.

  • Fully converted components automatically appear in Dashboard Studio without needing manual updates.
  • Semi-converted components need manual updates. For example, you can manually update Simple XML conditional visibility by configuring a Dashboard Studio dashboard to show or hide panels conditionally.
  • Not converted components aren't supported in Dashboard Studio and have no workaround. You can experiment with different Dashboard Studio features to create similar functionality for unsupported components.

Visualizations

The following table displays which visualization components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Standard charts Fully converted Supported Dashboard Studio supports all standard charts, excluding the radial gauge visualization.
Maps Fully converted Supported The conversion does not convert coloring for choropleth maps with categorical coloring. You can reconfigure the coloring with the Dashboard Studio UI.
Drilldown configuration Fully converted Supported Predefined tokens have a different naming system in Dashboard Studio. For example, $click.value2$ in Simple XML is now $value$ in Dashboard Studio.
Trellis layout Semi-converted Semi-supported Dashboard Studio only supports trellis layout for single value visualizations. For other visualizations, you can create a similar effect to trellis layout by creating multiple instances of a visualization and putting the visualizations in a grid.
Conditional visibility Semi-converted Dashboard Studio does not automatically convert conditional visibility. Depending on whether data is available to display, you can configure dashboards to conditionally show or hide panels in Absolute layout. For more details, see Conditionally show or hide panels.
Table coloring configurations Semi-converted Semi-supported Dashboard Studio supports most coloring configurations, excluding heatmap, high/low, or gradient percentile scale coloring.
Custom third party visualizations Semi-converted Semi-supported Dashboard Studio does not support third-party visualizations. However, you can find many popular visualizations in Dashboard Studio, such as Sankey, punchcard, and parallel coordinates. Additionally, some visualizations convert to alternative visualizations. For example, the horseshoe meter converts to a single value radial. For more details, see Add and format visualizations.
Prebuilt panels Not converted Not supported Dashboard Studio does not support prebuilt panels.
Iframes Not converted Not supported Dashboard Studio does not support iframes.

Data sources

The following table displays which data source components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Inline search Fully converted Supported n/a
Saved searches Fully converted Supported Dashboard Studio does not support the cache option for saved searches.
Base and chain searches Fully converted Supported n/a
Sample ratio option Not converted Unsupported Dashboard Studio does not support the sample ratio option for data sources.

Inputs

The following table displays which input components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Standard inputs Fully converted Supported Standard inputs include time, dropdown, multiselect, and text. Dashboard Studio also supports a number input.
Submit button Fully converted Supported n/a
Inputs on canvas Fully converted Supported In Dashboard Studio, inputs on canvas are independent of panels. You can place inputs above or next to panels.
Radio, check box, and link list inputs Semi-converted Semi-supported Certain form inputs convert into different input types in Dashboard Studio. For example, radio inputs convert to dropdown, link lists to dropdown, and check box inputs to multiselect. You can also manually update the converted input type to any input of your choice.
Prefix and suffix attributes Not converted Unsupported n/a
Delimiters for token values Not converted Unsupported n/a
Delimiters in SPL queries Semi-converted Semi-supported The multiselect input currently only supports the comma (,) delimiter in SPL queries. To read more on using multiselect inputs, see Multiselect.
Input change handler Not converted Unsupported Dashboard Studio does not support input-specific change handlers, but you can add logic to searches and then reference results as tokens. For more details, see Setting tokens from search results or search job metadata.
Input event handlers Semi-converted Semi-supported Inputs do not automatically convert certain event handlers, such as conditional event handlers. You can manually update the inputs by setting and evaluating tokens for specific conditions. For more details, see Setting tokens from search results or search job metadata.
Default value Fully converted Fully supported n/a
Initial value Not converted Not supported Converted inputs support the setting for a default value, but not an initial value.

Interactivity, tokens, and drilldown

The following table displays which interactive, token, and drilldown components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Eval or condition match tokens, <change> and <init> tags Semi-converted Semi-supported To work around this semi-conversion, evaluate token values inside a search and use search tokens to access the results. For more details, see Setting tokens from search results or search job metadata.
Unsetting an event handler Semi-converted Semi-supported Dashboard Studio does not support unset tags for event handlers. You can conditionally show or hide panels based on data availability. For more details, see Conditionally show or hide panels.
Predefined time tokens Not converted Unsupported Predefined time tokens include $earliest$ and $latest$.
Search event handlers and advanced token logic Not converted Unsupported Dashboard Studio replaced search event handlers with tokens. Like event handlers, you can use tokens that automatically set based on the job status, metadata, or results of a search. For more details, see Setting tokens from search results or search job metadata.
Advanced token logic Not converted Unsupported n/a
Visualization event handlers Not converted Unsupported Dashboard Studio does not automatically convert visualization event handlers, which typically use drilldowns. You can manually update visualizations. For more details, see Setting tokens.

Dashboard level configurations

The following table displays which dashboard level components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Light theme and dark theme Fully converted Supported n/a
Hide Edit button Fully converted Supported n/a
Hide Open in Search button Fully converted Supported n/a
Hide Export button Fully converted Supported n/a
Hide Splunk bar, App bar, or filters Not converted Unsupported Dashboard Studio does not support hiding Splunk bar, App bar, or filters.

Extensions

The following table displays which dashboard extension components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Custom CSS Not converted Unsupported Dashboard Studio does not automatically convert custom CSS. With the Dashboard Studio UI, you can update common CSS use cases, such as setting a background color and changing a font style. For more details, see Set up a dashboard.
Custom JavaScript Not converted Unsupported n/a
Custom third party visualizations Not converted Unsupported n/a
HTML panels Semi-converted Semi-supported Dashboard Studio automatically converts only some HTML components. You can replace your HTML panels with Markdown. For more details, see Add text, links, and images with Markdown. For more about HTML conversion, see HTML to Markdown conversion.

Sharing dashboard content

The following table displays which dashboard sharing components are fully converted, semi-converted, or not converted. The table also shows if Dashboard Studio supports the component.

Component Conversion status Support status Notes
Export to PDF Fully converted Supported n/a
Update permissions Fully converted Supported n/a
Scheduled email export Not converted Unsupported n/a

HTML to Markdown conversion

During the dashboard conversion process, Dashboard Studio converts most components of HTML panels to Markdown. After conversion, the conversion report lists which HTML components Dashboard Studio fully converted and which did not. For HTML components that do not convert, Dashboard Studio preserves the source code in the Markdown component for reference. For example, iframes do not fully convert, which results in Dashboard Studio displaying the original iframe source code in a Markdown panel for preservation.

The following table shows the HTML components that Dashboard Studio fully converts.

HTML component Conversion status Support status Notes
Images Fully converted Supported n/a
Text Fully converted Supported n/a
Links Fully converted Supported n/a
Last modified on 12 April, 2024
Migrate your dashboards and delete the Splunk Dashboards app (beta)   Convert a Simple XML dashboard to a Dashboard Studio dashboard

This documentation applies to the following versions of Splunk Cloud Platform: 9.2.2403


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters