Connecting to SharePoint
Concept Information
Microsoft SharePoint is a web-based collaborative platform for sharing and managing organizational content and applications. Use the SharePoint data connector to import your organization's SharePoint data.
Before you import
Only tabular data
Analytics can only query SharePoint data that is in tabular form. The following items cannot be queried from Analytics because they are not in tabular form.
- Attachments
- FileVersions
- GetValidTerms
- Permissions
- Views
Multi-factor authentication not supported
The SharePoint data connector cannot access data from a SharePoint account that requires multi-factor authentication.
Known issue: filtering on datetime fields
If you import your data with the Convert Datetime to GMT option checked, you cannot filter on datetime fields. If you need to filter based on a datetime field, clear this option before importing.
Create a SharePoint connection
- From the Analytics main menu, select Import > Database and application.
- From the New Connections tab, in the ACL Connectors section, select Sharepoint.
Tip
You can filter the list of available connectors by entering a search string in the Filter connections box. Connectors are listed alphabetically.
- In the Data Connection Settings panel, enter the connection settings and at the bottom of the panel, click Save and Connect.
You can accept the default Connection Name, or enter a new one.
The connection for Sharepoint is saved to the Existing Connections tab. In the future, you can reconnect to Sharepoint from the saved connection.
Once the connection is established, the Data Access window opens to the Staging Area and you can begin importing data. For help importing data from Sharepoint, see Working with the Data Access window.
Connection settings
Basic settings
Setting | Description | Example |
---|---|---|
Connection Name | The name you want to give this connection in Analytics. | Sharepoint |
Host |
The SharePoint site you are connecting to. Set the URL to a Site Collection to work with all Lists and Documents in all nested Subsites. Set the URL to a specific Site to work with Lists and Documents in that Site only. |
https://teams.example.com/teamA |
User |
Your SharePoint user name. Note |
jgibbons |
Password |
Your SharePoint password. Note |
MyStrongPasswordExample |
Share Point Edition | The edition of SharePoint being used. It is either SharePoint Online or SharePoint On-Premise. | Sharepoint Online |
Use SSO |
When set to true, single sign-on (SSO) will be used to authenticate to SharePoint Online using the account specified via User and Password. Active Directory Federation Services (AD FS), OneLogin, and OKTA SSO are supported. SSO Domain may be required if the domain configured on the SSO domain is different than the domain for User. SSO is only applicable when using SharePoint Online. SSO is not supported for On-Premise versions of SharePoint. |
false |
Auth Scheme |
Together with Password and User, this field is used to authenticate against the server. NTLM is the default option. Use the following options to select your authentication scheme:
|
NTLM |
Advanced settings
Setting | Description | Example |
---|---|---|
SSO Domain |
This property is only applicable when using single sign-on (Use SSO is set to true) and if the domain for User (e.g. user@mydomain.com) is different than the domain configured within the SSO service (e.g. user@myssodomain.com). This property may be required when using AD FS, OneLogin, or OKTA SSO. |
myssodomain.com |
Convert Datetime to GMT | Converts datetime fields to GMT time zone during import. If false, the datetime value is converted to the operating system time zone of the machine running Analytics. | true |
Limit Key Size |
In some ODBC tools, (Microsoft Access, for example) the length of the primary key column cannot be larger than a specific value. This property makes the ODBC Driver override the reported length of all the primary key columns. It is especially useful when using the ODBC Driver as a Microsoft Access Linked Data Source. Setting Limit Key Size to zero will make the key length revert to the original length. |
255 |
Map to Long Varchar |
This property controls whether or not a column is returned as SQL_LONGVARCHAR. Some applications require all text data larger than a certain number of characters to be reported as SQL_LONGVARCHAR. Use this to map any column larger than the specified size so they are reported as SQL_LONGVARCHAR instead of SQL_VARCHAR. |
-1 |
Map to WVarchar |
This property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. It is set by default. String columns must be mapped to SQL_WVARCHAR to accommodate various international character sets, so Map to WVarchar is set to true by default. You may set it to false to use SQL_VARCHAR instead. |
true |
Pseudo Columns |
Indicates whether or not to include pseudo columns as columns to the table. This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. You can use an asterisk (*) to include all tables and all columns. |
|
Upper Case Identifiers |
Set this property to report all identifiers, including table and column names, in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. For example, you can use this property to avoid quoting identifiers. |
false |
Proxy Authentication Scheme |
The authentication type to use to authenticate to the Proxy Server. This value specifies the authentication type to use to authenticate to the HTTP proxy specified by Proxy Server and Proxy Port. Note that the driver will use the system proxy settings by default, without further configuration needed. If you want to connect to another proxy, you will need to set Proxy Auto Detect to false, in addition to Proxy Server and Proxy Port. To authenticate, set Proxy Authentication Scheme and set Proxy User and Proxy Password, if needed. The authentication type can be one of the following:
|
BASIC |
Proxy Auto Detect |
This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to false to use custom proxy settings. This takes precedence over other proxy settings. By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy. To connect to an HTTP proxy, see Proxy Server. |
false |
Proxy User |
A user name to be used to authenticate to the Proxy Server. The Proxy User and Proxy Password options are used to connect and authenticate against the HTTP proxy specified in ProxyServer. You can select one of the available authentication types in Proxy Authentication Scheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this to a username in one of the following formats:
|
jgibbons@example.com |
Proxy Password |
A password to be used to authenticate to the Proxy Server. This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set Proxy Server and Proxy Port. To specify the authentication type, set Proxy Authentication Scheme. If you are using HTTP authentication, additionally set Proxy User and Proxy Password to HTTP proxy. If you are using NTLM authentication, set Proxy User and Proxy Password to your Windows password. You may also need these to complete Kerberos authentication. By default, the driver uses the system proxy. If you want to connect to another proxy, set Proxy Auto Detect to false. |
MyStrongPasswordExample |
Proxy Server |
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy. By default, the driver uses the system proxy. If you need to use another proxy, set Proxy Auto Detect to false. |
127.168.192.10 |
Proxy Port | The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in Proxy Server. | 80 |
Proxy SSL Type |
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. Auto Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. Always The connection is always SSL enabled. Never The connection is not SSL enabled. Tunnel The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Auto |
Proxy Exception |
A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer. The ProxyServer will be used for all addresses, except for addresses defined in this property. |
127.168.189.10; 127.168.188.11 |