Oracle Data Integrator

The Oracle Data Integrator (ODI) Connector allows you to use the powerful Redwood scheduling engine and integrate the running of Load Plans and Scenarios into existing workflows. For example, another job may be configured to write some data to a database, when the data is available, an ODI Load Plan or Scenario can be triggered to perform further processing or ETL on the data.

Prerequisites

Contents

Object Type Name Description
Folder GLOBAL.Redwood.REDWOOD.DataIntegrator.$2 Provides definitions to run ODI Load Plans and Scenarios
Job Definition Redwood_DataIntegrator_RunLoadPlan Run an existing ODI Load Plan
Job Definition Redwood_DataIntegrator_RunScenario Run an existing ODI Scenario
Job Definition Redwood_DataIntegrator_LoadPlanTemplate Template for running an existing ODI Load Plan
Job Definition Redwood_DataIntegrator_ScenarioTemplate Template for running an existing ODI Scenario
Constraint Definition REDWOOD.Redwood_DataIntegrator_ODIConnectionConstraint Constraint for Oracle Data Integrator Connection fields
Extension Point REDWOOD.Redwood_DataIntegrator Oracle Data Integrator
Job Definition Type REDWOOD.Redwood_DataIntegrator Oracle Data Integrator Job Definition
Library REDWOOD.Redwood_DataIntegrator Oracle Data Integrator Library containing all dependencies

Setup

  1. Locate the ODI Connector in the Catalog and install it.
  2. Navigate to Configure > Admin > Security > Connections.
  3. Click New.
  4. Select the ODI Connection type.
  5. Click Next or Basic Properties, then create a Queue and Job Server for the Connection. All required settings will be set up automatically.
  6. Click Next or Security, then click to specify which roles can access the connection information. It is recommended to grant the role at least the following additional privileges: View on the ODI Job Server, View Processes on the ODI Queue, View on library Redwood_DataIntegrator, and Run on any Job Definitions users with this role are to submit.
  7. Click Next or ODI Properties and specify the Runtime Agent URL, Username, Password, and Work Repository for the Connection.
  8. Navigate to Configure > Control > Job Servers, locate the ODI Connector Job Server, start it, and make sure it reaches status Running.

Job Definitions

Redwood_DataIntegrator_RunLoadPlan

Runs an existing ODI Load Plan and monitor until completion.

This Job Definition executes an existing ODI Load Plan and waits for completion. An exception is thrown and the Job fails if any of the required Parameters are not specified or if they do not evaluate to a valid value (e.g. specified load plan, context, etc do not exist). The Job will complete in success if the Load Plan succeeds. If the Load Plan execution fails, the Job will complete in failure with a return code of 1. If the Redwood Job is killed while the Load Plan is still running, it will issue a cancel command to ODI to attempt to cancel the Load Plan.

In Parameters

Name Display Name Description Type Required
connection Connection The name of the Connection object that defines the connection the desired ODI Work Repository. Provides a drop down list of all available ODI connections from the Connection Management app. The user picks the name of an existing ODI Connection that has been defined in the connections app. String Yes
loadPlan Load Plan Name The name of the existing ODI Load Plan to run. String Yes
context Context The execution context to start the session in. String Yes
logLevel Log Level The log level to set for the ODI session. All tasks with a defined log level that is lower than this value will be kept in the session log when the session completes. Accepts a single-digit value from 0-6 that indicates the level of logging to keep after the session completes. All tasks with a defined log level that is lower than this value will be kept in the session log when the session completes.; defaults to 5. String Yes
keywords Keywords A comma-separated list of keywords to attach to the session. Takes a comma-separated list of keywords to attach to the session. This is used to help identify the session. String no
variables Variables A comma-separated list of key=value pairs where the key is the name of a project or global variable and the value is the value to provide to that variable for the session. String no

Redwood_DataIntegrator_LoadPlanTemplate

Template for running an ODI Load Plan. This Job Definition is a template to allow users to create Job Definitions that run specific Load Plans. It has the same Parameters and functionality as the Redwood_DataIntegrator_RunLoadPlan Job Definition, but it is marked as a template.

This template allows the user to expose individual variables as Parameters. To expose a variable as a Parameter after cloning the template, you can create one or more Parameters with the name prefix PAR_, and assign them to a Parameter Group named Parameters. At runtime, any Parameters matching these characteristics will be sent to the Load Plan as variables. For example, if a Parameter is named PAR_Variable1 and its value is set to Test, a variable called Variable 1 with the value of Test will be sent to the Load Plan at runtime.

Redwood_DataIntegrator_RunScenario

This Job Definition executes an existing ODI Scenario and waits for completion. An exception is thrown and the Job fails if any of the required Parameters are not specified or if they do not evaluate to a valid value (e.g. specified load plan, context, etc do not exist). The Job will complete successfully if the Scenario succeeds. If the Scenario execution fails, the Job will complete in failure with a return code of 1.

In Parameters

Name Display Name Description Type Required
connection Connection The name of the Connection object that defines the connection the desired ODI Work Repository. Provides a drop down list of all available ODI connections from the Connection Management app. The user picks the name of an existing ODI Connection that has been defined in the connections app. String Yes
scenarioName Scenario Name The name of the existing ODI Scenario to run. String Yes
scenarioVersion Scenario Version The version of the Scenario to run. Specifying Latest (default) will run the latest version. The version of the scenario to run. When Latest is specified, the code will pass a value of -1 to the web service which tells it to run the latest version of the scenario. String Yes
context Context The execution context to start the session in. String Yes
logLevel Log Level The log level to set for the ODI session. All tasks with a defined log level that is lower than this value will be kept in the session log when the session completes. Accepts 0-6, defaults to 5. String Yes
sessionName Session Name The name to use to identify the session that the Scenario runs in. If omitted, the Scenario name will be used as the session name. String No
keywords Keywords A comma-separated list of keywords to attach to the session. String
variables Variables A comma-separated list of key=value pairs where the key is the name of a project or global variable and the value is the value to provide to that variable for the session. String no

Redwood_DataIntegrator_ScenarioTemplate

This definition is a template that lets you create Job Definitions that run specific Scenarios. It has the same Parameters and functionality as the Redwood_DataIntegrator_RunScenario Job Definition, but it is marked as a template.

Exposing Variables as Parameters

The template Job Definitions let you expose individual variables as Parameters. To expose a variable as a Parameter after cloning the template, you can create one or more Parameters with the name prefix PAR_, and assign them to a Parameter Group named Parameters. At runtime, any Parameters matching these characteristics will be sent to the Scenario as variables. For example, if a Parameter is named PAR_Variable1 and its value is set to Test, a variable called Variable 1 with the value of Test will be sent to the Scenario at runtime.