Editing a Web Project - 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 also edit unpublished web projects that already exist within OnBase Studio. Published projects cannot be modified. To edit an unpublished web project, follow these steps:

  1. Open the OnBase Studio and select a repository.
  2. Select the Integration Services tab from within the Repositories panel. Existing web projects will be displayed in the Web Service Publishing node.
  3. Expand the Web Service Publishing node.
  4. Select the web project you want to edit.
    • If desired, you can modify the name of the project. To do so, follow these steps:

      1. Right-click on the name of the project within the Repositories panel.

      2. Select the Rename option.

      3. Modify the name of the project as desired, then press the Enter key.

        Information about the selected project is displayed in the Properties pane on the right side of the window.

    • If desired, you can modify the namespace for the project by editing the Target namespace for the web services field. For example:

      http://9secondfoods.com/PurchaseOrder

    • If desired, you can modify the name of the virtual directory used to publish the project's web services in the Virtual directory name of the web service field. This value must be unique. By default, this field is automatically populated using the value you entered in the Name field. For example:

      PurchaseOrders

  5. Expand a web project by clicking on the arrow to the left of the project's name in the Repositories pane.
    A list of available services is displayed.
  6. Select the web service you want to edit.
    • If desired, you can modify the name of the service. To do so, follow these steps:

      1. Right-click on the name of the service within the Repositories panel.

      2. Select the Rename option.

      3. Modify the name of the service as desired, then press the Enter key.

        Information about the selected web service is displayed in the Properties pane.

    • If desired, you can modify the name of the directory for the web service by editing the Service directory name field.

  7. Select the Protocol tab. The SOAP protocol options for the selected operation are displayed.
    If desired, you can modify the types of web service endpoint configured 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.

  8. Select the Security tab. The security options for the selected operation are displayed.
    If desired, you can modify the security level for your web service by selecting one of the available options:
    • 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 is recommended for all production deployments. This setting requires the use of TLS.

      Note:

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

      Note:

      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

    • 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 credentials 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. Expand the web service by clicking on the arrow to the left of the service name. A list of available operations is displayed.
  10. Select the operation you want to edit.
    • If desired, you can modify the name of the operation. To do so, follow these steps:

      1. Right-click on the name of the operation within the Repositories panel.

      2. Select the Rename option.

      3. Modify the name of the operation as desired, then press the Enter key.

        Information on the selected web operation is displayed in the Properties pane.

    • If desired, you can modify the XML-compatible name for the operation by editing the XML Compatible Name (follows XML validation rules) field. Unicode characters and special characters are not supported and cannot be added to the field.

  11. Select the Request operation items tab or Response operation items tab to configure the keywords that are used for requests or responses. The keywords available for the selected operation are displayed.
    • If desired, you can modify the Keyword Types to be used by your web operation by clicking Edit. After doing so, the Select and customize keywords dialog box is displayed.

      1. Deselect the Include option to remove a Keyword Type from the selected web operation.

        Tip:

        You can select and deselect the Include/Exclude all option to select or deselect all available Keyword Types.

      2. Select the Required option for any Keyword Types you want to be required for your web operation.

        Note:

        This option is not available for response messages.

      3. All available keywords will automatically have an XML-compatible name generated. You can change this name if desired by selecting a Keyword Type and then modifying the Edit XML Compatible Name field and clicking Set.

        The value entered in this field will be truncated to 120 characters when saved to the database.

      4. Click Apply to save your changes.

  12. Once you have made all required changes to a web operation, click the Save button in the Home section of the ribbon to save your changes.