SharePoint Server 2016 - Configure Office Online Server

Step 1: Create the binding between SharePoint 2016 and Office Web Apps Server

 

To get started, open an elevated SharePoint 2016 Management Shell. (Right-click SharePoint 2016 Management Shell, and then click Run as Administrator.)

Run the following command, where <WacServerName> is the fully qualified domain name (FQDN) of the URL that you set for the internal URL. This is the point of entry for Office Online Server traffic. For this test environment, you need to specify the –AllowHTTP parameter to allow SharePoint Server 2016 to receive discovery information from the Office Online Server farm by using HTTP. If you don’t specify –AllowHTTP, SharePoint Server 2016 will try to use HTTPS to communicate with the Office Online Server farm, and this command won’t work.

 

 

New-SPWOPIBinding -ServerName <WacServerName> -AllowHTTP

After running this command, you should see a list of bindings displayed at the Windows PowerShell command prompt.

Step 2: View the WOPI zones for the SharePoint bindings

 

Office Online Server uses zones to determine which URL (internal or external) and which protocol (HTTP or HTTPS) to use when it communicates with the host, in this case, SharePoint Server 2016. By default, SharePoint Server 2016 uses the internal-https zone. Run the following command to see what your current zone is.

 

 

Get-SPWOPIZone

The WOPI zone displayed by this command should be internal-http. If it’s displayed correctly, skip to step 4. If it isn’t, see the next step.

Step 3: Change the WOPI zone to internal-http

 

If the result from Step 3 was internal-https, run the following command to change the zone to internal-http. You need to make this change because the zone of SharePoint Server 2016 must match the zone of the Office Online Server farm.

 

 

Set-SPWOPIZone -zone "internal-http"

Verify that the new zone is internal-http by running Get-SPWOPIZone again.

Step 4: Change the AllowOAuthOverHttp setting in SharePoint 2016 to True

 

To use Office Online with SharePoint Server 2016 over HTTP in a test environment, you need to set AllowOAuthOverHttp to True. Otherwise Office Online won’t work. You can check the current status by running the following example.

 

 

(Get-SPSecurityTokenServiceConfig).AllowOAuthOverHttp

If this command returns False, run the following commands to set this to True.

 

 

$config = (Get-SPSecurityTokenServiceConfig)

 

 

$config.AllowOAuthOverHttp = $true

 

 

$config.Update()

Run the following command again to verify that the AllowOAuthOverHttp setting is now set to True.

 

 

(Get-SPSecurityTokenServiceConfig).AllowOAuthOverHttp

Step 5: Enable the Excel SOAP API

 

The Excel SOAP API is needed for scheduled data refresh with Excel Online, and for Excel Web Part rendering. To enable the Excel SOAP API, you need to add the WopiLegacySoapSupport property to the SharePoint Server farm properties using by Windows PowerShell. The input parameter is the URL to ExcelServiceInternal.asmx. This URL can address multiple OOS servers via load balancing. Simply replace the <string> with your Office Online Server path.

To enable the Excel SOAP API, run the following Windows PowerShell where <URL> is the URL of your Office Online Server farm. (For example, http://OfficeOnlineServer.contoso.com.)

 

 

$Farm = Get-SPFarm
$Farm.Properties.Add("WopiLegacySoapSupport", "<URL>/x/_vti_bin/ExcelServiceInternal.asmx");
$Farm.Update();

Step 6: Verify that Office Web Apps is working

 

In SharePoint Server 2016, make sure you’re not logged on as System Account because you won’t be able to edit or view the documents with Office Online. Go to a SharePoint Server 2016 document library that contains Office documents and view a Word, PowerPoint, Excel, or OneNote file. The document should open in a browser that displays the file by using Office Online.

In a production environment that uses HTTPS

 

Before you start the following procedures, make sure that you have set up Office Online Server by following the steps in Deploy a single-server Office Web Apps Server farm that uses HTTPS or Deploy a multi-server, load-balanced Office Web Apps Server farm that uses HTTPS.

Step 1: Create the binding between SharePoint 2016 and Office Online Server

 

To get started, open an elevated SharePoint 2016 Management Shell. (Right-click SharePoint 2016 Management Shell, and then click Run as Administrator.)

Run the following command, where <WacServerName> is the fully qualified domain name (FQDN) of the URL that you set for the internal URL. This is the point of entry for Office Online Server traffic.

 

 

New-SPWOPIBinding -ServerName <WacServerName>

Step 2: View the WOPI zone of SharePoint 2016

 

Office Online Server uses zones to determine which URL (internal or external) and which protocol (HTTP or HTTPS) to use when it communicates with the host, which in this case is SharePoint Server 2016. By default, SharePoint Server 2016 uses the internal-https zone. Verify that this is the current zone by running the following command.

 

 

Get-SPWOPIZone

Take note of the WOPI zone that is displayed.

Step 3: Change the WOPI zone if necessary

 

Depending on your environment, you might have to change the WOPI zone. If you have a SharePoint farm that's both internal and external, specify external. If you have a SharePoint farm that's internal only, specify internal.

If the results from Step 2 show that internal-https and the SharePoint farm is internal only, you can skip this step. If you have a SharePoint farm that’s internal and external, you need to run the following command to change the zone to external-https.

 

 

Set-SPWOPIZone -zone "external-https"

Step 4: Enable the Excel SOAP API

 

The Excel SOAP API is needed for scheduled data refresh with Excel Online, and for Excel Web Part rendering. To enable the Excel SOAP API, you need to add the WopiLegacySoapSupport property to the SharePoint Server farm properties using by Windows PowerShell. The input parameter is the URL to ExcelServiceInternal.asmx. This URL can address multiple OOS servers via load balancing. Simply replace the <string> with your Office Online Server path.

To enable the Excel SOAP API, run the following Windows PowerShell where <URL> is the URL of your Office Online Server farm. (For example, https://OfficeOnlineServer.contoso.com.)

 

 

$Farm = Get-SPFarm
$Farm.Properties.Add("WopiLegacySoapSupport", "<URL>/x/_vti_bin/ExcelServiceInternal.asmx");
$Farm.Update();

Step 5: Verify that Office Web Apps is working

 

In SharePoint Server 2016, make sure you aren’t logged on as System Account because you won’t be able to edit or view the documents with Office Online. Go to a SharePoint Server 2016 document library that contains Office documents and view a Word, PowerPoint, Excel, or OneNote file. The document should open in a browser that displays the file by using Office Online.