Install WorkZone SharePoint

Prerequisite:

  • WorkZone SharePoint is supported from WorkZone Cloud Edition only.
  • Your organization must use Azure AD.
  • The WorkZone SharePoint app must be registered in Azure AD (see Register WorkZone SharePoint app in Azure ).
  • WorkZone SharePoint requires WorkZone Content Server version 2022.1 or later.

WorkZone SharePoint Connector is designed and tested to work on Cloud-based (Azure) setup with Microsoft Office Online. It is independent from any other WorkZone service, although it connects to WorkZone Content Server (OData and OAuth2) and Office Online – SharePoint.

 

The WorkZone SharePoint architecture consists of 3 parts:

  1. WorkZone SharePoint Backend (SpConnector) - is responsible for communication between customer's SharePoint and WorkZone.
  2. WorkZone SharePoint Frontend – provides UI for WorkZone components displayed in SharePoint.
  3. WorkZone SharePoint package – a SharePoint app to deploy to your SharePoint site. See Microsoft documentation for detailed guidelines.

WorkZone SharePoint Backend (SpConnector)

Backend can be installed on any server.

Prerequisite:

  • Network connection must be opened for WorkZone Content Server OData, WorkZone Content Server OAuth2 and SharePoint Online
  • IIS website named WorkZone has to be created
  • ASP.NET Core Runtime Hosting Bundle in a version .NET 6.0.3 or later (delivered with the WorkZone SharePoint Connector) must be installed on the same server as the WorkZone SharePoint Connector
  1. Run the SpConnector.Setup.msi file.
  • Default installation path:

    • C:\Program Files (x86)\KMD\WorkZone\IIS\WorkZone\WZSP

  • Configuration file:

C:\Program Files (x86)\KMD\WorkZone\IIS\WorkZone\WZSP\appsettings.json

Parameterless installation leaves configuration values empty, although some settings are required to run the application.

Msi installer accepts the following parameters (case insensitive)

  • USE_HTTP - default value is false. Enforces HTTPS communication, if true HTTP is allowed.
  • WZ_CLIENT_ID - ClientID, registered on local WorkZone OAuth2. Required value.
  • WZ_CLIENT_SECRET - Client secret registered on local WorkZone OAuth2. Required value.
  • WZ_ALLOWED_URLS - WorkZone server URL (OData).
  • SP_Client_ID - application that is hosting SharePoint in Azure. Required value.
  • SP_Client_Secret - secret that allows connection to SharePoint. Required value.
  • SP_Tenant_ID - Azure tenant where SharePoint is hosted.
  • CORS_Policy - SharePoint instance URL.
Example:

msiexec /i "SpConnector.Setup.msi" WZ_CLIENT_ID=WZSP_ConfigClient_ID WZ_CLIENT_SECRET=secret WZ_ALLOWED_URLS=https://db01.lmdom.local SP_Client_Id=11b258ae-e076-4fcf-a5cf-2d6b00134e1b SP_Client_Secret=secret SP_Tenant_Id=a11f8617-45a3-48a0-a860-2e890e171ea0 CORS_Policy=https://kmddk.sharepoint.com/

The copy image is missing

Additionally, after installing the WorkZone SharePoint, add it to the allowed Cross Origin Resource Sharing (CORS) origins in OData by editing the

C:\Program Files (x86)\KMD\WorkZone\IIS\WorkZone\OData\web.config

file on the server with WorkZone Content Server. Add the SharePoint instance URL to the existing values under:

<add key="allowCorsOrigin" value="[SharePoint instance URL]" />

(where "[SharePoint instance URL]" is the actual URL). See AllowedCorsOrigins parameter in the Command line configuration for more information about allowing specific origins of the web client to be accessed.

WorkZone SharePoint Frontend

Frontend does not require any specific hosting. It can be hosted anywhere, but must be accessible for SharePoint. Frontend contains only static files that have to be put on the web server. For this reason, there is no installer provided by KMD.

WorkZone SharePoint package

Package is a SharePoint app that you will need to deploy to your SharePoint Online site, as described in the Microsoft guidelines.

The workzone.sppkg extention is provided by KMD to each customer/environment separately, as it contains the URL to WorkZone services (WorkZone domain, WorkZone SharePoint Backend and WorkZone SharePoint Frontend).

Upgrade WorkZone SharePoint

If you are upgrading from earlier versions, uninstall the old version of WorkZone SharePoint before installing the new version.