Skip to main content

Documentation Index

Fetch the complete documentation index at: https://domoinc-jkreitzman-patch-1.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Intro

Microsoft OneDrive for Business is an online file-sharing and personal cloud content management service for businesses. Use this connector to pull data files from your OneDrive for Business account into Domo. You can retrieve the data files in any of the following file types: CSV, XLS, XLSX, XML, ZIP, and GZIP. You can connect to your Microsoft OneDrive Business Enterprise OAuth Configuration account in the Data Center. This topic discusses the fields and menus specific to the Microsoft OneDrive Business Enterprise OAuth Configuration connector user interface. To add Data Sets, set update schedules, and edit Data Set information, see Adding a DataSet Using a Connector.

Prerequisites

To connect to your Microsoft OneDrive Business Enterprise OAuth Configuration account and create a DataSet, you need to select the OAuth Configuration.

Connecting to Your Microsoft OneDrive Business Enterprise OAuth Configuration Account

This section enumerates the options in the Credentials and Details panes on the Microsoft OneDrive Business Enterprise OAuth Configuration Connector page. The components of the other panes on this page, Scheduling, and Name & Describe Your DataSet, are universal across most connector types and are discussed in great detail in Adding a DataSet Using a Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your Microsoft OneDrive Business Enterprise OAuth Configuration account. The following table describes what is needed for each field:
FieldDescription
OAuth ConfigurationOAuth Configurations have service credentials stored by your administrator that automatically logs you in, so only your personal OAuth login is required. Your administrator may create and edit configurations in the Data Center, in the Accounts tab.
Once you have entered valid Microsoft OneDrive Business Enterprise OAuth Configuration credentials, you can use the same account at any time to create a new Microsoft OneDrive Business Enterprise OAuth Configuration DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector/Adapter Accounts.

Details Pane

MenuDescription
ReportSelect the Microsoft OneDrive Business Enterprise OAuth Configuration report you want to run. The following reports are available:

Report NameDescription
Most Used ReportsDownload Shared File (Using SharingURL)This report requires a URL input for the file to download. The advanced options are identical to those of other reports.
Other ReportsChildrenLists the children of the item with the specified folder or path.
Default DriveReturns the metadata about the authenticated user’s default drive in OneDrive.
Download Children Shared File (SharedWithMe Endpoint) - DEPRECATED
Note: This report has been deprecated. Use the Download Shared File (Using SharingURL) report instead.
Downloads a shared file from children’s folder into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Download FileDownloads a file into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Download Nested Children Shared File - DEPRECATED
Note: This report has been deprecated. Use the Download Shared File (Using SharingURL) report instead.
Downloads a shared file from the nested children folder into Domo as a DataSet. You specify the folder name and the complete file path, along with other information.
Download Shared File (Search Endpoint) - DEPRECATED
Note: This report has been deprecated. Use the Download Shared File (Using SharingURL) report instead.
Downloads a shared file into Domo as a DataSet. You can specify the file type, file or folder path, and other information.
Download Shared File (SharedWithMe Endpoint) - DEPRECATED
Note: This report has been deprecated. Use the Download Shared File (Using SharingURL) report instead.
Downloads a shared file into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Drive By IdLists the drives for a selected drive ID.
DrivesLists the available drives for the authenticated user.
PropertiesReturns the properties for the item with the specified file/folder or path.
Recent ItemsReturns a list of items that have been recently used by the authenticated user. This list includes items in the user’s drive as well as items they have access to from other drives.
Shared Items - DEPRECATED
Note: This report has been deprecated. Use the Download Shared File (Using SharingURL) report instead.
Lists items that are shared with the authenticated user.
Drive IdThe ID for the requested drive.
AddressingSelect the type of addressing with which the item can be found.
PathEnter the relative path of the file/folder to retrieve the report.

For Shared File, enter the relative path of the file/folder of the user who has shared the file/folder.

e.g. /Documents/test.csv
Folder NameEnter the folder name.
Shared File NameEnter the shared file name with extension.
File/Folder NameEnter the name (or a portion of the name), without extension, of the MS OneDrive file/folder to retrieve. The connector returns the most recently created or modified file matching the name, based on what you have selected in the Date Field menu.

Note: For the Children report, a Folder Name (or a portion of the Folder name) is expected.
Shared Folder NameEnter the parent shared folder name.
Nested Shared File PathEnter the complete nested path of the shared file with extension.

For example: Folder1/Folder2/test.csv
Match TypeSpecify whether the retrieved file starts with or contains the name you have entered in the File Name.
File Or FolderSpecify whether the item is a folder or a file.
File TypeSelect the file type for the data file you want to retrieve.
File Name or Portion to Search for in ZipEnter the name of the zipped file to be retrieved. Leave the field blank to retrieve the first zipped file.
Zipped File TypeSelect the file type for the zipped data file you want to retrieve.
Parent Folder NameEnter a complete folder name (not case-sensitive) to limit the file search to a specific folder’s root contents. Subfolders are ignored. If you leave this blank, the search includes all files in all folders for which you have access.
Date FieldSpecify whether to retrieve a file based on its creation or last modified date. This is useful when there are multiple files containing the name you have entered in the File Name.
Is Password Protected?Select Yes if the Excel file is password protected.
File PasswordEnter the file password.
Sheet NameEnter the sheet name you want to retrieve from the specified spreadsheet.
Sheet Name Match TypeSelect the type of match to perform on the sheet name.

Advanced

MenuDescription
Enter your data tagEnter the tag where your data resides in the XML text.
Do you require attributes in data?Select Yes if you require attribute values as a part of data.
Enter fields to excludeProvides a comma separated list of fields you want to exclude from the XML import.
Enter XPath expressionEnter 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 RowEnter the number for the header row in the data set.
Data Start RowEnter the number for the first data row in the data set.
FooterEnter the number of rows at the end of the data set to skip. For example, to skip the last two rows you would enter 2.
DelimiterSelect the desired delimiter for parsing CSV files.
Custom DelimiterEnter the desired CSV delimiter character. Enter \t for tab or Unicode chars in \\uxxxx form (e.g. \\u005E).
Quote CharacterSelect the desired quote character for parsing CSV files. (A double quote is the CSV standard.)
Custom Quote CharacterEnter the desired CSV quote character. Enter Unicode chars in \\uxxxx form (e.g. \\u005E).
Escape CharacterSelect the desired escape character for parsing CSV files.
Custom Escape CharacterEnter the desired CSV escape character. Enter Unicode chars in \\uxxxx form (e.g. \\u005E).
File EncodingSelect the file encoding. Defaults to UTF-8.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.

FAQ

You can use theDownload Shared File (Using SharingURL) report to access shared files. This report supports the following file formats: CSV, XLS, XLSX, XML, ZIP, and GZIP.
The Sharing URL can be obtained through two distinct methods:
    • Browser Address Bar: Use the file’s URL as displayed in the browser address bar during file viewing.
    • OneDrive Generation: Utilize the URL generated by OneDrive upon selecting Copy link from the Share menu.
      Screenshot
Dataset recreation isnot required. You can change the report the connector is using in the connector details to Download Shared File (Using SharingURL) report and enter the URL of the target file. The dataset settings and schema will remain unchanged.