SharePoint Files Output Tool

Use SharePoint Files Output to write the data to your CSV, XLSX, and YXDB files on the SharePoint site.

Tool Configuration

This process applies to Microsoft SharePoint Online. To install the SharePoint Files Output tool, in Designer, open the SharePoint Files .yxi file that you downloaded from the Gallery.

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

  1. To add SharePoint Files Output into the workflow, go to the Connectors tab, select SharePoint Files Output and drag and drop the tool to the canvas.
  2. The OAuth method is used for authentication.
    1. Sign in via Internet Browser: Use the default Alteryx application.
    2. Provide authentication details: Use you own OAuth application.

      To authenticate, insert your username and password. To be able to schedule you workflow on Server when using the Cloud services, you need to enable Use as service principal (app-only authentication) so that your token has an extended expiration. When using the SharePoint Files Output tool for the first time, you must give the app your consent to use the listed permissions. Go to the Custom API Application Setup section for the information on how to create you worn API application.

      Note

      Depending on your company policy, some permissions might require administrator approval. In such a case, fill in your reason in the app and send a request or contact your IT team directly.

  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 selected File format.
  5. Select the Create button.
  6. You can also Add Folder, which will be automatically selected.
  7. Based on the selected file format there are multiple options in the Options tab.
  8. For the XLSX file format, under the Data tab you can also specify in 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 the 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.
  10. Select Run to execute the workflow.

Custom API Application Setup

The SharePoint connector comes with a built-in multi-tenant app you can use, but if you prefer using your own one, follow these steps.

For more information on how to build and manage an application using the Microsoft Azure cloud services, refer to the Azure documentation (https://docs.microsoft.com/en-us/azure/?product=featured).

  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 Redirect URI (optional):
    1. Select Single-page application (SPA) from the dropdown menu.
    2. Set the URL to https://cef.alteryx.com/designer/oauthcallback.
  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
  11. 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.
  12. In API permissions add these Application permissions - Microsoft Graph
    • Files.Read.All
    • Files.ReadWrite.All
    • Sites.Read.All