Execute Web Service Templates

If you need to call a Web Service to get some information, the syntax can be daunting. For example, you could use a rule to make the call as follows:

The same rule written using an Execute Web Service template might be as follows:

Here is how this template would be defined:

Here are the possible settings on this screen:

Name

Specifies the name of the vocabulary template. The name is used for irSDK access.

Display Name

Name of the template to be displayed in the business language template list.

Menu Group

Menu group under which the template will be listed. You may choose to add your template to an existing menu group or create your own menu group.

Scope

The scope of the template availability can be limited to only the context of the previously selected entity by checking "Available in rules and calculations for this entity." The availability can also be extended to those rule elements which have a reference to the previously selected entity by checking "Available in rules and calculations for entities referencing this entity."

Business Language

Business language to be displayed in the business language editor.

Web Service

Specify the web service endpoint to be used.

Operation

Select the specific operation from among those the web service offers.

Input Mapping

Optionally specify input parameters to be passed to the web service as well as SOAP header parameters. Use "Field Mapping," where one or more web service input parameters may be assigned, element by element, to matching schema hierarchies within the rule application. Unused web service input parameters may be left empty if the web service allows this.

Output Mapping

Optionally specify where web service output as well as SOAP header output should be stored, using "Field Mapping," where one or more web service output elements may be assigned, element by element, to matching schema hierarchies in the rule application. Unused web service output elements may be left unassigned.

Timeout

Specify the duration (in milliseconds) to try executing the web service operation before it times out.

Retry

Specify the number of retries. If the connection is not established even after the specified timeout and retries, an error is thrown indicate the web service operation could not be executed.