Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Data Integrator
11
g
Release 1 (11.1.1)
Part Number E12643-04
Home
Book List
Master Index
Contact Us
Next
View PDF
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's New In Oracle Data Integrator?
New Features in Oracle Data Integrator 11gR1 PS1 (11.1.1.5)
New Features in Oracle Data Integrator 11gR1 (11.1.1.3)
Part I Understanding Oracle Data Integrator
1
Introduction to Oracle Data Integrator
1.1
Introduction to Data Integration with Oracle Data Integrator
1.1.1
Data Integration
1.1.2
Oracle Data Integrator
1.1.3
E-LT
1.2
Oracle Data Integrator Concepts
1.2.1
Introduction to Declarative Design
1.2.2
Introduction to Knowledge Modules
1.2.3
Introduction to Integration Interfaces
1.2.3.1
Datastores
1.2.3.2
Declarative Rules
1.2.3.3
Data Flow
1.3
Typical ODI Integration Projects
1.3.1
Batch Oriented Integration
1.3.2
Event Oriented Integration
1.3.3
Service-Oriented Architecture
1.3.4
Data Quality with ODI
1.3.5
Managing Environments
1.4
Oracle Data Integrator Architecture
1.4.1
Repositories
1.4.2
User Interfaces
1.4.3
Design-time Projects
1.4.4
Run-Time Agent
2
Oracle Data Integrator QuickStart
2.1
Oracle Data Integrator QuickStart List
Part II Administering the Oracle Data Integrator Architecture
3
Administering the Oracle Data Integrator Repositories
3.1
Introduction to Oracle Data Integrator Repositories
3.2
Creating Repository Storage Spaces
3.3
Creating the Master Repository
3.4
Connecting to the Master Repository
3.5
Creating a Work Repository
3.6
Connecting to a Work Repository
3.7
Changing the Work Repository Password
3.8
Advanced Actions for Administering Repositories
3.8.1
Attaching and Deleting a Work Repository
3.8.2
Erasing a Work Repository
3.8.3
Renumbering Repositories
3.8.4
Tuning the Repository
4
Setting-up the Topology
4.1
Introduction to the Oracle Data Integrator Topology
4.1.1
Physical Architecture
4.1.2
Contexts
4.1.3
Logical Architecture
4.1.4
Agents
4.1.5
Languages
4.1.6
Repositories
4.2
Setting Up the Topology
4.2.1
Creating a Context
4.2.2
Creating a Data Server
4.2.2.1
Pre-requisites and Guidelines
4.2.2.2
Creating a Data Server
4.2.2.3
Creating a Data Server (Advanced Settings)
4.2.2.4
Testing a Data Server Connection
4.2.3
Creating a Physical Schema
4.2.4
Creating a Logical Schema
4.2.5
Creating a Physical Agent
4.2.6
Creating a Logical Agent
4.3
Managing Agents
4.3.1
Standalone Agent
4.3.1.1
Configuring the Standalone Agent
4.3.1.2
Launching a Standalone Agent
4.3.1.3
Stopping an Agent
4.3.2
Java EE Agent
4.3.2.1
Deploying an Agent in a Java EE Application Server (Oracle WebLogic Server)
4.3.2.1.1
Define the Java EE Agent in the Topology
4.3.2.1.2
Create an WLS template for the Java EE Agent
4.3.2.2
Deploying Datasources from Oracle Data Integrator in WLS for an Agent
4.3.3
Load Balancing Agents
4.3.3.1
Delegating Sessions
4.3.3.2
Agent Unavailable
4.3.3.3
Setting Up Load Balancing
Part III Managing and Reverse-Engineering Metadata
5
Creating and Reverse-Engineering a Model
5.1
Introduction to Models
5.1.1
Datastores
5.1.2
Data Integrity
5.1.3
Reverse-engineering
5.1.4
Changed Data Capture
5.2
Creating and Reverse-Engineering a Model
5.2.1
Creating a Model
5.2.2
Reverse-engineering a Model
5.3
Creating and Reverse-Engineering a Datastore
5.3.1
Creating a Datastore
5.3.2
Reverse-Engineering File Datastores
5.3.2.1
Reverse-Engineering Fixed Files
5.3.2.2
Reverse-Engineering Delimited Files
5.3.2.3
Reverse-Engineering COBOL Files
5.3.3
Adding and Deleting Datastore Columns
5.3.4
Adding and Deleting Constraints and Filters
5.3.4.1
Keys
5.3.4.2
References
5.3.4.3
Conditions
5.3.4.4
Mandatory Columns
5.3.4.5
Filter
5.4
Editing and Viewing a Datastore's Data
5.5
Using Partitioning
5.5.1
Defining Manually Partitions and Sub-Partitions of Model Datastores
5.6
Checking Data Quality in a Model
5.6.1
Introduction to Data Integrity
5.6.2
Checking a Constraint
5.6.3
Perform a Static Check on a Model, Sub-Model or Datastore
5.6.4
Reviewing Erroneous Records
6
Working with Common Format Designer
6.1
Introduction to Common Format Designer
6.1.1
What is a Diagram?
6.1.2
Why assemble datastores and columns from other models?
6.1.3
Graphical Synonyms
6.2
Using the Diagram
6.2.1
Creating a New Diagram
6.2.2
Create Datastores and Columns
6.2.3
Creating Graphical Synonyms
6.2.4
Creating and Editing Constraints and Filters
6.2.5
Printing a Diagram
6.3
Generating DDL scripts
6.4
Generating Interface IN/OUT
7
Working with Changed Data Capture
7.1
Introduction to Changed Data Capture
7.1.1
The Journalizing Components
7.1.2
Simple vs. Consistent Set Journalizing
7.2
Setting up Journalizing
7.2.1
Setting up and Starting Journalizing
7.2.2
Journalizing Infrastructure Details
7.2.3
Journalizing Status
7.3
Using Changed Data
7.3.1
Viewing Changed Data
7.3.2
Using Changed Data: Simple Journalizing
7.3.3
Using Changed Data: Consistent Set Journalizing
7.3.4
Journalizing Tools
7.3.5
Package Templates for Using Journalizing
8
Working with Data Services
8.1
Introduction to Data Services
8.2
Setting Up Data Services
8.2.1
Configuring the Web Services Container
8.2.2
Setting up the Data Sources
8.2.3
Configuring the Model
8.3
Generating and Deploying Data Services
8.3.1
Generating and Deploying Data Services
8.3.2
Overview of Generated Services
8.3.3
Testing Data Services
Part IV Developing Integration Projects
9
Creating an Integration Project
9.1
Introduction to Integration Projects
9.1.1
Oracle Data Integrator Project Components
9.1.1.1
Oracle Data Integrator Project Components
9.1.1.2
Global Components
9.1.2
Project Life Cycle
9.2
Creating a New Project
9.3
Managing Knowledge Modules
9.3.1
Knowledge Modules Naming Convention
9.3.2
Choosing the Right Knowledge Modules
9.3.3
Importing and Replacing Knowledge Modules
9.3.4
Encrypting and Decrypting a KM
9.4
Organizing the Project with Folders
10
Working with Packages
10.1
Introduction to Packages
10.1.1
Introduction to Steps
10.1.2
Introduction to Creating Packages
10.1.3
Introduction to the Package editor
10.2
Creating a new Package
10.3
Working with Steps
10.3.1
Adding a Step
10.3.1.1
Executing an Interface
10.3.1.2
Executing a Procedure
10.3.1.3
Variable Steps
10.3.1.4
Adding Oracle Data Integrator Tool Steps
10.3.1.5
Model, Sub-Models and Datastore Related Steps
10.3.1.6
Checking a Model, Sub-Model or Datastore
10.3.1.7
Journalizing a Model or a Datastore
10.3.1.8
Reverse-Engineering a Model
10.3.2
Deleting a Step
10.3.3
Duplicating a Step
10.3.4
Running a Step
10.3.5
Editing a Step's Linked Object
10.3.6
Arranging the Steps Layout
10.4
Defining the Sequence of Steps
10.5
Running the Package
11
Working with Integration Interfaces
11.1
Introduction to Integration Interfaces
11.1.1
Components of an Integration Interface
11.2
Introduction to the Interface Editor
11.3
Creating an Interface
11.3.1
Create a New Interface
11.3.2
Define the Target Datastore
11.3.2.1
Permanent Target Datastore
11.3.2.2
Temporary Target Datastore
11.3.2.3
Define the Update Key
11.3.3
Define the Datasets
11.3.4
Define the Source Datastores and Lookups
11.3.4.1
Define the Source Datastores
11.3.4.2
Define Lookups
11.3.4.3
Define Filters on the Sources
11.3.4.4
Define Joins between Sources
11.3.5
Define the Mappings
11.3.6
Define the Interface Flow
11.3.7
Set up Flow Control and Post-Integration Control
11.3.7.1
Set up Flow Control
11.3.7.2
Set up Post-Integration Control
11.3.8
Execute the Integration Interface
11.4
Using the Quick-Edit Editor
11.4.1
Adding and Removing a Component
11.4.1.1
Adding Components
11.4.1.2
Removing Components
11.4.2
Editing a Component
11.4.3
Adding, Removing, and Configuring Datasets
11.4.4
Changing the Target DataStore
11.4.5
Customizing Tables
11.4.6
Using Keyboard Navigation for Common Tasks
11.5
Designing Integration Interfaces: E-LT- and ETL-Style Interfaces
12
Working with Procedures, Variables, Sequences, and User Functions
12.1
Working with Procedures
12.1.1
Introduction to Procedures
12.1.2
Creating Procedures
12.1.2.1
Create a New Procedure
12.1.2.2
Define the Procedure's Options
12.1.2.3
Create and Manage the Procedure's Commands
12.1.3
Using Procedures
12.1.3.1
Executing the Procedure
12.1.3.2
Using a Procedure in a Package
12.1.3.3
Generating a Scenario for a Procedure
12.1.4
Encrypting and Decrypting Procedures
12.1.4.1
Encrypting a KM or Procedure
12.1.4.2
Decrypting a KM or Procedure
12.2
Working with Variables
12.2.1
Introduction to Variables
12.2.2
Creating Variables
12.2.3
Using Variables
12.2.3.1
Using Variables in Packages
12.2.3.2
Using Variables in Interfaces
12.2.3.3
Using Variables in Object Properties
12.2.3.4
Using Variables in Procedures
12.2.3.5
Using Variables within Variables
12.2.3.6
Using Variables in the Resource Name of a Datastore
12.2.3.7
Using Variables in a Server URL
12.2.3.8
Using Variables in On Connect/Disconnect Commands
12.2.3.9
Passing a Variable to a Scenario
12.2.3.10
Generating a Scenario for a Variable
12.3
Working with Sequences
12.3.1
Introduction to Sequences
12.3.2
Creating Sequences
12.3.2.1
Creating Standard Sequences
12.3.2.2
Creating Specific Sequences
12.3.2.3
Creating Native Sequences
12.3.3
Using Sequences and Identity Columns
12.3.3.1
Tips for Using Standard and Specific Sequences
12.3.3.2
Identity Columns
12.4
Working with User Functions
12.4.1
Introduction User Functions
12.4.2
Creating User Functions
12.4.3
Using User Functions
13
Working with Scenarios
13.1
Introduction to Scenarios
13.2
Generating a Scenario
13.3
Regenerating a Scenario
13.4
Generating a Group of Scenarios
13.5
Exporting Scenarios
13.6
Importing Scenarios in Production
13.6.1
Import Scenarios
13.6.2
Replace a Scenario
13.6.3
Working with a Scenario from a Different Repository
13.7
Encrypting and Decrypting a Scenario
14
Working with Load Plans
14.1
Introduction to Load Plans
14.1.1
Load Plan Execution Lifecycle
14.1.2
Differences between Packages, Scenarios, and Load Plans
14.1.3
Load Plan Structure
14.1.4
Introduction to the Load Plan Editor
14.2
Creating a Load Plan
14.2.1
Creating a New Load Plan
14.2.2
Defining the Load Plan Step Sequence
14.2.2.1
Adding Load Plan Steps
14.2.2.2
Editing Load Plan Steps
14.2.2.3
Deleting a Step
14.2.2.4
Duplicating a Step
14.2.3
Working with Variables in Load Plans
14.2.3.1
Declaring Load Plan Variables
14.2.3.2
Setting Variable Values in a Step
14.2.4
Handling Load Plan Exceptions and Restartability
14.2.4.1
Defining Exceptions Flows
14.2.4.2
Using Exception Handling
14.2.4.3
Defining the Restart Behavior
14.3
Running Load Plans
14.4
Using Load Plans in Production
14.4.1
Running Load Plans in Production
14.4.2
Scheduling Load Plans
14.4.3
Exporting, Importing and Versioning Load Plans
14.4.3.1
Exporting Load Plans
14.4.3.2
Importing Load Plans
14.4.3.3
Versioning Load Plans
15
Working with Web Services in Oracle Data Integrator
15.1
Introduction to Web Services in Oracle Data Integrator
15.2
Data Services
15.3
Oracle Data Integrator Run-Time Services
15.4
Invoking Third-Party Web Services
15.4.1
Introduction to Web Service Invocation
15.4.2
Using the OdiInvokeWebService Tool
15.4.3
Web Service Invocation in Integration Flows
16
Working with Oracle Data Quality Products
16.1
Introduction to Oracle Data Quality Products
16.2
The Data Quality Process
16.2.1
Create a Quality Input File
16.2.2
Create an Entity
16.2.2.1
Step 1: Validate Loader Connections
16.2.2.2
Step 2: Create Entity and Import Data
16.2.2.3
Step 3: Verify Entity
16.2.3
Create a Profiling Project
16.2.4
Create a Oracle Data Quality Project
16.2.5
Export the Data Quality Project
16.2.6
Reverse-engineer the Entities
16.2.7
Use Oracle Data Quality Input and Output Files in Interfaces
16.2.8
Run this Quality Project from Oracle Data Integrator
16.2.9
Sequence the Process in a Package
Part V Managing Integration Projects
17
Organizing and Documenting your Work
17.1
Organizing Projects with Folders
17.1.1
Creating a New Folder
17.1.2
Arranging Project Folders
17.2
Organizing Models with Folders
17.2.1
Creating a New Model Folder
17.2.2
Arranging Model Folders
17.2.3
Creating and Organizing Sub-Models
17.3
Using Cross-References
17.3.1
Browsing Cross-References
17.3.2
Resolving Missing References
17.4
Using Markers and Memos
17.4.1
Markers
17.4.2
Memos
17.5
Handling Concurrent Changes
17.5.1
Concurrent Editing Check
17.5.2
Object Locking
17.6
Creating PDF Reports
17.6.1
Generating a Topology Report
17.6.2
Generating a Report for the Version Comparison Results
17.6.3
Generating a Report for an Oracle Data Integrator Object
17.6.4
Generating a Diagram Report
18
Working with Version Management
18.1
Working with Object Flags
18.2
Working with Versions
18.3
Working with the Version Comparison Tool
18.3.1
Viewing the Differences between two Versions
18.3.2
Using Comparison Filters
18.3.3
Generating and Printing a Report of your Comparison Results
18.4
Working with Solutions
18.4.1
Working with Elements in a Solution
18.4.2
Synchronizing Solutions
18.4.3
Restoring and Checking in a Solution
18.4.4
Importing and Exporting Solutions
19
Exporting/Importing
19.1
Import and Export Concepts
19.1.1
Internal Identifiers (IDs)
19.1.2
Relationships between Objects
19.1.3
Import Modes
19.1.4
Tips for Import/Export
19.2
Exporting and Importing Objects
19.2.1
Exporting one ODI Object
19.2.2
Export Multiple ODI Objects
19.2.3
Importing Objects
19.3
Repository-Level Export/Import
19.3.1
Exporting and Importing the Master Repository
19.3.2
Export/Import the Topology and Security Settings
19.3.3
Exporting and Importing a Work Repository
19.4
Exporting the Technical Environment
Part VI Running and Monitoring Integration Processes
20
Running Integration Processes
20.1
Understanding ODI Executions
20.2
Executing Interfaces, Procedures, Packages and Model Operations
20.3
Executing a Scenario
20.3.1
Executing a Scenario from ODI Studio
20.3.2
Executing a Scenario from a Command Line
20.4
Restarting a Session
20.4.1
Restarting a Session from ODI Studio
20.4.2
Restarting a Session from a Command Line
20.5
Stopping a Session
20.5.1
Stopping a Session From ODI Studio
20.5.2
Stopping a Session From a Command Line
20.6
Executing a Load Plan
20.6.1
Executing a Load Plan from ODI Studio
20.6.2
Executing a Load Plan from a Command Line
20.7
Restarting a Load Plan Run
20.7.1
Restarting a Load Plan from ODI Studio
20.7.2
Restarting a Load Plan from a Command Line
20.8
Stopping a Load Plan Run
20.8.1
Stopping a Load Plan from ODI Studio
20.8.2
Stopping a Load Plan Run from a Command Line
20.9
Scheduling Scenarios and Load Plans
20.9.1
Scheduling a Scenario or a Load Plan with the Built-in Scheduler
20.9.1.1
Scheduling a Scenario or a Load Plan
20.9.1.2
Updating an Agent's Schedule
20.9.1.3
Displaying the Schedule
20.9.2
Scheduling a Scenario or a Load Plan with an External Scheduler
20.10
Simulating an Execution
20.11
Managing Executions Using Web Services
20.11.1
Introduction to Run-Time Web Services
20.11.2
Executing a Scenario Using a Web Service
20.11.3
Monitoring a Session Status Using a Web Service
20.11.4
Restarting a Session Using a Web Service
20.11.5
Executing a Load Plan Using a Web Service
20.11.6
Stopping a Load Plan Run Using a Web Service
20.11.7
Restarting a Load Plan Instance Using a Web Service
20.11.8
Monitoring a Load Plan Run Status Using a Web Service
20.11.9
Listing Contexts Using a Web Service
20.11.10
Listing Scenarios Using a Web Service
20.11.11
Accessing the Web Service from a Command Line
20.11.12
Using the Run-Time Web Services with External Authentication
20.11.13
Using WS-Addressing
20.11.14
Using Asynchronous Web Services with Callback
21
Monitoring Integration Processes
21.1
Introduction to Monitoring
21.1.1
Introduction to Operator Navigator
21.1.2
Scenarios
21.1.3
Sessions
21.1.4
Load Plans
21.1.5
Load Plan Executions
21.1.6
Schedules
21.1.7
Log
21.1.8
Status
21.2
Monitoring Executions Results
21.2.1
Monitoring Sessions
21.2.2
Monitoring Load Plan Runs
21.2.3
Handling Failed Sessions
21.2.4
Reviewing Successful Sessions
21.2.5
Handling Failed Load Plans
21.2.6
Reviewing Successful Load Plans
21.3
Managing your Executions
21.3.1
Managing Sessions
21.3.1.1
Cleaning Stale Sessions
21.3.2
Managing Load Plan Executions
21.3.3
Managing the Log
21.3.3.1
Filtering Sessions
21.3.3.2
Purging the Log
21.3.3.3
Organizing the Log with Session Folders
21.3.3.4
Exporting and Importing Log Data
21.3.4
Managing Scenarios and Load Plans
21.3.4.1
Load Plan and Scenario Folders
21.3.4.2
Importing Load Plans, Scenarios, and Solutions in Production
21.3.5
Managing Schedules
22
Working with Oracle Data Integrator Console
22.1
Introduction to Oracle Data Integrator Console
22.1.1
Introduction to Oracle Data Integrator Console
22.1.2
Oracle Data Integrator Console Interface
22.2
Using Oracle Data Integrator Console
22.2.1
Connecting to Oracle Data Integrator Console
22.2.2
Generic User Operations
22.2.3
Managing Scenarios and Sessions
22.2.4
Managing Load Plans
22.2.5
Purging the Log
22.2.6
Using Data Lineage and Flow Map
22.2.7
Performing Administrative Operations
Part VII Managing the Security Settings
23
Managing the Security in Oracle Data Integrator
23.1
Introduction to Oracle Data Integrator Security
23.1.1
Objects, Instances and Methods
23.1.2
Profiles
23.1.3
Users
23.2
Setting up a Security Policy
23.2.1
Security Policy Approach
23.2.2
Managing Profiles
23.2.2.1
Creating a New Profile
23.2.2.2
Duplicating a Profile
23.2.2.3
Deleting a Profile
23.2.3
Managing Users
23.2.3.1
Creating a New User
23.2.3.2
Assigning a Profile to a User
23.2.3.3
Removing a Profile from a User
23.2.3.4
Deleting a User
23.2.4
Managing Privileges
23.2.4.1
Granting a Profile Method or User Method
23.2.4.2
Revoking a Profile Method or User Method
23.2.4.3
Granting an Authorization by Object Instance
23.2.4.4
Revoking an Authorization by Object Instance
23.2.4.5
Cleaning up Unused Authorizations
23.3
Advanced Security
23.3.1
Setting Up External Password Storage
23.3.1.1
Setting the Password Storage
23.3.1.2
Switching the Password Storage
23.3.1.3
Recovering the Password Storage
23.3.2
Setting Up External Authentication
23.3.2.1
Configuring ODI Components for External Authentication
23.3.2.2
Setting the Authentication Mode
23.3.2.3
Switching the Authentication Mode
23.3.3
Enforcing Password Policies
A
Oracle Data Integrator Tools Reference
A.1
Using the Oracle Data Integrator Tools
A.1.1
Using a Tool in a Package
A.1.2
Using a Tool in a Knowledge Module or a Procedure Command
A.1.3
Using a Tool from a Command Line
A.2
Using Open Tools
A.2.1
Installing and Declaring an Open Tool
A.2.1.1
Installing an Open Tool
A.2.1.2
Declaring a New Open Tool
A.2.2
Using Open Tools in a Package or Procedure
A.3
Developing Open Tools
A.3.1
Classes
A.3.2
Developing a New Open Tool
A.3.2.1
Implementing the Class
A.3.2.1.1
Declaration
A.3.2.1.2
Importing Packages
A.3.2.1.3
Defining the Parameters
A.3.2.1.4
Implementing Informational Functions
A.3.2.1.5
Execution
A.3.3
Open Tools at Run Time
A.4
ODI Tools per Category
A.4.1
Metadata
A.4.2
Oracle Data Integrator Objects
A.4.3
Utilities
A.4.4
Internet Related Tasks
A.4.5
Files
A.4.6
SAP
A.4.7
XML
A.4.8
Event Detection
A.4.9
Changed Data Capture
A.5
Alphabetic List of ODI Tools
A.5.1
OdiAnt
A.5.2
OdiBeep
A.5.3
OdiDataQuality
A.5.4
OdiDeleteScen
A.5.5
OdiExportAllScen
A.5.6
OdiExportEnvironmentInformation
A.5.7
OdiExportLog
A.5.8
OdiExportMaster
A.5.9
OdiExportObject
A.5.10
OdiExportScen
A.5.11
OdiExportWork
A.5.12
OdiFileAppend
A.5.13
OdiFileCopy
A.5.14
OdiFileDelete
A.5.15
OdiFileMove
A.5.16
OdiFileWait
A.5.17
OdiFtpGet
A.5.18
OdiFtpPut
A.5.19
OdiGenerateAllScen
A.5.20
OdiImportObject
A.5.21
OdiImportScen
A.5.22
OdiInvokeWebService
A.5.23
OdiKillAgent
A.5.24
OdiMkDir
A.5.25
OdiOSCommand
A.5.26
OdiOutFile
A.5.27
OdiPingAgent
A.5.28
OdiPurgeLog
A.5.29
OdiReadMail
A.5.30
OdiRefreshJournalCount
A.5.31
OdiReinitializeSeq
A.5.32
OdiReverseGetMetaData
A.5.33
OdiReverseResetTable
A.5.34
OdiReverseSetMetaData
A.5.35
OdiRetrieveJournalData
A.5.36
OdiSAPALEClient and OdiSAPALEClient3
A.5.37
OdiSAPALEServer and OdiSAPALEServer3
A.5.38
OdiScpGet
A.5.39
OdiScpPut
A.5.40
OdiSendMail
A.5.41
OdiSftpGet
A.5.42
OdiSftpPut
A.5.43
OdiSleep
A.5.44
OdiSqlUnload
A.5.45
OdiStartLoadPlan
A.5.46
OdiStartScen
A.5.47
OdiUnZip
A.5.48
OdiUpdateAgentSchedule
A.5.49
OdiWaitForChildSession
A.5.50
OdiWaitForData
A.5.51
OdiWaitForLogData
A.5.52
OdiWaitForTable
A.5.53
OdiXMLConcat
A.5.54
OdiXMLSplit
A.5.55
OdiZip
B
User Parameters
Scripting on this page enhances content navigation, but does not change the content in any way.