Skip to main content

[en] Microsoft SharePoint

[en] Connection Type

[en] Alteryx Tool. The latest version is available from the Alteryx Community.

[en] Driver Details

[en] For more information, see Microsoft portal.

[en] Type of Support

[en] Read & Write

[en] Validated On

[en] SharePoint Files tools: Online

[en] SharePoint List tools: 2007, 2010, 2013, 2016, Online

[en] Version

[en] Description

[en] v5.0.10

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

  • [en] Compatible with AMP engine only.

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

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

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

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

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

[en] Known Issue

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

[en] v2.4.1

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

  • [en] Compatible with AMP engine only.

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

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

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

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

  • [en] 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)

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

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

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

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

[en] Known Issues

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

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

[en] v2.4.0

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

  • [en] Compatible with AMP engine only.

  • [en] Fixed issue where SharePoint Input returned a conversion error when inputting certain data types from List. (TPM-1848)

  • [en] Fixed issue where SharePoint Output changed the date fields to 70 years in the future. (TPM-1822)

  • [en] Fixed issue where SharePoint Input didn’t read some list columns when the list was created from Blank list. (TPM-1726)

  • [en] 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)

  • [en] Fixed issue where SharePoint Input read the whole List despite an applied view. (TDCE-104)

[en] Known Issues

  • [en] NTLM proxy authentication is not working for SharePoint 365 when using Service Principal.

  • [en] NTLM proxy authentication is not working for SharePoint On-Premise.

[en] v2.3.0

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

  • [en] Compatible with AMP engine only.

  • [en] Added support for certificates which contain special characters.

  • [en] Added support for NTLM proxy authentication (evaluation) - SharePoint 365 only.

  • [en] Re-added support for SharePoint On-Premise (version 2013 and 2016).

  • [en] Fixed issue with reading and writing various SharePoint List data types.

  • [en] Fixed issue with reading “N/A” values.

[en] Known Issues

  • [en] Reading some types of metadata may cause errors.

  • [en] 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.

  • [en] Reading YXDB files with datetime field types causes error.

[en] v2.2.0

  • [en] Compatible with Alteryx Designer and Server 2021.4.2 Patch 4, 2022.1 Patch 2 and later.

  • [en] Compatible with AMP engine only.

  • [en] Added support for DCM.

    • [en] DCM is required for running this connector on Alteryx Server.

  • [en] FIPS capable.

  • [en] Added option to download folders and files locally for later processing.

  • [en] Temporarily removed support for SharePoint On-Premise (version 2013 and 2016).

  • [en] Renamed the tools to SharePoint Input and SharePoint Output.

  • [en] Changed the behavior of sheet name field to be excluded from the written data. Added option to keep the sheet name field.

  • [en] SSL/TLS validation is now performed against Windows Certificate Store.

  • [en] Service principal authentication can leverage Sites.Selected instead of the Sites.All permission.

[en] v2.1.0

  • [en] SharePoint Files Output now includes lists writing functionality.

  • [en] Writing data into a list can fail because of API limitations. One of the identified reasons is HTML code included in the data.

  • [en] Minor bug fixes.

[en] v2.0.1

  • [en] Compatible with Alteryx Designer version 2021.3.4 and later.

  • [en] SharePoint Files Input now includes lists reading functionality.

  • [en] All the tools use user’s browser instead of embedded CEF to comply with Conditional Access policy.

  • [en] User-based authentication for SharePoint 365 is valid for up to 6 months depending on the user’s Azure policy.

[en] v1.1.1

  • [en] Sites are loaded incrementally instead of all-at-once.

  • [en] Fixed DriveID error.

  • [en] Fixed bug affecting the output of null values into .yxdb file.

[en] v1.1.0

  • [en] Added Support for SharePoint On-Premise (version 2013 and 2016).

  • [en] 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.

[en] v1.0.4

  • [en] Compatible with Alteryx Designer version 2021.2.2 and later.

  • [en] Initial release.

  • [en] Built-in multitenant Azure App with an option to use custom Azure App (incl. single tenant app).

  • [en] Supports reading and writing XLSX, CSV and YXDB file formats.

  • [en] Proxy support.

  • [en] Requires SharePoint 365.

[en] Alteryx Tools Used to Connect

重要

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

[en] We renamed SharePoint Files to SharePoint in version 2.2.0.

[en] 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.

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

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

[en] Standard Workflow Processing

[en] SharePoint Input Tool

SharepointFiles

[en] Link

[en] SharePoint Output Tool

SharepointFiles

[en] Link

[en] SharePoint List Input Tool

SharePoint List Input Tool Icon

[en] Link

[en] SharePoint List Output Tool

SharePoint List Output Tool Icon

[en] Link

[en] Data Connection Manager

[en] 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.

[en] Enable AMP Engine

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

[en] Custom API Application Setup

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

[en] SharePoint List app-only authentication requires a certificate.

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

  1. [en] Navigate to  Microsoft Azure.

  2. [en] Sign in with your Microsoft Azure Active Directory account.

  3. [en] On the Home screen use Search, or go to the upper left corner menu to open the Azure Active Directory service.

  4. [en] Open App registrations in the left menu.

  5. [en] Select + New registration.

  6. [en] Specify the Name of the app.

  7. [en] Choose desired account type – both Single tenant and Multitenant are allowed.

  8. [en] In the Redirect URI part:

    1. [en] For Sharepoint Files version 1.1.1 and earlier: Select Single-page application (SPA) from the dropdown menu and set the two URLs:

    2. [en] 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:

  9. [en] Select Register.

    [en] The Application (client) ID is your Client ID.

    [en] The Directory (tenant) ID is your Tenant ID.

  10. [en] Go to Client credentials and add New client secret.

    [en] Copy the Value as it won't be accessible again once you leave the page - this is your Client Secret.

  11. [en] Go to API permissions to add these Delegated permissions - Microsoft Graph

    1. [en] Files.ReadWrite.All

    2. [en] offline_access

    3. [en] openid

    4. [en] User.Read

    5. [en] Sites.Read.All

    6. [en] email

    7. [en] profile

    8. [en] Files.Read.All

  12. [en] For Sharepoint Files Input version 2.0.1 and later, add also these Delegated permissions - SharePoint:

    1. [en] AllSites.Manage

    2. [en] AllSites.Read

    3. [en] AllSites.Write

    4. [en] Sites.Search.All

  13. [en] If you want to use service principal (app-only authentication) add the following permissions:In API permissions, add these Application permissions - Microsoft Graph:

    [en] a.  Files.Read.All

    [en] b. Files.ReadWrite.All

    [en] c. Sites.Read.All

    注意

    [en] For Sharepoint version 2.2.0 and later, the tool supports Sites.Selected instead of Sites.Read.All.  In API permissions, add this Application permissions - Microsoft Graph: Sites.Selected. See How to set up SharePoint Sites.Selected for more information on configuring this setup.

[en] 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.

[en] For more information, visit the Microsoft portal.

[en] Additional Details

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

  • [en] When writing to SharePoint, convert your system's timezone to UTC with the DateTimeToUTC() function.

  • [en] When reading from SharePoint, convert from UTC to your system's timezone with the DateTimeToLocal() function.

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

重要

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