Integrated Office Viewer

Reference Guide

Includes:

Installation Guide
Administration Guide
User Guide

Foundation EP3
Copyright
Information in this document is subject to change without notice. The software described in this document is
furnished only under a separate license agreement and may be used or copied only according to the terms of
such agreement. It is against the law to copy the software except as specifically allowed in the license
agreement. This document or accompanying materials contains certain information which is confidential
information of Hyland Software, Inc. and its affiliates, and which is subject to the confidentiality provisions
agreed to by you.
All data, names, and formats used in this document’s examples are fictitious unless noted otherwise.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright law, no part of this document may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or
for any purpose, without the express written permission of Hyland Software, Inc. or one of its affiliates.
Hyland ® and Hyland Software ®, as well as Hyland product names, are registered and/or unregistered
trademarks of Hyland Software, Inc. and its affiliates in the United States and other countries. All other
trademarks, service marks, trade names and products of other companies are the property of their respective
owners.
© 2020 Hyland Software, Inc. and its affiliates. All rights reserved.
Document Name ............................................................................................... Integrated Office Viewer
Department/Group.......................................................................................................... Documentation
Revision Number ............................................................................................................Foundation EP3

© 2020 Hyland Software, Inc. and its affiliates ii

 Integrated Office Viewer
Table of Contents

OVERVIEW
Licensing .....................................................................................................................................................1

INSTALLATION GUIDE

INSTALLATION
Requirements ............................................................................................................................................3
General Requirements ......................................................................................................................................... 3
Integrated Office Viewer Requirements.............................................................................................................. 3
Supported File Types with the Integrated Office Viewer ................................................................................... 3
Upgrade Considerations .........................................................................................................................5
Installation .................................................................................................................................................5
Configuring the WOPI Endpoint Settings............................................................................................................ 5
Configuring the WOPI Endpoint for an Application Server ........................................................................ 6
Configuring the WOPI Endpoint for a Specific Database ........................................................................... 9
Troubleshooting .................................................................................................................................... 12
File Size Limit Error is Encountered When Using the Installation ................................................................... 12

ADMINISTRATION GUIDE

CONFIGURATION
Configuring a Temporary File Cache ................................................................................................................ 15
Registering the Hyland Broker for Microsoft Office......................................................................................... 18
Configuring Document Types for Editing ......................................................................................................... 19
Configuring the Web Server to Open Documents in a New Window .............................................................. 20
Disabling Co-Authoring ...................................................................................................................................... 21

USER GUIDE

USAGE
Using the Integrated Office Viewer .................................................................................................. 23
Viewing Documents ........................................................................................................................................... 23
Printing Documents .................................................................................................................................... 24
Editing Documents ............................................................................................................................................. 24
System Interaction ................................................................................................................................ 25
Office Business Application .............................................................................................................................. 25

© 2020 Hyland Software, Inc. and its affiliates iii

 O VERVIEW

The OnBase Integrated Office Viewer (previously known as the WOPI Viewer or WOPI Server)
integrates with the Microsoft Office Online Server or Office for the web. It provides users with
integrated access to OpenDocument and Microsoft Office documents within OnBase and
seamlessly displays Word, Excel, and PowerPoint documents to end users within the familiar
OnBase client interfaces.
In addition to the OnBase Integrated Office Viewer, depending on whether you use the
Microsoft Office Online Server or Office for the web, two additional configurations may be
used: the WOPI endpoint and the Hyland Broker for Microsoft Office.
The WOPI endpoint is a communication layer between the separately installed and configured
Microsoft Office Online Server or Office for the web and the OnBase Application Server.
The Hyland Broker for Microsoft Office is used to enable communication between the OnBase
Integrated Office Viewer and Office for the web.

Licensing
There is no additional licensing required to use this module.

© 2020 Hyland Software, Inc. and its affiliates 1

Integrated Office Viewer

Installation Guide

Foundation EP3
 I NSTALLATION

Requirements
The following sections outline requirement information specific to Integrated Office Viewer in
OnBase Foundation EP3.

General Requirements
For general requirement information that applies to Integrated Office Viewer and other
modules, see the sections on the following topics in the Installation Requirements manual:
• Server C++ Requirements

Integrated Office Viewer Requirements

