Planning for a New Web Service

During the Web service creation process, you can locate and configure many components that are already part of Sterling B2B Integrator.

You can use almost any business process, service, or adapter (except internal services and business processes) as a Web service component.

Consider the following as you plan a new Web service:

Item

What to Consider

Services or adapters

Which services or adapters could this new Web service invoke when a consumer request is received?

Hint: Generally, it is recommended to create a unique configuration of any service or adapter for use with your Web service.

Business processes

Which services or adapters could this new Web service invoke when a consumer request is received?

Hint: When preparing to use a business process as part of a Web service, ensure that it is the default version of the business process. In addition, all services and adapters are enabled.

Transport

Do I want to use standard HTTP or secure HTTPS for the SOAP transport binding for this Web service?

Security settings

Do I want to use legacy security settings for backward compatibility with existing business processes or enhanced security settings that offers enhanced message-level security, including encryption/decryption, signing options, and timestamps?
Note: Legacy security settings, business processes, and services will be phased out in subsequent releases.

Signing / Encryption Order

Determine the order of signature and encryption (Sign First or Encrypt First).

Queued Mode

Do I want to queue business processes or execute them on the same thread as the thread where the bootstrapping of the business process has taken effect?

Input XML Schema

Do I want Sterling B2B Integrator to use a specific input schema when processing the SOAP request?

Hint: Associate an input XML schema with a business process and then associate the business process with the Web service.

Output XML Schema

Do I want a customized or default response from Sterling B2B Integrator?

Hint: Associate an output XML schema with a business process and then associate the business process with the Web service.

Message Reliability Settings

What type of messages will my Web service accept? Sterling B2B Integrator supports the following reliability settings:
  • AutoDetect
  • ReliableOnly
  • NonReliable
Note: You cannot send the same reliable message (groupID and sequenceNo) to two different Web services configured in the same Sterling B2B Integrator instance.

WS-I Conformance Settings

What type of message conformance will my Web service have?

Sterling B2B Integrator supports the following conformance types:
  • Conform WSDL – Adds a WS-I claim element to every WSDL node
  • Conform SOAP Response – Adds a WS-I claim header to the SOAP response

Attachment Settings

What type of attachments will my Web service accept?

Sterling B2B Integrator supports the following types of attachments:
Note: Attachments do not need to be XML.
  • Input – Request can have an attachment as part of SOAP message.
  • Output – Sends the primary document as an attachment along with the SOAP response as a multipart MIME message. Optional.
    Restriction: Microsoft® products support only dime format, not mime or s-mime.
  • Inline – No attachments. Information must be contained inline in the message.

    Example: A multipart mime message. Optional.

    Note: If the Inline option is selected, the resulting WSDL will not be compliant with WS-I Basic Profile 1.0. See the topic Frequently Asked Questions for additional information on attachments.

Certificates

Web services supports message signing for both incoming and outgoing messages.

Web services uses the following types of certificates:
  • Trusted Certificate – Used to verify signatures received from a Web service consumer
  • System Certificate (X.509) – Used to sign Sterling B2B Integrator response to a consumer
  • Encryption Certificate – Used to encrypt the body of the response

Consumer Access to the Web Service

In order for a consumer to access and use your Web service, you must create a user account for them in Sterling B2B Integrator. The user account must have access rights to all components used with the Web service (services, adapters, and business processes).