Configuration Guides › Policy Server Configuration Guide › Variables › Create a Variable › Create an XML Envelope Header Variable

Create an XML Envelope Header Variable

XML Envelope Header Variables let you obtain information from any element in the SOAP envelope header (including WS‑Security headers) of an incoming XML message, for use in policy expressions or responses.

Specifically, XML Envelope Header variables are resolved to the value of an XPath string that identifies a SOAP envelope header element (and optionally, an operation to perform on that element) of an XML document.

Note: For more information about XPATH, see the XPATH specification available at http://www.w3.org/TR/xpath.

To create a variable

1. Open the domain to which to you want to add a variable.
2. Click the Variables tab.

   A table lists the variables associated with the domain.

3. Click Create Variable.

   The Create Variable screen appears.

4. Verify that Create a new object is selected, and click OK.

   Variable settings open.

5. Type the variable name in the Name field.
6. Select XML Header from the Variable Type list.

   XML Header variable settings open.

   Note: Click Help for descriptions of settings and controls, including their respective requirements and limits.

7. Specify the data type in which the value of the specified XPATH query should be returned by choosing one of the following options from the Return Type list:
   • Boolean
   • Number
   • String (the default)
8. Type in an XPath query that you want to resolve to the variable value in the Query box.
9. Click Finish.

   The variable appears in the Variables tab of the domain. The variable can now be used in policy expressions or responses.