User Interface Customization

The UI can be customized using an external file. The file can be uploaded through the customize operation on the agent type.

The file format of the customization file is JSON. If the customization file is provided as a part of the custom static resource, the file must be named customization.json and placed in the top-level folder. The file should contain a single object. The object members are individual customization rules, where the member name is the selected attribute and the member value is the customization value.

Syntax for the customization rules: 

<Object Type Name>[#<Operation Name>[#<Method Type>[.<Parameter Name>]]]

The following is an example for customizing the references in the Tomcat sample provided with the product: 

"server@members": {
        "title": "Tomcat",
        "columns": [ 
            { "label": "name", "expr": "name", "entityLink": true },
            { "label": "url",  "expr": "config.path" },
            { "label": "status",  "expr": "status.state" }
        ]
    }

code explanation:

  • server@members: is the reference for the object type server
  • title": "Tomcat": Is the custom title which can also be defined using the "label" flag
  • "columns": Indicates the number of columns. In this case, it is 3.
    • "label": Is the title of the column.
    • "expr": Is the content in the column.
    • "entityLink"Is a toggle that can be either true or false. Indicates that a cell can be displayed as a link to an entity page.
The following additional properties can be set:
  • "collapsed": This property can be set on a reference. If set, the panel containing the reference will be collapsed, on display.
  • referenceOrderIs the order in which a reference is displayed. For example, "referenceOrder": ["foo", "bar"] indicates that "foo" is displayed before "bar".
  • "confirm":This property can be set on an operation. If set to false, the confirmation dialog is skipped.
Contents
Search Results