Getting Started

You have to go through the following steps in order to be able to start to create Oracle Data Integrator objects using the ODI Generator tool:

  1. Check the prerequisites.
  2. Download and install ODI Generator.
  3. Install ODI SDK files.
  4. Modify the configuration file (optional).
  5. Download and install the example project.
  6. Launch ODI Generator
  7. Connect to an ODI repository.
  8. Create ODI objects.


1. Check the prerequisites

ODI Generator is a Java tool that makes use of Oracle Data Integrator SDK. For this reason, the following software components should be installed on the computer where the ODI Generator runs:

  • Oracle JDK 1.8.0_181+ 64bit
  • ODI Studio or ODI (corresponding to ODI Generator versions available to download).

The required JDK version depends on the version of ODI 12.2.1+ used with the tool. Check the Oracle Fusion Middleware 12c Certification Matrix document for the ODI version you want to use with ODI Generator to find out which JDK version you need to have installed on your computer.

2. Download and install ODI Generator

Go to and download the ODI Generation zip file. ODI Generator version reflects the ODI version with which it is compatible. Currently, it is possible to download only the versions compatible with ODI and ODI 12.2.4. 



Other versions are available on request. Please contact us if a version that is not mentioned above is required.

To install the tool, extract the content of the zip file to a location on your computer. If the downloaded file is not corrupted, after the extraction you will get a folder content like shown below. For version the folder name will be odigenerator_12.2.1.4. The folder name can be changed after the installation.



3. Install ODI SDK files

As ODI SDK jar files cannot be provided via the site it is necessary to install them from the ODI Studio installation available on your computer. To install them, open the file Install_3rd_party_libs.bat provided with ODI Generator and set the value of the ORACLE_HOME variable accordingly. It should contain the location of the ODI Studio installation. Please make sure that the version of ODI Studio indicated by this variable and the version of ODI Generator is the same.

Install 3rd party files

After changing the value of the ORACLE_HOME variable in the file, open a command-line window, change the current directory to the folder where the ODI Generator tool is installed (i.e. C:\Software\odigenerator_12.2.1.3) and execute the Install_3rd_party_libs.bat file.

Check the log for errors. If the ORACLE_HOME variable was correctly set in the Install_3rd_party_libs.bat file, after the execution is finished, ODI SDK files should have been copied to odigenlib\modules\ext\org.pecheasoft.odigen-odi-library\oracle-odi folder. Please check that this folder is not empty.

If the folder is empty after was Install_3rd_party_libs.bat executed please make sure you have correctly set the value of  ORACLE_HOME.


4. Modify the configuration file

You might have to change the ODI Generator's configuration file if one of the following situations occur:

  • The JDK required by ODI Generator is not your default JDK and/or java executable is not in the PATH environment variable
  • You need to pass additional parameters to JDK (i.e. to indicate the location of tnsnames.ora file)

The configuration file is named odigengui.conf and can be found on the etc folder of your installation. To explicitly set the location of the JDK to be used by the tool uncomment and set accordingly the variable jdkhome. To provide additional parameters to the tool and/or to JDK edit the variable default_options.

config file


5. Download and install the example project

An ODI Generator project is a collection of folders and files organized hierarchically. There are several types of files contained in such a project:

  • ODI repository connection files (i.e. a plain text file containing the properties required to connect to an ODI Repository)
  • Relational database connection files (i.e. a plain text file containing the properties required to connect to a relational database)
  • Datastores and mappings files (i.e. plain text files containing datastores definitions and SQL statements used to create ODI mappings)
  • Template files
  • Files produced by the reverse engineering process.

The example project can be downloaded using the following link:

Extract the content of the downloaded zip file to a location of your choice on your computer. If the zip file was downloaded without errors, after extraction, the content of the folder will look like this:

demo project

6. Launch ODI Generator 

To start the ODI Generator tool, execute odigengui.exe or odigengui64.exe files which can be found in the bin folder. If the tool was correctly configured, the graphic interface will start, looking like below:

tool start 1

On the tool's main menu select View -> IDE Log, to display the log console and check if any error is present. Some warnings are shown but you can ignore them.

tool start 2

If any error is shown on the log console, please check if the configuration process was correctly performed. If you are sure the configuration was correctly done but you still got errors, please contact us.


7. Connect to an ODI repository

To start working with ODI Generator you need to open the demo project provided and create/import a connection to an ODI work repository. To open a project, use the File -> Open Project... menu entry or the Open Project... button from the main toolbar. In the File chooser dialog select the folder containing the demo project you have downloaded from the site (i.e. C:\Projects\Demo Project) and press the Open Project button.

open project 1

After this, you will see Projects, Files, and Service tabs opening on the left side. You can close the Services tab.

open project 2

In order to import an ODI connection created with ODI Studio, on the Projects tab expand Connections and select Oracle Data Integrator node then click the Import button on the main toolbar. On the file chooser dialog which opens select snp_login_work_12.xml file then press the Open button.

Import connection

The tool will show a list of ODI connections which you can import in the Connections folder of the ODI Generator tool. Select one or more connections that you want to import then press OK. 

Import connection 2

Few seconds after you should see that selected ODI connections have been imported.

Import connection 3

Finally, select the ODI connection corresponding to the ODI work repository where you want to create ODI objects and press the Connect button from the main toolbar. On the login dialog shown after press the Login button.

connect odi 1

If the login process is successful the ODI Explorer button on the main toolbar becomes active. You can also check the log info show in the IDE Log console. You should see log messages indicating that ODI Generator successfully connected to an ODI work repository.

connect odi 2

At this point, you can start creating ODI objects using ODI Generator.


8. Create ODI objects

 ODI Generator is using statements written in a language using a SQL-like syntax to create, change, delete ODI objects like datastores, mapping, reusable mapping, packages, and scenarios.

The provided demo project contains some files on which you can find examples of statements used to create ODI objects. The example files can be found on the Examples\Demo scripts folder of the demo project.

The examples require the existence of the following logical schemas: 

Logical schema name  Technology


Please create these logical schemas in your ODI repository before running the examples provided in the demo project.

To view/edit and execute a script, select the Files tab, then go to Examples -> Demo scripts folder and double click on the example file which you want to see/execute. The respective file will be opened in a dedicated tab. Press the Run button on the main toolbar to execute the file. Please execute the example files sequentially as files with higher-order numbers are referencing objects create by files with a lower-order number.

execute 1