Skip to Content

Oracle connection guide


This guide describes the system requirements and instructions for connecting Vinyl to an Oracle database server.

After you configure an Oracle Data Server connection in Vinyl, you create Oracle Data Sources to import Oracle schema in a Vinyl application, allowing you to expose the data and interact with it through Vinyl.

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

System requirements

Database server

Oracle Database Server

Client web browser

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84+

Connection instructions

Adding a data server

  1. Navigate to the Vinyl IDE

  2. From the Connect menu, click on Data Servers

  3. Click the + Server button on the top left of the Data Servers panel. This will bring up the Server page. Provide the following information:

    • Name: An identifiable and unique server name. For example: Oracle

    • Type: Select Oracle from the dropdown menu

    • Host Name: The hostname of your Oracle server. For example: int-oracle-

    • Port: The port number for the Oracle server. The default port is 1433.

    • Instance Name: Enter the Oracle schema name. This value is required for connecting to an Oracle server. For example: ORCL

    • User Name: The user name used to access the Oracle database server

    • Password: The password associated with the above user name

    • Advanced Settings: Includes the Ping Timeout setting, which determines the amount of time (in seconds) that Vinyl will wait for a ping back from the server before declaring a timeout.


  4. After filling in all necessary credentials, click the Save button

Testing the connection

From Testing, click the Test Connection button to make sure the server is properly configured

Adding a data source

After the server settings have been saved, the Oracle database (or schema) needs to be connected to a Vinyl app. Databases that are connected to Vinyl apps are referred to as a data source.

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

  2. Click the Data Sources tile

  3. Click the + Source button

  4. Select New source on existing connection

  5. Click Next

  6. Select the Oracle Data server configured

  7. Click Next

  8. Select the Oracle schema you want to import

  9. Click Next

  10. Click Proceed

  11. Review the available Tables, Views, and Procedures and either click Import Schema > Proceed for an individual Table or click Import All > Proceed if you intend to import all available data


  12. Review the Summary screen information and click Done