You are here:

Web Service variables

Web Service variables augment the functionality of setting the default value of a parameter on a Web method.

You may want to supply a default value that is a value returned by another Web method call. In this case, you cannot set the default value for the parameter to a (static) string literal, but you can set the value to a "Web Service variable" that represents the value. Runtime variables are used in the same way as default values.

Web Service variables start with a percent sign (%) to distinguish them from default values.

For example, let's say you have a Web method that you want to use as a source. However, the Web method, you must provide a SOAP header containing a hash value based on your user id. This hash value is provided at the time you login to the Web service and is unknown at the time you design the integration.

Web Service variables allow you to define a variable that will represent the hash value at design time; and then use that variable as if it were a static value. This concept is described in greater detail in some of the Samples.

To set a Web Service variable:

In the Scribe Workbench, click View > Connections. The Connection Manager dialog box appears.
Select the Web Service connection and click Edit. The Connection Settings dialog box appears.
Click the Connection tab.
Click Change Connection. The Connection Information dialog box appears.
If you are modifying a connection that is not used in a DTS, click Connection.
Verify Web Services is selected and click OK. The Web Service Connection Manager dialog box appears.
Select the Web Service you want to edit and click Edit. The Edit Web Service dialog box appears.
Click the Configuration tab.
Expand the Methods node.
Select the method and the parameter that you want to configure.
Parameter names are prefixed with the direction of the parameter: [In], [Out], [In Out], or [Return].
As you select each parameter, the properties that you can assign display. Select any optional properties that you want to assign.
In the Value text box, type the default value or select it from the list. If desired, enter the Failure Condition for Return parameters.
- For Return parameters only, enter a regular expression to evaluate. If the value satisfies the regular expression, the Web method call is considered to have failed and that failure is logged.
- User-defined Web Service variables must begin with a percent sign (%) sign. Omitting the % sign will define this as a static value (note that Scribe system variables begin with a colon (:), such as ":Password").

Note: Insight only inserts data into the SOAP header on the initial connection call. Therefore, you can only use Web Service variables with SOAP header values from the assigned login method or from :Username or :Password variables. See Default Values.