Riva Insight On-Premises Prerequisites - MongoDb (Insight 2026.3+)

Curtis Massie
Curtis Massie
  • Updated

MongoDB Installation

MongoDB is used to store the Track State Data.

NOTE: The steps below are using MongoDB community version, however the decision on which MongoDB version or MongoDB compatible database to use is up to your organization.  MongoDB compatible databases must support MongoDB APIs. TSS has been confirmed for MongoDB and Amazon DocumentDB.

  1. Download MongoDB (MongoDb Versions)
    • Ensure the download is unblocked.
  2. Install MongoDB
    1. During installation leave all defaults
    2. Make sure that MongoDB Compass is also selected
    3. The setup wizard can take 10 minutes or more to complete
    4. ‘Finish’ the setup wizard and the MongoDB Compass will automatically open. Leave the MongoDB Compass open as it will be used in later steps below

MongoDB Shell Installation

The MongoDB Shell will be used to create the root user.

  1. Download Mongo DBShell .MSI (x64)
  2. Install Mongo DBShell 
    1. Default location for All Users is %ProgramFiles%\mongosh\mongosh.exe (E.G. C:\Program Files\mongosh\mongosh.exe)
    2. Default location for %LocalAppData%\Programs\mongosh\mongosh.exe (E.G. C:\Users\<Your-Username>\AppData\Local\Programs\mongosh\mongosh.exe)

MongoDB Root User

  1. Run MongoDB Shell as an Administrator:
    1. Go to the folder where the MongoDB Shell was installed (see the default locations above).
    2. Right-click on 'mongosh.exe' and select 'run as Administrator'
  2. Enter 'mongodb://localhost' as the database name (if prompted)
  3. Type 'use admin' to switch to the admin database
    • The prompt should show as admin>
  4. Create a root user using the following command:

    REPLACE user (root) with the user name of your choice, and pwd (mongoAdmin) with a secure password.
    • db.createUser({
          user: "root",
          pwd: "mongoAdmin#9vK!q",
          roles: [{
              role: "root", // Assign the root role
              db: "admin" // Assign to the admin database
          }]
      })
  5. Exit the shell by typing 'exit'.

Special characters in passwords: If the password contains characters such as #, @, :, /, ? or %, percent-encode them in connection strings. For example, # becomes %23, so the example password above is entered as mongoAdmin%239vK!q.

Recommended: Instead of the root user, create a dedicated user for Riva Insight with the readWrite role on the Track State Service database.

MongoDB Connection

  1. Open MongoDB Compass
  2. Click on '+ Add new connection'
  3. For the URI, enter mongodb://root:mongoAdmin%239vK!q@localhost:27017/?tls=false
    1. Replace the user (root) and password with the username and password you created above, percent-encoding any special characters.
  4. Select 'Save & Connect'
  5. The database can now be connected to as localhost:27017