How to Connect to an Embedded Alteryx Server MongoDB using Studio 3T

Studio 3T is a GUI editor for MongoDB. This article covers connecting to the Embedded Alteryx Server MongoDB.  This article applies to both the free and paid versions of Studio 3T.  Speak with your DBA to connect to User-Managed or MongoDB Atlas. 

• Alteryx Server
  • Versions 2018.3+
  • Admin access to Alteryx Server machine (Controller node if multi-node configuration)
• Studio 3T (Download here)

• Gather your connection details
  • Open Alteryx System Settings on the Server (Controller) machine.
  • Gather the following information from the Controller > Persistence > Database section:
    • Host
    • Username
    • Password (not the Admin Password) 

The Server MongoDB has three databases:

• AlteryxGallery
• AlteryxGallery_Lucene
• AlteryxService

Connect to AlteryxGallery database

• Open Studio 3T
• Select File > Connect...
• Click "New Connection"
  • Select "Manually configure my connection settings" and click "Next"
  • 
• In the "New Connection" window
  • Connection name: AlteryxGallery
  • "Server" Tab
    • Server: localhost (if connecting from Controller Node) or machine name/IP if connecting remotely
    • Port: 27018
    • 
  • "Authentication" Tab
    • Authentication Mode: Basic (SCRAM-SHA-256)
    • User name: user
    • Password: <password gathered from Alteryx System Settings>
    • Authentication DB: AlteryxGallery
    • 
    • Click "Test Connection" to confirm the connection was set up correctly.
    • 
    • Click "Save".

Connect to AlteryxService and AlteryxGallery_Lucene databases

• Follow the same process above with the following changes:
  • Change "Connection name" and "Authentication DB" to AlteryxService to connect to AlteryxService database.
  • Change "Connection name" and "Authentication DB" to AlteryxGallery_Lucene to connect to AlteryxLucene database.
• You can also clone a preexisting connection via the Connection Manager (File > Connect > Clone) and change the above fields so you don't have to reinput the User name and Password.  These credentials are the same for all three MongoDB databases.  

Common Issues

• "Authentication Failed" message when connecting.
  • 
  • Confirm the User name and Password for your connection are correct.
• "Socket error: Connection refused: no further information"
  • 
  • Make sure the Alteryx Service is running via Windows.  

• MongoDB Schema Reference | Alteryx Help