Microsoft SharePoint

Type of Support: Read & Write
Validated On:

SharePoint List tools: 2007, 2010, 2013, 2016, Online

SharePoint Files tools: Online

Connection Type: Alteryx Tool. The latest version is available from the Alteryx Analytics Gallery.
Driver Details: For more information, see Microsoft Portal.

Alteryx Tools Used to Connect

Important

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).

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

SharePoint List Input Tool and SharePoint List Output Tool (Standard workflow processing)

SharePoint Input Tool and SharePoint Output Tool (Standard workflow processing)

Data Connection Manager

The SharePoint tools support Designer DCM for 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 Alteryx AMP Engine enabled for the workflows that contain the SharePoint tools to leverage the full potential of Designer capabilities.

Custom API Application Setup

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

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

  1. Go to Microsoft Azure portal.
  2. Sign in with your Microsoft Azure Active Directory account.
  3. On the Home screen use Search, or go to the upper left corner menu to open the Azure Active Directory service.
  4. Open App registrations in the left menu.
  5. Select + New registration.
  6. Specify the Name of the app.
  7. Choose the desired account type–both Single tenant and Multitenant are allowed.
  8. In the Redirect URI (optional) item:
    • For Sharepoint Files Input version 1.1.1 and earlier: Select Single-page application (SPA) from the dropdown menu and set the 2 URLs:
      • https://cef.alteryx.com/designer/oauthcallback

      • https://login.live.com/oauth20_desktop.srf

    • For SharePoint Files Input version 2.0.1 and SharePoint Files Output version 2.1.0 and later: Select Web-page application (WPA) from the dropdown menu and set the URL:

      • http://localhost/

  9. Select Register.
    • The Application (client) ID is your Client ID.

    • The Directory (tenant) ID is your Tenant ID.

  10. 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.

  11. Go to API permissions to add these Delegated permissions - Microsoft Graph:

    • Files.ReadWrite.All

    • offline_access

    • openid

    • User.Read

    • Sites.Read.All

    • email

    • profile

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

    • AllSites.Manage

    • AllSites.Read

    • AllSites.Write

    • Files.Read.All

    • Sites.Search.All

  13. 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. In API permissions, add these Application permissions - Microsoft Graph:

    • For SharePoint version 2.2.0 and later: In API permissions, add these Application permissions - Microsoft Graph:

    • For SharePoint Files version 2.0.1 and earlier: In API permissions, add these Application permissions - Microsoft Graph:

      • Files.Read.All

      • Files.ReadWrite.All

      • 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, go to the 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, go to Functions.