Web Services Security Guides › CA SiteMinder WSS Policy Configuration Guide › Variables › Variables Overview › 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.

Follow these steps:

1. Click Policies, Domain.
2. Click Variables.
3. Click Create Variable.

   Verify that the Create a new object of type Variable option is selected.

4. Click OK.
5. Select a domain from the list and click Next.
6. Type the variable name in the Name field.
7. Select XML Header from the Variable Type list.

   XML Header variable settings open.

8. 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)
9. Type in an XPath query that you want to resolve to the variable value in the Query box.
10. Click Finish.

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

Create a Static Variable

You create a static variable to make it available for use in policies or responses.

Note: The value of the resolved variable must not be greater than 1 K.

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 Static from the Variable Type list.

   Static variable settings open.

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

7. Specify the data type and value of the variable in the Variable Information group box.
8. Click Submit.

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

Create a Request Context Variable

You create a request context variable to make it available for use in policies or responses.

Note: The value of the resolved variable must not be greater than 1 K.

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.

   Note: Request Context variable names must begin with the percent character (%).

   Example: %REQUEST_ACTION

6. Select Request Context from the Variable Type list.

   Request context settings open.

7. Select the variable value from the Property list.
8. Click OK.

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

Create a User Context Variable

You create a user context variable to make it available for use in policies or responses.

Note: The value of the resolved variable must not be greater than 1 K.

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.

   Note: User Context variable names must begin with the percent character (%).

   Example: %SM_USERPATH

6. Select User Context from the Variable Type list.

   User context settings open.

7. Select the portion of the user context that provides the value of the variable from the Property list.

   The return type value appears as either string or boolean depending on the value you selected from the Property list.

8. (Required for User Property and Directory Entry) Enter the name of the directory or user attribute that provides the variable value in the Property field.
9. (Required for User Property and Directory Entry) Enter the size of the buffer (in bytes) that is to store the variable in the Buffer field.
10. (Required for Directory Entry) Enter the distinguished name of the directory entry in the DN field.
11. Click Submit.
12. The variable appears in the Variables tab of the domain. The variable can now be used in policy expressions or responses.

Create a Form Post Variable

You create a Form Post variable to make it available for use in policies.

Note: The value of the resolved variable must not be greater than 1 K.

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 Post from the Variable Type list.

   Form post settings open.

7. Enter the name of the POST variable contained in the form in the Form Field Name field.
8. Click OK.

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