To use the Integrated Office Viewer, it is required to configure the WOPI endpoint in the
Application Server’s web.config file. To configure the WOPI endpoint, you must have:
• A functioning Microsoft Office environment, consisting of one of the following:
• Microsoft Office Online Server farm
• Microsoft Office for the web (Office 365)
• A functioning OnBase Application Server
Additionally, if you are integrating with Microsoft Office for the web (Office 365), you must
register your solution with Hyland Software and receive a tenant ID code, which is needed to
enable Hyland Broker for Microsoft Office settings. For more information on registering your
solution, contact your first line of support.
To install the OnBase Application Server, see the Application Server module reference guide.
Information on installation and configuration of the Microsoft Office servers or subscriptions is
available from Microsoft.

Supported File Types with the Integrated Office Viewer

To view and edit some of the supported document types in OnBase using the OnBase
Integrated Office Viewer, the OnBase WOPI endpoint must be configured to integrate with the
Microsoft Office Online Server or Office for the web.

© 2020 Hyland Software, Inc. and its affiliates 3

 Integrated Office Viewer
Installation

This table shows the file-access level for OpenDocument and Microsoft Office documents that
are displayed in the OnBase Integrated Office Viewer in the OnBase clients.

File Type Microsoft Office Online Server or

Office for the web

Microsoft Excel

ods view and edit

xls read-only

xlsb read-only

xlsm read-only

xlsx view and edit

Microsoft PowerPoint

odp view and edit

pot read-only

potm read-only

potx read-only

pps read-only

ppsm read-only

ppsx read-only

ppt read-only

pptm read-only

pptx view and edit

Microsoft Word

doc read-only

docm read-only

docx view and edit

dot read-only

dotm read-only

dotx read-only

© 2020 Hyland Software, Inc. and its affiliates 4

 Integrated Office Viewer
Installation

File Type Microsoft Office Online Server or

Office for the web

odt view and edit

Upgrade Considerations
There are no additional upgrade considerations for this module.

Installation
No special installation steps are required for the Integrated Office Viewer. However, you must
complete the configuration of the WOPI endpoint after the installation of your Application
Server as they require changes to the Application Server’s web.config file. See Configuring the
WOPI Endpoint Settings on page 5.

Configuring the WOPI Endpoint Settings

The WOPI endpoint provides users with integrated access to Office documents within the
OnBase clients. Enabling the WOPI endpoint gives users the ability to view Office documents in
an OnBase client while using the Microsoft Office Online Server or Office for the web.
The WOPI endpoint can be configured using one of the following methods:
• Using the Web Application Management Console (WAMCon) to configure the WOPI
endpoint for all users connecting to a specific Application Server.
• Using WAMCon and OnBase Configuration to configure the WOPI endpoint for all
users connecting to a specific database.

Note: You must have a working Application Server installed to configure the WOPI endpoint.
See the Application Server documentation for information on installing the Application Server.

Regardless of the method used, if you are integrating with Microsoft Office for the web (Office
365), you must perform additional configuration of the tenant ID in the OnBase Configuration
module. See Registering the Hyland Broker for Microsoft Office on page 18.
For instructions on either of these methods of configuration, see the following sections:
• Configuring the WOPI Endpoint for an Application Server on page 6
• Configuring the WOPI Endpoint for a Specific Database on page 9

© 2020 Hyland Software, Inc. and its affiliates 5

 Integrated Office Viewer
Installation

Configuring the WOPI Endpoint for an Application Server

Depending on your solution, the WOPI endpoint can be fully configured in the Web Application
Management Console (WAMCon). WAMCon must be installed prior to configuration. See the
Web Application Management Console documentation for information on installing and
configuring WAMCon.
You must also have access to the Application Server’s web.config file to enable Microsoft
Office Online Server settings or Office for the web settings for configuration in WAMCon.
When configuring the WOPI endpoint using this method, you are configuring the WOPI endpoint
for all users connecting to a specific Application Server.

Note: If you are integrating with Microsoft Office for the web (Office 365), additional
configuration outside of WAMCon is required. You must configure Hyland Broker for Microsoft
Office settings in the Configuration module with a tenant ID code received from Hyland
Software. See Registering the Hyland Broker for Microsoft Office on page 18.

To configure the WOPI endpoint for a specific Application Server:

