Defining a Web Service Provider (SOAP/WSDL)

Defining this object establishes the resources required when providing a service to be made available for consumers using the SOAP protocol.

1. Under the Service section, the object name (that you created) automatically appears in the Name field. This indicates the Service to be made available. Names should be descriptive.
2. In the External Address field, enter the external server address that consumers will use to obtain your service. This information is typically the domain of your IT department.
3. As in the step above, the information to be entered in the External Port field can be provided by your IT department, or someone responsible for your company's server management policies.
4. To configure HTTP Basic Authentication Validation for this Web Service Provider, select Basic from the Authorization Type drop-down.
   Note:

   SSL must be enabled when using Basic Authentication. To enable, select the SSL checkbox.

   

   Basic Authentication must be enabled through Access Control. Once the object has been configured (and deployed), basic authentication must be enabled through the Access Control View in the Admin Console. To do so, create or edit a user profile so that it contains the Authorize Web Services Provider Connections security permission. Only users with a specific Access Control permission (Add/Modify/Delete Users, Roles, and LDAP Profiles) can do this.

   Note: For added security, do not assign the Web Services permission to the existing admin or superuser roles.
5. Use the Operation section to create, define, and use multiple operations from within a single Provider object.
   • To create: Click the button to add an operation.
   • Provide a name for the operation. When defining the operation name, it should follow a descriptive, verb-noun pattern. For example: lookupOrders or lookupOrdersByID

     If planning to use an output Schema to send a response to consumers of your service, then select the Is Synchronous checkbox. While an input Schema is needed to receive the request from a consumer, an output schema (i.e. response) is optional. When synchronous, the output Schema will be required.

   • The source folder, Package Name, and Business Process name are generated for you in the next screen; however one recommendation is to add a package name to the existing package location designated for the Business Process associated with your new operation.

   

   The example above shows that “Lookup” has been appended to the existing package. The example below shows how this package has been created; and it contains the LookupOrdersById Business Process.

   

6. For each operation created, the corresponding Properties view displays the following:
   1. Name: Displays the name of the operation. To rename the operation, click this field.
   2. Input Schema: The Schema used to define the XML request message. The consumer of your service will need this definition in order to send request messages. Use the Click to set Schema field to select an existing Schema, or click the Input Schema link to create one, in which a Schema editor opens.
   3. Output Schema:(for Synchronous operations only) This Schema used to define the optional XML response message. Use the Click to set Schema field to select an existing Schema, or click the Output Schema link to create one, in which a Schema editor opens.
   4. Business Process: (automatically populated) The Business Process used to prepare and send the response message.
      Note:

      • Clarify automatically creates a corresponding package containing this Business Process, which is preconfigured with the Web Service Provider object just defined in this task.
      • The Business Process contains two tasks: SendSoapReply, which sends the response message to a consumer, and SetExitStatus, which sets the Business Process’s Exit Status to true. All task parameters are pre-populated. Additional configuration will be required.
      • Note: Any additional tasks will need to be added and defined to the Business Process. For example, some additional tasks might include determining the requested purchase order number (using GetProperty), gathering the data, and generating an e-mail (SendEmail).
      • For SOAP, additional tasks would be required to assemble a response message (using your outbound Schemas).