Parameters
Parameters are the data that components receive and return. Proton has three kinds of reusable data:
| Type | Where it applies | What for |
|---|---|---|
| Parameter | In components | The inputs (in_) and outputs (out_) of each step. |
| Dataset variable | In a dataset | A value shared among the steps of a dataset. |
| General parameter | Across the whole organization | A value used by many automations, such as an address or a fixed code. |
Values that change from one environment to another (address, username, staging and production password) are better kept in the environment variables.
Component parameters
A parameter is either an input (the step receives it) or an output (the step returns it, and another step can use it).
Naming rules
- Inputs start with
in_; outputs, without_. For example,in_clienteandout_numero_pedido. - No spaces. The name becomes a key in the automation code.
- Up to 100 characters.
- Unique in the organization, across inputs and outputs, case-insensitive. The same parameter can be used by several components.
The code reads the parameter by exactly its registered name, so in_Cliente and in_cliente do not match.
Create and link
Parameters are created and linked on the component screen, with Create parameter or Add parameters. Then each dataset fills in the values when you build the dataset.
Rename
The parameter's pencil opens the edit form, with Where it is used: the components, how many datasets and automations and the last run.
- The type (input or output) does not change. To switch it, create another parameter.
- Inside Proton nothing breaks: components and datasets stay linked to the parameter.
- The code has to change too. The code reads the parameter by name: after you rename it, runs cannot find the parameter until the code changes. The edit form shows the old name and the new one so you can copy the change.
Dataset variables
Dataset variables are in Dataset Variable, in the dataset actions. They apply to every step of the dataset: a parameter of type Dataset Variable uses the variable's value.
- The name is unique in the dataset.
- Duplicating the dataset carries the variables over.
General parameters
Automations > General Parameter holds the values shared by the whole organization. A parameter of type General in a dataset uses the general parameter's value: changing the general parameter changes every dataset that uses it.
- Add asks for the name (unique in the organization), the value, the category and, if needed, Encrypt value.
- Categories, in a tree, organize the parameters (for example, Credentials, URLs). Deleting a category leaves its parameters without a category.
- An encrypted value no longer appears. To change it, uncheck Encrypt value when editing and type the new value.
Permissions
Parameters, dataset variables, general parameters and general parameter categories have their own permissions in the profile (read, create, update and delete).