1. Locate the web.config file for the Application Server you want to configure for the WOPI
endpoint. In a default installation, the web.config file is located at
C:\inetpub\wwwroot\AppServer .
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. Locate the following element in the web.config file and remove the opening <!-- and the
closing --> :
<!--<Hyland.Core.Wopi>
<useOfficeWebAppServer value="false"/>
<owaServerUri value="https://[servername]/"/>
<owaProxyBase value="https://[servername]/[appserver]/private" />
</Hyland.Core.Wopi>-->
4. Save and close the web.config file.
5. Open the Web Application Management Console.

© 2020 Hyland Software, Inc. and its affiliates 6

 Integrated Office Viewer
Installation

6. Click the Open Web Application button. The Web Application Management Console
dialog box is displayed.

7. Select the configured Application Server from the Web Application column that you
want to configure for the WOPI endpoint.
8. Click OK .
9. Click the WOPI tab. The WOPI endpoint settings are displayed.

© 2020 Hyland Software, Inc. and its affiliates 7

 Integrated Office Viewer
Installation

10. Configure the following required WOPI endpoint settings for the selected Application
Server:

Setting Description

WOPI Endpoint Select this option to enable the WOPI endpoint on your
Application Server.

Note: A reverse proxy may be needed to ensure the WOPI

endpoint is available outside of your internal network. This
availability is necessary if you are using the Hyland Broker for
Microsoft Office for Office for the web to connect to the WOPI
endpoint.

Use Office Online Server Select this option to enable the OnBase Integrated Office Viewer.

Office Online Server URI
Enter the URL path that connects to the server of your version of
Microsoft Office.
• For the Microsoft Office Online Server, for a typical
installation, the path is https://localhost , where localhost is
the machine name of the Office Online Server.
• For Office for the web, the path points to a Microsoft hosted
server. This path is provided to your system administrator
from your first line of support.

Office Online Server Proxy Enter the URL path that connects to the OnBase Application
Base Server based on your version of Microsoft Office.
• For the Microsoft Office Online Server, for a typical
installation, the path is https://localhost/AppServer , where
localhost is the machine name of the Application Server,
adding /private to the end of the URL to connect to the WOPI
endpoint. The resulting URL is https://localhost/
AppServer/private .
• For Office for the web, the path points to the Hyland Broker
for Microsoft Office and is provided to you by your first line
of support as part of your registration.

11. Click the Miscellaneous tab. The miscellaneous Application Server settings are
displayed.
12. From the OWIN section, in the Application Server Origin field, enter the URL path to the
Application Server. For a typical installation, the path is https://localhost/AppServer ,
where localhost is the machine name of the Application Server.
13. Select the Automatic App Startup setting below the Application Server Origin field.

© 2020 Hyland Software, Inc. and its affiliates 8

 Integrated Office Viewer
Installation

14. Select File | Save .

Note: Changes to the configuration of the Application Server require an IIS reset to take effect.

15. If you are integrating with Microsoft Office for the web (Office 365), additional
configuration is required. You must configure Hyland Broker for Microsoft Office
settings in the Configuration module with a tenant ID code received from Hyland
Software. See Registering the Hyland Broker for Microsoft Office on page 18.

Configuring the WOPI Endpoint for a Specific Database

The WOPI endpoint can be configured in the Web Application Management Console (WAMCon)
and OnBase Configuration for use with a specified database. WAMCon must be installed prior
to configuration. See the Web Application Management Console documentation for
information on installing and configuring WAMCon.
When configuring the WOPI endpoint using this method, you are configuring the WOPI endpoint
for all users connecting to a specific database. Additionally, if you created a temporary file
cache earlier in the configuration process, the cache must be associated with the OnBase
Integrated Office Viewer. See Configuring a Temporary File Cache on page 15 for more
information.
To configure the WOPI endpoint for use with a specific database:
1. Open the Web Application Management Console to configure the required Application
Server settings.
2. Click the Open Web Application button. The Web Application Management Console
dialog box is displayed.

3. Select the configured Application Server from the Web Application column that
references the specific database you want to configure for the WOPI endpoint.

© 2020 Hyland Software, Inc. and its affiliates 9

 Integrated Office Viewer
Installation

4. Click OK .
5. Click the WOPI tab. The WOPI endpoint settings are displayed.

6. Configure the following required WOPI endpoint setting for the selected Application
Server that references your database:

Setting Description

