You are on page 1of 74

Oracle® Fusion Middleware

Using Oracle Data Integrator on Oracle Cloud


Marketplace

12.2.1.4.0
F22173-05
June 2020
Oracle Fusion Middleware Using Oracle Data Integrator on Oracle Cloud Marketplace, 12.2.1.4.0

F22173-05

Copyright © 2019, 2020, Oracle and/or its affiliates.

Primary Author: Oracle Corporation

This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed or activated on delivered hardware, and modifications of such programs)
and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government
end users are "commercial computer software" or “commercial computer software documentation” pursuant
to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works,
and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle
computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the
license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud
services are defined by the applicable contract for such services. No other rights are granted to the U.S.
Government.

This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc,
and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not
be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
Audience vi
Documentation Accessibility vi
Related Documents vi
Conventions vii

1 Getting Started with Oracle Cloud Marketplace


1.1 Prerequisites 1-1
1.2 Selecting Your Product 1-3
1.2.1 Terminology Information 1-4
1.3 Launching Your Oracle Data Integrator Instance 1-6
1.4 Connecting to ODI Compute Instance 1-10
1.5 Accessing the ODI Compute Instance 1-11
1.6 Using Autonomous Databases in ODI 1-12
1.7 Installation Locations 1-14
1.8 Log Files Location 1-14
1.9 Patching 1-14

2 Using ODI Web Studio


2.1 Introduction 2-1
2.1.1 Introduction to Oracle Data Integrator Web Studio 2-1
2.1.2 Introduction to Oracle Data Integrator Web Studio Administrator 2-2
2.1.3 Introduction to Oracle Data Integrator Repositories 2-2
2.1.4 Introduction to Oracle Data Integrator Run-Time Agent 2-2
2.2 Administering ODI Web Studio 2-2
2.2.1 Accessing ODI Web Studio Administrator 2-3
2.2.2 Creating Master and Work Repositories 2-3
2.2.3 Connecting to Repository 2-4
2.2.4 Setting Up the Connections 2-5
2.2.4.1 Creating a Data Server and Schema 2-6
2.2.5 Reverse Engineering Datastores 2-7

iii
2.2.5.1 Creating a Model 2-7
2.2.5.2 Creating Datastores 2-9
2.2.6 Monitoring and Managing your Execution Results 2-10
2.2.7 Managing Users 2-10
2.3 Working with ODI Web Studio 2-11
2.3.1 Accessing ODI Web Studio 2-12
2.3.2 Create a New Project 2-12
2.3.3 Get Started with Data Flows 2-13
2.3.4 About Data Flow Editor 2-13
2.3.5 Create a New Data Flow 2-14
2.3.5.1 Add Components 2-14
2.3.5.2 Map Data Columns 2-15
2.3.5.3 Set Target Component Options 2-16
2.3.5.4 Validate and Execute a Data Flow 2-16
2.3.6 Introduction to Workflows 2-16
2.3.7 Create a New Workflow 2-17
2.3.8 Execute a Workflow 2-17
2.3.9 Scheduling Data Flows or Workflows 2-17
2.3.10 Managing Jobs 2-18

3 Using ODI Studio


3.1 Accessing ODI Studio 3-1
3.2 Working with ODI Instance 3-3
3.2.1 Configuring Data Sources and Targets 3-4
3.2.2 Reverse Engineering Data Models 3-4
3.2.3 Creating Mappings 3-5
3.2.4 Monitoring ODI Executions 3-6

4 Managing ODI Setup


4.1 Working with ODI Linux Services 4-1
4.2 Changing Repository in ODI Web Studio/ODI Web Studio Administrator 4-2
4.3 Switching Repositories of the ODI App Server 4-2
4.4 Managing ODI App Server 4-4
4.5 Managing ODI Credential 4-6
4.6 Configuring Proxy Settings 4-6

5 Configuring ODI Marketplace Repositories on DBCS Instance

iv
6 Configuring Oracle Enterprise Manager for Oracle Fusion
Middleware on Oracle Cloud Marketplace

7 Configuring the Domain for Collocated/Java EE Agent on Oracle


Cloud Marketplace

8 Configuring High Availability for ODI on Oracle Cloud Marketplace


8.1 Setting Up 2-Node Cluster for High Availability 8-1
8.2 Configuring Horizontal Clustering 8-1
8.3 Enabling Incoming Ports and Services 8-4

9 Troubleshooting ODI on OCI

10 Known Issues and Workarounds

v
Preface

Preface
This book describes how to use Oracle Data Integrator on Oracle Cloud Marketplace.
This preface contains the following topics:
• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Audience
This document helps you to use Oracle Data Integrator on Oracle Cloud Marketplace.

Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the
Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.

Access to Oracle Support


Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.

Related Documents
For more information, see the following documents in Oracle Data Integrator Library:
• Release Notes for Oracle Data Integrator
• Understanding Oracle Data Integrator
• Developing Integration Projects with Oracle Data Integrator
• Installing and Configuring Oracle Data Integrator
• Upgrading Oracle Data Integrator
• Integrating Big Data with Oracle Data Integrator Guide
• Application Adapters Guide for Oracle Data Integrator
• Developing Knowledge Modules with Oracle Data Integrator

vi
Preface

• Connectivity and Knowledge Modules Guide for Oracle Data Integrator


Developer's Guide
• Oracle Data Integrator Tools Reference
• Data Services Java API Reference for Oracle Data Integrator
• Open Tools Java API Reference for Oracle Data Integrator
• Getting Started with SAP ABAP BW Adapter for Oracle Data Integrator
• Java API Reference for Oracle Data Integrator
• Getting Started with SAP ABAP ERP Adapter for Oracle Data Integrator
• Oracle Data Integrator 12c Online Help, which is available in ODI Studio through
the JDeveloper Help Center when you press F1 or from the main menu by
selecting Help, and then Search or Table of Contents.

Conventions
The following text conventions are used in this document:

Convention Meaning
boldface Boldface type indicates graphical user interface elements associated
with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for
which you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code
in examples, text that appears on the screen, or text that you enter.

vii
1
Getting Started with Oracle Cloud
Marketplace
Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables
customers to quickly set up and run Oracle Data Integrator (ODI) on Oracle Cloud. It
provides a fully unified solution for building, deploying, and managing complex data
warehouses or as part of data- centric architectures in a SOA or business intelligence
environment. In addition, it combines all the elements of data integration - data
movement, data synchronization, data quality, data management, and data services -
to ensure that information is timely, accurate, and consistent across complex systems.
This chapter contains the following sections:
• Prerequisites
• Selecting Your Product
• Launching Your Oracle Data Integrator Instance
• Connecting to ODI Compute Instance
• Accessing ODI Studio
• Using Autonomous Databases in ODI
• Installation Locations
• Log Files Location
• Patching

Note:
Refer to Launching Your First Linux Instance documentation before creating
the ODI instance.

1.1 Prerequisites
Make sure you have the following prerequisites before using Oracle Data Integrator on
Oracle Cloud Marketplace:
• Oracle Cloud Account
• Have access to assigned Oracle Cloud Tenant
• Compute node resources within Oracle Cloud Tenant
Go through the following prerequisites carefully before creating the ODI instance:
• Refer to Creating Dynamic Group Polices for compartment, before provisioning
ODI and ADB Instances.

1-1
Chapter 1
Prerequisites

• Read thoroughly the password policies provided in the Stack UI and create
passwords accordingly during provisioning.
• Wait till the completion of ODI instance creation, check for its status and then
proceed working on it.
For more information, refer to the usage instructions in Launching Your Oracle
Data Integrator Instance.

Supported Browsers
Oracle Cloud Infrastructure supports the latest desktop versions of Google Chrome,
Microsoft Edge, Internet Explorer 11, Safari, Firefox, and Firefox ESR. Note that
mobile browsers as well as private browsing mode is not supported for Firefox,
Internet Explorer, or Edge.

Creating an SSH/RSA Key


To work with the Oracle Cloud Infrastructure once the Oracle Data Integrator Compute
Node is built, you have to provide a SSH Public Key to allow you to login to the node.
In order to build your SSH keys, perform the following steps:
1. In a terminal window, generate the SSH key using the following command:

$ ssh-keygen Generating public/private rsa key pair.

2. Enter the path to store this file. By default, this gets saved in your home directory
under a hidden folder called .ssh. Change this default location, if required.

Enter file in which to save the key (/Users/johndoe/.ssh/id_rsa):


<Return>

3. Enter a passphrase using your key.

Enter passphrase (empty for no passphrase): <passphrase>

4. Re-enter the passphrase to confirm it.

Enter same passphrase again: <passphrase>

5. Check the results.


The key fingerprint (a colon separated series of two digit hexadecimal values) is
displayed. Check if the path to the key is correct. In the above example, the path
is /Users/johndoe/.ssh/id_rsa.pub. You have now created a public and private
key pair.

Creating Dynamic Group and Policies


During ODI Instance provisioning, data servers for all accessible Autonomous
Databases (ADB) are automatically created, as long as the dynamic group and
policies are created before deploying ODI on Marketplace and are set as mentioned
below. Dynamic Group and Policies are required when using the ODI Repository on an
Autonomous Database.

1-2
Chapter 1
Selecting Your Product

• Create a dynamic group to include matching rules for instances in a specified


compartment. For example

