.. _workflow_for_creating_configuration_templates:

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:

.. note:: 
   Fields specific to the template for the selected target model type are not included in the table. 


.. tabularcolumns:: |p{4cm}|p{4cm}|p{7cm}|

+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Title                  | Field Name              | Description                                                                                              |
+========================+=========================+==========================================================================================================+
| Name *                 | name                    | The name that is given to the Configuration Template.                                                    |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Description            | description             | A description for the Configuration Template.                                                            |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Foreach Elements       | foreach.[n]             | Iterates over the list returned by the macro and appends array elements to the specified field.          |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Property *             | property                | The field property to iterate over.                                                                      |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Macro List *           | macro_list              | The macro that produces the list to iterate over.                                                        |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Context Variable *     | context_var             | The context variable that will contain the data from the iteration.                                      |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Schema Defaults        | schema_defaults.[n]     | Applicable only when the configuration template is used directly in API requests. This attribute         |
|                        |                         | contains a list of paths to the properties of the template section that must be used to enrich the       |
|                        |                         | default values of the schema. All paths specified must refer to array attributes.                        |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Target Model Type *    | target_model_type       | The target model type and name that the Configuration Template applies to.                               |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Merge Strategy         | merge_strategy          | Determines how this CFT will be merged into another CFT when it is being processed in a PWF.             |
|                        |                         | Default: additive.                                                                                       |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+
| Template *             | template                | The contents of the template, such as defaults and macros. The names shown in the template are           |
|                        |                         | determined by the attribute names of the Target Model Type.                                              |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+