WOPI Endpoint Select this option to enable the WOPI endpoint on your
Application Server that references your database.

Note: A reverse proxy may be needed to ensure the WOPI

endpoint is available outside of your internal network. This
availability is necessary if you are using the Hyland Broker for
Microsoft Office for Office for the web to connect to the WOPI
endpoint.

7. Click the Miscellaneous tab. The miscellaneous Application Server settings are
displayed.
8. From the OWIN section, in the Application Server Origin field, enter the URL path to the
Application Server. For a typical installation, the path is https://localhost/AppServer ,
where localhost is the machine name of the Application Server.
9. Select the Automatic App Startup setting below the Application Server Origin field.
10. Select File | Save . A confirmation dialog box is displayed.
11. Click Yes .

Note: Changes to the configuration of the Application Server require an IIS reset to take effect.

12. Open the OnBase Configuration module to configure the Microsoft Office Online Server
or Office for the web settings for the database used by the selected Application Server.

© 2020 Hyland Software, Inc. and its affiliates 10

 Integrated Office Viewer
Installation

13. Select Utils | Integrated Office Viewer Settings . The Integrated Office Viewer Settings
dialog box is displayed.

14. Select Enable Integrated Office Viewer to use the WOPI endpoint to display Microsoft
Office documents.
15. In the Office Server Path field, enter the URL path that connects to the server of your
version of Microsoft Office.
• For the Microsoft Office Online Server, for a typical installation, the path is https://
localhost , where localhost is the machine name of the Office Online Server.
• For Office for the web, the path points to a Microsoft hosted server. This path is
provided to your system administrator from your first line of support.

Note: The Office Server Path is limited to 255 characters.

16. In the WOPI Endpoint Path field, enter the URL path that connects to the OnBase
Application Server based on your version of Microsoft Office.
• For the Microsoft Office Online Server, for a typical installation, the path is https://
localhost/AppServer , where localhost is the machine name of the Application
Server, adding /private to the end of the URL to connect to the WOPI endpoint. The
resulting URL is https://localhost/AppServer/private .
• For Office for the web, the path points to the Hyland Broker for Microsoft Office and
is provided to you by your first line of support as part of your registration.

Note: The WOPI Endpoint Path is limited to 255 characters.

17. From the WOPI Temporary Cache drop-down menu, select one of the caches configured
earlier in the Cache Configuration dialog.
If no temporary file caches have been configured, a new cache can be configured by
clicking the Configure button next to the WOPI Temporary Cache field. For information
on creating a new cache, see Configuring a Temporary File Cache on page 15.

© 2020 Hyland Software, Inc. and its affiliates 11

 Integrated Office Viewer
Installation

18. If you are using the Hyland Broker for Microsoft Office to integrate with Microsoft Office
for the web (Office 365), in the Tenant ID field, enter the tenant ID code provided by
Hyland Software. If you are not using the Hyland Broker for Microsoft Office, leave this
field blank.
For more information about registering your solution and receiving a tenant ID, contact
your first line of support.
19. Click Save .

Troubleshooting
The following topics discuss common issues experienced while using the Installation.

File Size Limit Error is Encountered When Using the

Installation
If you are using Microsoft Office for the web, you may experience a file size error when
attempting to view a larger document in the OnBase Installation. Depending on the type of file
you are attempting to open, you may receive an error that says:
Sorry, we can’t open your workbook in Excel Online because it exceeds the 5 MB file size
limit.

The file size limit for Microsoft Office for the web applications is imposed by Microsoft. The
current file size limitations set by Microsoft are:

Microsoft Application Mode File Size Limit

Excel for the web View 5 MB

Excel for the web Edit 5 MB

PowerPoint for the web View No limit

PowerPoint for the web Edit 300 MB

© 2020 Hyland Software, Inc. and its affiliates 12

 Integrated Office Viewer
Installation

Microsoft Application Mode File Size Limit

Word for the web View No limit

Word for the web Edit 50 MB

For more information on Microsoft Office for the web file size limitations and to confirm the
current limitation set by Microsoft, see the documentation available from Microsoft.

© 2020 Hyland Software, Inc. and its affiliates 13

Integrated Office Viewer

Administration Guide

Foundation EP3
 C ONFIGURATION

