Tag naming conventions

The Tag Name syntax for SOAP and REST connections is

<Instance>.<Operation>.<Support>.<Tag>

where:

• Instance: unique object within the Communication Driver

• Operation: operation to be executed

• Support: status of the operation

• Tag: name of the tag

Instance Naming Rules

• The instance name must be less than 20 characters long.

• The instance name must be unique within each node of the SOAP or REST hierarchy.

• The instance name must be unique for each specified operation within the same node.

Support Names and Description

There are five support name options.

• run - initiates execution of an operation.

• inputs/query - contains one or more inputs to be set before executing an operation.

  Note: The term 'input' is used for SOAP, and 'query' is used for REST.

• status - indicates the progress, success, or fail of an executed operation.

  (1=Executing, 2=Success, 3=Failed)

• result - contains all the result tags generated from an operation. For more information on the errorcode and error messages, see Troubleshoot the WEBSVC Communication Driver.

• errormsg - indicates an error message when an operation fails to execute.

Tag Naming Rules

• The tag name can have many additional levels, each separated by "."

• The number of levels for ‘result’ is determined by the response data received from the WEBSVC operation execution.

Example

Consider two separate instances - Phone1 and Phone2 with the same operation name: CheckPhoneNumber. Phone1 is used to execute the CheckPhoneNumber operation from Client 1. Phone2 is used to execute the CheckPhoneNumber operation from Client 2.

Instance Phone1

$op$phone1.checkphonenumber.inputs.licensekey

$op$phone1.checkphonenumber.inputs.phonenumber

$op$phone1.checkphonenumber

$op$phone1.checkphonenumber.errormsg

$op$phone1.checkphonenumber.result

Instance Phone2

$op$phone2.checkphonenumber.inputs.licensekey

$op$phone2.checkphonenumber.inputs.phonenumber

$op$phone2.checkphonenumber

$op$phone2.checkphonenumber.errormsg

$op$phone2.checkphonenumber.result