ALL {instance.compartment.id =
'ocid1.compartment.oc1..aaaaaaaabgr34tpuanpvq6xfb667nsmy2jz45zj6dexo
jhxdsv4mjayem3cq'}

For more information, refer to Create Dynamic Groups and Policy.


• Navigate to Identity -> Policies -> Create Policy to create policy statements as
specified below :
If you set policy at:
– ODI compartment level, then all ADW/ATP instances from the compartment
where ODI instance is created are listed.
For example - To List ADW/ATP instances only from the ODI instance
compartment, you have to setup the following policy:

Allow dynamic-group odi_group to inspect autonomous-database-


family in compartment odi
Allow dynamic-group odi_group to read autonomous-database-family
in compartment odi
Allow dynamic-group odi_group to inspect compartments in
compartment odi

– ODI tenant level, then all ADW/ATP instances from all the compartments of
the tenancy are listed.
For example - To list ADW/ATP instances from all the compartments of
tenancy, you have to setup the following policy:

Allow dynamic-group odi_group to inspect autonomous-database-


family in tenancy
Allow dynamic-group odi_group to read autonomous-database-family
in tenancy
Allow dynamic-group odi_group to inspect compartments in tenancy

1.2 Selecting Your Product


Once you have found Oracle Data Integrator from the search results on Oracle Cloud
Marketplace, the following options appear allowing you to select the required product:
1. From the application page, select Get App.
2. Select OCI Region or Login using your Single Sign-On credentials.
• OCI Region – Select the desired region and click Create Stack.
3. Provide the OCI tenant details.
4. Sign-in to the Identity provider.
5. On the Oracle Data Integrator page, provide the following information:
a. Type - It is Stack by default.
b. Version - It provides a list of product versions that are available in the listing.
They are :

1-3
Chapter 1
Selecting Your Product

• ODI Studio V12.2.1.4.0 (BYOL)


• ODI Studio V12.2.1.4.0 (DB Cloud Services Edition) - default
• ODI Web Studio V12.2.1.4.0 (DB Cloud Services Edition)
Oracle Data Integrator on Cloud Marketplace has two different versions to help
with your data transformations. They are:
• Oracle Data Integrator Web Studio - Select this product if you wish to
create and execute your data flows and work flows, monitor, manage and
if required schedule them, through an easy-to-use Web Studio interface
without requiring to write any code.

Note:
This product version is available only from ODI Web
V12.2.1.4.200618 with Bundle Patch 12.2.1.4.200618 release
and later.

• Oracle Data Integrator Studio - Select this product if you wish to


develop all your data mapping transformations using ODI Studio. This
deployment installs ODI Studio and ODI Agent with automatically created
ODI Repository (either embedded MYSQL or ADB databases) during new
ODI Compute provisioning.
Select the required product.
c. Compartment - Specifies the compartment where the compute node will be
built. It is generally the location that you have access to build the compute
node.
d. Terms of Use - This checkbox is selected by default. Oracle recommends to
review the licenses before proceeding.
e. Launch Stack - It launches the stack in the OCI environment. After selecting all
the required information, click Launch Stack.

Note:
Provisioning your instance on Oracle Cloud Marketplace greatly depends
on your product selection. You cannot use the same VM instance
for multiple product offerings . The procedure listed below are product
specific and may differ based on the product version.

1.2.1 Terminology Information


The Terminology Information used in Oracle Data Integrator Web Studio and Studio
are:

1-4
Chapter 1
Selecting Your Product

ODI Studio ODI Web Studio Functions


Data Server Connection Represents the physical object
where data is stored.
Examples include Database
Instances, File Servers, Cloud
Application Instances.The
properties contain all
information required to
connect and access data.
Technology Connection Type Examples include Oracle, IBM
DB2, Oracle Netsuite, Oracle
Object Storage.
For the list of supported
technologies, see Setting Up
the Connections
Physical Schema Schema Examples include Database
Schema, File server Folder,
Object Storage Bucket.
Data Store Data Entity A Tabular representation of
a data structure. Examples
include Database Tables,
Files.
Reverse Engineering Import to Collection or Refresh The process of obtaining the
Collection metadata for a filtered set
of objects in a Schema.
Examples include Table
Definitions from an Oracle
Schema, VOs from a Cloud
Applications Offering.
Model Collection The container for the imported
objects. The properties define
the rules for importing (how to
filter and so on).
Project Project Container for the
Transformation Design
components (Mappings,
Packages, Jobs). This
doesn't include Data Servers,
Schemas, Data Stores and
Folders (which are shared
between Projects)
Mapping Data Flow The Transformation Design.
Defines how data flows from
one Data Store to another,
and how it is transformed.
Package Workflow Defines the sequence in which
Mappings will be executed,
together with what happens of
failure conditions.
Job / Session Job The execution of a Package,
Mapping or Reverse Engineer.
Schedule Schedule The rules for when a session
executes.

1-5
Chapter 1
Launching Your Oracle Data Integrator Instance

ODI Studio ODI Web Studio Functions


Resource Resource Something you can schedule
(a mapping or package).

1.3 Launching Your Oracle Data Integrator Instance


Follow the below procedure to launch your ODI instance:
Once you click Launch Stack, you are navigated to the Create Stack page.
1. Fill in the required Stack information:
• Name - Name of the Stack. It has a default name and provides a datetime
stamp. You can edit this detail, if required.
• Description - Description that you provide while creating the Stack.
• Create In Compartment – It defaults to the compartment you have selected on
the Oracle Data Integrator for Oracle page.
• Tags (optional) – Tags are a convenient way to assign a tracking mechanism
but are not mandatory.You can assign a tag of your choice for easy tracking.
You have to assign a tag for some environments for cost analysis purposes.
• Click Next.
2. Fill in the required details to configure variables. This information is required to
build the compute node with Oracle Data Integrator.
• General Settings -
a. Networking Options - Denotes the networking options in which the
Oracle Data Integrator compute instance and all the associated network
resources have to be created. Select between two available options:
– New networking components will be created - Select this option
to have a new network (VCN) and subnet created and configured
alongside this new ODI instance. Minimal inputs are required when
you select this option.
– Existing networking components will be used - Select this option to
use the existing network components and subnets.
b. ODI Repository Location - Select between the following options for
creating a repository:
– Create a new ODI Repository in an Autonomous Database
– Connect to an existing ODI Repository in an Autonomous Database
– Create an Embedded ODI Repository
When you select the option Create a new ODI Repository in an
Autonomous Database, the repo mode created during configuration is
marked as:
– ODI Web Studio mode - when the stack product selection is Oracle
Data Integrator Web Studio.
– ODI Studio mode - when the stack product selection is Oracle Data
Integrator Studio.

1-6
Chapter 1
Launching Your Oracle Data Integrator Instance

When you select the option Connect to an existing ODI Repository in


an Autonomous Database, the repo mode created during configuration
is marked as:
– ODI Studio mode - when the stack choice is ODI Studio.
– Web Studio Mode - when the stack choice is basic and when there
are no precreated user objects in the repository. If user objects exists,
then repo will be marked as ODI Studio mode.

Note:
Oracle Data Integrator Repositories that you create during
provisioning are mode specific. You cannot use a repository
created in ODI Web Studio mode with a stack in ODI Studio
mode and you cannot access a repository created in ODI Studio
mode with a stack in ODI Web Studio mode.

c. Resource Display Name Prefix (optional) - It is the prefix added to the


display name of all the compute and network resources generated .
Display name is used to identify all new OCI resources. If you do not
specify any prefix, then it is automatically generated.
d. Target Compartment – Denotes the target compartment for all the
provisioned resources .
• Network Configuration -
– New networking components will be created -
a. Virtual Network CIDR (optional) - A single, contiguous Virtual Cloud
Network (VCN) CIDR block for the VCN. For example: 172.16.0.0/16.
You cannot change this value later.

Note:
This option is available for both new and existing modes of
network creation.

b. Create or Use a Public ODI Subnet - It creates all the ODI resources
of the newly created instance in a public subnet. This option is
selected by default. If you clear this checkbox, all the ODI resources
are created in a private subnet.
– Existing networking components with be used -
a. Virtual Network CIDR (optional) - A single, contiguous Virtual Cloud
Network (VCN) CIDR block for the VCN. For example: 172.16.0.0/16.
You cannot change this value later.
b. VCN Compartment - Specifies the VCN compartment where the
compute node will be built. It is generally the location that you have
access to build the compute node. From the Virtual cloud network
compartment drop-down list, select the compartment where your VCN
has been setup.

1-7
Chapter 1
Launching Your Oracle Data Integrator Instance

c. VCN - A VCN is a software-defined network that you set up in the


Oracle Cloud Infrastructure data centers in a particular region. Select
the desired VCN for the newly created instance. From the Virtual
cloud network drop-down list, choose your VCN.
d. Subnet Compartment - Denotes the subnet compartment to use
for the newly created instance if you are not creating a new
network. From the Subnet Compartment drop-down list, select the
compartment containing the subnet that you wish to use.
e. Subnet (optional) - Existing subnet to use for the newly created
instance if you are not creating a new network. From the Subnet
drop-down list, select the subnet you wish to use (you need not
change this normally from the default one, when you select the Subnet
compartment ).

Note:
While creating a subnet, select the option Use DNS
Hostnames in this Subnet. If you do not select this option
you cannot edit the subnet information and as a result of
this, stack creation fails. To rectify this, you have to create a
different subnet again by enabling this option.

f. Assign Public Address - This option indicates if the newly created


VM should have a public IP address.This option is set to True, by
default. If you set this to False, no public ip address will be assigned
preventing public access to the compute node.

Note:
If you are using a private IP address to access the compute
node, you have to setup an IPSec VPN or FastConnect
connection. Refer to OCI documentation for more details.

• ODI Instance Settings -


a. ODI Node Shape - Shape of new compute instance. Supported
shapes are VM.Standard 2.4, VM.Standard 2.8, VM.Standard 2.16 and
VM.Standard 2.24. From the Node Shape drop-down list, select the
required shape.
b. SSH Public Key - Public Key for allowing SSH access as the ‘oracle’ user.
Refer to Prerequisites section, for more details on creating the SSH Public
Key.
c. ODI Availability Domain - It specifies the availability domain for the newly
created Oracle Data Integrator Instance. From the Select an Availability
Domain for your Instance drop-down, choose an availability domain. If
you are using regional subnet in Network Configurations, you can use any
of the availability domains from the ODI Availability Domain list.
d. ODI VNC Password - Provide a new password that you will use to connect
to the VNC Server on the newly created ODI instance.
• New ODI Metadata Repository Settings -

1-8
Chapter 1
Launching Your Oracle Data Integrator Instance

– Autonomous Database Instance - Select the created Autonomous


Database instance from this drop down arrow.
– Autonomous Database Password - Provide the password credentials of
the administator user of the autonomous database.
– Supervisor Password - Provide the ODI Supervisor password.

Note:
ODI Supervisor password should be 6-12 characters in length
and no special characters except $, # and _ are allowed.

– Schema Prefix - Specifies the prefix used for the RCU Schemas, used to
identify them. For existing repository, provide the prefix configured during
repository creation.

Note:
A valid prefix should contain only alpha-numeric characters. It
should not start with a number and should not contain any
special characters. A maximum of 12 characters are allowed.

– Schema Password - Specifies the password used for accessing the RCU
Schemas. For existing repository, provide the password configured during
repository creation.

Note:
Schema password that you provide should :
* contain only alpha-numeric characters,
* be a minimum of 12 characters in length,
* contain at least one alphabet in upper case,
* cannot start with a number
* no special characters except $, # and _ are allowed.

3. Click Next.
4. On the Review page, review the information you provided and then click Create.
5. When you get a message Provisioning Completed/Successful from the OCI
console, the instance is created. However please note the rest of the ODI
configuration happens in the background and takes approximately 20 minutes to
complete. If you attempt to access ODI prior to this, provisioning will be under
progress and you may not view default configurations in ODI Studio.
6. After approximately 20 minutes log into the VNC viewer using your <IP address>:1
and check the status of the configuration. To check the status of the configuration,
open a terminal window and execute the following command: tail -f $MW_HOME/
logs/odiConfigure.log. Upon successful completion, you will get the message

1-9
Chapter 1
Connecting to ODI Compute Instance

ODI Apps started Successfully.. Wait for a few minutes for ODI apps to start up
successfully.
7. Now the newly created ODI Instance is ready for use. Based on the type of ODI
Deployment, you can now launch the ODI Web Studio from a web browser or the
ODI Studio to start working on your data integration projects.
8. To check the logs, navigate to $MW_HOME/logs/odiConfigure.log.

1.4 Connecting to ODI Compute Instance


You can connect to an ODI compute instance by using a Secure Shell (SSH)
connection. Most Linux distributions include an SSH client by default. For Windows,
you can download a free SSH client called PuTTY from http://www.putty.org.
1. To connect to your ODI compute instance from linux,
• Log in to your instance using SSH.
• Use the following command to set the file permissions so that only you can
read the file:

$ chmod 400 <private_key>

where <private_key> is the full path and name of the file that contains the
private key associated with the instance you want to access.
• Use the following SSH command to access the instance.

$ ssh –i <private_key> <username>@<public-ip-address>

where
– <private_key> is the full path and name of the file that contains the
private key associated with the instance you want to access.
– <username> is the default name for the instance. The default user name is
oracle.
– <public-ip-address> is your instance IP address that you retrieved from
the Console.
2. To connect to your ODI compute instance from windows,
• Open putty.exe.
• In the Category pane, select Window, and then select Translation.
• In the Remote character set drop-down list, select UTF-8. The default locale
setting on Linux-based instances is UTF-8, and this configures PuTTY to use
the same locale.
• In the Category pane, select Session and enter the following:
a. Host Name (or IP address):<username>@<public-ip-address> , where
<username> is the default name for the instance. For Oracle Linux and
CentOS images, the default user name is oracle. For the Ubuntu image,
the default name is ubuntu and <public-ip-address> is your instance
public IP address that you retrieved from the console.

1-10
Chapter 1
Accessing the ODI Compute Instance

b. Port: 22
c. Connection type: SSH
• In the Category pane, expand Connection, expand SSH, and then click Auth.
• Click Browse, and then select your private key.
• Click Open to start the session.
If this is your first time connecting to the compute instance, you might see a
message that the server's host key is not cached in the registry. Click Yes to
continue the connection.

1.5 Accessing the ODI Compute Instance


To access ODI apps through VNC, do the following:
1. Install a VNC viewer on your local computer.
2. Use SSH to connect to the compute instance running the Oracle Data Integrator
Image, as described in Connecting to ODI Compute Instance .
3. On your local computer, connect to your instance and create a ssh tunnel for port
5901 (for display number 1):

$ ssh -L 5901:localhost:5901 –i id_rsa oracle@<IP Address>

4. On your local computer, for the VNC to work, add an Ingress rule as follows:

No 0.0.0.0/15 TCP All 5901 TCP traffic for ports: 5901

5. On your local computer, start a VNC viewer and establish a VNC connection to
localhost:1.
6. Enter the VNC password that you had provided during the stack creation.
7. For connecting multiple users, after the vncpasswd utility exits, start the VNC
server by typing vncserver. This will start a VNC server with display number 1
for the oracle user, and the VNC server starts automatically if your instance is
rebooted. For example vncserver@:2 or vncserver@:3.
To start developing your data flows or data mappings/transformations,
• If your product deployment is ODI Studio, then launch studio from the available
options.
• Else, in a web browser which has network connectivity to your compute instance,
type-in the url - http://localhost:9999/odi-web-studio
1. From the Applications menu, navigate to Programming -> ODI Web Studio or ODI
Studio,
or
Double click the short icon for ODI Web Studio or ODI Studio present in your
Desktop,
or
Navigate to the location $MW_HOME/oracle/odi/studio/bin/odi in the VNC.

1-11
Chapter 1
Using Autonomous Databases in ODI

2. Connect to the repository with already populated login credentials. The Login
Name value varies based on the selected repository. For ADB repository, the Login
Name is ODI_ADW_REPO and for MySQL Embedded repository it is ODISA_MYSQL.
3. Post successful configuration, check if the newly created data server is available
for use :
• In ODI Web Studio Administrator - Connections -> Technologies -> Oracle
• In ODI Studio - Topology navigator -> Technologies -> Oracle.
4. In ODI studio, navigate to Topology -> Physical Architecture -> Agent ->
OracleDIAgent1 and click Test, to check if the Standalone Agent is working.

Note:
For more details on services, refer to Managing ODI App Server.

5. Click Test connection, to check if the created ADB Dataserver is working.

1.6 Using Autonomous Databases in ODI


The newly created ODI repository will be pre-populated with Oracle Data Servers
representing all accessible Autonomous Databases based on defined policies. If you
aim to use any of these as a part of your ODI transformations, then you have to add
the username and password to the Data Server properties in the Topology tab in ODI
Studio.
If, at a later date, more Autonomous Databases become available to you, you can
use the "Discover ADB's" feature available in Create New Dataserver on Oracle
Technology of ODI Studio, to quickly setup the additional instances that were not
available at the time when the instance was created. When you select the required
ADB instance from displayed instance list, the wallet gets auto downloaded and
once you provide the dataserver name, credentials and then select connection details/
service profiles and save, the new Oracle Dataserver for the selected ADB instance is
created.
To create an Autonomous (ADB) Dataserver in ODI repository,
• Connecting to the Pre-created ADB Dataservers in ODI Repository
• Using Dataserver Setup in ODI Studio

Connecting to the Pre-created ADB Dataservers in ODI Repository


Connect to the readily available or pre-created ADB dataservers in ODI studio. You
have to add actual username and password by connecting to the dataserver, do a test
connection and continue with your data integration project in ODI studio.

Note:
You need to provide the username and password for the created instance as
prepopulated login credentials may not work.

1-12
Chapter 1
Using Autonomous Databases in ODI

Using Dataserver Setup in ODI Studio


You can create additional ADB Dataservers using the Oracle technologies Dataserver
setup in ODI Studio.
Navigate to the Topology navigator, expand the Technologies node in the Physical
Architecture navigation tree and under Oracle technology, select any pre-created ADB
Dataserver.
1. In the Definition tab, click Discover ADBs. The list of available ADB instances are
displayed.
2. Select the required ADB instance from the Discover Autonomous Databases drop-
down list.
Upon selection, Use Credential File checkbox is auto-selected in the connection
node.
In the Credential Details node, Credential File text box is auto-populated with the
respective mapped credential file.

Figure 1-1 Discover ADBs

3. In the Data Server node,


• Name: Enter the name of the newly created data server.
• Instance/dblink(Data Server): TNS Alias used for this Oracle instance. It
will be used to identify the Oracle instance when using database links and
SQL*Loader.
4. In the Connection node,
• User/Password: Oracle user (with its password), having select privileges on
the source schemas, select/insert privileges on the target schemas and select/
insert/object creation privileges on the work schemas that will be indicated in
the Oracle physical schemas created under this data server.
• JNDI Connection: Select this check-box to configure the JNDI connection
settings. Navigate to the JNDI tab, and fill in the required fields.
5. In the Credentials Details node,

1-13
Chapter 1
Installation Locations

• Connection Details - Click the Connection Details drop down arrow to choose
the required connection URL from the list of available connection URLs
retrieved from tnsnames.ora.
6. Click Test Connection.
Upon successful test connection, the new Dataserver gets created in the ODI
repository.

1.7 Installation Locations


Please note, the following installation locations are used by this image. You may need
this information if you want to change any aspects of the installation:

Table 1-1 Installation Locations

Area Location on Server

MW_HOME /u01/oracle/mwh

ODI_HOME MW_HOME+”/odi”

OPatch Home $MW_HOME/OPatch


MySQL Home $MW_HOME/../mysql_home

1.8 Log Files Location


The following log files help you to keep a track record on all the events happening in
your ODI instance on Oracle Cloud Marketplace:

Log Files Location


ODI Image Creation Logs $MW_HOME/logs/odi_install_config.log
ODI Configuration Logs $MW_HOME/logs/odiConfigure.log
ODI Agent Logs $MW_HOME/app_logs/odiagent.log
ODI Rest Logs $MW_HOME/app_logs/
odi_adp_rest_txt.log
ODI Studio Logs $MW_HOME/odi/log/studio.log

1.9 Patching
The ODI image on the Oracle Cloud Marketplace contains an Enterprise installation of
ODI.
Patching is manual using OPatch.
You can upgrade your existing ODI image to the latest version available on the Oracle
Marketplace directly, by either reusing your existing repository database or by creating
a new repository database. But before this, you should backup your work (export),
create a new instance and then restore (import) it, to proceed with your upgradation
process.

1-14
2
Using ODI Web Studio
This chapter helps you to work with ODI Web Studio on Oracle Cloud Marketplace.

Note:
ODI Web Studio is available only when you selelct Web Studio version from
the ODI product listing on Oracle Cloud Marketplace. For more details, see
Selecting Your Product.

It contains the following sections:


• Introduction
• Administering ODI Web Studio
• Working with ODI Web Studio

2.1 Introduction
This chapter introduces Oracle Data Integrator Web Studio.
It contains the following sections:
• Introduction to Oracle Data Integrator Web Studio
• Introduction to Oracle Data Integrator Web Studio Administrator
• Introduction to Oracle Data Integrator Repositories
• Introduction to Oracle Data Integrator Run-Time Agent

2.1.1 Introduction to Oracle Data Integrator Web Studio


Oracle Data Integrator Web Studio allows you to design graphical data transformations
in the form of data flows and workflows. The data flows define how the data is moved
and transformed between different systems, while the workflows define the sequence
in which the data flows are executed.
Oracle Data Integrator Web Studio provides an easy-to-use user interface to create
your data flows and workflows, without requiring you to write any code. You can drag
and drop the components, that is data entities and operators, such as Join, Split,
and Aggregate, on the design canvas of the Oracle Data Integrator Web Studio user
interface and connect them to complete your data flows and workflows.
After your data flows and workflows are ready, you can execute them immediately or
schedule to execute them at a later time. On execution, Oracle Data Integrator Web
Studio generates the code for you.
For detailed information on the terminologies associated with Oracle Data Integrator
Web Studio and their respective functions, see Terminology Information.

2-1
Chapter 2
Administering ODI Web Studio

2.1.2 Introduction to Oracle Data Integrator Web Studio Administrator


Oracle Data Integrator Web Studio Administrator allows you to prepare the
components required for designing all your data flows through Web Studio.
Use Oracle Data Integrator Web Studio Administrator to:
• Set up a robust environment by creating Data Servers, Physical schema, Models
and Data Stores
• Import metadata automatically into ODI by a process called reverse-engineering
• Monitor Reverse-Engineering execution results
• Manage users, by granting privileges to enforce security in Oracle Data Integrator.
For detailed information on the terminologies associated with Oracle Data Integrator
Web Studio Administrator and their respective functions, see Terminology Information.

2.1.3 Introduction to Oracle Data Integrator Repositories


The Oracle Data Integrator Web Studio (ODI) Repository is composed of a master
repository and a work repository. Objects developed or configured by the users are
stored in one of these repository types. There is usually only one master repository
that stores the Security information, Connection information, and versioned and
archived objects. The work repository is the one that contains actual developed
objects.

2.1.4 Introduction to Oracle Data Integrator Run-Time Agent


Oracle Data Integrator run-time agent orchestrate the execution of jobs. In Oracle Data
Integrator Web Studio, the run time engine is ODI Agent and it is automatically setup
on your ODI Marketplace instance during provisioning. To know more about it, refer to
Managing ODI Setup.

2.2 Administering ODI Web Studio


Before you begin using Oracle Data Integrator Web Studio, you must perform
the following tasks using Oracle Data Integrator Web Studio Administrator. After
completing these tasks, the connections, models, and datastores created in Oracle
Data Integrator Web Studio Administrator are available for use in the Oracle Data
Integrator Web Studio.
It contains the following sections:
• Accessing ODI Web Studio
• Creating Master and Work Repositories
• Connecting to Repository
• Setting Up the Connections
• Reverse Engineering Datastores
• Monitoring and Managing your Execution Results
• Managing Users

2-2
Chapter 2
Administering ODI Web Studio

For detailed information on the terminologies associated with Web Studio and their
respective functions, see Terminology Information.

2.2.1 Accessing ODI Web Studio Administrator


To access the ODI Web Studio Administrator,
• Follow the steps listed in Connecting to ODI Compute Instance .
• From the Applications menu, navigate to Programming -> ODI Web Studio
Administrator.
• Or, double click the launch ODI Web Studio Administrator shortcut icon available
on your desktop.
• Or in your VNC, navigate to a terminal and launch the ODI studio using the
following commands:

$ cd $MW_HOME/odi/studio/bin
$ ./odi -clean

ODI Web Studio Administrator is launched allowing you to manage various aspects of
your integration project.
Connect to the repository with already populated login credentials. The Login Name
value varies based on the selected repository. For ADB repository, the Login Name is
ODI_ADW_REPO and for MySQL Embedded repository it is ODISA_MYSQL.

Post successful configuration, check if the newly created data server is available under
Connections -> Technologies -> Oracle.

2.2.2 Creating Master and Work Repositories


ODI repository is already created during provisioning. Apart from the repository which
is already created, if you wish to create a separate ODI Repository, follow the below
steps:
ODI Repository can be created using ODI Web Studio Administrator or using
Repository Creation Utility.
1. Using ODI Web Studio Administrator -
Before creating the ODI repositories, you have to create a schema for these
repositories to work.
Follow the below commands to create a schema:

create user <odi_schema_user> identified by <odi_schema_password>;


grant unlimited tablespace to <odi_schema_user> WITH ADMIN OPTION;
grant CONNECT, RESOURCE to <odi_schema_user> WITH ADMIN OPTION;

To create master and work repositories in Oracle Data Integrator Web Studio
Administrator,
Launch the ODI Web Studio Administrator and click the + icon on the menu and
select the option Create New Master Repository. Enter the required details and
click OK.
2. Using Repository Creation Utility -

2-3
Chapter 2
Administering ODI Web Studio

Use the repository creation utility (rcu) to create the repositories, if you want to
setup J2EE agent/collocated agent.
Follow the below procedure to create repositories using the Repository Creation
Utility:
a. Find the repository creation utility executable available in the $MW_HOME/
oracle_common/bin directory in the Fusion Middleware home and launch rcu.
b. The first screen is just a welcome screen. Click Next.
c. Accept the default values and click Next.
d. Specify the database connection details. Once entered, you can see a dialog
box showing the progress of the three checks carried out on the database,
making sure that the connection is successful.
e. Select the repository components to install. Some are selected by default.
Make sure you select the Master and Work repository option. Click Next.
You can now see a dialog box showing the progress of the checks carried out
on the prerequisites for the components you selected
f. If all the prerequisite checks pass, then enter the password for the schema
users for the repositories. It's easiest to use the same passwords for all
schemas, however, make sure you choose the option that conforms to your
company security policy. Click Next.
g. Enter the password for the Supervisor user, what type the work repository is,
its name and the password for its user. Also specify the encryption algorithm.
Click Next.
h. Map the tablespaces. This is where you specify the name of the schema
owners, and the default and temporary tablespace names for each
component. You can accept the default names, or choose to specify your own.
Click Next.
i. The penultimate screen summarizes your selections, and from here, you
create the repositories. Click Create. Note that it takes several minutes to
create all the repositories.
j. Click Close after you have reviewed the summary of the repositories just
created.
Once you have created a master repository and at least one work repository, you then
create a connection, log in to ODI, and connect to these repositories.
Refer to the tutorial, Oracle Data Integrator 12c - Creating and Connecting to ODI
Master and Work Repositories for detailed steps on how to create your master and
work repositories.

2.2.3 Connecting to Repository


Follow the steps to connect to Master and Work repositories in ODI Web Studio
Admininstrator:
Once you have a master repository and a work repository, you can create a connection
in Oracle Data Integrator.
1. Start ODI Studio, and click Connect to Repository.
2. Enter Wallet Password if you are using the wallet. Enter the wallet password. Click
OK.

2-4
Chapter 2
Administering ODI Web Studio

3. Click New in the Oracle Data Integrator Login window.


The Repository Connection Information dialog displays.
4. Enter a name for the Login.

Note:
From 12.2.1.4.200618 version of ODI Marketplace release, short url
with TNS_ADMIN is used in ODI Studio/Administrator login field.

5. Enter Supervisor as the user, and the password for it. (Note, it's what you entered
when creating the repositories).
6. Enter the database connection details for the master repository.
7. Select the work repository.
8. Click Test Connection, to test the connection and upon successful test
connection, click OK.

Note:
To configure repository of the ODI Agent/ODI Apps, refer to Switching
Repositories of the ODI App Server.

Now you can log into ODI.

2.2.4 Setting Up the Connections


Integration projects exist in different environments and using Oracle Data Integrator
Web Studio Administrator you can define and maintain these environments with
utmost ease. To define an environment, you must create the physical components
and configure the connection details using Oracle Data Integrator Web Studio
Administrator.
The physical components that store and expose structured data in Oracle Data
Integrator (ODI) are defined as data servers. Each data server is always linked to
a single technology. It stores information according to a specific technical logic, which
is declared in the schemas attached to it.
Supported Technologies are:
• Oracle
• Oracle Object Storage
• Oracle BI Cloud Connector
• Oracle Sales Cloud
• Oracle NetSuite
• Oracle Marketing Cloud
• Oracle Service Cloud
• Oracle BI Cloud Service

2-5
Chapter 2
Administering ODI Web Studio

• Casandra
• Derby
• Hypersonic SQL
• IBM DB2 UDB
• IBM DB2/400
• Informix
• Microsoft SQL Server
• MySQL
• Netezza
• PostgreSQL
• Salesforce.com
• Teradata
• Timesten
For detailed information on the terminologies associated with Web Studio and their
respective functions, see Terminology Information.

2.2.4.1 Creating a Data Server and Schema


A Data Server constitutes the physical components that store and expose structured
data in Oracle Data Integrator. Data servers store information according to a specific
technical logic, which is declared in the schemas attached to it.
Follow the below procedure to create a data server and schema in Oracle Data
Integrator Web Studio Administrator:

Creating a Data Server


Navigate to Connections to create the physical data server. This example assumes
the technology is Oracle.
1. Click the Physical Architecture bar. Expand the Technologies node, scroll down
and right-click the Oracle node. To know about the supported technologies, see
Setting Up the Connections.
2. Select New Data Server. In the resulting Definition page enter the data server's
Name, Instance, system user name and system user password.
3. Click the JDBC tab. Click Search to the right of the JDBC Driver field. In the
Drivers dialog box, select Oracle JDBC Driver and click OK.
4. Click Search, to the right of the JDBC URL field. In the URL examples dialog box,
select the first URL in the Name list and click OK. If necessary, edit the JDBC URL
as appropriate for your environment.
5. Click Test Connection. In the Confirmation dialog box, click Yes to confirm saving
your data before testing the connection.
6. Click OK in the Information dialog box that displays.
7. In the Test Connection dialog box, click Test. Acknowledge the connection test as
successful. (If not successful, correct the connection details.)

2-6
Chapter 2
Administering ODI Web Studio

Creating a Schema
To create a new schema for your data server :
1. Right-click the newly-created data server, and select New Schema.
2. Select the schema name from the Schema (Schema) drop-down list in the new
window that appears, then select the appropriate name from the Schema (Work
Schema) drop-down list.
3. Click the Default check box, if this is to be the default schema for this data server.
4. Click Yes in the Confirmation dialog box that displays. Leave all the other fields
unchanged. Click Save.
5. Click OK in the Information dialog box that displays.
Expand the data server hierarchy and confirm that the schema has been added to
the data server.
Once you create a new Data Server and Schema, Logical Schema is automatically
created for you and it gets mapped to your created Schema. For more information, see
Creating a Data Server.

2.2.5 Reverse Engineering Datastores


Reverse-engineering is a completely automated process in ODI for retrieving metadata
from a database. It can be used to create new models or to fill in gaps in existing
models. ODI connects to the database by using the basic features of the JDBC driver
and directly queries the system tables to retrieve the metadata. It then transforms and
writes this metadata into the ODI repository. Naturally, the method for doing this varies
greatly depending on the technology that is being reverse-engineered. Thus, for each
technology, there is a specific Reverse-engineering Knowledge Module (RKM). This
RKM tells ODI how to extract metadata for the given technology. All the RKMs needed
for the supported technologies are preseeded.
For detailed information on the terminologies associated with Web Studio and their
respective functions, see Terminology Information.
The Data Stores are automatically created during the Reverse Engineering process.
Follow the below steps to create models and datastores in Oracle Data Integrator Web
Studio Administrator.
From the Connections tab, navigate to Models and start creating models and
datastores.

2.2.5.1 Creating a Model


A model in Oracle Data Integrator (ODI) is a description of a relational data model. It's
a representation of the structure of a number of interconnected datastores stored in a
single schema on a particular technology. The model in ODI does not, however, hold
data, such as banking figures or names of customers. Instead, it holds only metadata:
the names of columns, and the constraints that exist between tables. This metadata
can be imported automatically into ODI through reverse-engineering. You can also
define the metadata manually, creating columns or constraints directly in ODI.
Follow the below procedure to create a data model in Oracle Data Integrator Web
Studio Administrator:
1. Navigate to Connections and select the Models view.

2-7
Chapter 2
Administering ODI Web Studio

You can choose to create the model in selected model folder or you can create a
top-level model.
2. Click the New Model icon.
The window for the new model appears.
3. Enter the name of your model.
Like most objects in ODI, there is also a code to enter. By default, this is the same
as the name, but uppercase with underscores instead of spaces.
4. Specify the technology of the underlying database in this field.
A model must be linked to a specific technology.
5. Logical schema to which the model belongs is automatically created and auto-
populated here. It is created in the following format: <Data Server Name
_Physical Schema Name_ls>. If required, choose the appropriate logical schema.
There is only one context (global) which determines the schema that is be used as
the source of the metadata.
6. Enter a description for your model.
For more information, see Creating a Model.
To perform customized reverse-engineering by using an RKM, perform the following
steps:
1. Click the Reverse Engineer tab of the model.
The Customized option button is selected by default.
2. Fill in the details for the following fields:
• Context: the context used for the reverse-engineering process
• Logical Agent - Choose the required agent for the reverse-engineering
process.
• Object Type: the type of objects to reverse-engineer (tables, view, and so
on). Only object of these types will be taken into account by the reverse-
engineering process.
• Mask: Enter in the Mask field the mask of tables to reverse engineer. The
mask selects the objects to reverse. This mask uses the SQL LIKE syntax. The
percent (%) symbol means zero or more characters, and the underscore (_)
symbol means one character.
• Select the Knowledge Module: Select the KM that you want to use for
performing the reverse-engineering process. This KM is typically called RKM
“<Project_Name>.<Project_Folder>” for example, “Knowledge Module:
HandsOnLabs.HandsOnLoads”
• Optionally, you can specify the characters to remove for the table alias.
These are the characters to delete in order to derive the alias. Note that if
the datastores already exist, the characters specified here will not be removed
from the table alias. Updating a datastore is not applied to the table alias.
3. Click Reverse Engineer in the Model toolbar menu, then Yes to validate the
changes.
4. Click OK. The Session Started dialog appears.
5. Click OK.

2-8
Chapter 2
Administering ODI Web Studio

You can review the reverse-engineering tasks in the Sessions tab of the Operator
Navigator. If the reverse-engineering process completes correctly, reverse-engineered
datastores appear under the model node in the Models panel of Connections tab.

2.2.5.2 Creating Datastores


A datastore in Oracle Data Integrator (ODI) is a data structure, for example a table in
a relational database. All datasources in ODI, regardless of the underlying technology,
appear as datastores, and can be manipulated and integrated in the same way.
The datastores are grouped in data models, which contain all declarative rules and
constraints.
Follow the below procedure to create a datastore in Oracle Data Integrator Web Studio
Administrator:
The easiest and most common way to create a datastore is by reverse-engineering
its structure from the technology (for example, Oracle or MySQL database). However,
you can create datastores in two other ways:
• Directly in the model - Navigate to Connections and a model tree appears.
• By using the Common Format Designer component.
In these cases, the datastores do not necessarily have to exist in the data server. This
can be useful for creating a new text file with a structure that you define.
To create a datastore directly in a model, perform the following steps:
1. Navigate to Connections and select a model.
2. Right-click and select New Datastore.
The Resource Name field refers to the physical name of the table in a database
or the name of the file for a file-based datastore. If you use a mapping to create
this datastore in a database, the resource name is the name of the table that is
generated. The alias, on the other hand, is the name that you use to refer to the
datastore in mappings, joins, and so on.
3. Set the name. This is the name that is displayed in ODI in the Model tree view.
Often, this is similar to the resource name.
4. Provide a description for the datastore (optional).
After you set up the basic parameters, you may want to add columns to the definition.
To do this, perform the following steps:
1. Click the Attributes tab.
2. Click the Add Column icon to add another column.
3. Define properties for each column.
The meanings of the Name, Type, Logical length, and Scale options depend on
the technology of the model. Not Null means that the field is mandatory. You can
set other properties in the columns by double-clicking their names in the Models
view.
4. Reorder the newly-added columns using the up and down arrows.
For more information on this, see Creating and Reverse-Engineering a Datastore.
By this, you create all the essentials elements required in the environment to perform
your data transformations in Oracle Data Integrator Web Studio.

2-9
Chapter 2
Administering ODI Web Studio

2.2.6 Monitoring and Managing your Execution Results


To manage and monitor your execution results or jobs:
• In Oracle Data Integrator Web Studio Administrator, navigate to Operator tab
or
• In Oracle Data Integrator Web Studio, navigate to Jobs
Navigate to the Operator tab, to start a scenario from Oracle Data Integrator Web
Studio Administrator.
Follow the below steps to start a scenario:
1. Select the scenario in the Scenarios navigation tree in Operator Navigator.
2. Right click, then select Run.
3. In the Run dialog, set the execution parameters. To execute the scenario with the
agent that is built into Oracle Data Integrator Web Studio Administrator, select the
required runtime agent.
4. Click OK.
5. If the scenario uses variables as parameters, the Variable values dialog is
displayed. Select the values for the session variables. Selecting Latest value for a
variable uses its current value, or default value if none is available.
When the agent has started to process the session, the Session Started dialog
appears, allowing you to monitor and manage your execution results.

2.2.7 Managing Users


To manage users, navigate to the Users tab of Oracle Data Integrator Web Studio
Administrator.
The way in which you manage users depends, in part, on where the user is defined.
By default, a user corresponds to the login name used to connect to a repository and
is persisted in the internal repository of Oracle Data Integrator. However, if external
authentication is enabled for Oracle Data Integrator components:
• Users authenticated into Oracle Data Integrator are created and managed in an
external identity store, such as Oracle Internet Directory. You use the tools and
utilities provided with that store to create, update, and delete users.
• To let external users access Oracle Data Integrator, you can do any of the
following:
– Map the external user to an Oracle Data Integrator role.
– Map any of the enterprise roles to which this external user belongs to an
Oracle Data Integrator role.
– Register the external user in Oracle Data Integrator using the Security
Navigator as in prior releases.

Creating an User in the Internal Repository


To create an user in the internal repository of Oracle Data Integrator:
1. In the Users tab, expand the Users navigation tree.

2-10
Chapter 2
Working with ODI Web Studio

2. Click New User in the toolbar of the Users navigation tree.


3. In the Name field, enter a name for your user.
4. Provide the Initials for this user.
5. Do one of the following:
• If using internal authentication, click Enter the Password and provide a
password for this user.
• If using external authentication, click Retrieve GUID to associate the new user
with a user from the external identity store. The user name in Oracle Data
Integrator must match the user name in the identity store. If a match is found,
a Global Unique ID appears in the External GUID field.
6. From the File main menu, select Save.
The new user appears in the Users navigation tree. From the User editor, an ODI
supervisor user can disable other ODI user accounts including other supervisor
accounts. In the New user screen, Supervisor checkbox is selected and disabled by
default. Thus, all other profiles will be disabled.

WARNING:
At least one supervisor user account should be maintained at all times. If all
supervisor user accounts expire, contact Oracle Support.

Deleting a User from the Internal Repository


To delete a user that is defined in the internal repository of Oracle Data Integrator:
1. In the Users tab expand the Users navigation tree.
2. From the list of users, select the user that you want to delete.
3. Right-click and select Delete.
4. Click OK in the Confirmation window.
The user disappears from the list.

Viewing User Connection Information


To view user connection information:
1. From the Users toolbar menu, select Review User Activity.... The User
Connections dialog appears.
2. Enter the filter criteria to view relevant user connection information and click Filter.
User connections are displayed in the Connections section, based on the set filter
criteria.

2.3 Working with ODI Web Studio


This chapter guides you to connect and work with the ODI Web Studio.
It contains the following sections:

2-11
Chapter 2
Working with ODI Web Studio

• Accessing ODI Web Studio


• Create a New Project
• Get Started with Data Flows
• About Data Flow Editor
• Create a New Data Flow
• Introduction to Workflows
• Create a New Workflow
• Execute a Workflow
• Scheduling Data Flows or Workflows
• Managing Jobs
For detailed information on the terminologies associated with Web Studio and their
respective functions, see Terminology Information.

2.3.1 Accessing ODI Web Studio


Follow the below steps to access ODI Web Studio on Oracle Cloud Marketplace:
• To start your ODI Web Studio, in a web browser that has network access to the
ODI Instance, type in <ip address>:9999/odi-web-studio/ in the toolbar and
click Enter. You are navigated to the login page.
In the Sign Into Oracle Data Integrator page, enter the following login credentials
and click Connect:
– Username - SUPERVISOR
– Password
* For ADB - Use the password that you provided during the ODI stack
provisioning.
* For Mysql - Execute getPassword.sh to get the password.
The ODI Web Studio appears allowing you to perform the data transformations.

2.3.2 Create a New Project


A Project is the top-level container, which can include multiple folders to organize your
data flows or work flows.
To create a new project:
1. Access the Oracle Data Integrator Web Studio.
2. In the left navigation pane, click Data Flows.

3. Click the Create Project icon ( ).


4. Enter a name for the project and click OK.

The folder is created with a default folder. You can click the Actions icon ( )
next to the default folder and select Edit to rename it.

2-12
Chapter 2
Working with ODI Web Studio

5. To add more folders to the project, click the Actions icon ( ) next to the project
and click Create Folder.

2.3.3 Get Started with Data Flows


Perform the following steps to access the Data flow editor where you can start creating
your data flows.
To start creating data flows:
1. On the Home page, click the Data Flows tile.
2. In the left pane, expand the Project folder.

3. Click the Actions icon ( ) next to folder in which you want to create the data flow,
and click Create Data Flow.
4. This action takes you to the the Data flow editor where you create the data flow.
For more information, see About Data Flow Editor.

2.3.4 About Data Flow Editor


The Data flow editor is divided into four parts, the Data Entity Panel, the
Transformations Toolbar, the Design Canvas, and the Properties Panel.

• Data Entity Panel: The data entity panel displays the Data Entities that are
available to use in your Data flows. These are organized by Connections,
Schemas and Collections. Expand these tree nodes to find the required Data
Entities, or else use the Filter to use them on the design canvas.
• Transformations Toolbar: The transformations toolbar display the transformation
options that can be used in your data flows. Just like Data Entities, you can drag
and drop the Transformations you want to use on the design canvas.
• Design Canvas: The design canvas is where you build your transformation logic.
After adding the Data Entities and Transformations to the design canvas, you can
connect them in a logical order to complete your data flows.
• Properties Panel: The properties panel displays the properties of the selected
object on the design canvas. The Properties Panel is grouped into four Tabs.
General, Attributes, Column Mapping, and Options. Not all tabs are available
as they vary based on the selected object.

2-13
Chapter 2
Working with ODI Web Studio

2.3.5 Create a New Data Flow


A data flow defines how the data is moved and transformed between different
systems.
Oracle Data Integrator Web Studio supports the following Data Transformation
Components:
• Aggregate
• Expression
• Filter
• Join
• Distinct
• Lookup
• Set
• Sort
• Split
• Subquery Filter
• Table Function
• Data Cleanse
To create a data flow:
1. Access Oracle Data Integrator Web Studio.
2. On the Home page, click the Data Flows tile.
3. In the left pane, expand the Project folder for which you are creating the data flow.

4. Click the Actions icon ( ) next to folder in which you want to create the data flow,
and click Create Data Flow.
5. Enter a name for the data flow and click OK.

2.3.5.1 Add Components


To add components to your data flow:
1. In the Data Entities panel, expand the Connections, Schemas, and Collections to
see the available Data Entities.
2. Drag the data entities that you want to use in the data flow and drop them on the
design canvas.
3. From the Transformations toolbar, drag the transformation component that you
want to use in the data flow and drop them on the design canvas.

4. Select an object on the design canvas, and drag the Connector icon ( ) next
to it to connect the components.
5. After saving the data flow, there may be a Transfer icon overlaid on one or more
of the component connections. This indicates that ODI has detected an additional

2-14
Chapter 2
Working with ODI Web Studio

step and it is required to move the data between data servers. You can click on
this Icon to view properties associated with this step.
For example:

2.3.5.2 Map Data Columns


When you connect the source datastore with the target datastore, the column names
are automatically mapped by the column names. You have a choice to map the
columns by Position or by Name or map the columns manually using the Expression
Editor.
To map columns by Position or by Name:
1. Select the target datastore.
2. Click the arrow icon present on the top right corner to expand the Properties
Panel. This will give you more space to work with.

3. In the Properties Panel, click the Column Mapping icon ( ).


4. To map the columns by Position or by Name, from the Auto Map drop-down
menu, select By Position or By Name.
To map the columns manually:
1. From the Auto Map drop-down menu, select Clear to clear the existing mappings.
2. Drag and drop the attributes from the tree on the left to map with the Expression
column.
3. To edit an expression, click the Edit icon of the respective column. The
Expression Editor appears allowing you to perform the required changes (for
example, you can just add an expression-"UPPER" or open the Expression Editor
to edit the expression).

Note:
Use the expression editor only if you have complex expressions for a
particular column.

4. Click OK.

2-15
Chapter 2
Working with ODI Web Studio

2.3.5.3 Set Target Component Options


You can modify the data flow options that must be used for the target component
during the data flow execution.
To modify the data flow options:
1. Select the target component on the design canvas.

2. Expand the Properties Panel and click the Options icon ( ).


3. Change the IKM options as appropriate.

2.3.5.4 Validate and Execute a Data Flow


After your data flow is ready, do the following:
1. Click Save.
After saving, if data needs to be staged before transforming, Transfer button is
added to one or more links. You can click these buttons to set more options, if
available.

2. Click the Validate icon ( ) in the toolbar above the design canvas to validate the
data flow.

3. After a successful validation, click the Execute icon ( ) next to the Validate icon
to execute the data flow.
A message appears that displays the execution job ID and name that you can
monitor on the Jobs page. For more information, see Managing Jobs.

2.3.6 Introduction to Workflows


A workflow is made up of multiple data flows organized in a sequence in which
they must be executed. Each data flow is executed as a step. When you execute a
workflow, a data flow either succeeds or fails. Depending on whether the first data flow
succeeds or fails, you can choose the next data flow that must be executed.
Here is an example of a workflow:

In this example, the workflow performs the following actions:


1. Execute the "Weekly FDA feed" data flow .
2. If the "Weekly FDA feed" data flow execution is successful, execute the "Weekly
CDC alerts" data flow.

2-16
Chapter 2
Working with ODI Web Studio

3. If the "Weekly CDC alerts"data flow execution is successful, execute the "Load
Medicare" data flow.
4. If any of the above data flow fails, then execute the "Audit_error_log" data flow.

2.3.7 Create a New Workflow


To create a new workflow:
1. On the Home page, click the Workflows tile.
2. In the left pane, expand the Project folder. It displays all the data flows available in
the project.

3. Click the Actions icon ( ) next to folder in which you want to create the
workflow, and click Create Workflow and provide a name for the workflow.
4. Select the data flow that you want to execute first and select First Step check box
in the Properties Panel.
5. Select either the ok (green arrow) icon, the not ok (red arrow) or the ok/not ok
(black arrow) in the toolbar.
This defines the mode that subsequent links drawn on the canvas will be set to.
• ok (green) defines the success path.
• not ok (red) defines the failure path.
• ok/not ok (black) defines a path that is followed on success or failure.

6. Select the data flow and click the Connector icon ( ) next to it to connect it
with the next data flow.
7. Click Save.

2.3.8 Execute a Workflow


1. To execute a Workflow, edit the Workflow and click the Execute Workflow icon
( ).

2. Select the object in the canvas and click the Execute Step icon ( ), to execute
only the selected data flow.
You can monitor the execution status on the Jobs page. For more information, see
Managing Jobs.

2.3.9 Scheduling Data Flows or Workflows


You can schedule Workflows and Data Flows to run at specified time interval. Each
schedule allows you to specify a start date and time, and execution frequency.
To schedule a data flow or a workflow:
1. In the left pane, click Schedules.
2. Click Create Schedule.

2-17
Chapter 2
Working with ODI Web Studio

3. From the Resource drop-down menu, select Data Flow or Workflow as


appropriate.
4. From the Resource Name drop-down list, select a data flow or workflow that you
want to schedule.
5. Select the scheduling options and click Save.

2.3.10 Managing Jobs


On the Home page, click Jobs in the left pane to access the Jobs page.
The Jobs page lists the execution job sessions that are running and completed. You
can click on any of the sessions from the list to see its details. For each session, you
can see the status of each of the steps that were executed. From the Actions menu,
you can Delete, Restart, Stop and Rerun jobs, if required. If any of the steps failed,
you can click on them to see the error details.

2-18
3
Using ODI Studio
This chapter helps you to configure and use ODI Studio on Oracle Cloud Marketplace.
For detailed information on the terminologies associated with ODI Studio and their
respective functions, see Terminology Information.
It contains the following sections:
• Accessing ODI Studio
• Using Autonomous Databases in ODI
• Working with ODI Instance

3.1 Accessing ODI Studio


To access ODI studio through VNC, do the following:
1. Install a VNC viewer on your local computer.
2. Use SSH to connect to the compute instance running the Oracle Data Integrator
Image, as described in Connecting to ODI Compute Instance .
3. On your local computer, connect to your instance and create a ssh tunnel for port
5901 (for display number 1):

$ ssh -L 5901:localhost:5901 –i id_rsa oracle@<IP Address>

4. On your local computer, for the VNC to work, add an Ingress rule as follows:

No 0.0.0.0/15 TCP All 5901 TCP traffic for ports: 5901

5. On your local computer, start a VNC viewer and establish a VNC connection to
localhost:1.
6. Enter the VNC password that you had provided during the stack creation.
7. For connecting multiple users, after the vncpasswd utility exits, start the VNC
server by typing vncserver. This will start a VNC server with display number 1
for the oracle user, and the VNC server starts automatically if your instance is
rebooted. For example vncserver@:2 or vncserver@:3.
To launch the ODI instance,
1. From the Applications menu, navigate to Programming -> ODI Studio
or
Double click the short icon for ODI Studio present in your Desktop
or
Navigate to the location $MW_HOME/oracle/odi/studio/bin/odi in the VNC.

3-1
Chapter 3
Accessing ODI Studio

2. Connect to the repository with already populated login credentials. The Login
Name value varies based on the selected repository. For ADB repostiory, the Login
Name is ODI_ADW_REPO and for MySQL Embedded repository it is ODISA_MYSQL.
3. Post successful configuration, check if the newly created data server is available in
the Topology navigator -> Technologies -> Oracle.

For more details on MySQL services, refer to Troubleshooting ODI on OCI


.
4. In ODI studio, navigate to Topology -> Physical Architecture -> Agent ->
OracleDIAgent1 and click Test, to check if the Standalone Agent is working.
5. Depending on your network, you may need to provide proxy details for the
database server JDBC connection.

3-2
Chapter 3
Working with ODI Instance

6. Click Test connection, to check if the created ADB Dataserver is working.


7. Depending on your network, you can setup a proxy for ODI. In ODI Studio,
navigate to Tools, Preferences, Web Browser and Proxy, to setup a proxy for your
network. Proxy may be required for accessing certain hosts, for example - Oracle
Object Storage.

Note:
Depending on your OCI network configurations, you may or may not
require access through proxy-hosts. While you are connecting through
proxy, make sure that the proxy address/port or the source dataserver is
allowed through OCI VCN configurations.

Note:
If you are using a BI Cloud Connector Dataserver, you may need to add
the BI Cloud Connector host to the Proxy Exclusion field.

3.2 Working with ODI Instance


This chapter guides you to connect and work with the ODI instance.
It contains the following sections:
• Configuring Data Sources and Targets
• Reverse Engineering Data Models
• Creating Mappings

3-3
Chapter 3
Working with ODI Instance

• Monitoring ODI Executions

3.2.1 Configuring Data Sources and Targets


The physical components that store and expose structured data in Oracle Data
Integrator (ODI) are defined as data servers. Each data server is always linked to
a single technology. It stores information according to a specific technical logic, which
is declared in the physical schemas attached to it.
For example -

For more information, refer to Overview of Oracle Data Integrator Topology chapter in
Developing Integration Projects with Oracle Data Integrator guide.

3.2.2 Reverse Engineering Data Models


To automatically populate datastores into the model, you reverse-engineer the
model. A standard reverse-engineering uses the capacities of the JDBC driver
used to connect the data server to retrieve the model metadata. A customized
reverse-engineering uses a reverse-engineering Knowledge Module (RKM), to retrieve
metadata for a specific type of technology and create the corresponding datastore
definition in the data model.
For example -

3-4
Chapter 3
Working with ODI Instance

For more information, refer to Creating and Reverse-Engineering a Model chapter in


Developing Integration Projects with Oracle Data Integrator guide.

3.2.3 Creating Mappings


Mappings in Oracle Data Integrator (ODI) are the logical and physical organization
of your data sources, targets, and the transformations through which the data flows
from source to target. Mappings are made up of several parts, datastores, datasets,
re-usable mappings, connectors, knowledge modules, variables, sequences, user
functions, and other components. Optionally, you can specify a staging schema. You
create and manage mappings using the mapping editor, which opens whenever you
open a mapping. Mappings are organized in folders under individual projects, found
under Projects in the Designer Navigator.
For example -

For more information, refer to Creating and Using Mappings in Developing Integration
Projects with Oracle Data Integrator guide.

3-5
Chapter 3
Working with ODI Instance

3.2.4 Monitoring ODI Executions


Monitoring your development executions consists of viewing the execution results and
managing the development executions when the executions are successful or in error.
Through Operator Navigator, you can view your execution results and manage your
development executions in the sessions, as well as the Scenarios and Load Plans in
production. Operator navigator stores this information in a work repository, while using
the topology defined in the master repository.
For example -

For more information, refer to Monitoring Integration Processes chapter in


Administering Oracle Data Integrator guide.

3-6
4
Managing ODI Setup
This chapter helps you to manage the ODI setup that you have provisioned on Oracle
Cloud Marketplace.
It contains the following sections:
• Working with ODI Linux Services
• Changing Repository in ODI Web Studio/ODI Web Studio Administrator
• Switching Repositories of the ODI App Server
• Managing ODI App Server
• Managing ODI Credential
• Configuring Proxy Settings

4.1 Working with ODI Linux Services


The following table lists all the available services in ODI marketplace installation for
applicable technology and stack deployment:

Name of the Database Type of Stack Supported Supported


Linux Service Technology Deployment Release Funtions
Versions
agentodi.serv MYSQL,ADB ODI Studio Supported in You can start,
ice release(s) prior to stop and check
12.2.1.4.200618 the status of the
version of ODI service.
Marketplace.
mysqlodi.serv MYSQL ODI Studio Supported in You can start,
ice release(s) prior to stop and check
12.2.1.4.200618 the status of the
version of ODI service.
Marketplace.
manageodiapps MYSQL,ADB ODI Studio, ODI Supported only You can only
.service Web Studio from ODI Web check the status
V12.2.1.4.200618 of the service.
and later versions Use the python
of ODI commands listed
Marketplace. below, to start,
stop and restart
the ODI Agent
and/or ODI Web
Studio.

4-1
Chapter 4
Changing Repository in ODI Web Studio/ODI Web Studio Administrator

4.2 Changing Repository in ODI Web Studio/ODI Web


Studio Administrator
Follow the below procedure to change repository in ODI Web Studio (if not already
created):
1. Launch ODI Studio.
2. Select the option Connect to Repository.
3. Create new login using '+' icon and provide the connection details.
4. Click Test and then click OK, if test connection is successful.
5. Click OK on the Oracle Data Integrator Login dialog.

4.3 Switching Repositories of the ODI App Server


You can switch to any existing ADB or DBCS repository from existing ODI VM
Instance.

Note:
You can switch between repositories only when the repositories in stack
mode and repo mode match.

In ODI App Server, you can switch repository in the following technologies:
• Switching from ADB to ADB
• Switching from MYSQL to ADB or DBCS

Note:
But the reverse (switching back to MYSQL from ADB or DBCS) is not
supported.

• Switching from DBCS to DBCS


• Switching from DBCS or ADB

Switching Between ADB Repositories


If you already have a ADB repository in which you have your transformation project
developed and wish to continue with your development in the same repository, follow
the below procedure to switch from the new ADB repository (that you just created) to
your existing ADB repository:

4-2
Chapter 4
Switching Repositories of the ODI App Server

1. Create odi-setup.properties file in the location $MW_HOME/odi/common/scripts


and if the file already exists, clear the existing content of the file and then add the
following properties:

dbTech=ADB
rcuCreationMode=false
odiSchemaPassword=<valid password>
odiSchemaUser=<odi schema username>
odiSupervisorPassword=<odi SUPERVISOR password>
walletZipLoc=<path_to_zipped_wallet>
workRepoName=<WORK REPO NAME>

Note:
workRepoName=<WORK REPO NAME> is an optional propery but you may
have to configure this property if your default work respository name is
not WORKREP.

2. Create repository.properties file in the location $MW_HOME/odi/common/scripts


and if the file already exists, clear the existing content of the file and then add the
following properties:

masterReposDriver=oracle.jdbc.OracleDriver
masterReposUser=<odi schema username>
workReposName=<WORK REPO NAME>

3. Navigate to the location $MW_HOME/odi/common/scripts directory and execute the


following python scripts in the given order:

python odiMPConfiguration.py
python manageOdiApps.py start

Note:
Stop the server before running any configuration. For more information on
this, refer to Managing ODI App Server.

Switching Between DBCS Repositories


If you already have a DBCS repository in which you have your tranformation project
developed and wish to continue with your development in the same repository, follow
the below procedure to switch from the new DBCS repository (that you just created) to
your existing DBCS repository:
1. Create odi-setup.properties file in the location $MW_HOME/odi/common/scripts
and if the file already exists, clear the existing content of the file and then add the
following properties:

dbTech=DBCS
dbHost=<IP Address of the DBCS Instance>
dbPort=<port of DBCS Instance>

4-3
Chapter 4
Managing ODI App Server

dbServiceName=<Service Name of DBCS Instance>


odiSchemaUser=<odi schema username>
odiSchemaPassword=<valid password>
odiSupervisorPassword=<odi SUPERVISOR password>
workRepoName=<WORK REPO NAME>

2. Create repository.properties file in the location $MW_HOME/odi/common/scripts


and if the file already exists, clear the existing content of the file and then add the
following properties:

masterReposDriver=oracle.jdbc.OracleDriver
masterReposUser=<odi schema username>
workReposName=<WORK REPO NAME>

3. Navigate to the location $MW_HOME/odi/common/scripts directory and execute the


following python scripts in the given order:

python odiMPConfiguration.py
python manageOdiApps.py start

Note:
Stop the server before running any configuration. For more information on
this, refer to Managing ODI App Server.

4.4 Managing ODI App Server


The following commands help you to manage ODI App server associated with your
provisioned ODI instance on Oracle Cloud Marketplace.
Applications available in ODI Web Studio are:

APPODIAGENT, APPODIREST, APPODIWEBSTUDIO

Application available in ODI Studio are:

APPODIAGENT

You can use ODI App Server to manage all the ODI applications deployed in ODI App
Server.
Navigate to the location $MW_HOME/odi/common/scripts to run the following
commands:
• Use the following command to check the status of the service (as the oracle user):

systemctl status manageoidapps.service

4-4
Chapter 4
Managing ODI App Server

Note:
You cannot use this command to start or stop the service.

• Use the following command to start the service:

python manageOdiApps.py start

• Use the following command to shutdown the service:

python manageOdiApps.py shutdown

• Use the following command to restart the service:

python manageOdiApps.py restart

• Use the following command to start all the applications associated with the
service:

python manageOdiApps.py start -apps=<allowed values>

allowed values: all or APPODIWEBSTUDIO/APPODIREST/APPODIAGENT with


combination separated by ","

• Use the following command to stop all the applications associated with the service:

python manageOdiApps.py stop -apps=<allowed values>

allowed values: all or APPODIWEBSTUDIO/APPODIREST/APPODIAGENT with


combination separated by ","

Note:
When you execute the command python manageOdiApps.py, two log
files odiagent.log and odi_adp_rest_txt.log are created. For details
on the location of the files, refer to Log Files Location.

• Use the following command to get the status of all applications associated with the
service:

python manageOdiApps.py status

• If you have provisoned this stack prior to 12.2.1.4.200618 release version of ODI
Marketplace or if you have provisioned this stack for ODI Studio, follow the below
procedure to manage your ODI Agent lifecycle:
– To stop the ODI Agent:

python stopAgent.py

4-5
Chapter 4
Managing ODI Credential

– To start the ODI Agent:

python startAgent.py $MW_HOME

Note:
The script files stopAgent.py and startAgent.py are not applicable for
Web Studio stack deployment.

4.5 Managing ODI Credential


If you have either updated the odi schema password on the database or the
SUPERVISOR password in ODI repository, you can use the manageCredentials.py
script to update or manage ODI credentials required to start the ODI App Server
successfully.
Navigate to the location $MW_HOME/odi/common/scripts to run the following
commands:

S.No. Key Name


1 odiSchemaPassword
2 odiSupervisorPassword

Use the following command to set the credential key in the Credential Store:

python manageCredentials.py set <Key Name>=<value>

Use the following command to get the credential key value stored in the Credential
Store:

python manageCredentials.py read <key Name>

4.6 Configuring Proxy Settings


Depending on your network, you can setup a proxy for ODI. Proxy may be required for
accessing certain hosts, for example - Oracle Object Storage.

Note:
Depending on your OCI network configurations, you may or may not require
access through proxy-hosts. While you are connecting through proxy, make
sure that the proxy address/port or the source dataserver is allowed through
OCI VCN configurations.

You can set proxy:


• In ODI Studio or ODI Studio Administrator

4-6
Chapter 4
Configuring Proxy Settings

• For ODI Agent


• In ODI App server
To set proxy in ODI Studio and ODI Web Studio Administrator, navigate to Tools,
Preferences, Web Browser and Proxy, to setup a proxy for your network.
Follow the below procedure to set proxy for ODI Agent if, you have provisoned this
stack prior to 12.2.1.4.200618 release version of ODI Marketplace:

Note:
For backward compatibilty, use the scripts startAgent.py and
stopAgent.py to manage ODI Agent Lifecycle.

1. From the location $MW_HOME/oracle/odi/common/scripts, locate and edit the file


startAgent.py and add the following lines after the property after -Drepo.props=

-Xms1024m -Xmx4048 -cp

-Dhttp.proxyHost=www-proxy-xxx.com -Dhttp.proxyPort=80
-Dhttps.proxyHost=www-proxy-xxx.com -Dhttps.proxyPort=80 -cp

For example, after adding the above lines, your file should be like this:

subprocess.call('nohup java
-Drepo.props=odi-setup.properties
-Xms1024m -Xmx4048 -cp
-Dhttp.proxyHost=www-proxy-xxx.com -Dhttp.proxyPort=80
-Dhttps.proxyHost=www-proxy-xxx.com -Dhttps.proxyPort=80 -cp
$AGENTCLASSPATH oracle.odi.OdiStandaloneAgentStarter'+'
'+oraclediagentPath+"
&", shell=True)

2. Save the file and use the following command to start the agent:

python startAgent.py $MW_HOME

Note:
Ensure you do not add any extra lines or space or tab on the file
startAgent.py. Just add -D option within the line content. It is a python
script and it requires proper line indentation to work.

3. Test the standalone agent from ODI studio to see if the agent has started
successfully. Then execute the packages/mappings using the standalone agent.

4-7
Chapter 4
Configuring Proxy Settings

Note:
If you are using a BI Cloud Connector Dataserver, you may need to add the
BI Cloud Connector host to the Proxy Exclusion field.

Follow the below procedure to set proxy in ODI App Server:


1. Open the script file manageOdiApps.py.
2. Find the below lines in the file:

JETTY_SERVER_COMMAND_STR = 'java -DAPP_LOGS='+APP_LOGS+'


-Dconfig.template.file=../../apps/webapps.template.yaml
-Dapps.config=../../apps/webapps.yaml -Drepo.props=odi-
setup.properties -Drestrepo.props=repository.properties
-Djetty.enabled=true -Dagent.logging.config=../logging/agent-
logging-config.xml -cp $CLASSPATH
oracle.odi.setup.util.ODIMPJettyServerAppsManager

3. After the above lines, add the below line before -cp:

-Dhttp.proxyHost=<proxyhost> -Dhttp.proxyPort=<proxy port> -


Dhttps.proxyHost=<proxyhost> -Dhttps.proxyPort=<proxy port>

4. Save the file.


5. Restart the ODI App server.

4-8
5
Configuring ODI Marketplace Repositories
on DBCS Instance
This chapter helps you to create a new DBCS instance and set up ODI master and
work repositories for the newly created DBCS instance on Oracle Cloud Marketplace.
Perform the following steps to create a DBCS instance and set up ODI master and
work repositories for the created DBCS instance:

Creating a DBCS instance on Oracle Cloud Marketplace


Follow the below steps to create a DBCS instance on Oracle Cloud Marketplace:
1. From the OCI console, navigate to the left menu, click Database and select Bare
Metal, VM and Exadata.
2. Select the required compartment and click Create DB System. DB System
Information screen appears. It allows you to configure all the required details for
creating a DB instance, such as compartment, Database name, username and
password. All the default values are auto-populated.
3. In the Add SSH keys section, select the option Paste SSh key and provide the
genereated SSH key in the SSH key text box.
4. In the Specify the network information section, click the Virtual Cloud Network
in ODI drop-down arrow to select the required virtul cloud network.
5. Provide the required details in Hostname Prefix, Host domain name and Host
domain URL text boxes. Click Next.
6. Create Administrator Credentials screen appears allowing you to configure the
password for the default admin user.

Note:
Admin password that you provide should be 9 to 30 characters in length,
contain at least two alphabets in upper case, two alphabets in lower
case, two special characters (which includes _, # or -) and two numeric
characters.

7. After configuring all the details, click Create DB system.


A new DBCS instance is created.

Setting up ODI on DBCS


For setting up ODI master and work repositories on a DBCS instance, you need to
install ODI schemas using RCU. After installing the schemas you can set up ODI on
DBCS by providing the DBaaS connection credentials.
For more information on creating schemas using RCU, refer to Creating Master and
Work Repositories.

5-1
Chapter 5

Note:
If you wish to use the newly created DBCS repository for your default ODI
Marketplace Agent, refer to Switching Repositories of the ODI App Server.

Configuring the Domain for a Standalone Agent


Create and configure a standalone domain for a standalone agent using
the Configuration Wizard. For more information on configuring ODI Domain
($ODI_DOMAIN_HOME) with Standalone/JEE Agent template, refer to Configuring the
Domain for a Standalone Agent chapter of Installing and Configuring Oracle Data
Integrator guide.
After creating the domain based on the type of agent deployed, start the agent
(standalone agent) or Admin Server and Managed server (JEE agent) from the
location $ODI_DOMAIN_HOME/bin.

Note:
For more details on creating and configuring a JEE agent, refer to
Configuring the Domain for a Java EE Agent chapter of Installing and
Configuring Oracle Data Integrator guide.

5-2
6
Configuring Oracle Enterprise Manager for
Oracle Fusion Middleware on Oracle Cloud
Marketplace
This chapter helps you to access Oracle Enterprise Manager Fusion Middleware
Control Console on Oracle Cloud Marketplace, and display WebCenter-related pages
from where you can perform all necessary configuration, monitoring, and management
tasks.

Prerequisites
Ensure to configure the following prerequisites before configuring Oracle Enterprise
Manager for Oracle Fusion Middleware on Oracle Cloud Marketplace:
1. STB and other required schema as created by Repository Creation Utility (RCU).

Note:
Repository Creation Utility (RCU) schemas are created by default in
Oracle Cloud Marketplace and the default STB schema name is in
the format <schema_name>_STB. Check with support team to know the
exact schema name. You can also find the schema name (for example
- ADW11_STB) in odi-setup.properties file along with the following
properties:
• sMasterDBDriver
• sMasterDBUsername
• odiSupervisorUser
• sMasterDBUrl

2. Physical agent in ODI studio with agent name as OracleDIAgent pointing to host
name and port where you plan to configure OracleDIAgent.

Note:
This is a Java EE Agent and when you create it in ODI studio it works
only after completing all the configurations in the configuration wizard
and starting admin and manager servers.

Configuring Oracle Enterprise Manager


Following steps help you to configure Oracle Enterprise Manager for Oracle Fusion
Middleware on Oracle Cloud Marketplace:

6-1
Chapter 6

1. Navigate to /u01/oracle/mwh/oracle_common/common/bin and execute the file


config.sh using the command /u01/oracle/mwh/oracle_common/common/bin>./
config.sh.
Oracle WebLogic Server Configuration wizard appears.
2. From the Create Domain screen, select Create a new domain option and click
Browse to select the desired domain location. The selected location appears in
the Domain Location text box. Click Next.
3. From the Templates screen, select Create Domain Using Product Templates
option. Available Templates appear. Select Oracle Data Integrator - Console,
Agent and Enterprise Manager Plugin. All the dependent templates are selected
automatically. Click Next.
4. From the Application Location screen, click Browse to select the desired
location for the application. The selected location appears in Application
Location text box. Click Next.
5. From the Administrator Account screen, provide the admin server login
credentials in the following fields:
• Name
• Password
• Confirm Password and click Next.
6. From the Domain Mode and JDK screen, for JDK, select Oracle HotSpot
1.8.0_191/u01/oracle/mwh/jdk1.8.0_191 option and click Next.
7. From the Database Configuration Type screen, for Specify AutoConfiguration
Options Using parameter, select RCU Data option and fill-in the required details
for the following fields:
• Connection URL
• Schema Owner
• Schema Password
Click Connection Properties. The Connection Properties screen displays the
following details:

oracle.net.authentication_service TCPS
oracle.net.ssl_server_dn_match false
javax.net.ssl.trustStore /u01/oracle/mwh/wallet/cwallet.sso (Path
of the wallet location)
javax.net.ssl.keyStoreType SSO
javax.net.ssl.keyStore /u01/oracle/mwh/wallet/cwallet.sso(Path of
the wallet location)
javax.net.ssl.trustStoreType SSO

Note:
Make sure to provide the path for truststore and keystore parameters
same as the path of your wallet file.

Click Save & Close. Click RCU Configuration and Click Next.

6-2
Chapter 6

8. Provide the essential details in Component Datasources screen.

Note:
Make sure to change the connection string, connection properties for
each component schema, as they are not carried forward from the
previous screens.

Figure 6-1 Sample for Component Datasources

This image is a sample with changes for component LocalSvcTblSchema and you
have to make changes for the following:
• WLS Schema
• ODI Master Schema
• ODI Work Schema
• OPSS Audit Schema
• OPSS Audit Viewer Schema
• OPSS Schema

6-3
Chapter 6

Figure 6-2 Sample for OPSS Audit Schema

9. After providing all the above details, JDBC Test screen appears. Review all the
details and click Next.

Figure 6-3 Sample JDB Test Configuration

10. From the Credentials screen, enter the Supervisor password for your ODI
instance and click Next.
11. From the Advanced Configuration screen, select the check boxes for the
following servers/services:

6-4
Chapter 6

• Administration Server
• Node Manager
• Topology
• Deployments and Services and click Next.
12. The Administration Server screen displays the port number in which the admin
server listens. It is auto-populated by default. Click Next.
13. From the Node Manager screen, provide the node manager login credentials
in Username, Password and Confirm Password fields and click Next. Node
manager login credentials can be same as Admin server login credentials, which
means you can use the same username and password for logging into both Node
manager and Admin server.
14. From the Managed Servers screen, provide the server name and port details in
Server Name and Listen Port columns respectively.
15. From the Clusters screen, click Add, to create a new cluster. Click Next.

16. The Server Templates screen displays all the available server templates. Click
Add, to add new server templates, if required, else, click Next. Assign the required
server template to the newly created Cluster.
17. The Coherence Cluster screen displays the available cluster name and port
number. Click Next.
18. In the Machines screen, click Add, to add a machine and provide the name, port
and address of the Node Manager. After adding a machine, add Admin server and
ODI_server to the created machine. Click Next.
19. The Virtual Targets screen displays the details of configured virtual targets, if any.
It includes details such as name, target, host names, URI prefix, explicit port and
port offset. Click Next.
20. The Partitions screen displays the details of all the available partitions. Click
Next.
21. The Deployments screen displays a list of all the Deployments and Deployment
Targets. Click Next.
22. The Service Targets screen displays a list of all the Services and Deployment
Targets. Click Next.
23. The Configuration Summary screen displays a summary of all the performed
configurations. Click Create. Configuration Process screen appears displaying
the status of the process and configurations.
24. Upon completion, End of Configuration screen appears, displaying the
Configuration Succeeded message along with the configured Domain Location
and Admin Server URL details. Click Finish.
Other Configurations
1. Locate jps-config.xml file and configure the following properties in your jps-
config.xml file. By default, you can find this file in the following location
- ~/oracle/user_projects/domains/base_domain/config/fmwconfig and this
location is based on the created base domain.

<property name="javax.net.ssl.trustStore" value="/u01/oracle/mwh/


wallet_ADWSAT1/cwallet.sso"/>
<property name="oracle.net.authentication_service"

6-5
Chapter 6

value="TCPS"/>
<property name="oracle.net.ssl_server_dn_match"
value="false"/>
<property name="javax.net.ssl.keyStoreType"
value="SSO"/>
<property name="javax.net.ssl.trustStoreType"
value="SSO"/>
<property name="javax.net.ssl.keyStore" value="/u01/
oracle/mwh/wallet_ADWSAT1/cwallet.sso"/>

Figure 6-4 JPS Configuration File

2. In the command prompt, navigate to Node manager


properties file /u01/oracle/mwh/user_projects/domains/base_domain/
nodemanager/nodemanger.properties and edit the property SecureListener=
false and make sure the listener port is matching with the configured port. Save
the file and navigate to the domain creation path and start the node manager using
the following command :

/u01/oracle/mwh/user_projects/domMains/base_domain/bin>./
startNodeManager.sh

3. In the command prompt, navigate to the domain creation path (configured in the
above steps) and perform the following:
• Start the Admin server using the following command:

/u01/oracle/mwh/user_projects/domains/base_domain/bin> ./
startWebLogic.sh

• Start the Managed server using the following command:

/u01/oracle/mwh/user_projects/domains/base_domain/bin> ./
startManagedWebLogic.sh ODI_server1 http://localhost:7001

The command /startManagedWebLogic.sh helps you to start the managed


server which is required to start the ODI Console and Oracle DIAgent.
After performing all the above configurations, navigate to a web browser and access
this URL http://<<hostname>>:<<port>>/em.

6-6
Chapter 6

For example,

http://localhost:7001/em/

Provide your login credentials and click Sign In, to access the newly configured
Oracle Enterprise Manager Fusion Middleware Control Console on Oracle Cloud
Marketplace.
After logging in, you can check the health of the servers. From the Oracle Enterprise
Manager Fusion Middleware Control Console you can start and stop the servers and
agents. You can also check if, the console is working by logging into the console
http://localhost:managedserverport/odiconsole.

6-7
7
Configuring the Domain for Collocated/
Java EE Agent on Oracle Cloud
Marketplace
This chapter helps you to create and configure a Oracle Data Integrator (ODI) domain
for the collocated/Java EE agent standard installation topology on Oracle Cloud
Marketplace.
Configuring Collocated/Java EE agent on Oracle Cloud Marketplace includes the
following high level steps:
• Navigate to the location (ORACLE_HOME/oracle_common/common/bin) and execute
the script config.sh to launch the WebLogic Server Configuration Wizard.
• Select the ODI collocated / JEE agent template and deploy.
• After succesful deployment, start the collocated / JEE Agent, Weblogic Server and
Managed Server.
For detailed instructions on creating and configuring a WebLogic domain for a Java EE
agent, refer to Configuring the Domain for a Java EE Agent .

7-1
8
Configuring High Availability for ODI on
Oracle Cloud Marketplace
This chapter helps you to configure High Availability (HA) topology for Oracle Data
Integrator on Oracle Cloud Marketplace. The sections in this chapter outline the
concepts and steps that are important for designing high availability deployment.
It contains the following sections:
• Setting Up 2-Node Cluster for High Availability
• Configuring Horizontal Clustering
• Enabling Incoming Ports and Services

8.1 Setting Up 2-Node Cluster for High Availability


Follow the below steps to setup 2-node cluster for ODI on Oracle Cloud Marketplace.

Prerequisites
Go through the following prerequisites before setting up 2-Node Cluster for High
Availability. Make sure you have the following before setting up 2-Node Cluster for
High Availability:
1. OCI Virtual Cloud Network (VCN) setup that supports communication with all the
compute instances created in its subnet.
• All the communication channels are through private IPs.
• External communication established outside the subnet are through public IPs.
• Ably configured for Ingress/Egress.
2. ADB or DBaaS instance created in the same subnet and VCN as described in
Step 1.
3. ODI compute instance 1 created in the same subnet and VCN as described in
Step 1.
4. ODI compute instance 2 created in the same subnet and VCN as described in
Step 1.
5. Firewall configurations in all the compute instances that are part of the cluster.
• Enabling Incoming Ports and Services (through firewall commands).

8.2 Configuring Horizontal Clustering


Follow the below steps for configuring Horizontal 2-Node Clustering for ODI on Oracle
Cloud Marketplace.

8-1
Chapter 8
Configuring Horizontal Clustering

1. Node-1 and Node-2 have middleware home installed on the same path and have
the same ODI version.
2. Node 1 - Install ODI schemas using RCU
• Here you will be providing the DBaaS or ADW connection credentials.
3. Node 1 - Create ODI Domain ($ODI_DOMAIN_HOME) with Horizontal Clustering
using JEE Agent template.
• RCU association - STB schemas created in step (2)
• Managed Servers - ODI_Server1 on Node1 with port 8001 ; ODI_Server 2 on
Node 2 with port 8001
• Cluster Topology - ODI_Cluster1 with nodes (ODI_Server1, ODI_Server2)
• Node Manager Topology
a. Node Manager on Node-1 (AdminServer; ODI_Server1).
b. Node Manager on Node-2 (ODI_Server2).
4. On Node-1
• Start the Admin Server.
• Start the node manager from $ODI_DOMAIN_HOME/bin.
• Pack the domain using pack.sh (with managed=true).
5. On Node-2
• Unpack the domain in the same domain path of step (3), $ODI_DOMAIN_HOME.
• Start the node manager from $ODI_DOMAIN_HOME/bin.

Note:
Before starting the node manager, in the nodemanager.properties
file, set the property SecureListener=false and make sure the
listner port is matching with the configured port.

6. Load Balancer Setup with OCI (using OCI console)


• Configure Load Balancer with Backend Sets and Listener.
a. Backend Sets : Add two ODI compute instances and specify the managed
server port address (8001 in the example)
b. Listener : This the front-end address that ODI repository queries for
communicating with the agent. Based on your need it can be any of the
following :
– Public IPs : https with certificates
– Private IPs : http with (NO SSL)
7. Associate Load Balancer Agent in ODI repository
• In the ODI Studio, navigate to Create a new agent and configure the following
parameters :
a. OracleDIAgent with Load Balancer Listener Host Address
b. Load Balancer Port Address

8-2
Chapter 8
Configuring Horizontal Clustering

c. webapp(context)- oraclediagent
d. agent work repository (workrep)- jdbc/odiMasterRepository or
jdbc/odiWorkRepository
• Node-1 or Node-2 through WLS Console : Configure Coherence cache
configuration.
– Through WLS Admin Console - Configure Coherence cache properties for
UNICAST clustering in JAVA_OPTIONS for managed server startup.
a. tangosol.coherence.localport configuration parameter defines the
port which a node in the cluster can use for coherence cluster. It is
connected by agent nodes to detect coherence cluster existence and
other coherence communication.
b. All the ODI Agents deployed on a cluster must be connected to the
same Coherence cluster cloud. This enables the agents to share the
knowledge of the tasks performed by each of them as well as allow for
Scheduling Service migration when needed. Following properties are
introduced to configure the Coherence listen addresses.
* oracle.odi.coherence.wkaN : The host name of a Managed
Server.
* oracle.odi.coherence.wkaN.port : Coherence Unicast port
configured on that Managed Server.
* Where N = 1..10
c. Sample Configuration

For Example:
Node 1:

"-Dtangosol.coherence.localport=8095
-Doracle.odi.coherence.wka1=<MS1_HOSTNAME>
-Doracle.odi.coherence.wka1.port=8095
-Doracle.odi.coherence.wka2=<MS2_HOSTNAME>
-Doracle.odi.coherence.wka2.port=8096"

Node 2:

"-Dtangosol.coherence.localport=8096
-Doracle.odi.coherence.wka1=<MS1_HOSTNAME>
-Doracle.odi.coherence.wka1.port=8095
-Doracle.odi.coherence.wka2=<MS2_HOSTNAME>
-Doracle.odi.coherence.wka2.port=8096"

8. Node-1 or Node-2 through WLS console - Start both the managed servers
(ODI_Server1 and ODI_Server2) from the console through node managers.

8-3
Chapter 8
Enabling Incoming Ports and Services

Note:

1. The above steps are guidelines for setting up HA Cluster with 2 nodes.
The same procedure can be extended to have any number of nodes in
the cluster.
2. Load balancer created can either be private or public. It is always
recommended to configure public end-points with SSL. For more
information on this, refer to Overview of Load Balancing.
3. The subnets can be regional or specific to an Availability domain. For
maximum availability, Oracle recommends you to configure regional
subnets. For more information, refer to VCNs and Subnets.

8.3 Enabling Incoming Ports and Services


For establishing communication between the instances, you need to ensure that the
underlying Security List (associated with VCN), has all the IP protocols enabled.
The following is an example of security list that enables communication within the
instances participating in High Availability (HA) cluster:

Note:
All the instances participating either directly or indirectly should be following
the below ingress and egress rules.

Table 8-1 Ingress and Egress Rules Table

Stateless Source IP Source Destinati Type and Allows Comment


Protocol Port on Port Code s
Range Range
No 0.0.0.0/0 TCP All 22 Nil TCP traffic For SSH
for ports: communic
22 SSH ation we
Remote need to
Login open port
Protocol # 22.

8-4
Chapter 8
Enabling Incoming Ports and Services

Table 8-1 (Cont.) Ingress and Egress Rules Table

Stateless Source IP Source Destinati Type and Allows Comment


Protocol Port on Port Code s
Range Range
No 0.0.0.0/0 ICMP Nil Nil 3,4 ICMP ICMP is a
traffic for: supporting
3, 4 protocol
Destinatio and at the
n minimum,
Unreacha ingress
ble: rules
Fragment should
ation allow for
Needed type 3, 4
and Don't and 8. For
Fragment more
was Set informatio
n on ICMP
protocols,
refer to
the IANA
list.
No 10.0.0.0/1 ICMP Nil Nil 3 ICMP ICMP is a
6 traffic for: supporting
3 protocol
Destinatio and at the
n minimum,
Unreacha ingress
ble rules
should
allow for
type 3, 4
and 8. For
more
informatio
n on ICMP
protocols,
refer to
the IANA
list.

8-5
Chapter 8
Enabling Incoming Ports and Services

Table 8-1 (Cont.) Ingress and Egress Rules Table

Stateless Source IP Source Destinati Type and Allows Comment


Protocol Port on Port Code s
Range Range
No 0.0.0.0/0 ICMP Nil Nil 8 ICMP ICMP is a
traffic for: supporting
8 Echo protocol
and at the
minimum,
ingress
rules
should
allow for
type 3, 4
and 8. For
more
informatio
n on ICMP
protocols,
refer to
theIANA
list.
No 0.0.0.0/0 TCP All 1521 Nil TCP traffic Port 1521
for ports: is for
1521 database
traffic.
No 0.0.0.0/0 TCP All 443 Nil TCP traffic Port 443 is
for ports: the SSL
443 traffic.
HTTPS
No 0.0.0.0/0 TCP All 7001 Nil TCP traffic WLS
for ports: Admin
7001 Server
communic
ation port.
No 0.0.0.0/0 TCP All 8001 Nil TCP traffic Managed
for ports : Server
8001 communic
ation port
for all
nodes.
No 0.0.0.0/0 TCP All 5556 Nil TCP traffic Node
for ports : Manager
5556 Port in
Node1.
No 0.0.0.0/0 TCP All 5557 Nil TCP traffic Node
for ports : Manager
5557 Port in
Node2.
No 0.0.0.0/0 UDP All 7574 Nil UDP WLS
traffic for Cluster
ports : port
7574

8-6
Chapter 8
Enabling Incoming Ports and Services

Table 8-1 (Cont.) Ingress and Egress Rules Table

Stateless Source IP Source Destinati Type and Allows Comment


Protocol Port on Port Code s
Range Range
No 0.0.0.0/0 TCP All 8095 Nil TCP traffic Oracle
for ports : Coherenc
8095 e port on
Node1.
No 0.0.0.0/0 TCP All 8096 Nil TCP traffic Oracle
for ports : Coherenc
8096 e port on
Node2.

Firewall Rules
Even after setting the ingress and egress rules, in some cases the instances may not
allow the incoming traffic. This is because of the firewall associated with the instance.
Ensure to enable all the communication ports by configuring the firewall.
The following is an example of firewall commands for the above ingress/egress ports
(that has enabled port communication) :
Firewall command to enable port communication between the nodes (run on both
machines):

sudo firewall-cmd --permanent --new-service=odiwls


sudo firewall-cmd --permanent --service=odiwls --set-description="ODI
WLS server"
sudo firewall-cmd --permanent --service=odiwls --add-port=7001/tcp
sudo firewall-cmd --permanent --add-service=odiwls
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odimanagedwls


sudo firewall-cmd --permanent --service=odimanagedwls --set-
description="ODI WLS Managed Server"
sudo firewall-cmd --permanent --service=odimanagedwls --add-
port=8001/tcp
sudo firewall-cmd --permanent --add-service=odimanagedwls
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odiwlsnodemgr1


sudo firewall-cmd --permanent --service=odiwlsnodemgr --set-
description="ODI WLS Node Manager1"
sudo firewall-cmd --permanent --service=odiwlsnodemgr --add-
port=5556/tcp
sudo firewall-cmd --permanent --add-service=odiwlsnodemgr1
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odiwlsnodemgr2


sudo firewall-cmd --permanent --service=odiwlsnodemgr --set-
description="ODI WLS Node Manager2"
sudo firewall-cmd --permanent --service=odiwlsnodemgr --add-

8-7
Chapter 8
Enabling Incoming Ports and Services

port=5557/tcp
sudo firewall-cmd --permanent --add-service=odiwlsnodemgr2
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odiwlscluster


sudo firewall-cmd --permanent --service=odiwlscluster --set-
description="ODI WLS cluster"
sudo firewall-cmd --permanent --service=odiwlscluster --add-
port=7574/udp
sudo firewall-cmd --permanent --add-service=odiwlscluster
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odiwlscoherencewk1


sudo firewall-cmd --permanent --service=odiwlscoherencewk1 --set-
description="ODI WLS coherence WKA1"
sudo firewall-cmd --permanent --service=odiwlscoherencewk1 --add-
port=8095/tcp
sudo firewall-cmd --permanent --add-service=odiwlscoherencewk1
sudo firewall-cmd --reload

sudo firewall-cmd --permanent --new-service=odiwlscoherencewk2


sudo firewall-cmd --permanent --service=odiwlscoherencewk2 --set-
description="ODI WLS coherence WKA2"
sudo firewall-cmd --permanent --service=odiwlscoherencewk2 --add-
port=8096/tcp
sudo firewall-cmd --permanent --add-service=odiwlscoherencewk2
sudo firewall-cmd --reload

8-8
9
Troubleshooting ODI on OCI
This chapter describes about various services associated with ODI on OCI and ways
to troubleshoot them when you encounter issues while using them.

Note:
If you are facing issues connecting to ADB dataserver and MySQL repository
after long hours of inactivity, try reconnecting to ODI repository to overcome
this problem.

How Tos

Note:
The following commands are supported in release(s) prior to
12.2.1.4.200618 version of ODI Marketplace. For latest release, refer to
Managing ODI Credential .

• How to get the password for a MYSQL based ODI repository?

$MW_HOME/odi/common/scripts/getPassword.sh

• How to update ODI Repository and schema credentials for ADB technology?

cd $MW_HOME/odi/common/scripts
Create a new file updateCredentials.sh and add below contents
echo "Updating credentials in wallet..."
WCLASSPATH=../../sdk/lib/odi-core.jar:../../sdk/lib/commons-
lang-2.2.jar:../../../oracle_common/modules/oracle.jps/*:../../../
oracle_common/modules/oracle.igf/identitydirectory.jar:../../../
oracle_common/modules/oracle.idm/identitystore.jar:../../../
oracle_common/modules/oracle.osdt/osdt_cert.jar:../../../
oracle_common/modules/oracle.osdt/osdt_core.jar:../../../
oracle_common/modules/oracle.osdt/osdt_xmlsec.jar:../../../
oracle_common/modules/oracle.pki/oraclepki.jar:../../../wlserver/
modules/com.oracle.weblogic.security.jar:../../../wlserver/modules/
com.oracle.weblogic.security.subject.jar
export WCLASSPATH
java -cp $WCLASSPATH oracle.odi.setup.util.ODIWalletSetupUtil
odi ../../common/scripts/jps-config-jse.xml <supervisorPassword>
<schemaPassword>
Save the file and stop the ODI agent.

9-1
Chapter 9

Run the script ./updateCredentials.sh.


Restart the ODI agent.

Note:
In the above commands, change the values for <supervisorPassword>
<schemaPassword> fields with your respective ODI supervisor password
and ADB Repository schema password.

9-2
10
Known Issues and Workarounds
This chapter details known issues in this release, and their workarounds.

Mismatch in Server Certificate DN with connection details having tls for ATP/
ADW-D:
When you navigate to Dataserver configured with ATP/ADW-D and select Connection
details with TLS, Test connection fails due to server certificate issue. It happens when
you force JDBC driver to match DN (Server's Distinguished Name) by setting the
property oracle.net.ssl_server_dn_match=true and DN mentioned in JDBC URL
does not match with the DN mentioned in server certificate.
As a workaround, mention the correct DN in JDBC URL or set
oracle.net.ssl_server_dn_match=false in the JDBC tab of ATP/ADW data server.

For example, the expected DN in the JDBC URL is:

jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=tcps)(HOST=servername)
(PORT=
2484))(CONNECT_DATA=(SERVICE_NAME=servicename))
(SECURITY=(SSL_SERVER_CERT_DN=\
"CN=server_test,C=US\")))

10-1

You might also like