Global parameters
Last updated
Last updated
'Global parameters' is used to define parameters that can be reused on multiple operations. You can define query, form, body, header and matrix parameters.
A global parameter is defined like a 'normal' one except that you have to give it a unique identifier once you have defined it. This is to enable you to have multiple global parameters with the same parameter 'Name'. You can of course still only apply one global parameter of given 'Name' to an operation, but this way you can build up a library of useful parameters.
Once you have defined a global parameter you can add it to any operation (as long as that operation not already has a parameter with the same 'Name'). Just select parameters on operation and press the 'ADD GLOBAL' button.
Select parameter of interest and press 'OK'. You will then be given the option to include the parameter as a copy or as reference. If added as copy, a new parameter that looks exactly like the global one will be added to the operation, but there is no connection between the two. So if the global parameter is changed in any way, the added copy is not affected. If you add it as a reference any changes to the global parameter will affect the parameter you added to the operation (it is the same parameter). So if you for instance change the 'Name' of the global parameter, this means that the operation now sends a parameter with a different 'Name'. This can create conflicts. Let's say for instance that you add the global parameter 'q1' to an operation as a reference. You then add the parameter 'q2' to the operation. If you then change the 'Name' of the global parameter to 'q2' the operation will have two parameters with the same 'Name'. This is not allowed, but will not raise any warnings until you try to "Create/update connector".
In the 'Global parameters' section you can create parameters of kind 'Internal'. This kind of parameters can only be add to operations as a reference, never a copy. The purpose of internal parameters are to be able to send in parameters to an operation that can be used in model transformations. They are not sent to the remote API. Internal parameters will always be set to a nullable type. So when you use it in a model transformation this must be considered. Let's say for instance that you have a global internal parameter called 'Remove empty entries' of type 'Boolean', the usage of that parameter could look like this:
Configuration parameters
With configuration parameters you can define parameters that are to be provided from the connector configuration. The values of these parameters can then be used wherever you can provide c# code, like model transformations or computed parameters.
You can set 'Mask value' if the parameter can contain sensitive data. The values of the parameters are always encrypted when stored though. With 'Default value' you can provide a value that is to set on the parameter unless the user changes it.
