SharePoint destination#

This guide explains how to load data into Microsoft SharePoint for storage and further use.

Prerequisites#

Before you complete the procedure in this guide, perform all of the following actions:

  • Create a datastream whose data you want to load into SharePoint. For more information on creating a datastream, see Collecting data in Adverity.

  • Log in to your Microsoft account to authorize Adverity to access your SharePoint environment.

Procedure#

To load data from a datastream into SharePoint, follow these steps:

  1. Add SharePoint as a destination to the workspace which contains the datastream or to one of its parent workspaces.

  2. Assign the SharePoint destination to the datastream.

    You can assign as many destinations to a datastream as you want.

    Some destinations require specific Data Mapping. If these Data Mapping requirements conflict, the destinations cannot be assigned to the same datastream.

  3. Configure load settings.

  4. Enable data loading into the destination from the datastream.

Adding SharePoint as a destination#

To add SharePoint as a destination to a workspace, follow these steps:

  1. Go to the Destinations page.

  2. Click + Create destination.

  3. Search for and click SharePoint.

  4. Choose how to authorize Adverity to access SharePoint:

    • To use your own Microsoft account, click Access SharePoint using your credentials.

    • To ask someone else to use their account, click Access SharePoint using someone else’s credentials.

      If you choose this option, the person you ask to create the authorization will need to log in and complete the authorization steps.

  5. Click Next.

  6. Log in to your Microsoft account.

  7. In the Configuration page, fill in the following fields:

    Site ID

    Enter the unique identifier of your SharePoint site.

    Subsite

    If applicable, enter the subsite within the main site where files will be stored.

    Drive ID

    Provide the Drive ID for the SharePoint library or folder where files will be saved.

    File format

    Select the file format for exported data.

    Output format

    Select the output structure of the exported file.

    File name template

    Use this setting to customize file names. Supported placeholders include:

    • {app_label}

    • {checksum_crc32}

    • {datasource_label}

    • {datastream_id}

    • {datastream_type}

    • {extension}

    • {extract_id}

    • {id}

    • {meta[*]}

    • {name}

    • {scheduled_day}

    • {scheduled_month}

    • {scheduled_year}

    • {upload_day}

    • {upload_hour}

    • {upload_minute}

    • {upload_month}

    • {upload_second}

    • {upload_year}

    For more information on metadata and placeholders, see Using placeholders.

    Note

    Whitespaces in file names and paths are not supported.

    Encyption method

    Choose the encryption method to secure exported files.

    Data Mapping

    Choose from the following options:

    • Disabled - Do not apply Data Mapping.

    • Enabled (with metadata) - Apply Data Mapping and include metadata columns (timestamps and filename).

    • Enabled (without metadata) - Apply Data Mapping without adding metadata columns.

    Force string type

    Select this checkbox to force all exported fields to be converted to the String data type.

    Format column names

    Select this checkbox to replace spaces and special characters in column names with underscores and prefix columns starting with numbers with “n”.

    Convert column names to lowercase

    Select this checkbox to convert all column names to lowercase.

    String Line Breaks

    Select how to handle line breaks in exported data:

    • Surround string with quotation marks

    • Remove line breaks by escaping them

    • Replace line breaks with spaces

  8. Click Create.

Assigning SharePoint as a destination#

To assign the SharePoint destination to a datastream, follow these steps:

  1. Go to the Datastreams page.

  2. Open the chosen datastream by clicking on its name.

  3. In the Load section, click + Add destination.

  4. Select the SharePoint checkbox in the list.

  5. Click Save.

  6. For the automatically enabled destinations, in the pop-up window, click Yes, load data if you want to automatically load previously collected data into the new destination.

    The following data extracts will be loaded:

    • All data extracts with the status collected if no other destinations are enabled for the datastream

    • All data extracts with the status loaded if the data extracts have already been sent to Adverity Data Storage or other external destinations

    Alternatively, click Skip to continue configuring settings or manually reload data extracts. For more information, see Re-loading a data extract.

Configuring settings for loading data into SharePoint#

To configure the settings for loading data into SharePoint, follow these steps:

  1. Go to the Datastreams page.

  2. Open the chosen datastream by clicking on its name.

  3. In the Load section, find the SharePoint destination in the list, and click image1 Actions on the right.

  4. Click image2 Destination settings.

  5. Fill in the following fields:

    Filename (to define folder, use “/”)

    Use this setting to set custom file names. Supported placeholders include:

    • {app_label}

    • {checksum_crc32}

    • {datasource_label}

    • {datastream_id}

    • {datastream_type}

    • {extension}

    • {extract_id}

    • {id}

    • {meta[*]}

    • {name}

    • {scheduled_day}

    • {scheduled_month}

    • {scheduled_year}

    • {upload_day}

    • {upload_hour}

    • {upload_minute}

    • {upload_month}

    • {upload_second}

    • {upload_year}

    For more information on metadata and placeholders, see Using placeholders.

    Note

    Whitespaces in file names and paths are not supported.

  6. Click Save.

Enabling data loading into SharePoint destination#

To enable data loading into the SharePoint destination from the datastream, follow these steps:

  1. Go to the Datastreams page.

  2. Open the chosen datastream by clicking on its name.

  3. In the list in the Load section, find the SharePoint destination, and enable the toggle.

  4. In the pop-up window, click Yes, load data if you want to automatically load previously collected data into the newly enabled destination.

    The following data extracts will be loaded:

    • All data extracts with the status collected if no other destinations are enabled for the datastream

    • All data extracts with the status loaded if the data extracts have already been sent to Adverity Data Storage or external destinations

    Alternatively, click Skip to only load data extracts collected from this point forward or reload extracts manually.