Bridge Specifications
| Vendor | Microsoft |
| Tool Name | OneDrive |
| Tool Version | 1.0 |
| Tool Web Site | https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage |
| Supported Methodology | [File System] Multi-Model, Data Store (Physical Data Model) via Java REST API on XLSX, CSV, JSON, XML, TXT, AVRO, PARQUET, ORC, COBOL File |
SPECIFICATIONS
Tool: Microsoft / OneDrive version 1.0 via Java REST API on XLSX, CSV, JSON, XML, TXT, AVRO, PARQUET, ORC, COBOL File
See https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage
Metadata: [File System] Multi-Model, Data Store (Physical Data Model)
Component: MicrosoftOneDrive version 11.2.0
DISCLAIMER
This import bridge requires internet access to download third-party libraries:
- such as https://repo.maven.apache.org/maven2/ to download open source third-party libraries,
- and more sites for other third-party software such as database specific JDBC drivers.
The downloaded third-party libraries are stored into $HOME/data/download/MIMB/
- If HTTPS fails, the import bridge then tries with HTTP.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -java.parameters option in the Miscellaneous parameter).
- If the import bridge does not have full access to internet, that $HOME/data/download/MIMB/ directory can be copied from another server with internet access where the command $HOME/bin/MIMB.sh (or .bat) -d can be used to download all third-party libraries used by all bridges at once.
By running this import bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third-party software libraries.
OVERVIEW
This import bridge uses Microsoft Graph API to import files from OneDrive and provide lineage for XLSX.
This import bridge assumes that the metadata structure of existing files does not change during import.
This import bridge allows to import file types:
- xlsx
- delimited (csv)
- json
- fixed width
- parquet
- avro
- orc
- cobol
- xml
REQUIREMENTS
Please follow the instructions here to set up Azure Application.
https://learn.microsoft.com/en-us/graph/auth/
- Authorization:
Bridge supports two authentication methods - using user/password or client secret.
You can find detailed information about user/password auth here:
https://learn.microsoft.com/en-us/graph/auth-v2-user?tabs=http
You can find detailed information about client secret auth here:
https://learn.microsoft.com/en-us/graph/auth-v2-service?tabs=http
To configure application access to OneDrive resources please follow the steps described here:
https://learn.microsoft.com/en-us/graph/permissions-selected-overview?tabs=http
If you are using user/password auth method and trying to import from personal drive of other user, then application must have permissions to list users and their drives, or you can explicitly specify drive owner by -drive.owner misc param. Please refer to miscellaneous for detailed information.
To use this bridge, you will need to add API permissions to the Azure Application:
- Files.Read.All;
- Files.SelectedOperations.Selected - if you want to configure application access to OneDrive resources;
- User.ReadBasic.All - if you want to import from personal drive and didn't specify the -drive.owner miscellaneous;
LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html
Bridge currenlty supports import from drives types:
- personal
- site (both subsite and root site)
Bridge does not support user/password method for multi-factor authentication accounts.
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope |
| Directory (tenant) ID | Directory (tenant) ID | STRING | Mandatory | ||
| Application (client) ID | Application (client) ID | STRING | Mandatory | ||
| Application (client) Secret | Client Secret (Optional). If you are using user/password, leave this field empty. | PASSWORD | |||
| User | User login (Optional). If you are using client secret, leave this field empty. | STRING | |||
| Password | User password (Optional). If you are using client secret, leave this field empty. | PASSWORD | |||
| Root Folder | The complete, URL-encoded HTTP address of the OneDrive folder to import. Example: https://contoso.sharepoint.com/sites/Sales/Shared%20Documents/Reports How to obtain: In the OneDrive web UI, you can just navigate to the folder you wish to import. Choose one of the following: Shared Link: Click Share, then Copy link, and use the resulting URL (e.g., https://contoso.sharepoint.com/sites/Sales/Shared%20Documents/Reports). Direct link path: Open the folder’s Details pane, expand More details, locate Path, and click the Copy button to grab the /:f:/s/... URL, like https://contoso.sharepoint.com/:f:/s/Sales/Eg5qD8zzIIpAgado603VlW0BTXvs1FU3IvTGlSrdnYzk6g?e=Ox3EHx. Verify: Paste the URL into a new browser tab, if it loads the folder contents, it’s valid. Note: All spaces and special characters must be URL-encoded (e.g., Shared Documents → Shared%20Documents). |
STRING | Mandatory | ||
| Include Filters | The include folder and file filter pattern relative to the root folder. The pattern uses extended Unix glob case-sensitive expression syntax. Here are some common examples: *.* - include any file at the root level *.xlsx - include only xlsx files at the root level **.xlsx -include only xlsx files at any level *.{xlsx,gz} include only xlsx or gz files at the root level dir\*.xlsx - include only xlsx files in the 'dir' folder dir\**.xlsx - include only xlsx files under 'dir' folder at any level dir\**.* - include any file under 'dir' folder at any level f.xlsx - include only f.xlsx under root level **\f.xlsx - include only f.xlsx at any level **dir\** - include all files under any 'dir' folder at any level **dir1\dir2\** - include all files under any 'dir2' folder under any 'dir1' folder at any level |
STRING | |||
| Exclude Filters | The exclude folder and file filter pattern relative to the root folder. The pattern uses the same syntax as the Include filter. See it for the syntax details and examples. Files that match the exclude filter are skipped. When both include and exclude filters are empty all folders and files under the Root Folder are included. When the include filter is empty and the exclude one is not folders and files under the Root Folder are included except ones matching the exclude filter. |
STRING | |||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT SQL SERVER" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -Dname=value -Xms1G The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ and exceptionally a few other tool sites) in order to download the necessary third-party software libraries. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -prescript "script.bat arg1 arg2" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty. -restore <directory> Specify the backup <directory> to be restored. DATA CONNECTION OPTIONS Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following option allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs. -connection.cast ConnectionName=ConnectionType Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g. -connection.cast "My Database"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP VERTICA -connection.rename OldConnection=NewConnection Renames an existing connection to a new name, e.g. -connection.rename OldConnectionName=NewConnectionName Multiple existing database connections can be renamed and merged into one new database connection, e.g. -connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase -connection.split oldConnection.Schema1=newConnection Splits a database connection into one or multiple database connections. A single database connection can be split into one connection per schema, e.g. -connection.split MyDatabase All database connections can be split into one connection per schema, e.g. -connection.split * A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g. -connection.split MyDatabase.schema1=MySchema1 -connection.map SourcePath=DestinationPath Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file). On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a Hive table implemented (external) by the same file specified using a relative path with default file name and extension, e.g. -connection.map /user1/folder=hdfs://host:8020/users/user1/folder/file.csv On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g. -connection.map /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -connection.casesensitive ConnectionName... Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" -connection.caseinsensitive ConnectionName... Overrides the default case sensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.caseinsensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) ONEDRIVE OPTIONS -drive.owner <principal_name> Drive owner can be a user, site or group, e.g.: User: michael.doe@organization.com Root Folder: https://some.organization.com/personal/john_doe_organization_com/Documents/Apps/dir/subdir Miscellaneous: -drive.owner john.doe@organization.com If you want to import files from personal drive without specifying this option, bridge will try to list all users' drives, retrieving only user id, user display name, drive web url and drive id of a drive for security reasons using 'select' parameter (https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#select-parameter) By default, bridge will try to retrieve drive of an user you login with first, and only then lists users' drives. -processing.max.threads <number> Allows for parallel processing up to a maximum number of threads (by default 4). If there are too many threads, it can lead to server overuse, and therefore to request throttling. |
STRING |
Bridge Mapping
Mapping information is not available