To view OpenDocument and Microsoft Office documents in OnBase using the OnBase
Integrated Office Viewer, you must have a functioning Microsoft Office environment installed
and configured and a functioning OnBase Application Server. See the Requirements on page 3
for more information.
You must also have the WOPI endpoint connection settings configured in the OnBase
Configuration module. See Installation on page 5 for more information on the WOPI endpoint
and configuration.
See the following sections for more information on configuring the Integrated Office Viewer:
• Configuring a Temporary File Cache on page 15
• Registering the Hyland Broker for Microsoft Office on page 18
• Configuring Document Types for Editing on page 19
• Configuring the Web Server to Open Documents in a New Window on page 20
• Disabling Co-Authoring on page 21

Configuring a Temporary File Cache

Temporary file caches can be configured for use with the OnBase Integrated Office Viewer. The
temporary file cache allows users to preview Microsoft Office documents when selecting them
for upload within the Unity Client and temporarily save edits made to Microsoft Office
documents in the OnBase Integrated Office Viewer. Once the document is uploaded or edits are
saved to OnBase, temporary files are removed from the cache.

Note: After a temporary file cache is configured, it must be associated with the OnBase
Integrated Office Viewer in the Integrated Office Viewer Settings dialog box in OnBase
Configuration. For more information, see Configuring the WOPI Endpoint for a Specific
Database on page 9.

© 2020 Hyland Software, Inc. and its affiliates 15

 Integrated Office Viewer
Configuration

To create a temporary file cache:

1. In the Configuration module, select Utils | Integrated Office Viewer Settings . The
Integrated Office Viewer Settings dialog box is displayed.

2. Click the Configure button next to the WOPI Temporary Cache drop-down list. The
Temporary File Caches : Integrated Office Viewer dialog box is displayed.

© 2020 Hyland Software, Inc. and its affiliates 16

 Integrated Office Viewer
Configuration

3. In the empty field, type the name of the cache you want to create.

4. Click Create . The Cache Configuration dialog box is displayed.

Note: If the Cache Configuration dialog box is accessed from the Distribution Service
Settings or Integrated Office Viewer Settings dialog box, the Type drop-down list is set to
Distribution Service or Integrated Office Viewer , depending on the point of access, and cannot
be changed. These temporary caches, created from the Configure button in the Distribution
Service Settings dialog box or the Integrated Office Viewer Settings dialog box, are
automatically associated with the desired functionality upon completion of configuration.

5. Enter the file path of the temporary file cache in the Path field in one of the following
ways:
• Type the file path in the Path field
• Click the Browse button to navigate to the file path location

Note: The file you browse to must be a UNC share in which the Application Server has access
to the share. The share name must not contain spaces.

6. Select the Encrypt Files option to encrypt the temporary files. Encrypting the data
prevents people from opening the files, which keeps the information more secure.

© 2020 Hyland Software, Inc. and its affiliates 17

 Integrated Office Viewer
Configuration

7. Select one of the following temporary cache purging options:

•Automatic Purge : Automatically purge any temporary cache files every number of
days, specified in the Retention Time (Days) field.
• Manual Purge : Manually purge temporary cache files from the temporary cache
directory.
8. Click Save .

Registering the Hyland Broker for Microsoft Office

In order to use the Hyland Broker for Microsoft Office to integrate with Microsoft Office for the
web (Office 365), you must register your solution with Hyland Software. As part of the
registration process, you will receive a tenant ID code, which is required to complete
configuration of the Hyland Broker for Microsoft Office settings.
For information about registering your solution and receiving a tenant ID, contact your first line
of support.
Once you have received a tenant ID from Hyland Software, follow these steps to add it to your
configuration:
1. Open the OnBase Configuration module for the database being used to integrate with
Microsoft Office 365.
2. Select Utils | Integrated Office Viewer Settings . The Integrated Office Viewer Settings
dialog box is displayed.

3. In the Tenant ID field, enter the tenant ID code provided by Hyland Software.
4. Click Save .

© 2020 Hyland Software, Inc. and its affiliates 18

 Integrated Office Viewer
Configuration

Configuring Document Types for Editing

To edit Microsoft Office documents using the OnBase Integrated Office Viewer, the Document
Type must be configured in the Rendition / Revision Control Settings dialog box in the
Configuration module.
Some of these Document Type settings behave differently in the Integrated Office Viewer than
they do in other contexts. In particular, users are not prompted to save or cancel changes in the
Integrated Office Viewer; when the user closes the browser window, any changes are
automatically saved to OnBase. It is also not possible to create new OnBase documents using
the Integrated Office Viewer. See the following explanations for more information on each
setting.
The following option is required to edit documents in the OnBase Integrated Office Viewer:

