Welcome > Integration > Web service references > Create a Web service reference

Create a Web service reference

  1. Navigate to Integration > Web service references.

    The Web service references page appears.

  2. Click New.

    The New web service references dialog box is displayed.

  3. By default, the system automatically saves a new web service reference in your working category. To store the web service reference in a different category, select a category on the Category list.

    The categorization of web services helps restrict access to web services to specific users.

    Note When you export/import a process map or a form that has a web service, TotalAgility also exports/imports the category of the web service. If the category does not already exist, TotalAgility also creates the category for the web service.

  4. Select a web Service type to configure. Available options are:

    • SOAP (Default): Specify the URL that references the Web Service Description Language (WSDL) file for the web service. For example, http://localhost/PlatformManagerWs/PlatformManagerWs.asmx?WSDL.

    • SOAP WCF: Specify a web service with a .svc extension.

    • RESTful: Specify the URL which maps the four HTTP methods: GET, PUT, POST and DELETE. See RESTful Service activity and Configure a RESTful Service activity.

    See Web services supported by TotalAgility for more information about supported web services.

  5. Enter a Name for the web service.
  6. Enter the web service URL.
    Note If the Allow all system setting is not enabled, you can only provide whitelisted web service URL and Endpoint URL; otherwise, a message appears stating the connection is denied because the URL connection string is not whitelisted.
  7. Use the Endpoint URL for changing the web service execution location without regenerating the web service proxy DLLs. For example, use Endpoint URL to dynamically change the execution location from Test server to Production server to facilitate migration. To specify the URL, perform the following steps:
    1. Click Yes for Endpoint URL. (Default: No)
    2. Enter the endpoint URL.

    Note The Endpoint URL must be the location of the web service and not the WSDL link. Use an Endpoint URL only for SOAP and WCF. The Endpoint URL does not support RESTful web services.

  8. To control access to the web service and not just restrict access to the configured TotalAgility Enterprise services account, perform the following steps:
    1. Click Yes for User credentials. (Default: No)
    2. Enter the endpoint User name and Password.
  9. To add a custom header to a web service, perform the following steps:
    1. Click for Custom header.
    2. Enter a Name, such as Host.
    3. Enter a Value, such as localhost.
    4. Click Add.
  10. Click Save.

Create a web service activity or add a web service event to interact with internet web services. You can call any web service with a public class and public methods from a web service activity. Each public method has a list of parameters to which you must assign variables.

View associations

You can view the items associated with a web service reference.

  1. Navigate to the web service references list page.
  2. On the context menu of the web service reference for which to view the associations, click Associations.
    The Integration associations - <web service reference name> dialog box displayed.

    The names of items, such as processes being used by the current web service reference are displayed as hyperlink. You can click the item name link to open the item in a new browser tab and make changes, as needed.

    Note If the Web service (for Restful service type) integration is configured in any of the versions prior to TotalAgility 7.7.0, on upgrading to 7.8.0, the associated processes for a Web service integration are not listed. You must reconfigure the integration to view the processes using this integration.

See also: