The assign variable policy can be used to parse the message body to make the various parts of the message available as variables which can be used in the proxy pipeline.
The message body could be any of the following:
- request to a proxy
- response from the target server
- response from an external service call out
For example, a service call made to Google Location JSON service can be parsed to obtain the variables latitude and longitude of a location and can be used in the flow to build a request to the target server/another service call or responded to the client.
To add a variable, perform the following actions in the Assign Variable Policy Configuration page:
Click the Add button and provide a name for the variable to configure source information.
Figure 1: Adding properties
- Click the Source drop-down list to select the source from the following options that appear in the list:
Figure 2: Selecting the Source value
- Provide the substantiating values for the respective source (refer to the sections below) as selected.
Click Save to complete assigning the variable.
The Source attribute helps to provide extra information which can be used by the Variable parameters that are added. Sources are of different types which may be specified as per requirement. The sections below explain the same.
Provide the parameter name in the Param Name field. The value of the query parameter is copied to the variable.
Figure 3: Query Param source properties
Provide the parameter name in the Param Name field. The value of the Form Parameter is copied to the variable.
Figure 4: Form Param source properties
Provide the path pattern in the Pattern Name property value. This Path will be used by the variable parameter.
Figure 5: Path Param source properties
Provide the parameter name in the Param Name field. This Header parameter will be used by the variable parameter.
Figure 6: Header source properties
Provide parameter name in the Param Name field.
Figure 7: Variable source properties
Provide a JSON Path value in the JSON Path field to insert the JSON message content to the variable parameter.
Figure 8: Payload source properties
Choose Is XML option to provide XPath and thereby insert XML in the Variable parameter. To provide Namespaces for the prefixes used in the XPath expression, click the Add button present next to the Namespaces table.
Figure 9: Is XML option under Payload source properties
Provide a value for the Constant in the Value editor to be used by the Variable parameter.
Figure 10: Constant source properties
Choose the Use Variable option to provide a variable prefix and suffix in the Variable Prefix and Variable Suffix fields respectively.
Figure 11: Use Variables option under Constant source properties
Provide the script in the Value editor under the Source drop-down list for the Variable parameter to use.
The function can use the variable context which can be used to inject the context of the request. The variable context supports the following methods.