frevvo Latest - This documentation is for frevvo v10.0. Not for you? Earlier documentation is available too.
All customers need a valid Office 365 SharePoint account.
Submissions can contain multiple files of different types - Invoice, Receipt, PO etc. You may want to save these files in different locations on your SharePoint site.
The SharePoint Connector wizard, allows you to:
The frevvo SharePoint wizard guides you through connecting your forms/workflows to SharePoint.
On This Page:
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.
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:
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
where the <server>:<port> is the same host and port in the URL used to access frevvo. https://<server>:<port>/frevvo/web/sharepoint/token
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="Manage" /> </AppPermissionRequests>
Remember SharePoint only allows https.
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:
Login to frevvo as the tenant admin
Click the Edit Tenant link.
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
Enter the Client Id and the Client Secret that you saved in Step 1 into the respective fields.
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
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.
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.
Go to Settings mode in the Guided Designer navigation bar.
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.
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.
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.
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.
Data - include the frevvo XML document
Snapshot - include a snapshot of your form/workflow in the format selected in the Send Snapshot field
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.
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.
Click the
save and test icon to save the form/workflow and bring up Test mode popup.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.
< (less than)
> (greater than)
: (colon - sometimes works, but is actually NTFS Alternate Data Streams)
" (double quote)
/ (forward slash)
(backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)
This can happen if you do not name the PDF file, and it defaults to your form/workflow name, if that name has special characters.
You cannot use templates (i.e. {EmployeeName} in Sharepoint Folder names.
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:
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.
Some common issues with solutions are listed below.
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.
The maximum size for all fevvo connectors is set to unlimited. Any size file can be uploaded to frevvo and posted to SharePoint.
To determine the version of the SharePoint connector you are using:
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.