[Index]

Model: data/ConfigurationTemplate

Configuration Templates

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Configuration templates are used to define values for attributes of any model. The values can be fixed values or existing macros visible from the hierarchy context where the configuration template is applied. The templates provide a useful way to define default values for items that are exposed in the Admin Portal (visible, invisible or read-only). They also provide a mechanism to map data from data input via the Admin Portal or device model events to other models or Provisioning Workflows in the system.

One may want to hide attributes of a model while setting them to a specific fixed value (for example a hard-coded setting); or one may wish to derive the value based on a macro (for example, look up the value based on data in the system).

For example, if a model has an attribute that is defined to be a date string, a Configuration Template for the attribute can be defined as a macro {{fn.now \"%Y-%m-%d\"}} in order to set the current date stamp as the value, such as 2013-04-18. Designers can access reference material for details on macros.

Another example is a model such as the Quick Add Subscriber that limits the user input to a few fields, whilst deriving the value of other hidden attributes from various Configuration Templates that are each applied to different underlying models that make up a Subscriber (for example, Voicemail account settings, conference account settings, phone, line, device profile settings, and so on).

When an instance of the model is added or updated, the Configuration Template that has been enabled for the model applies. For array elements of data models, a list and a variable can be specified to be looped through so that a value is applied to each element in the model array.

More than one Configuration Template can be created for a model. These can then be used as needed. Configuration Templates can also be applied to models in the design of for example Provisioning Workflows.

A Menu Layout that can be associated with a user role can also apply a Configuration Template to a model that is selected as a menu item.

For administrators at Provider Administrator level or higher, a quick way to create a Configuration Template would be to open a similar template from for example the Configuration Templates menu and to customize a clone of it.

Administrators at levels above the Site Administrator can also customize these templates, including Field Display Policies.

Creating a Configuration Template

This procedure clones and edits an existing configuration template to create a new configuration template.

Perform these steps:

1. Log in as Provider Administrator or higher.

2. Go to Customizations > Configuration Templates to display the list of existing templates.

3. Click the template that you want to clone, and view the template information that displays.

4. Click Action > Clone.

5. Edit the required generic template fields, such as Name, Description, Target Model Type, and the fields specific to the selected model type. See Configuration Template Field Reference in the Core Feature Guide.

   Note

   Some fields are populated based on specific conditions. For example, when creating a device instance configuration template in a multi device or clustered environment, the values in drop-downs in the template that originate from a device will be the values from all the devices in the cluster. For this reason, the list may include duplicates, but in such a case, any duplicate may be chosen if required.

6. Click Save. The new, cloned template appears at the selected hierarchy level.

Example: Create a template for the Cisco 6941 SCCP Phone

1. Enter the hierarchy where the Cisco Unified Communications Manager you want to use exists. This step is required if the fields are to populate values because some of the values are derived from the actual device model through the API.

2. Click the Default CUCM Phone Template, and then click Action > Clone.

   Note: Do not click Save yet.

3. Change the template Name and Description.

4. Edit the template fields:

   • From the Device Protocol drop-down, choose SCCP.
   • From the BAT Phone Template drop-down, choose Standard 6941 SCCP.
   • From the Device Security Profile drop-down, choose Cisco 6941 - Standard SCCP Non-Secure Profile.
   • From the Product drop-down, choose Cisco 6941.
   • From the BLF Presence Group drop-down, choose Standard Presence Group.
   • In the remaining fields, use the cloned default values.

   Tip

   If you know the values for the fields, you can type the files in the fields instead of selecting the values from the list.

5. Click Save.

Configuration Template Field Reference

The table describes general fields on the Configuration Template editing screen:

Configuration Templates are applied to data models and domain models. When they are created, all the attribute fields of the model are exposed. Default values or macros can then be assigned to these fields as required. For array elements of the related data- and domain models, a list and a variable can be specified to loop through so that a value is applied to the model array. More than one Configuration Template can be created for a model. When an instance of the model is added or updated, the Configuration Template that has been enabled for the model applies.

Model Details: data/ConfigurationTemplate