Use JSON Editor for Widgets

To access the JSON editor when creating a new query-based widget, go to the query-based widget builder and click JSON in the upper-right corner.

You can also use the JSON editor to make changes to an existing query-based widget. Here's a scenario in which you can use the JSON editor to display metric data from all the sub-compartments within the root compartment in an existing query-based metric widget.

As a first step, edit the existing query-based metric widget using the JSON editor so it can display data from sub-compartments:

1. Go to the Dashboards page.
2. Click Create dashboard to create a new dashboard or open an existing dashboard in edit mode.
3. Add the query-based metric widget to the dashboard if it's not already added, click the Actions icon () on the widget and click Edit.
4. On the Widgets tab, click Edit Widget.

   The query-based widget builder is displayed.

5. In the upper-right corner, click JSON.

   The JSON editor is displayed and the widget parameters are specified in the parametersConfig section.

6. Add the valueFormat section in the definition of the compartmentId parameter:

   {
               "name": "compartmentId",
               "displayName": "$(bundle.globalSavedSearch.COMPARTMENT)",
               "required": true,
               "defaultFilterIds": [
                   "OOBSS-management-dashboard-compartment-filter"
               ],
               "valueFormat": {
                   "type": "object"
               },
               "editUi": {
                   "inputType": "compartmentSelect"
               }
           }

7. Click Apply.
8. Click Save to save the query-based metric widget.

   The dashboard is displayed in edit mode.

On editing the widget using the JSON editor, you must ensure that the Include subcompartments, Optional input is configured for the Compartment filter. The Subcompartments check box is then displayed in the Compartment filter, and you can select it to display metric data from all the sub-compartments within the root compartment. The option to view metric data from the sub-compartments can only be used if the root compartment is selected in the Compartment filter.

Here are some videos with information on how to edit JSON to customize widgets:

• How to edit JSON to add a constant value-based reference line to a widget
• How to edit JSON to add metrics to a dashboard widget

Use JSON Editor for Filters

For information on how to use the JSON editor to create filters, see Create Filters Using the JSON Editor.