Creating a Web Operation - Web Services Publishing - English - Foundation 22.1 - OnBase - external

Web Services Publishing
Platform
OnBase
Product
Web Services Publishing
Release
Foundation 22.1
License

You can use the Web Operation wizard to create a new web operation and add it to your system. Follow these steps:

  1. Open OnBase Studio and select a repository.
  2. Click the Web Operation button from the Integration Services ribbon.
    The Project Details dialog box is displayed.
  3. If you want to add the operation to an existing project, select that project from the Project drop-down list.
    Note:

    Published projects are not available for selection.

    If you want to add the operation to a new project, select <Create new web project...> and follow these steps:
    1. Type the name of the new project in the Name field. This value must be unique.
    2. Type the namespace for the new project in the Target namespace for the web services field. This namespace is used in published WSDLs and schemas to uniquely identify incoming requests with the proper web service and operations. This value must be unique. For example:
      http://9secondfoods.com/PurchaseOrder
      Note:

      This target namespace must be different from the namespace in the URI that the client application or client load balancer uses to interact with the web service. For example, if the client application or client load balancer uses https://example.com/MyWebProject_MyWebService?wsdl to access the web service's WSDL, then the Target namespace for the web services value for the Web Services Publishing project cannot also be example.com.

    3. Type the name of the virtual directory used to publish the project's web services in the Virtual directory name field. This name will be used to create a virtual directory in the IIS Web Server when publishing the web services. This value must be unique and cannot include spaces or special characters. By default, this field is automatically populated using the value you entered in the Name field. For example:
      PurchaseOrders
  4. Click Next. The Web Service Details dialog box is displayed.
  5. If you want to add the operation to an existing web service, select that web service from the Web service drop-down list. If you want to add the operation to a new web service, select <Create new web service...> and follow these steps:
    1. Type a unique name to identify this new web service in the Name field. This value must be unique within the web project.
    2. Type the name of the directory for the new web service in the Service directory name field. This name will be used to identify the web service when the request is processed by IIS. This value must be unique within the web project. By default, this field is automatically populated using the value you entered in the Name field.
    3. Click Next. The Web Service Endpoint Details dialog box is displayed.
  6. Select one or more types of web service endpoint you intend to configure for your web service.

    • SOAP 1.1: select this option to expose SOAP 1.1 endpoints for your web service.

    • SOAP 1.2: select this option to expose SOAP 1.2 endpoints for your web service.

    • REST: select this option to expose REST endpoints for your web service.

  7. Click Next. The Web Service Security Details dialog box is displayed.
  8. Select the security level for the web service:

    Security Level

    Description

    Highest

    When this setting is selected, the OnBase user name and password will be read from a header in the message using TLS. This is the most secure setting, and it is recommended for all production deployments. This setting requires the use of TLS.

    Note the following:

    • When using this setting, do not modify any web.config settings except username and password.

    • In order to use this option with REST web service endpoints, OnBase user account credentials must be included in message headers sent to the REST service. For example: username, password

    • This setting is required if you wish to publish your web service to the Application Server using Frictionless Hosting. If this setting is not required, you will only be able to publish your web service to an installer.

    Medium

    When this setting is selected, the OnBase service account user name and password will be read from the appSettings section of the service's web.config file using TLS. This setting is intended for systems that do not support safe storage for OnBase credentials. This setting requires the use of TLS.

    Note:

    When using this setting, the web.config file can be modified to support IIS authentication methods.

    Medium-Low

    When this setting is selected, the OnBase user name and password will be read from a header in the message. This setting will send credentials in clear text, and is not recommended for deployments on unsecured networks. HTTPS is the default protocol for the endpoint definition of web services which use this security setting.

    CAUTION:

    This setting is not recommended for most production deployment scenarios. This security setting should only be used if the data coming from and going to web services using this security setting is protected with encryption (via HTTPS) before it enters and as it leaves the trust boundaries of your internal network.

    Lowest

    When this setting is selected, the OnBase service account user name and password will be read from the appSettings section of the service's web.config file.

    CAUTION:

    This setting is strictly for development only, and it is not supported in production deployments. Web services with Lowest security cannot be published in a production environment; attempting to do so will result in an error.

    Note:

    When using this setting, the web.config file can be modified to support IIS authentication methods.
  9. Click Next. The Web Operation Details dialog box is displayed.
  10. Select the desired category for your web operation from the Category drop-down list, and the operation itself from the Action drop-down list. You can find more information on each available operation in the Outbound Operations section of the Enterprise Integration Server documentation (within the EIS Operations category).
  11. Click Next. Depending on the operation you have selected, you may be required to specify additional information. See the appropriate subsection for the operation you selected to continue configuration: