StyleBook groups

There are two StyleBook groups in Citrix ADM. They are the default StyleBooks and the custom StyleBooks. Whether it is a default or custom, a StyleBook is either a public or a private StyleBook. In Citrix ADM, you can view all the StyleBooks that are present in the system, regardless of their type or visibility status. You can also view a graphical display of how StyleBooks are connected with each other.

This document explains the different types of StyleBooks. Also, it explains the following actions that you can perform on the StyleBooks from Citrix ADM:

• Download a custom StyleBook and make modifications, or create a StyleBook based on an existing one.
• Hide Citrix ADM default StyleBooks.
• Delete a custom StyleBook from Citrix ADM.
• Add tags to the StyleBooks.

Default and custom StyleBooks

• Default StyleBooks are the StyleBooks shipped with Citrix ADM and they allow you to create configurations that you can deploy on your Citrix ADC instances. You cannot delete default StyleBooks, but you can hide them from the Citrix ADM GUI.
• Custom StyleBooks are your own StyleBooks that you imported in to Citrix ADM.

Both default and custom StyleBooks can be either public or private.

Public and private StyleBooks

StyleBooks from which you can create configuration packs can be categorized as public StyleBooks. That is, they are all available for your direct usage to create configurations from the Citrix ADM GUI and APIs.

But, some StyleBooks are used as building blocks for other StyleBooks. Such StyleBooks are marked as private. The private StyleBooks cannot be directly used to create configuration packs from the Citrix ADM GUI. But, you can still display and view these StyleBooks on Citrix ADM. To mark any of your custom StyleBooks as private, set the private attribute in the StyleBook to true. You can still use private StyleBooks to create configuration packs using the Citrix ADM APIs.

Example of a StyleBook marked as private

name: basic-lb-config
namespace: com.example.stylebooks
version: "0.1"
display-name: Load Balancing Configuration
description: |
    This StyleBook defines a simple load balancing configuration and is a building block to build other load balancing configurations.
schema-version: "1.0"
private: true
<!--NeedCopy-->