frevvo - SharePoint Configuration Scenarios

1. Cloud Customers Connecting to SharePoint Online - This configuration had 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:

   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 frevvo to authenticate.
      
      
4. frevvo Cloud customers connecting to SharePoint On-premise - This configuration is supported but considered unlikely as SharePoint On-premise 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

These instructions assume you are a frevvo Cloud customer or have an in-house installation of frevvo up and running using the frevvo Tomcat bundle. Follow these steps:

Step 1 - Configure frevvo as a SharePoint App/Add-in

frevvo must be added as a SharePoint provider hosted add-in by your global Office 365 tenant SharePoint Administrator. The process is described in Steps 1 and 2 on this Microsoft SharePoint website. Copy the Client Id and client Secret and save them somewhere on your desktop. You will need to add these values when configuring your tenant for SharePoint.

Here are some tips

• The Title can be anything that can differentiate your frevvo SharePoint application from other applications.
• The app domain field should be the frevvo server domain name plus the frevvo SSL port. It should be the same <server>:<port> as the redirect URL.
  • app.frevvo.com:443 for Cloud customers
  • <server>:8443 for an in-house installation.
• The Redirect URI for frevvo is shown below where the <server>:<port>  is the same host and port in the URL used to access frevvo.
  
  • For a cloud customer, that would be app.frevvo.com:443.
  • For an on-premise customer, a typical example would be <server>:8443.
    
    

https://<server>:<port>/frevvo/web/sharepoint/token

• The Permission Request XML should be: You can copy/paste this xml into the Permission Request XML box.
  
  

<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="Manage" />
</AppPermissionRequests>

Remember SharePoint only allows https.

Step 2 - Configure the frevvo Tenant for SharePoint

Cloud and in-house customers must configure their frevvo tenant to connect to SharePoint as a client. frevvo expects that customers will only be integrating with one SharePoint instance for their organization. You will need the SharePoint Client Id and the Client Secret from Step 1.

Follow these steps:

1. Login to frevvo as the tenant admin

2. Click the Edit Tenant link.

3. Click the  blue arrow to expand the SharePoint section.

4. Enter the Connector URL. - This URL is needed if you are using frevvo in the cloud and installing the connector locally. Enter the URL where your frevvo installation that is configured for SharePoint is located. This URL must use the https protocol.

   The URL in the Connector URL field will override the connector URL that is specified in the configuration property in the <frevvo-home>\tomcat\conf\frevvo-config.properties file. In some cases you can leave this field blank.

   The default value is shown below:
   frevvo.sharepoint.connector.url=http://localhost:8082/sharepoint

5. Enter the Client Id and the Client Secret that you saved in Step 1 into the respective fields.
   

6. Enter the SharePoint Domain Name e.g. <Your SharePoint tenant name>.sharepoint.com - there is a dot between the SharePoint tenant name and sharepoint.com
7. To determine the realm for your SharePoint site :

   1. Navigate to https://<tenant>.sharepoint.com/_layouts/appprincipals.aspx - change the <tenant> to the name of your SharePoint tenant - e.g. https://frevvo.sharepoint.com/_layouts/appprincipals.aspx

   2. Find your registered application in the list and and look at the App Identifier column. The unique identifier after the @-sign in the App Identifier is the app realm and must be entered in the Realm field.
      

8. Click Submit
9. Browse http://<your server:port>/sharepoint/health (replace <your server:port> with your frevvo server:port) to check the status of the connector. If the connector is up and running, you will see { "status" : "UP" }.
10. Proceed to Connect Forms/Workflows with the Save to SharePoint wizard

Step 3 - Connect Forms and Workflows with the SharePoint wizard

1. Login as a frevvo designer user. If you are In-House frevvoconnecting 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 frevvo SharePoint add-in.
      
      Click Trust It to authenticate and grant permission to frevvo. You will not see the trust screen on subsequent logins. The wizard will display.
      
      

      • 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 frevvo 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.

      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.
   

Special Characters in Filenames

If you want to customize the name of the PDF of your form/workflow to Sharepoint, make sure you have Save PDF checked. An optional field that is used to name the PDFs displays. You can use templates in this field. For example, if you have a control called EmployeeName in your form, you can type {EmployeeName} into the PDF Name field and the pdf's in the on your SharePoint site will be named {EmployeeName}.pdf.

• If you leave the PDF Name property blank, frevvo uses the Form/Workflow Name as the pdf file name.
  • If the Form/Workflow Name contains special characters, the PDF will not post to SharePoint generating an HTTP 403 status error. To avoid any issues, name your form/workflows using characters that are suitable for filenames and explicitly set the pdf name in the form/workflow using the same standard. Following the POSIX filename standard (A–Z a–z 0–9 . _ - ) will ensure it works.
• Special characters in filenames or folder names will cause the submission to be flagged with an error in the frevvo submission table. We recommend POSIX naming standards as there are some special characters that are not supported by the connector. 

Check Submissions on SharePoint

When the form is submitted or the workflow is completed, submission data, metadata and attachments are uploaded to the specified destination in your SharePoint account

Verify your stored submissions on your SharePoint website:

1. Test your form/workflow by filling in data, adding attachments, and submiting/completing it.
2. Login to your SharePoint account and navigate to the specified destination. The image shows submissions saved to a SharePoint list named Demo List and the John Edwards submission data and attachments.

Using the SharePoint Connector in an Azure SAML Security Manager tenant

At least one designer user that is going to be connecting forms/workflows to SharePoint with the Save to SharePoint wizard must also be a SharePoint user with the correct privileges to provide consent if your tenant is configured with the Azure SAML Security Manager.

Troubleshooting

Some common issues with solutions are listed below.

Doc Post Failure

If the submission doesn't reach your SharePoint website - if frevvo does not receive a response back from SharePoint with a status code of 200, you can find information about the error from the frevvo submission table.

All tenant admin(s) in your tenant or workflow admin(s) configured for specific workflows will receive a Doc Post Failure notification email to alert them that an issue has occurred. The <server-name> will be provided in the email subject.

Max file size

The maximum size for all fevvo connectors is set to unlimited. Any size file can be uploaded to frevvo and posted to SharePoint.

Determine the version of the SharePoint Connector you are using:

To determine the version of the SharePoint connector you are using:

1. Browse http://<your server:port>/sharepoint/info  - the version information is returned as shown in the image.
   

Refresh Token Expired

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.