Skip to Content

OData connection guide


This guide describes the system requirements and instructions for connecting Vinyl to an OData Data Server. This guide assumes you have an existing OData Data Server that you are looking to connect to Vinyl.

After connecting to an OData Data Server, and importing the desired data to work with, you can view, edit, and manipulate the OData information from Vinyl.

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

System requirements

Database server

  • OData Data Server

Client web browser

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84+

Connection instructions

Add a data source

  1. From the Vinyl app you wish to add the Data Source, navigate to the App Workbench

  2. Click the Data Sources tile

  3. Click + Source

  4. Select New Connection

  5. Click Next

  6. Select the Cloud as the Connection Category

  7. Search for OData and Select it


  8. Click Next

  9. Click the Skip button. Adding a Security Provider is outside the scope of this guide.

  10. Assign a Server Name. For example: OData

  11. Enter the Url, which represents the secure URL provided by OData to connect to the database. For example:

  12. Click Next

  13. Review the summary page information and click Done

Import the OData data

  1. Navigate to App Workbench > Data Sources

  2. Select the OData Data Source

  3. Click the Import button

  4. From Import Capabilities, provide information in Import Pattern to instruct Vinyl what data to import. For example: Customer

  5. Click Save

  6. Click the Import button

  7. Click Proceed


  8. Vinyl will now import the schema as a background task