This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Deploy a BI Connector

On this page

The MongoDB Connector for Business Intelligence allows you to query a MongoDB database using SQL commands to aid in data analysis. It translates SQL queries from data analysis tools to MongoDB aggregation pipelines on MongoDB database.


The BI Connector only allows read-only operations on data served in MongoDB databases. To create, update, or delete data you must use the MongoDB shell or any appropriate driver.

See also

For specifics on the BI Connector, see the BI Connector manual.

Use the following procedure to deploy a new MongoDB BI Connector for Ops Manager to manage.


You must provision servers onto which to deploy, and Ops Manager must have access to the servers.


If you will run MongoDB Enterprise and provision your own Linux servers, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies. See the link for the server’s operating system:



Click Deployment, then the Processes tab.


Choose New BI Connector.

  1. Click the Add New dropdown menu.
  2. Click New BI Connector.

Configure the BI Connector instance.

In the New BI Connector modal, configure the following settings:

Choose Server Select the host where this new BI Connector is installed.
Deployment Item Select the deployment item (standalone, replica set, or sharded cluster) to which this new BI connector connects.
Port to Listen On Select the port to which this new BI Connector connects to access the Deployment Item.
Read Preference

Select how the BI connector routes read operations to the members of a replica set. Available values include:

Included Namespace(s) (Optional)

Type the name of a database and/or collection to limit what data the BI Connector can access.

Leave this box blank to allow the BI Connector to use all namespaces on the host.

Click the + add another namespace link to add another namespace to your list of included namespaces.


(Optional) Set any Additional settings for the BI Connector instance.


If you need to use SSL to connect with the Deployment Item, configure these settings:

SSL Mode Select Disabled, Allow SSL, or Require SSL.
SSL PEM Key File Path Type the path on the MongoDB host where the SSL PEM key file is stored.
SSL PEM Key Password (Optional) If you encrypted the PEM file, type its password.


Linux Log File Path (Conditional: BI Connector is installed on a Linux platform) Type the path to the BI Connector log on that host.
Windows Log File Path (Conditional: BI Connector is installed on a Windows platform) Type the path to the BI Connector log on that host.
Log Rotation

Toggle to ON to enable. Default is OFF.

If toggled to ON, the logs are rotated when the Size Threshold or Time Threshold is met.

The next four settings require Log Rotation to be set to ON.

Size Threshold (MB) (Conditional: Log Rotation = ON ) Type the size the log file must reach in MB before the BI Connector rotates it automatically. The default value is 1000.0 (about 1 GB).
Time Threshold (Hours) (Conditional: Log Rotation = ON ) Type the duration the log file must cover in hours before the BI Connector rotates it automatically. The default value is 24 hours.
Max Uncompressed Files (Conditional: Log Rotation = ON ) Type how many rotated log files may stay uncompressed in the log directory before they are archived and compressed. (The suggested number is 2.)
Max Percent of Disk (Conditional: Log Rotation = ON ) Type the percentage of disk space on the host the log files may consume before older files are deleted. (The suggested number is 5.)

Click Create.


Click Review & Deploy to review your changes.


Click Confirm & Deploy to deploy your changes.

Otherwise, click Cancel and you can make additional changes.