Skip to main content

Microsoft SharePoint

Connection Type

Alteryx Tool. The latest version is available from the Alteryx Marketplace.

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, 2019, Online

Version

Description

v2.7.0

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Added support for GCC tenants.

  • Added an option to rename TXT files.

  • Added support for UTF-8-BOM in CSV files.

  • Fixed issue where SharePoint Output failed to overwrite sheets and tabs. (TPM-4002)

  • Fixed issue where SharePoint Output didn't behave correctly when the Keep Field in Output checkbox was selected. (TPM-3950, TPM-3928)

  • Fixed issue where SharePoint Input didn't load the Sites when the user signed in for the first time. (TPM-3946, TPM-3851, TPM-3842)

  • Fixed issue where SharePoint Output didn't load files and folders until the user refreshed the tool. (TPM-3938)

  • Fixed issue where the option to download the file locally for later processing didn't work properly. (TPM-3887)

  • Fixed issue where SharePoint Input returned "Index out of Range" error when the List had no data. (TPM-3884)

  • Fixed issue where the service principal didn't work properly. (TPM-3870)

  • Fixed issue where the SharePoint tools couldn't access data in calculated columns. (TPM-3864, TPM-3827)

  • Fixed issue where SharePoint Input returned the "Python int too large to convert to C long" error. (TPM-3832)

  • Fixed issue where SharePoint Output connected to a wrong tenant type. (TPM-3823)

  • Fixed issue where the user interface became blank when a wildcard was entered in the file path. (TPM-3787)

  • Fixed issue where SharePoint Input couldn't read CSV file encoded with UTF-8-BOM. (TPM-3766)

  • Fixed issue where SharePoint Input returned the "Invalid extension" error. (TPM-349)

  • Fixed issue where the SharePoint tools returned the "day is out of range for month: 0" error. (TDCE-564)

  • Fixed issue where the SharePoint tools failed if a proxy was used. (TDCE-511)

  • Fixed issue where special characters caused errors when overwriting lists. (TDCE-447)

  • Fixed issue where the SharePoint tools version 2.5.0 encountered various limits which weren't present in the previous versions. (TDCE-427)

  • Fixed issue where SharePoint Output didn't retain data types. (TDCE-379)

v2.6.3

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Fixed issue where SharePoint Input returned an error when the Return Only List of Full Paths checkbox was selected. (TPM-3789)

v2.6.2

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Added an error log message when the SharePoint tools fail to authenticate.

  • Fixed issue where SharePoint Output wasn’t behaving correctly when appending multiple columns. (TPM-3693)

  • Fixed issues where SharePoint Input failed to download files locally. (TPM-3692, TPM-3460)

  • Fixed issue where SharePoint Input read data as a wrong data type. (TPM-3688)

  • Fixed issue where SharePoint Output returned an error when overwriting data with a fixed decimal. (TPM-3687)

  • Fixed issue where SharePoint Output wrote date type data as strings. (TPM-3686)

  • Fixed issue where SharePoint Output failed to create new sheets in XLSX and YXDB files. (TPM-3685)

  • Fixed issue where SharePoint Output converted all data to string type data. (TPM-3591)

  • Fixed issue where batching logic wasn’t behaving correctly. (TPM-3566)

  • Fixed issue where SharePoint Input failed to read different data types in one column. (TPM-3468)

  • Fixed issue where SharePoint Input returned an error about converting data types. (TPM-3456)

  • Fixed issue where the SharePoint tools failed to read or write to files with special characters in the file name. (TPM-3454)

  • Fixed issue where SharePoint Output failed to append data in the On-Premise version. (TPM-3430)

  • Fixed issue where SharePoint Input failed to read list views with reserved characters in the view name. (TPM-3382)

  • Fixed issue where SharePoint Input failed because of date type data in XLSX files. (TPM-3285)

  • Fixed issue where SharePoint Input failed to download files locally to empty or invalid location. (TPM-3250)

  • Fixed issue where SharePoint Output returned an error when writing blob data type data to YXDB files. (TPM-2391)

  • Fixed issue where SharePoint Output incorrectly added time stamp when using certain file actions. (TPM-1816)

  • Fixed issue where SharePoint Output didn’t return an error when the lookup value didn’t exist or it contained a special character. (TDCE-474)

  • Fixed issue where SharePoint Input returned an error when reading data from Excel files. (TDCE-468)

  • Fixed issue where SharePoint Input omitted data in columns with an underscore in the column name. (TDCE-403)

  • Fixed issue where SharePoint Input failed to read custom views with more than 5000 rows. (TDCE-351)

