WS Host: Commands Tab

Using the Methods dialog box

Use the Methods dialog box to add, edit, and order method calls to the web service.

• Click Add to display the Edit Method dialog box, where you add a new web service call.
• For existing calls, highlight the entry and click Edit or double-click on the entry to display the Edit Method dialog box, where edit the web service call.
• Highlight and click Delete to remove the method call from the list for the command.
• Use Move Up and Move Down to move the highlighted method up and down in the list, respectively.

Adding or editing methods

Adding or editing the method will display the Edit Method dialog box. Provide information about the method you selected in the fields in the Edit Method dialog box.

Method

Choose the method you want to map from the drop-down menu. The menu is populate from methods defined in the WSDL.

Return Variable

This field is enabled if the method selected returns a value. Use this field to define a variable to store the result of the method call. Variable names must start and end with %. The type of the return data is displayed in parentheses following the Return Variable label. This variable can be used as a parameter input to a subsequent method call.

Success Expression

An optional expression that, if specified and true, will deem the method call successful. If the expression is false, the call is considered an error and subsequent calls are aborted. See WS Expressions for information about specifying an expression.

Parameters

A table that contains the parameters for the selected method as defined by the WSDL. Each line in the table represents one parameter and contains the parameter's name and type, indicates whether the parameter is part of a choice, whether the parameter is required, whether the parameter field is a password field, and the parameter value.

If the WSDL specifies that the parameter part of a choice, no more than one of the choices can be used. If the WSDL has a choice of three items, the Choice column will display 1/3, 2/3, and 3/3 to indicate each item of the group. If the WSDL specifies that the parameter is required, the Reqd field will be selected and disabled. Otherwise, you can check the Reqd field to ensure that the parameter is defined before the method is called. In the value field you can enter a legal value or previously defined variable. Selecting that cell will provide a drop-down with system-recognized variables that match the parameter type. 

If the parameter is a complex type or array type, a button is displayed and can be used to invoke another dialog to enter the values for the complex type or array values respectively. See WS Variables for more information about variables. If the field is left blank, then a value can be entered for it at the mailbox and/or action levels. If the field is selected as required then a value must be entered at the mailbox or action levels.

Incoming File

The Incoming File section of the dialog box is displayed when the methods are being defined for the GET command. The File Name is used to define the resulting filename for the file to get. This can be an actual file name value or a variable that stores the file name result. The File Data Variable should specify the resulting variable that holds the data to get. System-recognized values will appear in a drop-down box when selecting that field. See WS Variables for more information on specifying variable values. The Continue Expression is an expression which, if specified and true, determines whether to continue making calls for the same file or for subsequent files. If Get File In Blocks is selected on the Advanced tab, then this condition determines whether to continue calling the same method to continue getting blocks for the same file. If Get File In Blocks is cleared, then this condition determines whether there are more files to get and will repeat calling the same method until the condition returns false.

Incoming Directory

The Incoming Directory field is displayed when the methods are being defined for the DIR command. The %directoryfiles% is used to define the location of the directory file array when the array is not returned at the top-most level. If the array is at the top-most level, %directoryfiles% is defined in the Return Variable and this field will not be used.