Create a configuration template with Visual Editor

The Visual Editor mode enables you to create a simple application template without having to learn CML or understand the whole configuration file. This is a useful tool if you want to parameterize a small section of a configuration file to push changes to a server.

1. To begin, you can create an application configuration template using the Visual Editor by starting with an existing file, such as:
   • A working configuration file on an SA managed server
     See Creating a template from a working configuration file.
   • A sample configuration file imported from the local PC
     See Importing and creating a template.
2. Then, the Visual Editor mode provides a user interface for editing a simple application configuration template without using CML.
   • Simply mark the configuration options that should be replaced at configuration push time and the form view appears. The marked options populate the parameter name, display name, and data type fields based on the underlying template. The form view allows you to modify the parameter details as desired. See Editing a configuration template with Visual Editor.
     
3. After creating the template, you have the option of instantly generating the application configuration instance.
   • From a working configuration file on a managed server, you can view a list of compatible templates, open a template, and instantly generate the application configuration instance and attach it to the server. The configuration instance opens in the value set editor, where you can modify the values and push the changes to the server. See Managing configuration files

Importing and creating a template

1. From the SA Client navigation pane, access the folder where you wish to import the configuration file from your PC by selecting Library > By Folder or > By Type and navigate to the desired folder.

2. From the Actions menu, select Create Configuration Template from File....

   

3. Find and select the configuration file you wish to import and click Open.
4. A template of the selected file opens in Visual Editor mode.
   
   See The Visual Editor interface and Editing a configuration template with Visual Editor.

Creating a template from a working configuration file

To create a configuration template with the Visual Editor from a working configuration file:

1. Open a server browser:
   1. From the SA Client navigation pane, access the list of managed servers or device groups:
      1. Select Devices > Servers > All Managed Servers to view the server list.
      2. Select Devices > Device Groups to view the device group list.
   2. From the content pane, select the server or device group you want to open.
   3. From the Actions menu, select Open.
2. Navigate to Server Browser > Inventory > Files.
3. When prompted, choose the appropriate root path for the server file system (typically, root for UNIX or Administrator for Windows).
   
4. Right-click the configuration file and choose Create Configuration Template with Visual Editor.
   
   A template of the selected configuration file opens in Visual Editor mode. See The Visual Editor interface.

The Visual Editor interface

The Visual Editor interface displays the underlying application configuration template details in a split panel, where the lower panel displays the detailed properties of the selected parameter in an editable form view. The Parameter Properties panel appears when you first enter the Visual Editor window.

Visual Editor interface

Parameter Properties panel

When you select a value in the Visual Editor and then click inside the Parameter Name field of the Parameter Properties panel, the fields in the Parameter Properties panel are populated based on the values in the underlying configuration file.

The parameter properties fields are editable in the user-friendly form view.

Parameter Properties form

Advanced section of Parameter Properties: Use the Advanced section to specify additional options about the parameter, such as whether it is required (default) or optional, if it is a loop variable, an ordered list, a sequence (specify type and delimiter), or a range. The range is specified for a numeric type such as integer, decimal or port. (The numeric type can be part of a sequence.)

Advanced section of the Parameter Properties form

How the Visual Editor Interface Works

In the Visual Editor, select the value of configuration option that you wish to replace when you push the configuration and the form view appears.

The marked options populate the Parameter name, Display name, and Type (data type) fields in the Parameter Properties panel based on the data in the underlying configuration file. The form view allows you to modify the parameter details as desired.

Editing the configuration template in Visual Editor

For instructions on editing the configuration template with the Visual Editor, see Editing a configuration template with Visual Editor.

Advanced options in Visual Editor

The Advanced Options view allows the user to modify global CML options in the template. To access this view, select Advanced Options in the Views pane of the template.

These values are populated by default and do not require user input, but they are editable:

