[Index]

Model: data/ConfigurationTemplate

Configuration Templates

Full HTML Help

Introduction to Configuration Templates

Configuration templates (CFTs) are used to define values for the attributes of any model.

Values can be fixed values, or existing macros visible from the hierarchy (for example, customer or site), where the CFT is applied.

CFTs allow you to define default values for items exposed in the Admin Portal (visible, hidden, or read-only). CFTs provide a way to map data from data input via the Admin Portal or device model events to other models or provisioning workflows in the system.

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

Examples

• A model with an attribute defined as a date string; a CFT 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.
• A model such as Quick Add Subscriber (QAS), which limits user input to a few fields while deriving the value of other hidden attributes from various CFTs that are each applied to different underlying models that make up a subscriber, such as voicemail account settings, conference account settings, phone, line, or device profile settings.

When adding or updating an instance of the model, the CFT enabled on the model is applied.

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.

You can create one or more CFTs for a model, and these can be used as needed. CFTs 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 CFT to a model that is selected as a menu item.

Provider administrators (and higher level admins) can quickly add a new CFT by opening a similar CFT (via, say, the Configuration Templates menu), then making a copy (clone) of it, and customizing the clone to create a new CFT.

Administrators at levels above the site admin can also customize these templates, including Field Display Policies (FDPs).

Related Topics

Quick Add Subscriber in the Core Feature Guide

Quick Add Subscriber Groups in the Core Feature Guide

Add a Configuration Template

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

Perform these steps:

1. Log in to the Admin Portal as Provider administrator or higher.

2. Go to Customizations > Configuration Templates to view the list of existing CFTs.

3. Click on a configuration template (CFT) you wish to clone, and view its details.

4. Click Action > Clone.

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

   Note

   Some fields are populated based on specific conditions. For example, when creating a device instance CFT in a multi device or clustered environment, drop-down values in the CFT that originate from a device will be the values from all the devices in the cluster. For this reason, the list may include duplicates; in this case, you can choose any duplicate, if required.

6. Click Save.

   The new, cloned CFT appears at the selected hierarchy level.

Configuration Template Field Reference

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

Example: Add a CFT for a Cisco 6941 SCCP Phone

1. Choose the hierarchy where the CUCM you want to use exists.

   Note

   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

   Don't save your changes 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

   You can type in the values if you know them; else, choose values from the list.

5. Click Save.

EMCC Templates

Full HTML Help

Extension Mobility Cross Cluster (EMCC) templates allow you to define the common EMCC attributes to add a group of new EMCC.

Related Topics

• Configuration Templates

Clone and Add EMCC Template

Prerequisites:

• Before creating the template, ensure the EMCC settings are already configured in Cisco Unified Communications Manager (CUCM) Administration.

Perform these steps:

1. Log in as Provider administrator or higher.
2. Set the hierarchy path to the correct customer or location node.
3. Choose Customer Management > EMCC Templates.
4. Click on the EMCC Template from which you want to create a new EMCC Template.
5. Click Action > Clone. The selected EMCC Template is cloned. See also Configuration Templates for more information.
6. (Mandatory) Enter a new Name for the EMCC Template.
7. Edit existing fields, and add new fields as required.
8. Click Save to add the EMCC Template.

Modify EMCC Template

1. Log in as Provider administrator or higher.
2. Set the hierarchy path to the correct customer or location node.
3. Choose Customer Management > EMCC Templates.
4. Click on the EMCC Template that you want to edit. See also Configuration Templates for more information.
5. Edit and add the required fields, making sure that all mandatory fields are complete.
6. Click Save to save the modified EMCC Template.

Delete an EMCC Template

To delete an EMCC Template, click on the template to delete on the EMCC Templates list view, and then click Delete on the button bar.

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 Template Field Reference

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