Creating a Configuration Flow Template

System administrators create a configuration flow template. You can create a new template in the Configuration job page. You can also duplicate an existing configuration job or template and adjust it as necessary.

A detailed procedure for creating a template is provided below. For an overview of how to create a template, see "Configuration Flow Templates: Overview".

To create a configuration flow template

1. Access the page Commission ▶ Jobs

2. Click the Add Job Profile button. Alternatively, if you want to copy an existing job or template, select the job or template in the list and click the Duplicate Job Profile button. To edit an existing configuration job or template, double-click the job or template in the list.
   The Job configuration page is displayed.

3. Enter a name for the template in the Job name field.

4. Check the Flow template checkbox.
   

5. Enter a value in the Device token field. Enter a value for the device token. For more information about tokens and appropriate values, see "Tokens".

6. In the left pane, select the configuration steps that you want to include in this configuration template. For more information about a particular step, locate the section for that step in "Commissioning - Configuration Jobs".

7. If you need to change the order of the configuration steps, drag and drop the steps as required in the list. The steps will be executed in the listed order. This is important if certain steps are prerequisites for other steps. For example, a Layer 2 filter (the L2 Filter step) must be created before it can be used in a policy (the Policies step).

8. Complete the parameters for each configuration step that you select. Since you are creating a template, you can select or enter actual values, or you can enter flow tokens (variables) in the parameter fields.
   For detailed explanations of how to enter flow tokens, see "Entering Flow Tokens in Parameter Fields".

9. Click Apply, then click Close.

Job Configuration(Commission ▶ Jobs) for a Flow Template
General

Configuration Flow Template

Commissioning Data

Entering Flow Tokens in Parameter Fields

If you want the operator to enter or select a value for a configuration parameter at execution time (when they are setting up a configuration flow executor), you need to use a flow token in the configuration job template.

How you enter the flow token in a field depends on the type of field. This section explains how to enter a flow token in the different types of fields that appear in configuration job templates.

▶ To insert a flow token in a simple text field

1. Double-click in the field. The field becomes editable.

2. Enter a flow token in this format: ${theParameter}

3. When you leave the field, the token is accepted.

▶ To insert a flow token in a drop-down list

1. Double-click in the drop-down list. An arrow is displayed in the field.

2. Click on the arrow and select: Flow token.
   A dialog pops up to allow you to enter a flow token.

3. Enter a flow token in the dialog in this format: ${theParameter}

4. Click OK. The flow token is accepted and displayed in the drop-down list.

▶ To insert a flow token in a port field, interface field or MAC address field

1. Double-click in the field. The field becomes editable.

2. Enter a flow token in this format: ${portSelectedByOperator}

3. When you leave the field, the token is accepted.