Upgrade Considerations - Web Services Publishing - English - Foundation 22.1 - OnBase - external

Web Services Publishing

Platform
OnBase
Product
Web Services Publishing
Release
Foundation 22.1
License

The following upgrade considerations have been compiled by OnBase subject matter experts. These upgrade considerations are general and applicable to most OnBase solutions and network environments and should be considered each time an upgrade is performed.

Carefully consider the impact of making any changes, including those listed below, prior to implementing them in a production environment.

For additional general information about upgrading OnBase, refer to the Upgrade Guidelines reference manual , and visit the Hyland Community at: https://www.hyland.com/community.

Set Up Usage-Based Billing Server Registration

Beginning with version 18, if your system is licensed for Usage-Based Billing with the Web Services Publishing license and you are upgrading the Application Server used to communicate usage statistics to Hyland from version 17 or earlier, you must complete server registration by performing one of the following actions after upgrading the Application Server:

  • Apply a license certificate to the OnBase database.

  • Perform Usage-Based Billing Setup in the Configuration module at Utils | Licensing | Usage-Based Billing Setup.

CAUTION:

Do not apply a license certificate or perform Usage-Based Billing Setup in the Configuration module until after you have upgraded the Application Server. If you apply a license certificate or perform Usage-Based Billing setup before upgrading the Application Server from version 17 or earlier, the Application Server will not properly communicate your usage to Hyland, which could cause billing irregularities. Contact your first line of support for assistance if this happens.

If your system is licensed with the Enterprise Web Services Publishing license, no additional Usage-Based Billing server registration is required.

Web Service Security Settings

As of version 18 of Web Services Publishing, the Lowest security setting for a web service is not supported in production environments. This setting is strictly for development only. Web services with Lowest security cannot be published in a production environment; attempting to do so will result in an error. If you are upgrading from a version of Web Services Publishing prior to 18 and your solution includes web services configured with Lowest security, these web services will not function in your production environment of OnBase Foundation 22.1. You must copy and redistribute these web services in production using a higher security setting.

Additionally, changing a web service's security may change the endpoint URL used to call the web service. For example, the protocol in the URL may change from http to https, and the host name in the URL may also change to match the name on a security certificate. In that case, applications calling this web service will need to be updated to use this new URL.

Recreate Web Services

When upgrading your Web Services Publishing solution to version Foundation 22.1 from version 16 or below, you may need to recreate and redeploy any existing web services created prior to upgrading to version Foundation 22.1. The Required option was not supported for use in versions prior to version 15, so web services created with fields using this option may fail after upgrading to version Foundation 22.1.

Additional considerations apply to web services created using the following web operations:

  • Update a unity form operation: In previous versions, when Keyword Types assigned to a Unity Form were excluded from requests sent to an Update a unity form operation, the existing values for those Keyword Types were cleared from the Unity Form. As of version 17, if any Keyword Types are excluded from requests sent to this operation, the existing values for those Keyword Types on the Unity Form are now retained.

  • Update workview object operation: In previous versions, when attributes assigned to a WorkView object were excluded from requests sent to an Update workview object operation, the existing values for those attributes on the WorkView object were cleared from the WorkView object. As of version 17, if any attributes assigned to the WorkView object are excluded from requests sent to this operation, the existing values for those attributes on the WorkView object are now retained.

Contact your first line of support if recreating and redeploying your existing web services is not possible.

Backup web.config files for each web service

Create backup copies of the web.config files for each existing web service. If you need to make a change to an existing web service (for example, to leverage features in a new build of the Application Server), you must copy the existing web service and publish it as a new WSP project.

Stop Application Pools

Stop the application pools that existing web services are running under.

Update Web Service Web.config Files

If deploying new Application Server(s), update the web.config files of the web services to point to the new Application Server(s).

Allow Port Access

Ensure that any firewalls are configured to allow for http(s) requests to be made to the web service(s) on the appropriate ports.

Do Not Uninstall Hyland Adapter

As of version 17, a separate installation of the Hyland Adapter is no longer a prerequisite to install a published web service operation. However, operations published prior to version 17 still require the Hyland Adapter to be installed on the device the web service is installed on. If your system includes operations published prior to version 17, do not remove the Hyland Adapter installation from the devices those operations are installed upon.