• Defining the three mandatory fields: filename-key; filename-default and namespace
• Specifying whether the generated template will be a partial or full template (partial, by default, meaning only the specified values will be replaced.)
• The push timeout value and other CML formatting and parsing options.

Editing a configuration template with Visual Editor

In addition to basic instructions for the flow of the Visual Editor, this section has tips for editing a configuration template with the Visual Editor. For instructions on opening the visual editor, see Create a configuration template with Visual Editor.

To edit a configuration template:

1. Open the Visual Editor.
   SeeImporting and creating a template or Creating a template from a working configuration file.
2. Define the parameters you want to push.
   See Creating a simple parameter or Creating a sequence parameter for examples.
3. Review the Properties tab to specify the name of the template and the location where you want store it.
4. Click Save to save the template.

Creating a simple parameter

To create a simple parameter:

1. Select the configuration option that you wish to replace when you push the configuration and the form view appears.
   
2. In the Parameter Properties panel, click in the Parameter name field, and the marked options populate the Parameter name, Display name, and Data Type fields based on the underlying template.
   `
3. Enter the desired values for the Parameter name and Display name and click Save to save the parameter.
   
4. The newly created parameter will be highlighted in blue in the Visual Editor.

Creating a sequence parameter

To create a sequence parameter:

1. Perform the same steps as when you create a simple parameter (see Creating a simple parameter).
2. In the Advanced section, specify a value in the Sequence Type field: Set or List.
   
   A List must hold the elements in a particular sequence, and a Set cannot have any duplicate elements.
   
3. Specify the Sequence Delimiter. This is the type of character that is used to separate the values in the list.

In the Visual Editor panel, the sequence parameter will be created in such a way that all the elements in the configuration file that match the parameter will be highlighted using the same parameter name.

Managing configuration files

The Manage Configuration File feature enables you to quickly model a working configuration using an existing template.

To model a working configuration using an existing templates:

1. Open a server browser:
   1. From the SA Client navigation pane, access the list of managed servers or device groups:
      1. Select Devices > Servers > All Managed Servers to view the server list.
      2. Select Devices > Device Groups to view the device group list.
   2. From the content pane, select the server or device group you want to open.
   3. From the Actions menu, select Open.
2. Navigate to Server Browser > Inventory > Files. (This step requires that you have OGFS permissions.)
   
   When prompted choose the appropriate root path for her server file system (typically, root for UNIX or Administrator for Windows.)
3. Right-click on the configuration file and select Manage Configuration File.
   
   Existing templates in SA that match the configuration filename and path are listed as suggestions. Only templates that match the server platform are offered.

4. Select the template to view the contents in the preview pane.
   

   Alternative options:

   1. Choose “Display all templates” check box to expand the list to include all templates that match the server's platform.
   2. Click Cancel to close this window and return to the servers file system directory.
   3. Click Create New Template to create a new template based on the selected configuration file using the Visual Editor. (See Creating a template from a working configuration file or Editing a configuration template with Visual Editor.)
      1. If you select Create New Template, when you save and close the template, you are prompted to indicate if you want an application configuration to be generated and an instance be attached the server.
      2. Optional: If you just want to save the template to revisit later, click No. The template is saved in the directory specified in the Properties tab.
      3. Click Yes to instantly generate the application configuration instance and attach it to the server. The configuration instance appears in the Value Set Editor.
5. Click Use Selected Template to create a new application configuration using the selected template. (This step requires that you have permission to your Home folder.)
   
   The newly created configuration file will be placed in your Home folder in the SA Library and an instance of it will be attached to the managed server.
   
   A confirmation message appears advising that the configuration file was created and attached to the server.
   
6. Click OK. The configuration instance appears in the Value Set Editor.
   
7. Enter the value set data for this instance (see Setting values in the Value Set Editor).
8. (Optional) Click Preview to preview the change compared to the current value side by side. Click Close to return to the Application Configuration instance view.
   
9. Click Push to push the change to the server.