SharepointFiles

SharePoint Files Output Tool

Version:
2022.1
Last modified: May 31, 2022

Configure the Tool

This process applies to Microsoft SharePoint Online. To install the SharePoint Files Output tool, in Designer open the SharePoint Files YXI file available on the Alteryx Community.

To install the SharePoint Files Output tool for all users, open Designer as administrator.

  1. To add SharePoint Files Output into your workflow, go to the Connectors tool category, select SharePoint Files Output, and drag and drop the tool onto the canvas.
  2. The OAuth method is used for authentication.
    • For cloud authentication:
      • Sign in via Internet Browser: Use the default Alteryx application. 
      • Provide authentication details: Use your own OAuth application. To authenticate, enter your user name and password. To be able to schedule your workflow on Server when you use Cloud services, you need to enable Use as service principal (app-only authentication) so that your token has an extended expiration. When you use the SharePoint Files Input tool for the 1st time, you must give the app your consent to use the listed permissions. See the Custom API Application Setup section for information on how to create your own API application.   

        Depending on your company policy, some permissions might require administrator approval. If this is the case, enter your reason in the app and send a request or contact your IT team directly.

    • For on-premises authentication:
      • Provide Username, Password, and URL.
      • Connect to URL with Windows Account.
  3. You can now choose Site and Document Library (you can also use Search).
  4. Select Add File and enter the file name or select a field that contains the file name. The extension is added automatically according to file format that you select.
  5. Select the Create button.
  6. You can also Add Folder, which is automatically selected.
  7. Based on the selected file format there are multiple options present in the Options tab.
  8. For the XLSX file format, under the Data tab you can also specify to which sheet to write the data:
    • By Sheet Name: Provide the sheet name directly. If the sheet does not exist it will be created in SharePoint.
    • By Field: Create multiple sheets based on the Field name selection.
  9. You can select the Existing File Action (Rename, Overwrite, Append, and Abort) from the dropdown. By default, the Rename action is performed.

    If you select the Overwrite or Append options in Existing File Action, the updated sheet becomes the first sheet in the file. This can impact tools using the order numbers of sheets.

  10. Select Run to execute the workflow.

Custom API Application Setup

The SharePoint connector comes with a built-in multitenant app that you can use, but if you prefer your own app, follow the steps below. For more information on how to build and manage an application with Microsoft Azure cloud services, refer to the Azure documentation.

  1. Navigate to  https://portal.azure.com/#home.
  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 desired account type–both Single-tenant and Multitenant are allowed.
  8. In the optional Redirect URI...
    1. For SharePoint Files Output version 1.1.1 and earlier, select Single-page application (SPA) from the dropdown and set the 2 URLs: 
      1. https://cef.alteryx.com/designer/oauthcallback,
      2. https://login.live.com/oauth20_desktop.srf.
    2. For SharePoint Files Output version 2.0.1 and later, select Web-page application (WPA) from the dropdown 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 API permissions to add these Delegated permissions - Microsoft Graph:
    • Files.ReadWrite.All
    • offline_access
    • openid
    • User.Read
    • Sites.Read.All
    • email
    • profile
  11. For Sharepoint Files version 2.0.1 and later, add these Delegated permissions - SharePoint:
    • AllSites.Manage
    • AllSited.Read
    • AllSites.Write
    • Sites.Search.All
  12. 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 Secret ID. In API permissions add these Application permissions - Microsoft Graph:
    • Files.Read.All
    • Files.ReadWrite.All
    • Sites.Read.All
Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.