Application Delivery Management

Use GUI attributes in a custom StyleBook

October 14, 2020

Contributed by:

S L

You can add GUI attributes in the parameters section of your StyleBook to make the fields intuitive when displayed on Citrix Application Delivery Management (ADM).

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
<!--NeedCopy-->

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
gui:
 collapse_pane: true
 columns: 2
<!--NeedCopy-->

Example. You can also display a summary view of a parameter of type object[] (list of objects) as a table with the inner parameters representing the columns. To include or exclude an inner parameter from the summary view, you can use the summary_display attribute in the gui section as follows:

name: settings
label: Settings
type: object[]
parameters:
  -
    name: name
    label: Name
    description: Name of this setting
    type: string
    gui:
      summary_display: true
<!--NeedCopy-->

Example. Some StyleBooks on Citrix ADM are used only as building blocks for other StyleBooks. And, you might not want users to create configurations directly from these StyleBooks. Because these StyleBooks are to be used as part of other StyleBooks. Mark the StyleBook as private to ensure the StyleBook is not being used directly to create configurations in the Citrix ADM GUI.

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"
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Use GUI attributes in a custom StyleBook

October 14, 2020

Contributed by:

S L

October 14, 2020

Contributed by:

S L

Use GUI attributes in a custom StyleBook

In this article