Known Issues

  • SharePoint Output fails to write data in columns with an underscore in the column name to Lists. (TPM-3795)

  • SharePoint Input fails to correctly read datetime data from CSV files. (TPM-3793)

  • SharePoint Input fails to display results in file search using cloud authentication. (TPM-3791)

  • SharePoint Output fails to create files with special characters in file names. (TPM-3788)

  • The user interface becomes blank in case of a wrong file extension input. (TPM-3787)

  • SharePoint Input returns an error stating that the processed value exceeds the acceptable range. (TPM-3773)

  • SharePoint Output returns wrong logs for abort action. (TPM-3689)

v2.6.1

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Updated existing file actions.

    • Renamed Overwrite to Overwrite (Update Fields). This isn’t a breaking change, so you don’t need to reconfigure the tool.

    • Added Overwrite (Keep Existing Columns).

  • Fixed issue where SharePoint Output’s Overwrite option took too long to finish. (TPM-3560)

  • Fixed issue where SharePoint Output returned "Could not convert string to float" error. (TDCE-405)

  • Fixed issue where SharePoint Output couldn’t process request due to server load. (TPM-3453)

  • Fixed issue where SharePoint Input couldn’t process the metadata size correctly. (TPM-3497)

  • Fixed issue where SharePoint tools weren’t mapping data types correctly. (TPM-3547)

v2.6.0

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Updated to run on Designer 2024.1 and newer.

  • Fixed issue where SharePoint Input was incorrectly mapping data types. (TPM-3332)

  • Fixed issue where SharePoint Input read Datetime columns as string. (TPM-3223)

  • Fixed issue where SharePoint tool incorrectly opened browser authentication when user selected Service Principal as their authentication method. (TFLN-1892)

  • Fixed issue where SharePoint tool incorrectly opened browser authentication when user selected Service Principal as their authentication method. (TFLN-1892)

  • Fixed issue where SharePoint Output couldn’t load more than 25 Lists in the List browser. (TFLN-1796)

  • Fixed issue where SharePoint Output List wasn’t updating records correctly. (TDCE-279)

  • Fixed issue where SharePoint Output failed to append records of Person datatype to a List. (TDCE-275)

Known Issue

  • In some cases, SharePoint List Input can’t read certain List or View in case its name contains #. (TPM-3382)

  • In some cases, large number of WIN32STORE.PEM files remain under the AppData/Temp folder when SharePoint Tools are run. (TPM-3381)

  • If SharePoint List has a column name beginning with an underscore, SharePoint Input can’t read it. (TDCE-403)

  • In some cases, SharePoint Tools will incorrectly show an "Incorrect URL" error when user connects to an on-premise instance of SharePoint and opts to read from files. (TFLN-1980)

  • SharePoint Output might return "unexpected keyword" error when trying to write blob into YXDB. (TPM-2391)

  • SharePoint Output tool might take a long time or return an error when trying to overwrite data in SharePoint List. (TPM-3452, TPM-3478)

  • SharePoint Tools currently incorrectly parse certain PAC scripts using DIRECT connections, leading to failed authentication in SharePoint Tools. (TPM-2964)

