SharePoint Connector (Legacy)

onPhase Forms latest - This documentation is for onPhase Forms v11.3. Not for you? Earlier documentation is available too.

SharePoint Connector (Legacy)

The SharePoint Connector (Legacy) has been replaced by a new connector that uses the Microsoft Graph API. The documentation below is only relevant for customers using the legacy connector (configured prior to DocuPhase Forms v11.3.x). We strongly recommend switching to the new connector at your earliest convenience.

The SharePoint Connector (Legacy) is deprecated, meaning it will not receive bug fixes or enhancements, and will eventually be retired and removed from DocuPhase Forms in a future release.

 

Overview

The DocuPhase Forms SharePoint Connector and Send to SharePoint document action wizard make it easy to create forms and approval workflows that validate information, route for signatures as required and save the data and documents to a secure SharePoint website. The Connector was designed to integrate with Office 365 SharePoint Online.

To use the SharePoint Connector, customers need a valid Office 365 SharePoint account.

The SharePoint Connector allows you to save the form/workflow documents and metadata to a SharePoint document library and/or a list item. With point and click tools, designers can select the SharePoint destination and map form/workflow control values to the SharePoint metadata columns.

The DocuPhase Forms SharePoint wizard guides you through connecting your forms/workflows to SharePoint.

Choose your Configuration Scenario

First, choose which configuration scenario is best for you. Follow the links for detailed instructions.

Cloud Customers Connecting to SharePoint Online

This configuration has been certified by DocuPhase Forms. Follow these steps:

  1. Configure DocuPhase Forms as a SharePoint Add-in

  2. Configure SharePoint for your DocuPhase Forms tenant.

  3. Connect your Forms/Workflows using the SharePoint wizard.

On Premise Customers connecting to SharePoint Online

This configuration has been certified by DocuPhase Forms. Follow these steps:

DocuPhase Forms only supports/certifies the SharePoint Connector running in the Apache Tomcat container.

  1. Configure DocuPhase Forms as a SharePoint Add-in

  2. Download the SharePoint Connector. Rename it to sharepoint.war. Copy it to the <frevvo-home>\tomcat\webapps folder

  3. Configure SharePoint for your DocuPhase Forms tenant

  4. Connect your Forms/Workflows using the SharePoint wizard.

On Premise customers using SharePoint On-premise

This configuration is supported but not certified.

  1. Customers using SharePoint On-premise also need an Office 365 SharePoint Online account. This is necessary to obtain an authorization token. There is no data transfer from SharePoint On-premise to SharePoint Online.

  2. Customers are responsible for configuring the On-premise installation and the integration with SharePoint Online.

  3. The On-premise version of SharePoint must be version 2013+.

  4. Refer to this Microsoft website for information about how to use Office 365 to allow DocuPhase Forms to authenticate.

DocuPhase Forms Cloud customers connecting to SharePoint On-premise

This configuration is supported but considered unlikely as it requires your On-premise SharePoint to be exposed to the Cloud. Customers are responsible for configuring the On-premise installation and its exposure to the Cloud. 

Configuring the SharePoint Connector

Step 1 - Configure DocuPhase Forms as a SharePoint App (Add-in)

We've provided the steps for configuring DocuPhase Forms as a SharePoint App/Add-in. Keep in mind that the SharePoint UI may change from time to time, and modify as needed for your version. Refer to this Microsoft SharePoint article for more information about adding Apps/Add-ins.

DocuPhase Forms must be added as a SharePoint provider-hosted add-in by your SharePoint Global Administrator in the Sharepoint admin center. The URL will have -admin after the domain name, e.g. https://mycompany-admin.sharepoint.com/.

Create the App

  1. Navigate to https://<yourSharePointSite>-admin.sharepoint.com/_layouts/15/appregnew.aspx

  2. Click Generate on Client ID and Client Secret. Copy the Client Id and client Secret and save them to a text file. You will need to add these values when configuring your tenant for SharePoint.

  3. Enter a Title. The Title can be anything that can differentiate your DocuPhase Forms SharePoint application from other applications

  4. Enter the App Domain. The app domain field should be the DocuPhase Forms server domain name plus the DocuPhase Forms SSL port. It should be the same <server>:<port> as the redirect URL.

    1. Cloud customers: app.frevvo.com:443

    2. On Premise customers: <server>:8443 (or your <server>:<port> if not using the default)
      Please note, SharePoint sometimes will not accept the port in the URL. In that case, please try with the domain only.

  5. Enter the Redirect URI. The Redirect URI for DocuPhase Forms is shown below where the <server>:<port> is the same host and port in the URL used to access DocuPhase Forms.
    Redirect URI

    https://<server>:<port>/frevvo/web/sharepoint/token
    1. Cloud customers: app.frevvo.com

    2. On Premise customers: <server>:8443 (or your <server>:<port> if not using the default)

    3. Remember SharePoint only allows https.
      Please note, SharePoint sometimes will not accept the port in the URL. In that case, please try with the domain only.

  6. Click Create. You will see a message such as "The app identifier has been successfully created." Copy the information on this screen and save it to a text file. You will need these values for the next step.

Grant the App Permissions

  1. Navigate to https://<yourSharePointSite>-admin.sharepoint.com/_layouts/15/appinv.aspx.



  2. In the App ID field, paste the Client ID you copied earlier. Click Lookup. 

  3. The Title, App Domain, and Redirect URI fields should get filled with the information you entered in the last step.

  4. Enter the Permission Request XML. Copy/paste this xml into the Permission Request XML box.

    <AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="Manage" /> </AppPermissionRequests>
  5. Click Create. If prompted, click Trust It.
    If you see an error that you do not have permission to trust this app, please make sure you are logged in as a global admin the Sharepoint admin center. The URL will have -admin after the domain name, e.g. https://mycompany-admin.sharepoint.com/.

We recommend that you create a separate user in SharePoint for DocuPhase Forms forms connection, and use that user while configuring the Send to SharePoint wizard in DocuPhase Forms. This DocuPhase Forms-specific SharePoint user always remains active and eliminates issues if the designer user configured your forms to submit to SharePoint using their own SharePoint login and then leaves the company.