SharePoint Integration

Prev Next

The SharePoint integration allows you to capture submission PDFs and attachments and add new content to SharePoint Lists.

Important Note

If you do not have this integration enabled for your site, please contact your Account Manager.

Entra ID Configuration

To use the SharePoint integration, you will need to first configure your Entra ID (previously Active Directory) application.

Note:

You must be an Administrator in your SharePoint site to set up the integration.

  1. Navigate to the Entra Website

  2. Navigate to App (Application) Registrations in the left navigation menu and click New registration New registration button at the top of the App registrations page.

  3. Give the application a Name and set the supported account type to Single Tenant Registering the OneBlink SharePoint App with single tenant accounts in Microsoft Entra.

  4. Click Register Instructions to register an app with a highlighted 'Register' button.

  5. Navigate to Certificates & secrets in the navigation menu and click New client secret Certificates and secrets tab with the New Client secret button selected on the page.

  6. Give the client secret a Description and Expiration Date The Description and Expires fields on the Add a client secret flyout.

    Note:

    Entra requires an expiration to be set. Please be aware of when these client secrets expire, as they will need to be recreated after the expiration period.

  7. Click Add The Add button in the bottom left corner of the client secret page.

  8. Copy the value of the client secret and store it somewhere temporarily Copy the client secret.

    Note:

    The client secret value will not be available after this point.

  9. Navigate to API Permissions in the navigation menu and click Add a permission SharePoint App API permissions page with 'Add a permission' highlighted.

  10. Select Microsoft Graph for the permission Request API permissions for Microsoft Graph.

  11. Click Application permissions Requesting API permissions for Microsoft Graph with highlighted application permissions section.

  12. Check the Sites.Manage.All and Sites.Read.All checkboxes, then click Add permissions Request API permissions with highlighted options for Sites.Manage.All and Sites.Read.All.

  13. Click Grant admin consent for the domain SharePoint App API permissions with highlighted admin consent option.

    Note:

    You will need Entra administrator permissions to be able to click this option.

  14. Your Entra ID has been configured

  15. Navigate to Overview in the left navigation menu, then copy the Application (client) ID and Directory (tenant) ID and store them somewhere temporarily Overview of OneBlink SharePoint App with highlighted Application and Directory IDs.


Set Up the SharePoint Integration

  1. Sign in to your site

  2. Navigate to Advanced Tools and select Integrations Advanced Tools option in the left-hand navigation menu with Integrations highlighted.

  3. Click Setup Integration on the SharePoint card Setup Integration button on the Sharepoint integration card.

  4. Copy and paste the Entra Directory (tenant) ID, Entra Application (client) ID, and Client Secret saved from the Entra ID Configuration instructions into the applicable fields SharePoint form displaying fields for tenant ID, application ID, and client secret.

  5. Click Save Save button in the bottom right corner of the SharePoint integration page.

  6. The SharePoint integration has been set up


Set Up a SharePoint List Column

Users can map radio buttons to SharePoint list elements by pulling in the option lists from SharePoint. When new choice options are added in SharePoint, they will automatically pull into the list in Process Automation and Digital Services. After adding the list as a form element, you can select the element on the SharePoint: Create List Item workflow event.

Creating a new SharePoint list with required fields and categories highlighted.


Workflow Events

With the integration card setup complete, you can now use SharePoint workflow events.

SharePoint: Create List Item

The Create List Item workflow event will allow you to link to an existing SharePoint List and add new rows populating the columns with form data.

Workflow Event Configuration

Workflow settings for SharePoint list item submission with various input fields displayed.

  • Event Type: Select SharePoint: Create List Item.

  • Label: Add an optional label to the event.

  • SharePoint Site: Select the SharePoint Site your list lives in.

  • SharePoint List: Choose the relevant list you would like to populate with form data.

  • List Mapping: After selecting your list, the platform will pull in all the columns in the list and allow you to map them. The "SharePoint: Create List Item" workflow event currently caters to the following SharePoint List Column Types:

    • Text

    • Choice (Radio)

    • Date and time

    • Multiple lines of text

    • Number

    • Yes/No

  • Run Conditionally: This allows you to run the workflow event when specific conditions are met.

  • Advanced:

    • Retry on failure: Allow the platform to attempt to retry to call your SharePoint instance if there are issues on the first attempt.

Future submissions will be added to the linked SharePoint List.

Contact form submission details including ID, date, user name, and message content.

SharePoint: Store PDF

The Store PDF workflow event will allow you to store the submission PDF and any form attachments to a folder within your SharePoint site.

Note:

When storing PDFs it is important to make sure that the PDF has a unique name or is being stored in a uniquely named folder. If the PDF name is not unique and a new PDF is created with the same name then it will overwrite the original with the new PDFs content. The best way to ensure that the PDF file name or the folder path is unique is to include the submission ID (identifier) {SUBMISSION_ID}.

Workflow Event Configuration

Workflow settings for SharePoint event submission with highlighted options and fields.

  • Event Type: Select SharePoint: Store PDF.

  • Label: Add an optional label to the event.

  • SharePoint Site: Select the SharePoint Site where the PDF will be stored.

  • SharePoint Drive: Select your SharePoint Drive where the PDF will be stored.

  • Folder Path: Choose the specific folder in your SharePoint site where the PDF will be stored.

    • The default path is set to /{FORM_NAME}/{SUBMISSION_ID}, but you will need to enter the specific path for your SharePoint site folder.

  • Include Attachments: Choose if you would like to also store the form attachments along with the Submission PDF.

    • The attachment file names will be configured as the following: {element-name}-{ATTACHMENT_ID}-{filename}.{file-extension}.

  • Run Conditionally: This allows you to run the workflow event when specific conditions are met, for more check out this article.

  • Advanced:

    • Exclude Elements: This allows you to remove elements from the PDF that may not be relevant to this recipient.

    • PDF File Name: The name of the PDF can also be changed to more easily conform to any existing processes.

      • The default name is set to {FORM_NAME}-{SUBMISSION_ID}.pdf.

    • Display Submission ID in PDF: Turning this on will ensure the submission ID is added as a footer to each page of the PDF.

    • Display External ID: Turning this on will ensure the external ID is added as a footer to each page of the PDF.

    • Include calendar booking details: This option is only shown if you have a calendar booking event configured. It will include the details of the calendar booking on a new page at the bottom of the PDF.

    • Include payment details: This option is only shown if you have a payment event configured. It will include the details of the payment on a new page at the bottom of the PDF.

    • Include approval form content: This option is only shown if you have an approval flow configured. It will include the details of any approval forms on a new page at the bottom of the PDF.

    • Page break on form pages: Turning this on will create a page break in the PDF that reflects the page breaks in the form itself.

    • Retry on failure: Allow the platform to attempt to retry to call your SharePoint instance if there are issues on the first attempt.