v2.5.0

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector in Alteryx Server.

  • Removed usage of .shiv folder.

  • Added support for Multi-Geo tenants.

  • Added support for SharePoint 2019.

  • The Site's dropdown now displays Site URLs on hover.

  • Fixed issue where workflow ran indefinitely when no data was passed into the SharePoint Output tool. (TPM-2131)

  • Fixed issue where accessing files from SharePoint On-Premises resulted in error "Expecting value: line 1 column 1 (char 0)". (TPM-2602)

  • Fixed issue where default SharePoint List fields were duplicated when included in the selected List View. (TPM -2967)

  • Fixed issue where the SharePoint connector showed "Failed to read port assignment" error when user’s AD username contained a space. (TPM-2141)

  • Fixed issue where SharePoint Output always kept Sheet Name field in the output data, regardless of whether "Keep Field in Output" was checked or not. (TDCE-240)

  • Fixed issue where SharePoint Output failed to append records to List that has Person or Group datatype field using an email address. (TPM-2020)

  • Fixed issue where the SharePoint connector failed to read and write files that had special characters, such as "#", in the file name. (TPM-2619)

  • Fixed issue where SharePoint Input sometimes incorrectly read Managed Metadata data type from SharePoint List. (TPM-2663)

  • Fixed issue where using the upsert operation in SharePoint List created duplicate records. (TPM-1875)

  • Fixed issue where using the overwrite operation in SharePoint List created more records than expected. (TDCE-225)

  • Fixed issue where SharePoint Output replaced "NA" values with blanks when writing into XLSX. (TPM-2577)

  • Fixed issue where SharePoint Output failed to write into YXDB files containing Fixed decimal metadata. (TPM-2965)

  • Fixed issue where SharePoint Output failed to update a List when the ID column was selected as the Primary column. (TPM-2872)

  • Fixed issue where SharePoint Input failed to read from SharePoint sites starting with uppercase letter S. (TPM-2620)

  • Fixed issue where SharePoint Output failed to insert more than 800 records into SharePoint List. (TPM-2556)

  • Fixed issue where SharePoint tool ignored proxy setting in a single-proxy environment. (TFLN-1804)

  • Fixed issue where tool failed to connect when PAC was downloaded as plaintext or JSON. (TPM-2927)

v2.4.2

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4, 2022.3 Patch 3 and later.

  • Compatible with AMP engine only.

  • Fixed issue that prevented SharePoint List Output to update more than first 100 records. (TDCE-126)

  • Fixed issue where SharePoint List Input didn't’t include any Lookup values in the resulting dataset. (TDCE-187)

  • Fixed issue where SharePoint List Output couldn’t append records of the Choice data type. (TPM-2125)

  • Fixed issue where SharePoint List Output couldn’t update the list if the primary column was renamed. (TPM-2215)

  • SharePoint Output now uses a semicolon ; as a delimiter for multiple choices.

Known Issue

  • Workflow runs indefinitely when no data is passed into SharePoint Output tool. (TPM-2131)

v2.4.1

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4, 2022.3 Patch 3 and later.

  • Compatible with AMP engine only.

  • Fixed issue where SharePoint Input didn’t recognize the files with date or datetime fields as a valid YXDB file. (TPM-758)

  • Fixed issue where SharePoint Output to List updated only first 100 records. (TDCE-126)

  • Fixed issue where SharePoint Output tool didn’t display InvalidClientQueryException error sent by SharePoint API. (TDCE-136)

  • Fixed issue where SharePoint Output didn’t write to List fields that started with an underscore. (TDCE-137)

  • Fixed issue where the SharePoint Input ‘Download file locally’ option didn’t work with files other than XLSX, CSV and YXDB. (TFLN-1296, TPM-1956)

  • Fixed issue where SharePoint Output set to overwrite a specific sheet in XLSX file modified other sheets as well. (TPM-1575)

  • Fixed issue where SharePoint Output failed when creating or appending lists with Int16, Int32, Int64, Date and Datetime datatypes. (TPM-1803)

  • Fixed issue where default SharePoint List fields were written twice in case they were set to be visible in SharePoint List. (TPM-1876)

  • NTLM proxy authentication is now supported for SharePoint On-Premise. (TPM-1922)

Known Issues

  • Appending to Choice data type columns in SharePoint List currently doesn’t work. (TPM-2125)

  • Workflow runs indefinitely when no data is passed into SharePoint Output tool. (TPM-2131)

v2.4.0

  • Compatible with Designer 2021.4.2 Patch 6, 2022.1 Patch 4, 2022.3 Patch 3 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.x

  • 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

Important

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

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 Microsoft Azure API Application Setup

To set up a custom API application for this tool, see our guide.

Enable Legacy Encryption Methods

If you're connecting to SharePoint On-Premises or using a proxy with NTLM authentication, you need to enable Encryption Methods in OpenSSL3.

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.

Important

Desktop Automation (Scheduler) is not supported by SharePoint (SharePoint Files).