Connecting to Microsoft Active Directory
The Sisense Microsoft Active Directory connector is a certified connector that allows you to import data from the Microsoft Active Directory API into Sisense via theSisense generic JDBC connector. The Microsoft Active Directory connector offers the most natural way to integrate with Active Directory Users, Groups, Roles, Contacts, and more, and provides additional powerful features.
Sisense Microsoft Active Directory connector is a certified connector. The support for the connector is provided by Sisense and will be assisted by the certification partner's support, if needed. For any support issues or additional functionality requests, please contact your Sisense representative or open a request through our Help Center. For advanced inquiries specific to driver functionality, you can also contact our certification partner’s support directly via [email protected].
After you have downloaded the driver, you can connect through a connection string in Sisense. The connection string is used to authenticate users who connect to the Microsoft Active Directory APIs. . The connection string is used to authenticate users who connect to the Microsoft Active Directory tables. Once you have connected to Microsoft Active Directory, you can import a variety of tables from the Microsoft Active Directory API.
This page describes how to download the Microsoft Active Directory driver and deploy it, how to connect to Microsoft Active Directory with a connection string, provides information about the Microsoft Active Directory data model, and more.
- Downloading the Microsoft Active Directory JDBC Driver
- Deploying the Microsoft Active Directory JDBC Driver
- Connecting to Microsoft Active Directory
- Adding Microsoft Active Directory Tables to your ElastiCube
- Microsoft Active Directory Connector: Additional Resources
You can download the Microsoft Active Directory JDBC driver here.
- The driver is certified for Sisense v7.2 and above.
- Click the above link to download a 30-days free-trail of the driver. Contact Sisense for the full license version.
- Sisense v7.4 and above: Click the above link to download a ready-to-use driver.
- Sisense prior to v7.4: Click the above link to download a 30-days free-trail of the driver. Contact Sisense for the full license version.
Pre-requisit: The install file (setup.jar) is a Java Application that requires Java 6 (J2SE) or above to run.
To install the driver, double-click the setup.jar file and proceed with the instructions in the installation wizard.
Depending on the machine on which you are accessing the Sisense application, install the driver in one of the following locations:
- When Sisense is installed on your local machine, deploy the driver locally.
- For a non-local installation (when accessing Sisense on a remote Windows server, or accessing the Sisense hosted cloud environment), select one of the below methods:
- Deploy the driver on the Sisense server machine, and then perform all the authentication on the server machine. OR
- Deploy the driver on your local machine (or any other machine, as convenient), perform all the authentication on that machine, and then copy the JAR file to the remote server. For detailed instructions, see here.
- If you are on a Linux deployment, deploy the driver on your local machine (or any other machine), perform all the authentication on that machine, and then copy the JAR file to this location: opt/sisense/storage/. For detailed instructions, see here.
Note: The default location of the JAR file: C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib
If you do not have Java 6 installed, you may download it from here.
If your system is not set up to run Java applications, execute the following command: java -jar setup.jar.
To access Microsoft Active Directory from Sisense, you must provide valid Oauth Microsoft Active Directory credentials through a connection string. The connection string is used to authenticate users who connect to the Microsoft Active Directory tables. Once you have connected to Microsoft Active Directory, you can create the connection string and provide Sisense with it to connect to your data.
To create the connection string:
- Open the lib directory for the connector. This is the default path: C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib.
- Double-click the jar file in the lib directory.
Alternatively, to open the jar file from the command line, enter the following command in the command prompt (change the driver name to your driver): cd C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib. Press Enter and then enter the following command (change the driver name to your driver): “C:\Program Files\Sisense\infra\jre\bin\java.exe" -jar cdata.jdbc.<Driver Name>.jar. Press Enter again.
The Connection String Builder opens.
- Enter the values for the following connection properties (click in the Value column to enter a value or to modify an existing value):
- Valid User and Password credentials (e.g., Domain\\BobF or cn=Bob F,ou=Employees,dc=Domain).
- Server information, including the IP or host name of the Server and the Port.
- BaseDN will limit the scope of LDAP searches to the height of the distinguished name provided.
Note: Specifying a narrow BaseDN may greatly increase performance; for example, cn=users,dc=domain will only return results contained within cn=users and its children.
- If you define your own custom schemas to work with your ActiveDirectory object classes, set Location to the path to the folder containing the schema files.
- If the Connection String Builder has a InitiateOAuth property, set it to OFF to avoid entering the OAuth Authorization process. Note: This property may not appear for some connectors.
- Press Enter to add all the connection properties to the connection string.
An example of the connection string:
- Click Test Connection. A new browser tab opens where you need to log in to your application in order to grant access. (Each application will display a different window and messages.)
Close the Authorization Successful! message that opens.
- Go back to the Connection String Builder dialog, and click OK in the Test Connection Successful message to close it.
- Click Copy to Clipboard to obtain the connection string.
You need to follow the above instructions only on first connect, and then when your credentials to the application change.
To help you create a connection string and test the connection, see Connection String Builder for Certified Connectors.
If you have any issues connecting to your data source, see Troubleshooting JDBC Data Connectors.
- Open Sisense.
For a non-local installation, open Sisense on the hosted cloud environment.
- In the Data page, open an ElastiCubeor create a new ElastiCube.
- In the Model Editor, click . The Add Data dialog box is displayed.
- Click Generic JDBC to open the JDBC settings.
- In Connection String, paste the string you obtained above.
- In JDBC JARs Folder, enter the name of the directory where the Microsoft Active Directory JAR file is located (see Deploying the Microsoft Active Directory JDBC Driver).
- In Driver's Class Name, enter the following class name: cdata.jdbc.activedirectory.ActiveDirectoryDriver.
- If you wish to secure the connection, enter your Microsoft Active Directory credentials in User Name and Password and remove the relevant properties from the connection string. Otherwise, leave these fields blank.
- Click Next. A list of tables in the database are displayed. All tables and views associated with the database will appear in a new window.
- From the Tables list, select the relevant table or view you want to work with. You can click next to the relevant table or click Preview to see a preview of the data inside it.
- (Optional) Click + to customize the data you want to import with SQL. See Importing Data with Custom Queries for more information.
- After you have selected all the relevant tables, click Done. The tables are added to your data model.
For the full documentation set for the Microsoft Active Directory connector, click here.
For connection string options, click here.
For information on the Microsoft Active Directory data model, click here.
- Accumulated builds are supported because all tables have string columns.
- Aggregate functions are not supported.