Difference between revisions of "Running ETL Scenarios"

From Toolsverse Knowledge Base
Jump to: navigation, search
(Running ETL scenario using standalone executable)
(Running ETL scenario using standalone executable)
Line 193: Line 193:
You can also set the name of the XML configuration file (connections):
You can also set the name of the XML configuration file (connections):
<pre>etl.exe -Detl.config.name=import_data_config.xml<.pre>
<pre>etl.exe -Detl.config.name=import_data_config.xml</pre>
Last but not least you can use properties file to define XML configuration file (connections):
Last but not least you can use properties file to define XML configuration file (connections):

Revision as of 22:45, 8 February 2015

Embedding ETL scenario into existing Java application

There are three easy steps:

  1. Instantiate EtlConfig
  2. Instantiate EtlProcess
  3. Execute scenario


public static void main(String[] args)
        LoadScenarioAndConfigurationFromFile engine = new LoadScenarioAndConfigurationFromFile();
            // instantiates ETL configuration
            EtlConfig etlConfig = new EtlConfig();
            // set log level to INFO which increases verbosity of the etl engine
            Logger.setLevel(EtlLogger.class, Logger.INFO);
            // creates embedded ETL process
            EtlProcess etlProcess = new EtlProcess(EtlProcess.EtlMode.EMBEDDED);
            // print out framework version
                    + " "
                    + SystemConfig.instance().getSystemProperty(
            // load configuration which contains source and destination
            // connections and ETL scenario name. Load and execute ETL scenario.
            // If no full path
            // provided the configuration file test_etl_config.xml is expected
            // to be under app_home/config
            EtlResponse response = engine.loadConfigAndExecute(etlConfig,
                    "test_etl_config.xml", etlProcess);
            // print out formatted output from the ETL response
        catch (Exception ex)

Look at other examples of embedding ETL engine into Java application.

Using Web service to run ETL scenario

To run ETL scenario using Web service you need to have ETL server installed, configured, up and running. Please read here how to install and configure ETL server.

You will also need to specify -Dnetwork.appserverurl JVM option.



You can use ETL_FRAMEWORK_HOME/config/etl.properties to set network.appserverurl or set it programmatically:

app.title=ETL Framework

Once server is configured using Web service is as easy as:

  1. Instantiating EtlConfig and adding all required connection information
  2. Instantiating instance and initializing EtlRequest
  3. Instantiating instance of the EtlService interface using ServiceFactory and appropriate dynamic proxy
  4. Calling EtlService#executeEtl


 * Creates connection aliases for ETL process, sets scenario name, remotely executes ETL scenario.
 * @return ETL response
 * @throws Exception in case of any error
private EtlResponse execute()
        throws Exception
        // initializes system config, loads properties
        // instantiates ETL config
        EtlConfig config = new EtlConfig();
        // initializes ETl config
        // creates source alias
        Alias source = new Alias();
        source.setName("Java DB");
        // creates destination alias
        Alias destination = new Alias();
        destination.setName("JSON files");
        // adds aliases. ETL process will create connections from these aliases
        config.addAliasToMap(EtlConfig.SOURCE_CONNECTION_NAME, source);
        config.addAliasToMap(EtlConfig.DEST_CONNECTION_NAME, destination);
        // creates empty ETL scenario, sets ETL action. The remote ETL process
        // will load it from file at the run-time.
        Scenario scenario = new Scenario();
        // creates ETL request using given config, scenario and log level
        EtlRequest request = new EtlRequest(config, scenario, Logger.INFO);
        if (Utils.isNothing(SystemConfig.instance().getSystemProperty(
        // gets ETL service from the factory. The ServiceProxyWeb used as a
        // dynamic proxy
        EtlService etlService = ServiceFactory.getService(EtlService.class,
        // remotely executes ETL process
        return etlService.executeEtl(request);

Running ETL scenario using standalone executable

  1. Open APP_HOME/config/etl_config.xml file in your favorite text editor.
  2. Add connections for the particular ETL scenario
  3. Specify connections to use and scenarios to run
  4. Save
  5. Run ETL executable. For example c:\etl\etl.exe on Windows
  6. When it is finished check the etl.log file located under APP_HOME/logs

Example of the etl_config.xml:

<?xml version="1.0" encoding="UTF-8"?>
      <connection alias="test javadb">
      <connection alias="test oracle">
         <driver>oracle.jdbc.driver.OracleDriver </driver>
         <source alias="test javadb" />
      <destination alias="test oracle"/> 
       <scenario name="move.xml" action="extract_load" />

In this example move.xml ETL scenario located under the {app.data}/scenario folder will be executed using extract_load action. Alias test javadb will be used for the source connection and alias test oracle for the destination.

You can pass properties file name (or any other -D property) as a command line argument:

etl.exe -Dconfig.file.name=import_data.properties

You can also set the name of the XML configuration file (connections):

etl.exe -Detl.config.name=import_data_config.xml

Last but not least you can use properties file to define XML configuration file (connections):

# don't modify
app.title=ETL Framework

Creating and running ETL scenario using Data Explorer

The best way to create, run and schedule ETL, data integration and data migration scenario is using Data Explorer - an integrated ETL IDE.