Checklist: Develop a New Web Service

When you identify a need to provide a new Web service, this checklist to guide you through the implementation process.

About this task

Once you have identified a need to provide a new Web service, the following checklist guides you through the implementation process:

Procedure

  1. Plan the business function.
  2. Identify the consumer who requires access to this Web service (your partner). Create a user account for each consumer in Sterling B2B Integrator and send the user account and password to the consumer.
  3. Fill out the Collecting Consumer Information and Collecting Provider Information checklists. The checklists keep information relevant to developing and implementing a new Web service in two documents.
  4. Discuss the following security requirements with your Web service consumer:
    • Will messages be signed?
    • Will messages be encrypted?
    • What type of certificate will they use (CA or other third party)?
    • What type of encryption will be used, and in what order (encryption or signature first)?
    • When will certificates be obtained?
    • How will the public keys and passphrases be exchanged (e-mail, phone, or letter)?
  5. Create a system certificate, if responses must be signed, and send the consumer the public key for the certificate.
  6. Check the certificate into Sterling B2B Integrator.
  7. If requests must be signed, have the consumer obtain a CA certificate and send you the public key.
  8. Check the public key for your consumer's certificate into Sterling B2B Integrator.
  9. Decide which components (services, adapters, or business processes) you need to create in Sterling B2B Integrator for this Web service.
  10. Create the necessary service and adapter configurations and business process models. Ensure that the service configurations are enabled.
    Note: If you plan to use HTTPS instead of HTTP, select “https” in the SOAP Transport Bindings Settings page during configuration of the SOA HTTP Server adapter instance.
  11. Create the necessary business processes, check in new business process models, and enable them.

    Only the default version of each business process is available for Web services, so if you have more than one version of the business process, ensure that the correct version is the default version.

  12. Create input and output XML schemas for the business process models in this Web service.

    If you do not provide input and output XML schemas, default schemas are used. The default schemas do not perform any typing or validation.

  13. Check the XML schemas into Sterling B2B Integrator.
  14. Create a Web service in Sterling B2B Integrator.
  15. Map the XML schemas to the appropriate business process models in Sterling B2B Integrator.
  16. Generate the WSDL for the Web service.
  17. Send the WSDL to your consumers or enable them to access it from a URL on the Sterling B2B Integrator Web server. The consumer needs the WSDL to determine how to create SOAP messages.
    Note: To publish the Web service to a UDDI, use a third party tool.
  18. Test the Web service.
  19. Once testing is complete, notify the consumer that the service is ready for use.