Prev Next

ODBC Connection to Oracle Repository

In order for an Enterprise Architect client to open an Oracle repository using an ODBC connection, the client machine must have the Oracle client (including the ODBC driver) installed and an ODBC DSN defined for the same architecture (32 or 64 bit) that Enterprise Architect uses.

For example, if you are using the 64 bit version of Enterprise Architect, then the client machine will need a 64 bit ODBC driver and 64 bit ODBC DSN, but if you are using the 32 bit version of Enterprise Architect then a 32 ODBC driver and DSN will be required.

Prerequisites

  • An Oracle database server
  • An Enterprise Architect repository defined in the Oracle database server
  • You know the database user credentials that have SELECT, INSERT, UPDATE, DELETE, EXECUTE access permissions to the Enterprise Architect repository
  • Oracle Client already installed on the client machine; please ensure that the OLE DB drivers are installed (you can download the drivers from the Oracle Technology Network web site, as part of the Oracle Data Access Components (ODAC) package - see Learn more)

Access

Keyboard Shortcuts

Ctrl+O : Connect to Server drop-down arrow : ODBC Connection Wizard

Other

Project list: Open Project : Connect to Server drop-down arrow : ODBC Connection Wizard

Start Page : Manage Projects : Connect to Server drop-down arrow : ODBC Connection Wizard

Install the ODBC Driver

The ODBC driver will only need to be install once on each client machine, therefore if your machine already has the appropriate Oracle client (and ODBC driver) installed you can skip to the next step.

Step

Action

1

Download the appropriate Oracle instant client for your operating system and architecture (32 or 64 bit) of Enterprise Architect from the Oracle website.

Note:

  • Installing and configuring the Oracle instant client is not a trivial task, therefore it is best to involve people with previous experience performing this task. Unfortunately Sparx Systems can not provide support for another vendors software.

2

Run the Oracle Instant Client installer, making sure to include the Oracle ODBC driver component, and perform all client configuration necessary for applications to make use of this driver.

Create ODBC DSN

A separate ODBC DSN must be created for each Oracle repository that the client wants to connect to. 

An ODBC DSN is simply the details of the database (server and database names, Port and user credentials), stored in the registry and given a unique name that allows applications (like Enterprise Architect) to easily connect to databases.

Step

Action

1

The Windows Operating System includes 2 different versions of the ODBC administrative tool, one for 32 bit and the other for 64 bit applications. Therefore you need to open the 'Open Data Source Administrator' that corresponds to the architecture of your Enterprise Architect application.  The easiest way to achieve this is to use Enterprise Architect's build-in ribbon option:  'Settings > User Tools > ODBC Data Sources'.

The ODBC Data Source Administrator window displays.

2

Click on the Add button.

The 'Create New Data Source' dialog displays, enabling you to add a new DSN.

3

Select the appropriate Oracle ODBC Driver from the list.

4

Click on the Finish button.

The 'Oracle ODBC Driver Configuration' dialog is displayed.

5

Enter these configuration details:

  • Data Source Name: (DSN), a unique name for the connection
  • Description: (optional) description of the DSN
  • TNS Service Name: The Oracle service name (as defined in the TNSNAMES.ORA) of the Oracle database
  • User ID: the database owner of repository

6

Click [Test Connection] button, you will then be prompted for the User's password, enter the Password and click [OK]  to confirm that the details are correct.

7

If the test succeeds, click on the OK button to complete the configuration.

If the test does not succeed, review your settings.

Connect to the Repository

Once the ODBC driver is installed and ODBC DSN defined on an individual machine the Enterprise Architect client can open the repository according to these steps:

Step

Action

1

Open the 'Data Link Properties' dialog using one of these methods:

Keyboard Shortcut:  Ctrl+O : Connect to Server

Start Page | Server Connection (direct to 'Open Server Connection' dialog)

Project list | Open Project : Connect to Server

Start Page : Manage Projects : Connect to Server

2

On the Provider tab select 'Microsoft OLE DB Provider for ODBC Drivers', click  [Next >>]

3

Select the ODBC DSN in the 'Use data source name' combo, click  Test Connection.

4

Once step 3 is successful, click [OK] to open the repository.

If the test does not succeed, review your settings.

Notes

  • Connecting to DBMS based Repositories is available in the Corporate, Unified and Ultimate Editions
  • As a general rule Sparx Systems usually recommends the use of the Oracle OLE DB driver over the Oracle ODBC driver due to better performance

Learn more