Skip to main content
waffle.svg
Domo Knowledge Base

Microsoft Sharepoint Online REST Connector

Version 8

 

Intro

Microsoft SharePoint Online enables an organization to easily create and manage custom team-focused and project-focused sites for collaboration. You can use Domo's Microsoft SharePoint Online REST Connector to get the data from an organization-wide intranet portal in different aspects based on sites within Domo. To do this, you must first create an app in Microsoft Azure. For more information about the Microsoft Sharepoint Online, visit their website at https://products.office.com/en-us/sharepoint/sharepoint-online-collaboration-software

You create a Microsoft Sharepoint Online connection in the Data Center. This topic discusses the fields and menus that are specific to the Microsoft Sharepoint Online REST connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Prerequisites

To connect to Microsoft Sharepoint Online in order to retrieve information, you must have the following:

  • An installed Microsoft Azure app.

  • The client ID and client secret for your Azure app. You may need the following information to register the app:

    • Azure Portal: https://portal.azure.com/

    • Sharepoint App to Register: SharePoint Online Rest API

    • Domo Re-direct URL: https://oauth.domo.com/api/data/v1/oauth/providers/microsoft-sharepoint/exchange

To obtain the Sharepoint Client ID:

1. Go to https://portal.azure.com

2. Select Azure Active Directory > App registrations.

3. Find and click on your web app.

4. The "application" ID is your Client ID.

To obtain the Sharepoint Client secret
  1. Go to https://portal.azure.com

  2. Select Azure Active Directory > App registrations.

  3. Find and click on your web app.

  4. Open Certificates and secrets.

  5. Click +New client secret.

  6. Provide the client secret description and the expiry period for your secret. Click Add.

  7. Your new client secret will appear. Copy it and paste in your Domo connector Client Secret field.

Creating an Azure App for Enterprise OAuth

To create a Microsoft Azure app, do the following:

1. Log into https://portal.azure.com

2. Click on App registrations.

Capture1.PNG

3. Click New registration.

4. Enter the application name and select the supported account type. Enter the Redirect URI for Web as https://oauth.domo.com/api/data/v1/oauth/providers/microsoft-sharepoint/exchange.

Register App Redirect URI.png

5. Click Register.

6. Now, click API Permissions.

API permission.png

11. Click +Add Permissions button.

Capture8.PNG

12. Select the permissions as required.

Delegated Permissions.png

13. After adding the permissions, all configured permissions will be listed as below.

Configured  Permissions.png

Connecting to Microsoft Sharepoint Online

This section enumerates the options in the Credentials and Details panes in the Microsoft Sharepoint Online REST Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to a Microsoft Dynamics CRM installation via Azure. The following table describes what is needed for each field:  

Field

Description

Client ID Enter the client ID for your installed Azure web app. For more information, see Prerequisites.
Client Secret Enter the client secret that was generated when you created your app. For more information, see Prerequisites.

Configuring the connection through OAuth

1. Enter your Client ID and Client Secret in the connector's credential section, and click Connect.

Connector login.png

2. If you are not already logged into your Microsoft Online account, an OAuth window will appear asking you to sign into your Microsoft Online account. 

Microsoft OAuth login.png

3. Select your account and login.

Note: If you are already logged into your Microsoft Online account when you connect in Domo, you are authenticated automatically when you click Connect. If you want to connect to an account that is different from the one you are logged into, you must first log out of current Microsoft Online account.

Once you have entered valid credentials, you can use the same account any time you go to create a new Microsoft Sharepoint Online REST DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Details Pane

This pane contains menus in which you can select your Sharepoint report and configure various options.

Menu

Description

Report

Select your desired Sharepoint Online report.

Download Item Contents

Returns file content for the requested file.

Files

Returns a list of files.

Get Items

Returns items present in the root drive of the selected site.

Groups

Returns a list of groups.

Group Sites

Returns a list of sites for the selected group.

List

Returns details for the selected list.

List Item Column Values

Returns column values for the selected list item.

List Item Detailed

Returns details for the selected list item.

List Items

Returns items in the selected list.

Roots

Returns a list of sites present at the root.

Site Lists

Returns all lists for the selected site.

Site Subsites

Returns a list of subsites for the selected site.

Group ID

Select the group you want to use.

Site or Subsite?

Select whether you want to pull data from a top-level site or a subsite.

Site ID

Select the site you want to pull data from.

Subsite ID

Select the subsite you want to pull data from.

List ID

Select the list you want to pull data from.

List Item ID

Enter the ID of the list item you want to retrieve information for.

Drive ID

Select the drive you want to pull data from.

File ID

Enter the ID of the file you want to retrieve information for. You can generate a list of files by running the "Files" report.

Relative Path

Enter the relative path of the folder from the selected drive, e.g. /MyFolder/MySubfolder

Expand Fields

Select all of the fields you want to expand.

File Type

Select the file type for the data file you want to retrieve. To show file content as a binary column, select Other.

Sheet Name (Optional)

Enter the name of the sheet you want to retrieve from the specified Excel spreadsheet. Be sure to check sheet names for accidental spaces.

Data Tag (Optional)

Enter the tag where the data is found in your XML text.

Do you require attributes in data?

Select Yes if you require attributes values as part of your data.

Enter fields to exclude (Optional)

Provide a comma-separated list of fields to exclude from your XML data.

Enter Xpath expression

Enter your XPath query using standard XPath syntax as defined by the World Wide Web Consortium. (http://www.w3.org/TR/2014/REC-xpath-30-20140408/)

Header Start Row (Optional)

Enter the header row number. If you do not enter a number, the first row is considered the header row.

Data Start Row (Optional)

Enter the starting data row number. If you do not enter a number, the first row after the header row is considered the starting row.

Footer Rows to Skip (Optional)

If there are one or more rows at the bottom of the file you do not want to import, enter the number of rows to skip.

Does Your JSON Text Require a Line Reader?

Select Yes if your JSON text includes multiple lines to read.

Header Tag (Optional)

Enter the tag for the header in your JSON text.

Data Tag (Optional)

Enter the tag for the data in your JSON text.

Fields to Exclude (Optional)

Provide a comma-separated list of fields to exclude from the JSON import.

Date Format

Select the date format that should be used when converting date columns. For Excel files, cell date format will have higher precedence.

Delimiter

Select the desired delimiter for parsing your CSV file.

Custom Delimiter

Enter the desired custom delimiter character. Enter \t for tab or Unicode characters in \uxxxx form.

Quote Character 

Select the desired quote character for parsing your CSV file.

Custom Quote Character

Enter the desired custom quote character. Enter \t for tab or Unicode characters in \uxxxx form.

Escape Character 

Select the desired escape character for parsing your CSV file.

Custom Escape Character

Enter the desired custom escape character. Enter \t for tab or Unicode characters in \uxxxx form.