Tokens

Tokens are what make configuration flow templates different from configuration jobs. By using tokens in configuration flow templates, you make it possible for operators to enter values for parameters when they are preparing to execute the configuration (in a configuration flow executor). You can also limit the number of selections that an operator must make before executing the flow. By defining tokens appropriately in templates, you can reduce the amount of operator intervention required at execution time.

Configuration flows support two types of tokens: flow tokens and device tokens (or NE tokens).

Flow Tokens

Flow tokens are variables used for configuration parameters. When you are defining a configuration flow template, you can enter a flow token in a field rather than a fixed value. At execution time, the operator will be prompted to enter a value or to select a value from a list.

To use a flow token in a parameter field, you enter the dollar sign character followed by the flow token name enclosed in curly braces like this:

${elementName}

Flow token names must begin with a letter and can include any combination of letters, digits and underscore characters. They should not include spaces, punctuation or special characters ( *, & ). Here are some examples of valid flow token names (in the exact form you would enter them in a
field):

${theNetwork}
${macAddress}

• Text field: If you put a flow token in a text field in the configuration flow template, the operator will have to enter a text in the executor.
• Drop-down list: If you put a flow token in a drop-down list in the configuration flow template, the operator will have to select one of the items in the list.
• Port field: If you put a flow token in a port field in the configuration flow template, the operator will be presented with a list of ports (determined from the devices managed by the system) and will have to choose one.
• Interface field: If you put a flow token in an interface field in the configuration flow template, the operator will be presented with a list of interfaces (determined from the devices managed by the system) and will have to choose one.
• MAC address: If you put a flow token in a MAC address field in the configuration flow template, the operator will be presented with a list of MAC addresses (for the devices managed by the system) and will have to choose one.

The same flow token name can be used multiple times. For example, if you configure a ${VLAN} flow token, that you use in the Layer 2 filter configuration step, you can use the same ${VLAN} flow token in the PAA step. By using the same flow token for several parameters, users will only be asked for the ${VLAN} value once and it will be used for both the filter and PAA steps.

The same flow tokens can be used in multiple templates. When a profile is created with multiple templates, Skylight orchestrator will scan the templates in order to identify common flow tokens and will only display them once in the profile.
You can use a combination of flow tokens in a parameter field. For example, in the Name field of the PAA step, you could enter:

PAA_${VLAN1}_to_${VLAN2}

Then, if the operator enters a value of 200 for VLAN1 and 300 for VLAN2 in the configuration flow executor, the PAA name would resolve to:

PAA_200_to_300

Device Tokens (NE Tokens)

A configuration template is applied to a list of devices (Skylight elements or sensor: control). The list can contain one or more devices. A Device token (sometimes labeled "NE token" or simply "Token") is a label on a list of devices. When you create a template, you can enter a device token in the template to indicate the type of device that the template should be applied to.

The device token is also a way of linking related configuration templates. You can use the same device token in multiple templates so that, when the configuration flow is executed, it can be applied to all the devices that correspond to the device token.

When you create a configuration profile, you can include multiple templates that use the same device token or different device tokens. The executor (used to run a profile) will have one or more lists of devices (depending on how many device tokens were used in the templates included in the profile).

When an operator executes a profile, he will have to select devices for each device token or list of devices. If all templates in the profile use the same device token, the executor will have one list of devices. If different templates use different device tokens, the executor will have multiple lists of devices (one list for each device token).

If you are creating templates, here are guidelines for defining device tokens:

• Naming device tokens: Choose names that clearly indicate to the operator the kind of device that he should select (for example: sensor: control). You will also be able to enter
  a description in the configuration profile to help the operator select appropriate devices.
• Multiple templates – Single device token: To create a profile that includes multiple templates to be applied to the same list of devices, use the same device token in all templates.

Example: If you define several templates to configure a GT element, all templates could use the device token: GT element. Then you would include all GT element templates in a profile. When the operator executes the profile, he would drag elements into a single list (the GT element list).

• Multiple templates – Multiple device tokens: To create a profile that performs different configuration tasks on different devices, you would define multiple templates with multiple different device tokens.

Example: For a configuration that sets up a PAA session, you could define two templates, one template for each endpoint. Template A would set up the configuration tasks for Node A (its device token would be Node A). Template Z would set up the configuration for Node Z (its device token would be Node Z). When an operator executes the profile on a pair of devices, he would drag one element into the Node A list and another element into the Node Z list.