Option Description

Allow Persistent Check Out This option is required for editing documents in the OnBase
Integrated Office Viewer.

Note: The EDM Services license is required to enable the

Allow Persistent Check Out option.

The following options for non-revisable Document Types behave differently in the OnBase
Integrated Office Viewer:

Option Behavior in Integrated Office Viewer

Create new document You cannot use this option for documents that you want to
edit in the Integrated Office Viewer.
Selecting this option disables the Allow Persistent Check
Out option, which is required for editing documents in the
Integrated Office Viewer.

Prompt to overwrite or create Any changes made to the document are immediately
new document overwritten to OnBase when the user closes the Integrated
Office Viewer browser window.
Users do not receive a prompt to save or cancel changes,
and there is no option to save the changes as a new
document.

© 2020 Hyland Software, Inc. and its affiliates 19

 Integrated Office Viewer
Configuration

The following options for revisable Document Types behave differently in the OnBase
Integrated Office Viewer:

Option Behavior in Integrated Office Viewer

Prompt for revision This option is not respected in the Integrated Office Viewer.
Any changes made to the document are immediately saved
as a new revision in OnBase when the user closes the
browser window.
Users do not receive a prompt to save as a revision or a new
document.

Allow Comments Users do not receive a prompt to enter revision comments in

the Integrated Office Viewer.
The user must enter a revision comment in the field at the
top of the Integrated Office Viewer and then click Update to
save the revision comment.

Force comment Users do not receive a prompt to enter revision comments in

the Integrated Office Viewer, even if Force comment is
selected for that Document Type.
The user must enter a revision comment in the field at the
top of the Integrated Office Viewer window and then click
Update to save the revision comment. If the user does not
enter a revision comment, a default revision comment is
automatically added when the browser window is closed.

Configuring the Web Server to Open Documents in a New

Window
When using the OnBase Integrated Office Viewer with the OnBase Web Client, Microsoft Office
documents can be viewed in a new window. When documents are viewed in this manner, the
main Client window displays a message explaining that the document is open in a separate
window.
To configure the Web Server to open Office documents in a separate window:
1. Open the web.config file for the Web Server in a plain-text editor.
2. Locate the <appSettings> section of the web.config file.
3. Within the <appSettings> section, paste the following:
<add key="openWopiDocumentsInSeparateWindow" value="true" />
When set to true , documents accessed by the OnBase Integrated Office Viewer in the
Web Client are viewed in a separate window. When set to false , documents are opened
in the main Web Client window.
4. Save and close the web.config file.

© 2020 Hyland Software, Inc. and its affiliates 20

 Integrated Office Viewer
Configuration

Disabling Co-Authoring
Co-authoring for Microsoft Office is enabled by default for the OnBase Integrated Office
Viewer. This feature allows multiple users to edit the same Office document in one session
while seeing edits in real-time. An administrator can choose to disable this feature through the
OnBase Configuration module if co-authoring is not desired.
To disable co-authoring for Microsoft Office:
1. From the OnBase Configuration module, select Utils | Integrated Office Viewer
Settings . The Integrated Office Viewer Settings dialog box is displayed.

2. Select Enable Integrated Office Viewer if this option is not already selected.
3. Select Disable Co-authoring and click Save .

© 2020 Hyland Software, Inc. and its affiliates 21

Integrated Office Viewer

User Guide

Foundation EP3
 U SAGE

Using the Integrated Office Viewer

You can use the OnBase Integrated Office Viewer to do the following actions:
• View OpenDocument and Microsoft Office documents
• Edit OpenDocument and Microsoft Office documents
The following are considerations when only viewing documents in the OnBase Integrated Office
Viewer:
• If your system is not integrated with the Microsoft Office Online Server or Office for
the web, documents opened in the OnBase Integrated Office Viewer are read-only
and cannot be edited.
• You cannot open protected Microsoft Office documents using the OnBase Integrated
Office Viewer.

Note: For more information on viewing documents in the Integrated Office Viewer, see Viewing
Documents on page 23.

