Implementing Changes in Core Services - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Standard
Essential
Premier

When configuration changes are made that affect a client or OnBase module connecting through the OnBase Application Server, a user must log out and log back in to their user account for the configuration changes to take effect. However, prior to logging back in, one of the following must happen:

  • The .NET worker process and application pool must be recycled.

    Note:

    For more information on recycling the worker process and application pool, refer to the Microsoft documentation.

  • The Application Server cache must be reset.

You can reset the Application Server cache in one of two ways. You can use the Reset Cache options within OnBase Configuration or Studio, or you can use the "iisreset" command from the Command Prompt window.

It is recommended that you reset the Application Server cache using the OnBase options. An IIS Reset disconnects all users and immediately ends all user sessions. The Reset Cache button in OnBase Configuration and the Reset Server Cache button in Studio work identically and allow existing user sessions to use an old datasource cache that updates after the user session ends, meaning that a small change will not interrupt users with existing sessions.

Note:

Changes can take up to one minute to be implemented. It is recommended to alert users of the changes only after the Application Server has had time to reset.

Resetting the Application Server cache is done in one of the following ways:

After resetting the Application Server cache, you may confirm the reset by viewing the Cache Activity tab of the Diagnostics Console. For more information on the Cache Activity tab, see the Diagnostics Service and Diagnostics Console documentation.

Consider the following when resetting the Application Server cache:

  • To avoid performance issues, only reset the Application Server cache during off-peak hours. Using the Reset Cache option in OnBase Configuration or the Reset Server Cache option in OnBase Studio may have a negative impact on system performance. Requests to the Application Server are forced to wait until the cache is rebuilt before they can be processed. Depending on the size of the OnBase system and the current server load, the performance impact of resetting the cache may be severe.

  • The Reset Cache functionality is not intended for implementing large-scale changes that can immediately impact a significant number of users in a potentially negative way, such as changes to licensing or Workflow processes. It is recommended that large-scale changes are first made and tested in a test environment before being moved into a production system. It is also recommended that no users are logged into the system when large-scale changes are moved to production. In this case, you should recycle the .NET worker process and application pool using an IIS Reset.

  • If you re-launch the OnBase Configuration module by clicking Disk Mgmt | Re-launch Configuration, you are not prompted to reset the cache. The cache is not reset upon re-launch.