Microsoft SharePoint Online connector

Use the Microsoft SharePoint Online (OAuth 2.0 with user-based access) type connector to deliver scanned files to a location in a selected Microsoft SharePoint Online document library with user-based authorization.

If you wish the users to authorize in advance (before going to the terminal), you can:

• Share an authorization link displayed in the connector configuration.
• Advise the users to use the Authorizations tab in Personal > My profile section of SAFEQ Cloud Web UI.

Integration is done using Graph API. Access is granted on per user basis using OAuth2 Authorization Code Flow, authorization is secured via Proof Key for Code Exchange (PKCE).

The following permissions (scopes) are needed:

Connector configuration

You can find the link for users to initiate authorization of the connector in this section.

SharePoint site name  – Define the site names you want your scans to be delivered to (marked below in green).

• If you use a custom site, the address will have this form:  https://myCompanyName.sharepoint.com/sites/<mySite>/<myOptionalSubsite>/<myDocumentLibrary>/Forms/AllItems.asp

  • Open your SharePoint site in your web browser. The part of the address that you need to enter in SharePoint site name is sites/<mySite>/<myOptionalSubsite>


    

    Example: If the address of your SharePoint site is https://acme.sharepoint.com/sites/HR/hiring/templates/Forms/AllItems.asp, the SharePoint site name will be sites/HR/hiring.

• If you use the default SharePoint site, the address will have this form:  https://myCompanyName.sharepoint.com/<myOptionalSubsite>/<myDocumentLibrary>/Forms/AllItems.asp.

  •  Open your SharePoint site in your web browser. The part of the address that you need to enter in SharePoint site name is <myOptionalSubsite>


    

    Example: If the address of your SharePoint site is https://acme.sharepoint.com/legal/templates/Forms/AllItems.asp, the SharePoint site name will be legal.

• Leave empty in case you wish to use the default site.

There are no additional configurable fields. 

Workflow configuration

Example:

1. In Connector, select your SharePoint connector.
2. The SharePoint site name is taken automatically from the connector configuration.

3. In Target SharePoint Online Library, enter name of the public SharePoint library. Be aware that the SharePoint library name is case-sensitive. Usually, at least the library "Documents" exists by default, so you can make an initial test using this library. The library name is taken from the Document Library, which the user can see on their SharePoint page.

   

   The library name in the SharePoint URL and in the SharePoint UI may differ from the real name of the library. This may happen, for example, when your SharePoint is installed in languages other than English or when someone renamed the library. You can obtain the real name via Graph API.See the section Obtaining the real name of the SharePoint library below.

    

   

    

4. In Additional Sharepoint Online path, enter the directory where the workflow delivers scanned files, relative to the connector's document library. You can use Capture variables. Keep in mind the limitations of characters that are allowed to be in paths. Optionally, you can specify a path to a subfolder.
   

   

5. In Document columns, you can add an administrator-predefined document column to the corresponding SharePoint document metadata. The document column value must be a string in the format expected by the SharePoint column. Otherwise, the column value will not be saved. You can use variables in column values. Duplicate column names are not allowed.

Obtaining the real name of the SharePoint library

1. Go to https://developer.microsoft.com/en-us/graph/graph-explorer.
2. Log in with an account that has access to the library.

3. Search for the site using the following query:
   

   CODE

   https://graph.microsoft.com/v1.0/sites?search=<site>

   Example: 
   

   CODE

   https://graph.microsoft.com/v1.0/sites?search=acme

    

4. Locate your site and copy the site ID.
   Example: 
   

   CODE

   acme.sharepoint.com,779cddfd-cef6-4d5a-b361-387183042c00,b9423f0d-e151-4e78-897d-5f2271751d39)

5. List the document libraries using the following query:
   

   CODE

   https://graph.microsoft.com/v1.0/sites/<library id>/drives

   Example: 
   

   CODE

   https://graph.microsoft.com/v1.0/sites/acme.sharepoint.com,779cddfd-cef6-4d5a-b361-387183042c00,b9423f0d-e151-4e78-897d-5f2271751d39/drives

    

6. Locate the document library in the response and use the "name" as the library name in the Target SharePoint Online Library field in SAFEQ Cloud.