Using the JSON Editor in Explorer

OPSI Data Object Explorers can have searches customized using the integrated JSON editor, this allows you to open all saved searches inside the Data Object Explorer, edit the searches metadata, view changes, and save them.

The OPSI Explorer user interface provides an SQL query editor and visualization selector. The query editor has two modes, basic mode and advanced mode. Within these modes you may need further customization, in these cases the JSON editor can be used. The following scenarios outline some of the situations you may need to access the JSON editor:
  • Access additional charts supported by the framework, for example: treemap, cigar chart, gauge, and labels, that are currently not available in the Explorer UI.
  • Provide additions properties not available in the visualizations, for example: update CSS style, column header name, add an icon, create a drill down link, or a drawer link.
  • Query and transform data from multiple data sources by updating via the JSON Editor the data configuration of the current metadata.
  • Open an existing saved search that has multiple data sources under data configuration, the query editor panel will be hidden, use the JSON Editor to update the query.
  • Open an existing saved search which has a customized UI configuration not supported by the visualization panel, the visualization panel will be hidden; use the JSON Editor to update the visualization.

Enable and Use the JSON Editor

The following is a list of general steps to enable the JSON Editor in Data Object Explorer
  1. Open the Ops Insights Data Object Explorer you wish to view, see: Accessing Data Object Explorers.
  2. Click the JSON Editor button located at the top right, in the Saved Search section. This opens the editor.

    Figure 12-4 JSON Editor

    JSON Editor
  3. Once in the JSON Editor you can update the data configuration for the query and/or update the UI configuration for the visualization.
    Note

    Hover over the property name to view its description.
  4. Fix any error or warnings that may arise.
    Note

    Hover over the error to view a description of the error.
  5. Once the metadata has been changed click the Apply button to apply changes. This will close the JSON Editor, the new visualization will load in the Data Object Explorer UI, and the new query will be shown in the Data Object Explorer UI as well.
    Note

    Apply does NOT save the changes done.
    To cancel any changes done, click Cancel to revert and close the JSON Editor.
  6. To save the changes, click the Save or Save As buttons at the top right within the Saved Search section.
    Note

    Save As is mandatory if the search is an out of box created by Oracle search.