The following are considerations when attempting to edit documents in the OnBase Integrated
Office Viewer:
• Microsoft Office documents can only be edited if your system is integrated with the
Microsoft Office Online Server or Office for the web.

Note: For more information on requirements for editing documents in the Integrated Office
Viewer, see Editing Documents on page 24.

This section contains the following information:

• Viewing Documents on page 23
• Editing Documents on page 24
• System Interaction on page 25

Viewing Documents
You can view OpenDocument and Microsoft Office documents in the OnBase Integrated Office
Viewer from the OnBase Client, Unity Client, or Web Client.
To view a document in the Integrated Office Viewer, open a document from a document search
results list. The Integrated Office Viewer is displayed.

© 2020 Hyland Software, Inc. and its affiliates 23

 Integrated Office Viewer
Usage

Printing Documents
You can print documents directly from the OnBase Integrated Office Viewer by clicking the
Print button.

Note: If a Microsoft Word document is configured with Date and Time fields that automatically
update, those fields update to the current date and time when the document is printed from the
OnBase Integrated Office Viewer. To avoid this, open the document using the Office Business
Application and print it from that interface instead of from the OnBase Integrated Office
Viewer.

Editing Documents
You can edit Microsoft Word, Excel, and PowerPoint documents in the OnBase Integrated
Office Viewer if you have the following:
• A document using a .docx, .xlsx, or .pptx file format
• The OnBase Integrated Office Viewer is integrated with the Microsoft Office Online
Server or Office for the web
• An EDM Services license

Note: If editing Microsoft Word, Excel, or PowerPoint documents is not available, ensure the
Allow Persistent Check Out option is selected for all Document Types configured for revisions
or overwrites. See your system administrator for more information about configuring Document
Types that can be edited in the OnBase Integrated Office Viewer.

To edit documents in the OnBase Integrated Office Viewer:

1. Open a Microsoft Office document. The OnBase Integrated Office Viewer is displayed.

Note: If you are using Microsoft Office for the web, you may experience a file size error when
attempting to view or edit a large document in the OnBase Integrated Office Viewer. The file
size limit for Microsoft Office for the web applications is imposed by Microsoft. For more
information, see File Size Limit Error is Encountered When Using the Installation on page 12.

2. Click the Edit in Browser button in the OnBase Integrated Office Viewer toolbar.

A new browser window is displayed with the document available to edit.

Note: The Edit in Browser button is not available if you do not have an EDM Services license or
if your Document Type is configured to save changes as a new document. See your system
administrator for more information.

© 2020 Hyland Software, Inc. and its affiliates 24

 Integrated Office Viewer
Usage

3. Edit the document as needed.

Note: If you are using Microsoft Office for the web, you may experience a file size error when
attempting to view or edit a large document in the OnBase Integrated Office Viewer. The file
size limit for Microsoft Office for the web applications is imposed by Microsoft. For more
information, see File Size Limit Error is Encountered When Using the Installation on page 12.

4. Enter a revision comment in the Revision Comment field at the top of the window, if
needed, if your Document Type is configured for revisions.

5. Click Update .
6. Close the browser window once editing is complete. Your changes are automatically
saved as a revision or an overwrite depending on your Document Type configuration.

System Interaction
The Integrated Office Viewer can be used in conjunction with other modules, depending on your
licensing.

Office Business Application

If you are licensed with and have the Office Business Application for 2019, 2016, or 2013
installed, you can open and edit Microsoft Office documents in their corresponding Microsoft
Office application instead of from the Integrated Office Viewer. Once documents are edited, the
changes can be imported back into OnBase.
To open and edit a document using the Office Business Application:
1. Open the document using the Office Business Application.
• From the OnBase Client, click the Document Options icon in the document title bar
and select Launch Office Business Application .
• From the Web Client, click the View in Native Application button, located beneath the
document toolbar.
• From the Unity Client, click the Open in Alternate Viewer button in the Document
ribbon and select Open in Office .
The Microsoft Office document is displayed in its Microsoft Office application.
2. Edit the document as needed.
3. Save the edited document as a new document or a revision of a document.

Note: See the section on importing and saving documents in the Office Business Application
20XX module reference guide (where XX is the year of the integration) for detailed instructions
on importing and saving a document using the Office Business Application.

© 2020 Hyland Software, Inc. and its affiliates 25