Configuring the Integrated Office Viewer Refresh Settings - Integrated Office Viewer - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/Integrated-Office-Viewer/Foundation-24.1/Integrated-Office-Viewer/Configuration/Configuring-the-Integrated-Office-Viewer-Refresh-Settings - 2024-11-04

Integrated Office Viewer

Platform
OnBase
Product
Integrated Office Viewer
Release
Foundation 24.1
License

When using the Integrated Office Viewer, by default, the document viewer performs a one-time automatic refresh immediately after editing a document. If this refresh happens before the changes are processed by Microsoft, then the document does not load and a blank page is displayed. A blank page may also be displayed if a document is opened after a recent IIS reset. To prevent a blank page from displaying, you may increase the number of refreshes after a document is edited or opened.

To increase the number of automatic refresh attempts made by the Integrated Office Viewer, two settings need to be added to the OnBase Web Server's web.config file: disableWopiAutoRefreshAfterEdit and wopiRefreshAttemptsAfterEdit. The first setting controls whether the Integrated Office Viewer performs a one-time automatic refresh, and the second setting determines the number of refresh attempts if the first setting is set to false.

To set the number of times the Integrated Office Viewer refreshes after a document is edited:

  1. Locate the web.config file for the OnBase Web Server.
  2. Open the web.config file in a plain-text editor, such as Notepad. Do not open the web.config file in a binary-text editor, such as Microsoft Word. Binary-text editors can introduce invalid characters to the configuration file that can cause unexpected errors when users attempt to use the WOPI endpoint.
    Note:

    If Windows UAC is enabled, the plain-text editor must be launched with elevated administrator privileges to edit the web.config file. To enable editing, right-click the text editor executable and select Run as administrator.

  3. In the <appsettings> node, add <add key="disableWopiAutoRefreshAfterEdit" value="false"/> .
    Configuring this setting to "false" disables the one-time automatic refresh and allows for a second setting that determines how many refresh attempts are made.
  4. In the <appsettings> node, add <add key="wopiRefreshAttemptsAfterEdit" value="n"/> , with n being replaced by the number of refresh attempts you would like the Integrated Office Viewer to make after a document is edited.
    Note:

    Each refresh attempt happens at one-second intervals after the first attempt. For example, if the value is set to "3", one refresh attempt is made immediately after the document is edited, and then the document is refreshed two more times for each second after the first attempt.

  5. Save and close the web.config file.
  6. Restart the OnBase Web Server for these changes to take effect.