Skip to Content

MongoDB connection guide 3.3


This guide describes the system requirements and instructions for connecting Vinyl to a Mongo database server.

To connect your servers, you must have Vinyl 3.3+ installed.

System requirements

Database server

Mongo Database Server

Client web browser

  • Chrome TM 60 or newer

  • Firefox ® 55 or newer

  • Safari ® 11.0.2 or newer

Connection instructions

Adding a server

  1. Navigate to the Vinyl IDE

  2. From the Connect menu, click the Data Servers button

  3. Click the + Server button on the top left of the Data Servers panel. This will bring up the Add Server page.

    • Server Name: Identifiable name for server connection

    • Type: Mongo

    • Host Name: Host URL associated with MongoDB Database instance

    • Port: Will populate with 27017 but double check server settings to see if it is different from default port (in this example, uses 52207 instead of default)

    • Instance Name: Name of your Mongo instance

    • Use SSL: Check server settings, like Port, this can vary

    • User Name/Password: Credentials associated with MongoDB Database instance


  4. Click Save to complete server connection

  5. From Testing, click Test Connection to ensure connection works properly

Importing database

  1. Navigate to the Vinyl IDE

  2. From the Connect menu, click the Data Servers button

  3. Locate the Mongo data server connection created and select it

  4. Click the Details button from the Mongo data server entry in the right-hand panel


  5. Click the Import button


Create a seed record for the database

  1. In the Dev Mongo database instance add a seed record fully populating all columns

  2. RDP on the App Server and create a folder that won't be erased for storing an output of your schema

  3. In Vinyl Dev, go to the IDE > Data Servers and locate the entry for the Mongo Data Server. Click Details > Advanced Settings and add the following Parameters to the Advanced field, making sure to point to the folder created in Step 2: GenerateSchemaFiles=OnUse;Location={{ YourFilePath }}


  4. Stop and Start IIS

  5. In Vinyl run the Results of each of the collections. Back in your App Server folder you should see a {{ collectionname }}.rsd file generated.

  6. Open the {{ collectionname }}.rsd file in your preferred text editor program and verify the schema looks correct

  7. Now back in Vinyl, remove the additional Parameters added in Step 3 and replace them with the following: Tables={{ CollectionName }};Location={{ YourFilePath }}

    1. If you have more than one Collection, in the Table= Parameter make sure to separate these with a comma

    Graphical user interface, application Description automatically generated

  8. Stop and Start IIS