.. _reference_config_template_field:



Configuration Template Field Reference
--------------------------------------

.. 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.                                              |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------+