About Flow Token Data Sets

A Flow token data set is a CSV file that supplies the value for the parameters that were defined with flow tokens. It is used to specify which Flow template configuration should be performed on which devices defined in an ME Reference dataset, based on Device token or Flow template configuration name.

The ME Reference file lists the devices to configure. See "About ME Reference Datasets (Device Datasets)".

Flow token data set and ME Reference is used for running a Configuration Flow Executor using Data Sets. See “Creating a Configuration Flow Executor using Data Sets”

Flow Token Dataset Examples

As seen in the image below, a Flow template configuration has been created with:

• Device Token: DEVICETOKEN1
• Flow tokens: username; number

Here is an example of a Flow token dataset file:

NEID,DEVICETOKEN,DATA
[*],DEVICETOKEN1,username=Username-1&number=9999

Example Flow token dataset file is available in the following directory on the Skylight orchestrator server:

/opt/accedian/skylight/samples/datasets/flow-dataset-sample.csv

Flow Token Dataset Format

The first line in a Flow token dataset file is always:

NEID, DEVICETOKEN, DATA

The first line defines the format for the rest of the lines in the file. It contains:

• NEID: The NEID values in a Flow token dataset file refer to the NEIDs defined in the associated ME Reference dataset. The NEIDs form the link between the two dataset files. They allow you to specify which Flow template configuration should be performed on which devices, see “Specifying NEID values in a Flow Token Dataset” section below.
• DEVICETOKEN: The Device Token is defined when creating Flow template configuration, see “Device Token (NE Tokens)” section in the “Token” page. In case you have created a Flow template configuration without using Device token, enter Flow template configuration name as an alternative.
• DATA: Contains the value for the parameters that were defined with flow tokens. They must belong in the Flow token configuration. Input data for this field is in the following format: Flow token = Flow token's value.

The "&" character is used to concatenate a pair of Flow Tokens and their value with another one in case multiple Flow tokens were defined when creating the Flow template.

Example:

FlowToken_1=Value_1&FlowToken2=Value_2

In addition, "&" is also used to concatenate Device tokens or Flow template configuration names (if Flow template configuration does not define Device token).

Example:

DEVICETOKEN1&DEVICETOKEN2

Specifying NEID Values in a Flow Token Dataset

In a Flow token data set, the NEID value is always enclosed in square brackets and can be specified in any of the following ways:

• NEID of a single device. For example: [1]
• Range of NEIDs. For example: [1-3]
• A list of individual NEIDs separated by semicolons. For example: [2;3;4]
• Several NEID ranges separated by semicolons. For example: [1-10;15-20]
• All devices in the associated ME Reference dataset: [*]

The NEID values in a configuration step dataset file refer to the NEIDs defined in the associated ME Reference dataset. The NEIDs form the link between the two dataset files. They allow you to specify which configuration steps should be performed on which devices.