How do I use Keys in DataFlows?

[data-usr]

There are different ways to use Keys - Property Loader Module, etc.

[andyvidan]

Typically, in a Dataflow, we load a Key using the Key Loader Module, as follows:

This allows you to simply select the key using the Key Selecting modal:

It is also sometimes helpful to use a Property Loader Module, where you can type in the name of the Key as the Module input:

NOTE: Key Loader Module uses the Key ID (integer) whereas the Property Loader Module uses the Key Name (string). Use the one that is best suited for your use case (e.g., if you want to dynamically pass in the Key name based on a Branch in the DataFlow)

There is also a Key picker functionality that is available, that may provide a “cleaner” DataFlow when the Key does not change (e.g., “hard-coded” Key scenarios).

To use this feature:

1. Simply right-click on the input (green dot) and a Context-menu will come up:

2. Select the ‘Select Key Value’ and a modal will be displayed with Keys you have access to.
3. Select the Key by choosing the Key from the list, and clicking on Select. You will see the Key listed in the input:

NOTE: The Key name that appears is a link. You can click on it, and it will open up a new page with the Key that you can view/edit as needed.

NOTE: You can have multiple Keys in one module. And since Keys can represent not just usernames/passwords, but also strings, integers, etc., you will find the Select Key feature on most Module inputs.