Product Documentation

Use GUI attributes in a custom StyleBook

May 24, 2018

You can add GUI attributes in the parameters section of your StyleBook to make the fields intuitive when displayed on NetScaler MAS.

Example: You can add a descriptive name for the parameter by using the label attribute, and add a tooltip for this parameter by using the description attribute.

name: ip

label: Virtual Server IP Address

description: IP address of the virtual server that represents the load balanced application.

type: ipaddress

required: true

Example: If you have a parameter of type object, you can define the layout by using the gui attribute. In this example, the layout is a collapsible object where fields are displayed in two columns.

name: svcg-advanced

label: Advanced Application Server Settings

type: object

required: false


     collapse_pane: true

     columns: 2

Example: Some StyleBooks are used as building blocks for other StyleBooks and you may not want to display these StyleBooks on NetScaler MAS since they are not intended to be used directly by users. For this, you can use the private attribute to prevent a StyleBook from being listed on NetScaler MAS.

name: basic-lb-config

description: This stylebook defines a simple load balancing configuration.

display-name: Load Balancing Configuration

namespace: com.example.stylebooks

private: true

schema-version: "1.0"

version: "0.1"