Versions Compared

Key

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

...

aligncenter

Image Removed

...

On This Page

Table of Contents

Overview

DryvIQ connections to SharePoint 2013, 2016, and 2019 on-premise platforms can be made by using any valid SharePoint user account with applicable permissions to access content. There are several ways to transfer content, this document outlines each of those situations and how to configure them.

Panel
bgColor#FFFAE6

Microsoft SharePoint supported versions:

  • 2013

  • 2016

  • 2019

Create Connection | User Interface

  1. Select Connections > Add connection.

  2. Select Microsoft SharePoint as the platform on the Add connection modal.

  3. Enter the connection information. Reference the table below for details about each field.

  4. Select Test connection to ensure DryvIQ can connect using the information entered.

  5. You will see a "Connection test succeeded" message on the Add connection modal when DryvIQ establishes connection. (If you don't see this message, verify the information you entered.)

  6. Select Done.

Add connection modal - Microsoft SharePoint

...

Field

Description

Required

Display As

Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists.

If you do not add a display name, the connection will automatically be named using the SharePoint URL. For example, Microsoft SharePoint (http://sharepoint.url.com/). If it will be useful for you to reference the connection by account, you should use the default name. 

Optional

URL

Enter the URL for SharePoint including the site collection where the target document library exists.

Required

User Name

Enter the SharePoint username. It can coincide with the Active Directory Universal Principal Name (UPN).

Required

Password

Enter the password for the username added in the previous field.

Required

SSO Provider

Only Active Directory Federation Services (ADFS) is supported as an SSO provider for SharePoint at this time. 

Optional

SSO URL

Enter the URL of the configured SSO provider.

Optional

Authentication type

Select the authentication method the server uses: Basic, Forms, or NTLM. You can select the Detect automatically option to have DryvIQ automatically detect the authentication type when testing the connection. This is the default selection. 

Optional

Connection Test Succeeded

...

Features and Limitations 

Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations. For more information on SharePoint restrictions, see Microsoft’s official documentation.

Info

Features and limitations may vary between SharePoint versions. Refer to Microsoft's official documentation for your specific version of SharePoint for a full list of supported features and limitations. 

Files and Folders

Below is list of SharePoint’s supported and unsupported features as well as additional file/folder restrictions. 

Other Features/Limitations (warning)

SharePoint 2013

SharePoint 2016

SharePoint 2019

File size maximum

2 GB

2 GB

15 GB

Path length maximum

260

260

400

Segment path length

128

128

260

Invalid characters
(See Invalid Characters and Spaces below)

| # { } % & \ ~ + / : * ? < > \\ “

| # % \ \\ / : * ? < > “

| \ \\ / : * ? < >  "

Restrictions
(See Invalid Characters and Spaces below)

  • Consecutive periods

  • Leading tildes

  • Leading periods

  • Trailing periods before extension

  • Trailing periods after extension

  • Leading whitespace

  • Trailing whitespace before extension

  • Trailing whitespace after extension

  • Non-printable

  • Leading tildes without an extension

  • Trailing periods after extension

  • Leading whitespace

  • Trailing whitespace after extension

  • Non-printable

  • Trailing periods after extension

  • Leading whitespace

  • Trailing whitespace after extension

  • Non-printable

Check Out

DryvIQ does not support Libraries that have Require Check-out enabled.

Date Preservation

Date preservation works with SharePoint if you are using author-preservation.

Enterprise Keywords

SharePoint doesn't allow duplicate Enterprise Keywords. The longest string allowed in an Enterprise Keyword is 255 characters. 

File Extensions

SharePoint restricts certain file extensions in different versions. Click here for the complete list.

Invalid Characters and Spaces

DryvIQ verifies file and folder names to identify unsupported characters based on the platform. It then replaces invalid characters with an underscore (_) so the files and folders can be transferred. 

The logic includes leading and trailing spaces in file and folder names. DryvIQ replaces the space rather than trimming it because trimming the space could cause duplicate file names. Adding the underscore ensures the name remains unique.

Okta

DryvIQ does not support Okta with SharePoint.

Restricted File/Folder Names

The following are restricted file and folder names:

  • _vti_test

  • _w

  • _t

The following are restricted folder names:

  • Test_files

Folder names cannot end with the following:

.files

_elemei

_files

_ficheiros

_Dateien

_arquivos

_fichiers

_dosyalar

_bestanden

_datoteke

_file

_fitxers

_archivos

_failid

_filer

_fails

_tiedostot

_bylos

_pliki

_fajlovi

_soubory

_fitxategiak

URLs

The transformation of URLs into SharePoint can sometimes increase the overall URL length, which can cause either 400 or 414 URL failures. (Spaces are the primary way this can happen.) DryvIQ recommends you remove the spaces or shrink the URL length to resolve this error.

Versioning

Versioning is supported if versioning is enabled on the library.

SharePoint 2019 supports version deletes. 

...

Create Connection | REST API

Create a Basic Connection

Create a basic SharePoint connection at the following endpoint.

Code Block
GET {{url}}v1/connections/platforms/SharePoint/new


Create a Connection with Applicable Authorization Type

Verify your instance support forms. In rare instances, there can be a misconfiguration with SharePoint that can falsely report that Forms are supported. If you are experiencing connection issues with SharePoint, you may need to configure for ntlm authentication for the auth_type parameter.

Code Block
{
  "name": "SharePoint 2016",
  "platform": {
    "id": "sharepoint"
  },
  "auth": {
    "uri":"http://url.com",
    "username":"USER",
    "password":"PASSWORD",
    "auth_type":"ntlm"    
  }
}

SharePoint Connection | API Job Configuration Examples

The example below shows a simple job for a SharePoint connection created as standard user without impersonation.

Code Block
{
    "name":"Simple Job",
    "kind": "transfer",
    "transfer": {
      "transfer_type": "copy",
        "source": {
            "connection": { "id": "{{SharePoint_Connection_sourceID}}" },
            "target": {
                "path": "/sourceDocumentLibrary"
            }
        },
        "destination": {
            "connection": { "id": "{{Box_Connection_destinationID}}" },
            "target": {
                "path": "/destinationFolder"
            }
        },
        "simulation_mode": false
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Report {Name}"
    }
}

SharePoint Connection Notes

/wiki/spaces/S4D/pages/547291146