Adding a web services server in the designer

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
You can add one or more web services servers to your process application. Each web services server describes the location of a web service endpoint and can be referenced by external services that you use to invoke a web service. This reference enables the sharing of configuration information for invoking web services that start the same endpoint, eliminating the need to configure similar information multiple times. In addition, if you need to change the information that is associated with a particular endpoint, you can change the web services server information and the updated information can be used by any external service that references the web services server.

Procedure

  1. Open the process application in the designer.
  2. Select the Servers tab from the Process App Settings editor.
  3. In the Servers section, click +. In the Details section, enter a meaningful name for the server. In the Type field, select Web Service Server. Add a meaningful description of the server in the Description field. This field is optional
  4. Enter the server binding properties for the Default environment:
    • The Default settings are used if nothing is specified for the other environments. You can have several environment types, which are added by clicking +. The other environment types that you can add are as follows:
      • Development: The environment where you develop your services.
      • Test: The environment where you test your services.
      • Staging: The environment where you deploy your services for pre-production testing.
      • Production: The environment where your services are deployed for use by your organization.
    • WSDL URL: The URL of the web service. For example: http://mycorporation.com/webservice/financialstatements?wsdl. You can enter a URL or discover a URL.
    • For protected services, click Protected WSDL and enter a userid and password.
      Important: Because the endpoint is not read from a protected WSDL, you must select Override Endpoint and specify the endpoint address manually.
    • Select Discover to discover a web service and generate an external service.
    • Select View to view the WSDL source code of a WSDL file.
    • Override Endpoint: If selected, you can override the WSDL URL field using the fields beneath the check box. This selection can be useful if you use different endpoints for development and testing, for example.
      • Endpoint Address: The URL of the web service you want to use. You can use the same format as the WSDL URL field that you are overriding.
      Note: If the endpoint address uses the https protocol, make sure that the certificate is trusted. If necessary, add it to the trust store related to the default ssl configuration.
    • Authentication: Specifies the type of authentication. Authentication ensures that the parties in a transaction are who they claim to be.
      • None: No authentication is required.
      • HTTP Authentication: User name and password are passed in a header element of a message.
    • Username: The user name that is registered at the server.
    • Password: The password that is registered at the server.
    Note: Server settings are typically configured during development, but they may differ between environments (such as using different endpoints or credentials) and can change over time. These settings can be updated at runtime—for example, through the operations REST APIs. For details, see REST API programming. To apply the same settings to another version, refer to Synchronize snapshots.
  5. Click Save or Finish Editing.
    For details about declaring variables for the client-side human services, see Declaring variables