Microsoft SharePoint

Version:

2023.1

Last modified: May 17, 2023

Connection Type	Alteryx Tool. The latest version is available from the Alteryx Community.
Driver Details	For more information, see Microsoft portal.
Type of Support	Read & Write
Validated On	SharePoint Files tools: Online SharePoint List tools: 2007, 2010, 2013, 2016, Online

Release Notes

Version	Description
v2.4.0	Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later. Compatible with AMP engine only. Fixed issue where SharePoint Input returned a conversion error when inputting certain data types from List. (TPM-1848) Fixed issue where SharePoint Output changed the date fields to 70 years in the future. (TPM-1822) Fixed issue where SharePoint Input didn’t read some list columns when the list was created from Blank list. (TPM-1726) Fixed issue where SharePoint Output failed to update List when the ID column was selected as the primary column for the update action. (TPM-1297) Fixed issue where SharePoint Input read the whole List despite an applied view. (TDCE-104) Known Issues NTLM proxy authentication is not working for SharePoint 365 when using Service Principal. NTLM proxy authentication is not working for SharePoint On-Premise.
v2.3.0	Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later. Compatible with AMP engine only. Added support for certificates which contain special characters. Added support for NTLM proxy authentication (evaluation) - SharePoint 365 only. Re-added support for SharePoint On-Premise (version 2013 and 2016). Fixed issue with reading and writing various SharePoint List data types. Fixed issue with reading “N/A” values. Known Issues Reading some types of metadata may cause errors. Update action on the SharePoint Files Output Tool does not work when the ID Column is present in the input data or is selected as the Primary Column. Reading YXDB files with datetime field types causes error.
v2.2.0	Compatible with Alteryx Designer and Server 2021.4.2 Patch 4, 2022.1 Patch 2 and later. Compatible with AMP engine only. Added support for DCM. DCM is required for running this connector on Alteryx Server. FIPS capable. Added option to download folders and files locally for later processing. Temporarily removed support for SharePoint On-Premise (version 2013 and 2016). Renamed the tools to SharePoint Input and SharePoint Output. Changed the behavior of sheet name field to be excluded from the written data. Added option to keep the sheet name field. SSL/TLS validation is now performed against Windows Certificate Store. Service principal authentication can leverage Sites.Selected instead of the Sites.All permission.
v2.1.0	SharePoint Files Output now includes lists writing functionality. Writing data into a list can fail because of API limitations. One of the identified reasons is HTML code included in the data. Minor bug fixes.
v2.0.1	Compatible with Alteryx Designer version 2021.3.4 and later. SharePoint Files Input now includes lists reading functionality. All the tools use user’s browser instead of embedded CEF to comply with Conditional Access policy. User-based authentication for SharePoint 365 is valid for up to 6 months depending on the user’s Azure policy.
v1.1.1	Sites are loaded incrementally instead of all-at-once. Fixed DriveID error. Fixed bug affecting the output of null values into .yxdb file.
v1.1.0	Added Support for SharePoint On-Premise (version 2013 and 2016). Fixed blank screen issue when authenticating in Designer 2021.3.2.54175. Please note that you also need to update to Designer 21.3.3.63061 or later.
v1.0.4	Compatible with Alteryx Designer version 2021.2.2 and later. Initial release. Built-in multitenant Azure App with an option to use custom Azure App (incl. single tenant app). Supports reading and writing XLSX, CSV and YXDB file formats. Proxy support. Requires SharePoint 365.

Alteryx Tools Used to Connect

As of Alteryx Designer and Server 2022.3, we deprecated the SharePoint List tools. Install the SharePoint tools which provide updated features.

We renamed SharePoint Files to SharePoint in version 2.2.0.

In SharePoint version 2.2.0, we temporarily removed support for SharePoint On-Premise (version 2013 and 2016). In SharePoint version 2.3.0, we re-enabled the support for SharePoint On-Premise.

As of SharePoint Files Output version 2.1.0, we included the list reading functionality in SharePoint Files Output.

As of SharePoint Files Input version 2.0.1, we included the list reading functionality in SharePoint Files Input.

Standard Workflow Processing

Link

SharePoint Input Tool

Link

SharePoint Output Tool

Link

SharePoint List Input Tool

Link

SharePoint List Output Tool

Data Connection Manager

The SharePoint tools version 2.2.0 and later support Data Connection Manager for an easier and a safer storage of your credentials. Create a connection to SharePoint and easily reuse the stored credentials in workflows that include the SharePoint tools. Alteryx Server requires stored credentials to successfully run the published workflows.

Enable AMP Engine

Make sure you have the AMP engine enabled for the workflows which contain the SharePoint tools version 2.2.0 and later.

Custom API Application Setup

Before using the SharePoint Online tools, you need to register an application endpoint for external clients.

SharePoint List app-only authentication requires a certificate.

For more information on how to build and manage an application using the Microsoft Azure cloud services, refer to the Azure documentation.

Navigate to  Microsoft Azure.
Sign in with your Microsoft Azure Active Directory account.
On the Home screen use Search, or go to the upper left corner menu to open the Azure Active Directory service.
Open App registrations in the left menu.
Select + New registration.
Specify the Name of the app.
Choose desired account type – both Single tenant and Multitenant are allowed.
In the Redirect URI part:
1. For Sharepoint Files version 1.1.1 and earlier: Select Single-page application (SPA) from the dropdown menu and set the two URLs:
  - https://cef.alteryx.com/designer/oauthcallback,
  - https://login.live.com/oauth20_desktop.srf.
2. For SharePoint Files Input version 2.0.1, Sharepoint Files Output version 2.1.0, and later: Select Web-page application (WPA) from the dropdown menu and set the URL:
  - http://localhost/
Select Register.
The Application (client) ID is your Client ID.
The Directory (tenant) ID is your Tenant ID.
Go to Client credentials and add New client secret.
Copy the Value as it won't be accessible again once you leave the page - this is your Client Secret.
Go to API permissions to add these Delegated permissions - Microsoft Graph
1. Files.ReadWrite.All
2. offline_access
3. openid
4. User.Read
5. Sites.Read.All
6. email
7. profile
8. Files.Read.All
For Sharepoint Files Input version 2.0.1 and later, add also these Delegated permissions - SharePoint:
1. AllSites.Manage
2. AllSites.Read
3. AllSites.Write
4. Sites.Search.All
If you want to use service principal (app-only authentication) proceed to Certificates & secrets and add New client secret. Copy the Value as it won't be accessible again once you leave the page – this is your Client Secret.
1. For Sharepoint version 2.2.0 and later: In API permissions, add these Application permissions - Microsoft Graph:
  1. Sites.Selected (See How to set up SharePoint Sites.Selected for more information.)
2. For Sharepoint Files version 2.0.1 and earlier: In API permissions, add these Application permissions - Microsoft Graph:
  1. Files.Read.All
  2. Files.ReadWrite.All
  3. Sites.Read.All

Now you can use this app in your Alteryx SharePoint Files connector. To authenticate login, you will need your User Name, Password, Client ID, and Client Secret ID and Tenant ID provided with application registration.

For more information, visit Microsoft portal.

Additional Details

SharePoint stores all DateTime values as UTC. To correctly convert your system's DateTime values to and from UTC, do the following:

When writing to SharePoint, convert your system's timezone to UTC with the DateTimeToUTC() function.
When reading from SharePoint, convert from UTC to your system's timezone with the DateTimeToLocal() function.

Otherwise, use another DateTime Function to perform the calculation. For additional information, see Functions.