Versions Compared

Version Old Version 13 New Version 14
Changes made by

Megan Ellis

Megan Ellis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The frevvo SharePoint Connector and Save 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.


Warning

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

...

  1. Cloud Customers Connecting to SharePoint Online - This configuration has been certified by frevvo. Follow these steps:
    1. Configure frevvo as a SharePoint Add-in
    2. Configure SharePoint for your frevvo tenant.
    3. Connect your Forms/Workflows using the SharePoint wizard.

  2. In-house Customers connecting to SharePoint Online - This configuration has been certified by frevvo. Follow these steps:

    Info

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

    1. Configure frevvo 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 frevvo tenant
    4. Connect your Forms/Workflows using the SharePoint wizard.

  3. In-house 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 the 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  to authenticate.

  4. frevvo 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.
    1. Customers are responsible for configuring the On-premise installation and it's exposure to the Cloud. 

Configuring the SharePoint Connector

...

Info

We've provided the steps for configuring frevvo 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.

Create the App

  1. Navigate to https://<yourSharePointSite>/_layouts/15/appregnew.aspx

  2. Click Generate on Client ID and Client Secret.

    Tip

    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 frevvo SharePoint application from other applications.

  4. Enter the App Domain. The app domain field should be the server domain name plus the SSL port. It should be the same <server>:<port> as the redirect URL.
    • Cloud customers: app.frevvo.com:443
    • On Premise customers: <server>:8443 (or your <server>:<port> if not using the default)

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

    Code Block
    titleRedirect URI
    https://<server>:<port>/frevvo/web/sharepoint/token

    • Cloud customers: app.frevvo.com:443

    • On Premise customers: <server>:8443 (or your <server>:<port> if not using the default)
    • Remember SharePoint only allows https.
  6. Click Create. You will see a message such as "The app identifier has been successfuly 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>/_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.

    Code Block
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="Manage" />
</AppPermissionRequests>
  5. Click Create. If prompted, click Trust It.
    Image Modified
Tip
We recommend that you create a separate user in SharePoint for frevvo forms connection, and use that user while configuring the Save to SharePoint wizard in frevvo forms. This frevvo 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.

Step 2 - Configure the frevvo Tenant for SharePoint

...

Excerpt

  1. Login as a  designer user. If you are In-House connecting to Sharepoint in the cloud, use the URL https://<server>:<SSL port>/frevvo/web/login. Example: https://localhost:8443/frevvo/web/login. Port 8443 is the default.

  2. Create your form or workflow with controls that capture the data that you want to store in the columns configured in the Lists and Libraries on your SharePoint website

  3. Go to Settings mode in the Guided Designer navigation bar.

  4. Select Send to Sharepoint. If the tenant is not configured for SharePoint, the Send to SharePoint option will not display.
  5. You’ll be redirected to login to SharePoint or Office 365 if you are logging into your account for the first time.

    1. On successful login, you will be asked to grant or deny access for your  SharePoint add-in.

      Click Trust It to authenticate and grant permission to . You will not see the trust screen on subsequent logins. The wizard will display.

      Tip
      • We recommend that you create a separate user in SharePoint for frevvo forms connection, and use that user while configuring the Save to SharePoint wizard in frevvo forms. This frevvo 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.
      •  At least one designer user must also be a SharePoint user with the correct privileges to provide consent when invoking the Save to SharePoint wizard if your tenant is configured with the Azure SAML Security Manager .
  6. You can set up a single Document Action to write to multiple places (SharePoint Library and List). Add a route for the second destination by clicking the Route 2 icon.

    1. Select a format for the Snapshot to be saved in SharePoint. The choices are: PDF, PNG or JPEG. If you do not check the Snapshot checkbox under the Destination Type section, you can leave this field empty. PDF is the default.

    2. Enter the site URL - this is the SharePoint site or subsite containing the destination e.g. https://frevvo.sharepoint.com - Remember this URL must specify the https protocol. This value is read in from the SharePoint tenant configuration screen for Route 1.

    3. Set up the first location (route) where you want to save your files in SharePoint. SharePoint destinations can be a Library (and optionally a Folder), or List. Select Library or List from the Destination Type dropdown.

    4. Enter the server relative path of the folder within the library. For example, for folder 'test' in library 'mylib', enter /mylib/test.

    5. Select a Content Type from the dropdown. The wizard automatically pulls the content type choices from your SharePoint site. The Content Type determines the available metadata column names for mapping. For example, if the destination is a Document list you would see Item as a choice for the Content Type. This means your submission is saved as a new item on your SharePoint list. Document Libraries show Document.as the Content Type.

    6. Check the types of files to be saved to the selected destination. The choices are:

      1. Data - include the XML document

      2. Snapshot - include a snapshot of your form/workflow in the format selected in the Send Snapshot field

      3. Attachments - include attachments uploaded to your forms/workflows. The wizard automatically lists the Upload Controls in your form/workflow by name when Files is checked. The attachments for the selected Upload Controls will be saved in the configured destination. 

      4. Gen Forms(PDF) - this checkbox appears if you have mapped PDFs associated with your form/workflow e.g. W-4 and I-9 filled out by a new employee. Select the mapped PDFs that you want to store in SharePoint.

    7. Map the Control Names in your form/workflow to the column names in your SharePoint destination. The wizard will populate the Column Name dropdown with all the columns in the destination but a maximum of 15 controls can be mapped.

      Tip

      When mapping Message controls with templates to the SharePoint Connector, the Save Value property should be checked.

  7. Click thesave and test icon to save the form/workflow and bring up Test mode popup.

  8. If you configure a second Route, clicking the Clear Route button removes the information for Route 2 only.

...

If your users see an error like "org.springframework.security.oauth2.client.resource.UserRedirectRequiredException: A redirect is required to get the users approval" when accessing or trying to submit a form, the cause is that your Sharepoint Token has expired. The user who owns the Sharepoint Account (usually the designer) will need to login and provide consent to refresh the token. You can learn more in this Microsoft Documentation. Currently frevvo does not provide a way to generate a new refresh token automatically. This feature may be added in a future release. However, until then the Sharepoint account user will have to provide consent for a fresh token every 6 months.