A Parameter is a value, object, or code snippet available throughout your Solution. You can think about parameters as similar to a configuration file usually used in traditional programming. Parameters simplify configuration, facilitate reuse of common info, and provide extra security, through encryption.

Typical things to store in parameters include API keys, domain specific constants like tax rates or threshold values, file or object paths, and algorithm parameters. Basically, anything you'd want to avoid using a "magic string" for. Parameters can store more complex objects, but in this case using a Buffer might be more appropriate. Likewise, connection strings and authentication info is better stored in a Connection.

Managing Parameters

Parameters are managed by clicking on the Parameters menu option. You can create a new Parameter by clicking the "+" sign to the right of the Parameters menu item, then setting the name of the Parameter, the type, and finally the value:

Security

You can opt to encrypt Parameter values for extra security. This triple-encrypts the value on Synatic. Encryption can be enable by selecting the secure option when creating a Parameter:

It is good practice to encrypt any sensitive information (API keys, etc)

Using Parameters

Field Binding

Parameters can be used wherever you see the Parameter Link symbol next to a field:

Clicking on the Parameter Link will allow you select the parameter, and bind it to the field:

Once selected, the Parameter will be shown with a preceding @ that signifies the parameter name.

The Parameter can be unlinked from a value by clicking on the unlink icon next to the field name.

Using parameters in strings

Parameters can be used inside strings by using the {@parameterName} character sequence:

Parameters can also be complex objects. In the above example, the Parameter “parameter1” has the property “value” that is being merged into the string on execution. If the value of parameter1 was:

The final URL that would be used is: http://www.test.com/test.

Did this answer your question?