Submit Button Behavior in Splunk Dashboard Studio with Canvas Layout.

Applicability

Description

Users frequently experience uncertainty when incorporating a Submit button in Splunk Dashboard Studio, particularly when the inputs are positioned within the canvas rather than in the global input area. This challenge stems from a basic difference between global inputs and in-canvas inputs.

Investigation

If you experience any uncertainty regarding the addition of a submit button in Dashboard Studio, particularly within the Canvas, you may refer to the following points for clarification and to alleviate any confusion.

1. Inputs in Canvas Layout:
   When all inputs are placed in the canvas, the Submit button does not appear.
   This is because inputs within the canvas are specific to the canvas or tab they are in and do not qualify as global inputs.
   
   
2.  Global Inputs:
   Positioned above the canvas and shared across all tabs in a dashboard.
   They directly interact with the Submit button, which triggers updates based on their token values.
   
   
3. Tokens: Tokens set by in-canvas inputs remain accessible globally but are not tied to the Submit button's functionality.
   
   
4. Tabbed Dashboards: In tabbed dashboards, global inputs apply across all tabs, while in-canvas inputs are specific to individual tabs. This distinction is essential for managing user experience and interactions.

This behavior is not a known issue, but an intentional design decision in Dashboard Studio.

Resolution

Ensure at least one input is placed in the global input area.
Enable the Submit button in the Canvas configuration:

{
    "layout": {
        "SubmitButton": true
    }
}

Alternatively, edit the dashboard source code and include the "SubmitButton": true property in the LAYOUT section and incase of rearranging Inputs for Submit button functionality, keep at least one input in the global input area. If all inputs are in-canvas and the Submit button is required, consider restructuring your dashboard layout.

Related Links

For more information, refer to Splunk’s official documentation on Dashboard Studio Configuration.