Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on...

44
Oracle® Fusion Middleware Using Oracle Data Integrator on Oracle Cloud Marketplace 12.2.1.4.0 F22173-04 February 2020

Transcript of Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on...

Page 1: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Oracle® Fusion MiddlewareUsing Oracle Data Integrator on Oracle CloudMarketplace

12.2.1.4.0F22173-04February 2020

Page 2: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Oracle Fusion Middleware Using Oracle Data Integrator on Oracle Cloud Marketplace, 12.2.1.4.0

F22173-04

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 onuse and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense 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 forinteroperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou 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 onbehalf 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 endusers are "commercial computer software" or “commercial computer software documentation” pursuant to theapplicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use,reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/oradaptation of i) Oracle programs (including any operating system, integrated software, any programsembedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oraclecomputer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in thelicense contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloudservices 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 thatmay create a risk of personal injury. If you use this software or hardware in dangerous applications, then youshall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure itssafe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of thissoftware or hardware in dangerous applications.

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

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks areused 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 registeredtrademark 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 expresslydisclaim all warranties of any kind with respect to third-party content, products, and services unless otherwiseset forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not beresponsible 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.

Page 3: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Contents

Preface

Audience v

Documentation Accessibility v

Related Documents v

Conventions vi

1 Getting Started with Oracle Cloud Marketplace

Prerequisites 1-1

Launching an Oracle Data Integrator Instance 1-3

Using Autonomous Databases in ODI 1-7

2 Working with ODI Instance

Connecting to ODI Instance 2-1

Starting ODI Studio 2-2

Configuring Data Sources and Targets 2-6

Reverse Engineering Data Models 2-6

Creating Mappings 2-7

Monitoring ODI Executions 2-8

Installation Locations 2-8

Patching 2-9

3 Configuring ODI Marketplace Repositories on DBCS Instance

4 Configuring Oracle Enterprise Manager for Oracle FusionMiddleware on Oracle Cloud Marketplace

5 Configuring High Availability for ODI on Oracle Cloud Marketplace

Setting Up 2-Node Cluster for High Availability 5-1

iii

Page 4: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Configuring Horizontal Clustering 5-1

Enabling Incoming Ports and Services 5-4

6 Troubleshooting ODI on OCI

iv

Page 5: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

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

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the OracleAccessibility 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 supportthrough 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=trsif you are hearing impaired.

Related DocumentsFor 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

v

Page 6: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

• Connectivity and Knowledge Modules Guide for Oracle Data IntegratorDeveloper'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 throughthe JDeveloper Help Center when you press F1 or from the main menu byselecting Help, and then Search or Table of Contents.

ConventionsThe following text conventions are used in this document:

Convention Meaning

boldface Boldface type indicates graphical user interface elements associatedwith an action, or terms defined in text or the glossary.

italic Italic type indicates book titles, emphasis, or placeholder variables forwhich you supply particular values.

monospace Monospace type indicates commands within a paragraph, URLs, codein examples, text that appears on the screen, or text that you enter.

Preface

vi

Page 7: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

1Getting Started with Oracle CloudMarketplace

Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enablescustomers to quickly set up and run Oracle Data Integrator (ODI) on Oracle Cloud andit provides a fully unified solution for building, deploying, and managing complex datawarehouses or as part of data- centric architectures in a SOA or business intelligenceenvironment. In addition, it combines all the elements of data integration - datamovement, data synchronization, data quality, data management, and data services -to ensure that information is timely, accurate, and consistent across complex systems.

It contains the following sections:

• Prerequisites

• Launching an Oracle Data Integrator Instance

• Using Autonomous Databases in ODI

Note:

Refer to Launching Your First Linux Instance documentation before creatingthe ODI instance.

PrerequisitesMake sure you have the following prerequisites before using Oracle Data Integrator onOracle 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 provisioningODI and ADW Instances.

• Read thoroughly the password policies provided in the Stack UI and createpasswords accordingly during provisioning.

• Wait till the completion of ODI instance creation, check for its status and thenproceed working on it.For more information, refer to the usage instructions in Launching an Oracle DataIntegrator Instance.

1-1

Page 8: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Supported Browsers

Oracle Cloud Infrastructure supports the latest desktop versions of Google Chrome,Microsoft Edge, Internet Explorer 11, Safari, Firefox, and Firefox ESR. Note thatmobile 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 ComputeNode 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 directoryunder 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) isdisplayed. Check if the path to the key is correct. In the above example, the pathis /Users/johndoe/.ssh/id_rsa.pub. You have now created a public and privatekey pair.

Creating Dynamic Group Policies

During ODI Instance provisioning, all accessible Autonomous (ADB) Dataservers areauto-created, provided the dynamic group policies are set as mentioned below:

• Create a dynamic group to include matching rules for instances in a specifiedcompartment. For example

ALL {instance.compartment.id = 'ocid1.compartment.oc1..aaaaaaaabgr34tpuanpvq6xfb667nsmy2jz45zj6dexojhxdsv4mjayem3cq'}

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

Chapter 1Prerequisites

1-2

Page 9: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

• Navigate to Identity -> Policies -> Create Policy to create policy statements asspecified below :If you set policy at:

– ODI compartment level, then all ADW/ATP instances from the compartmentwhere ODI instance is created are listed.For example - To List ADW/ATP instances only from the ODI instancecompartment, you have to setup the following policy:

Create dynamic group like: ALL {instance.compartment.id = 'ocid1.compartment.oc1..aaaaaaaabgr34tpuanpvq6xfb667nsmy2jz45zj6dexojhxdsv4mjayem3cq'}Allow dynamic-group odi_group to inspect autonomous-database-family in compartment odiAllow dynamic-group odi_group to read autonomous-database-family in compartment odiAllow dynamic-group odi_group to inspect compartments in compartment odi

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

Create dynamic group like: ALL {instance.compartment.id = 'ocid1.compartment.oc1..aaaaaaaabgr34tpuanpvq6xfb667nsmy2jz45zj6dexojhxdsv4mjayem3cq'}Allow dynamic-group odi_group to inspect autonomous-database-family in tenancyAllow dynamic-group odi_group to read autonomous-database-family in tenancyAllow dynamic-group odi_group to inspect compartments in tenancy

Launching an Oracle Data Integrator InstanceOnce you have found Oracle Data Integrator from the search results on Oracle CloudMarketplace, following steps help you to launch Oracle Data Integrator on OracleCloud Marketplace using the Stack Listing:

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:

• Select Version - It provides a list of versions that are available in the listing. Itis set to Oracle Data Integrator 12.2.1.4.0 by default.

• Select Compartment - Specifies the compartment where the compute node willbe built. It is generally the location that you have access to build the computenode.

Chapter 1Launching an Oracle Data Integrator Instance

1-3

Page 10: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

• Terms of Use - This checkbox is selected by default. Oracle recommends toreview the licenses before proceeding.

• Launch Stack - It launches the stack in the OCI environment.

6. Fill in the required Stack information:

• Name - Name of the Stack. It has a default name and provides a datetimestamp. 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 onthe Oracle Data Integrator for Oracle page.

• Tags (optional) – Tags are a convenient way to assign a tracking mechanismbut 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.

7. Fill in the required details to configure variables. This information is required tobuild the compute node with Oracle Data Integrator.

• General Settings -

a. Networking Options - Denotes the networking options in which the OracleData Integrator compute instance and all the associated networkresources have to be created. Select between two available options:

– New networking components will be created - Select this option tohave a new network (VCN) and subnet created and configuredalongside this new ODI instance. Minimal inputs are required whenyou select this option.

– Existing networking components will be used - Select this option touse the existing network components and subnets.

b. ODI Repository Location - Select between the following options forcreating 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

c. Resource Display Name Prefix (optional) - It is the prefix added to thedisplay name of all the compute and network resources generated .Display name is used to identify all new OCI resources. If you do notspecify any prefix, then it is automatically generated.

d. Target Compartment – Denotes the target compartment for all theprovisioned resources .

• Network Configuration -

– New networking components will be created -

a. Virtual Network CIDR (optional) - A single, contiguous Virtual CloudNetwork (VCN) CIDR block for the VCN. For example: 172.16.0.0/16.You cannot change this value later.

Chapter 1Launching an Oracle Data Integrator Instance

1-4

Page 11: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Note:

This option is available for both new and existing modes ofnetwork creation.

b. Create or Use a Public ODI Subnet - It creates all the ODI resourcesof the newly created instance in a public subnet. This option isselected by default. If you clear this checkbox, all the ODI resourcesare created in a private subnet.

– Existing networking components with be used -

a. Virtual Network CIDR (optional) - A single, contiguous Virtual CloudNetwork (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 thecompute node will be built. It is generally the location that you haveaccess to build the compute node. From the Virtual cloud networkcompartment drop-down list, select the compartment where your VCNhas been setup.

c. VCN - A VCN is a software-defined network that you set up in theOracle Cloud Infrastructure data centers in a particular region. Selectthe desired VCN for the newly created instance. From the Virtualcloud network drop-down list, choose your VCN.

d. Subnet Compartment - Denotes the subnet compartment to use forthe newly created instance if you are not creating a new network.From the Subnet Compartment drop-down list, select thecompartment containing the subnet that you wish to use.

e. Subnet (optional) - Existing subnet to use for the newly createdinstance 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 thisnormally from the default one, when you select the Subnetcompartment ).

Note:

While creating a subnet, select the option Use DNSHostnames in this Subnet. If you do not select this optionyou cannot edit the subnet information and as a result ofthis, stack creation fails. To rectify this, you have to create adifferent subnet again by enabling this option.

f. Assign Public Address - This option indicates if the newly created VMshould 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 assignedpreventing public access to the compute node.

Chapter 1Launching an Oracle Data Integrator Instance

1-5

Page 12: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Note:

If you are using a private IP address to access the computenode, you have to setup an IPSec VPN or FastConnectconnection. Refer to OCI documentation for more details.

• ODI Instance Settings -

a. ODI Node Shape - Shape of new compute instance. Supported shapesare VM.Standard 2.4, VM.Standard 2.8, VM.Standard 2.16 andVM.Standard 2.24. From the Node Shape drop-down list, select therequired shape.

b. SSH Public Key - Public Key for allowing SSH access as the ‘opc’ user.Refer to Prerequisites section, for more details on creating the SSH PublicKey.

c. ODI Availability Domain - It specifies the availability domain for the newlycreated Oracle Data Integrator Instance. From the Select an AvailabilityDomain for your Instance drop-down, choose an availability domain. Ifyou are using regional subnet in Network Configurations, you can use anyof the availability domains from the ODI Availability Domain list.

d. ODI VNC Password - Provide a new password that you will use to connectto the VNC Server on the newly created ODI instance.

• New ODI Metadata Repository Settings -

– Autonomous Database Instance - Select the created AutonomousDatabase instance from this drop down arrow.

– Autonomous Database Password - Provide the password credentials ofthe admin user of the autonomous database.

– Supervisor Password - Provide the ODI Supervisor password.

Note:

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

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

Note:

A valid prefix should contain only alpha-numeric characters. Itshould not start with a number and should not contain anyspecial characters. A maximum of 12 characters are allowed.

– Schema Password - Specifies the password used for accessing the RCUSchemas. For existing repository, provide the password configured duringrepository creation.

Chapter 1Launching an Oracle Data Integrator Instance

1-6

Page 13: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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.

8. Click Next.

9. On the Review page, review the information you provided and then click Create.

10. When you get a message Provisioning Completed/Successful from the OCIconsole, the instance is created. However please note the rest of the ODIconfiguration happens in the background and takes approximately 20 minutes tocomplete. If you attempt to access ODI prior to this, provisioning will be underprogress and you may not view default configurations in ODI Studio.

11. After approximately 20 minutes log into the VNC viewer using your <IP address>:1and check the status of the configuration. To check the status of the configuration,open a terminal window and execute the following command: tail -f /home/opc/logs/odiConfigure.log. Upon successful completion, you will get the messageInstallation completed. Wait for a few minutes for ODI Standalone agent tostart up successfully. After successful completion you get the message Agent StartCommand Executed.

12. Now the newly created ODI Instance is ready for use. Launch the ODI Studio.

13. To check the logs, navigate to /home/opc/logs/odiConfigure.log.

Using Autonomous Databases in ODIThe newly created ODI repository will be pre-populated with Oracle Data Serversrepresenting all accessible Autonomous Databases based on defined policies. If youaim to use any of these as a part of your ODI transformations, then you have to addthe username and password to the Data Server properties in the Topology tab in ODIStudio.

If, at a later date, more Autonomous Databases become available to you, you can usethe "Discover ADB's" feature available in Create New Dataserver on OracleTechnology of ODI Studio, to quickly setup the additional instances that were notavailable at the time when the instance was created. When you select the requiredADB instance from displayed instance list, the wallet gets auto downloaded and onceyou provide the dataserver name, credentials and then select connection details/service profiles and save, the new Oracle Dataserver for the selected ADB instance iscreated.

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

Chapter 1Using Autonomous Databases in ODI

1-7

Page 14: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Connecting to the Pre-created ADB Dataservers in ODI Repository

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

Note:

You need to provide the username and password for the created instance asprepopulated login credentials may not work.

Using Dataserver Setup in ODI Studio

You can create additional ADB Dataservers using the Oracle technologies Dataserversetup in ODI Studio.

Navigate to the Topology navigator, expand the Technologies node in the PhysicalArchitecture navigation tree and under Oracle technology, select any pre-created ADBDataserver.

1. In the Definition tab, click Discover ADBs. The list of available ADB instances aredisplayed.

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 connectionnode.

In the Credential Details node, Credential File text box is auto-populated with therespective 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 beused to identify the Oracle instance when using database links andSQL*Loader.

4. In the Connection node,

• User/Password: Oracle user (with its password), having select privileges onthe source schemas, select/insert privileges on the target schemas and select/

Chapter 1Using Autonomous Databases in ODI

1-8

Page 15: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

insert/object creation privileges on the work schemas that will be indicated inthe Oracle physical schemas created under this data server.

• JNDI Connection: Select this check-box to configure the JNDI connectionsettings. Navigate to the JNDI tab, and fill in the required fields.

5. In the Credentials Details node,

• Connection Details - Click the Connection Details drop down arrow to choosethe required connection URL from the list of available connection URLsretrieved from tnsnames.ora.

6. Click Test Connection.

Upon successful test connection, the new Dataserver gets created in the ODIrepository.

Chapter 1Using Autonomous Databases in ODI

1-9

Page 16: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

2Working with ODI Instance

This chapter guides you to connect and work with the ODI instance.

It contains the following sections:

• Connecting to ODI Instance

• Starting ODI Studio

• Configuring Data Sources and Targets

• Reverse Engineering Data Models

• Creating Mappings

• Monitoring ODI Executions

• Installation Locations

• Patching

Connecting to ODI InstanceYou can connect to an ODI instance by using a Secure Shell (SSH) connection. MostLinux distributions include an SSH client by default. For Windows, you can download afree SSH client called PuTTY from http://www.putty.org.

Note:

When you’re logged in as the default user - opc, you can use the sudocommand to run administrative tasks.

1. To connect to your ODI instance from linux,

• Log in to your instance using SSH.

• Use the following command to set the file permissions so that only you canread the file:

$ chmod 400 <private_key>

where <private_key> is the full path and name of the file that contains theprivate 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

2-1

Page 17: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

– <private_key> is the full path and name of the file that contains theprivate key associated with the instance you want to access.

– <username> is the default name for the instance. The default user name isopc.

– <public-ip-address> is your instance IP address that you retrieved fromthe Console.

2. To connect to your ODI 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 localesetting on Linux-based instances is UTF-8, and this configures PuTTY to usethe 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 andCentOS images, the default user name is opc. For the Ubuntu image, thedefault name is ubuntu and <public-ip-address> is your instance publicIP address that you retrieved from the console.

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 instance, you might see a message thatthe server's host key is not cached in the registry. Click Yes to continue theconnection.

Starting ODI StudioTo 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 IntegratorImage, as described in Connecting to ODI Instance.

3. On your local computer, connect to your instance and create a ssh tunnel for port5901 (for display number 1):

$ ssh -L 5901:localhost:5901 –i id_rsa opc@<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 tolocalhost:1.

6. Enter the VNC password that you had provided during the stack creation.

Chapter 2Starting ODI Studio

2-2

Page 18: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

7. For connecting multiple users, after the vncpasswd utility exits, start the VNCserver by typing vncserver. This will start a VNC server with display number 1 forthe opc 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 Studioor

Double click the short icon for ODI Studio present in your Desktopor

Navigate to the location /home/opc/oracle/odi/studio/bin/odi in the VNC.

2. Connect to the repository with already populated login credentials. The LoginName value varies based on the selected repository. For ADB repostiory, theLogin Name is ODI_ADW_REPO and for MySQL Embedded repository it isODISA_MYSQL.

3. Post successful configuration, check if the newly created data server is available inthe 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. Usethe following commands to stop and start the ODI standalone agent:

sudo systemctl stop agentodi.servicesudo systemctl start agentodi.service

Use the following command to know the status of the standalone agent:

sudo systemctl status agentodi.service

Chapter 2Starting ODI Studio

2-3

Page 19: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Use the following command to view the logs:

sudo journalctl -u agentodi.service -f

5. Depending on your network, you may need to provide proxy details for thedatabase server JDBC connection.

6. Click Test connection, to check if the created ADW 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 yournetwork. Proxy may be required for accessing certain hosts, for example - OracleObject Storage.

For executing mappings and packages with the standalone agent:

• Use the following command to stop the agent:

sudo systemctl stop agentodi.service

• From the ODI OCI instance, navigate to the location /home/opc/oracle/odi/common/scripts and edit the file odi-setup.properties and remove allentries and add below mandatory properties

rcuCreationMode=trueadwInstanceOcId=<ADW_Instance_OCID> #ODI repository ADB instanceadwInstancePassword=<ADW_ADMIN_PASSWORD>odiSchemaPassword=<ODI_SCHEMA_PASSWORD> #Refer password policiesodiSupervisorUser=SUPERVISORodiSupervisorPassword=<ODI_SUP_PASSWORD> #Refer password policiesodiSchemaPrefix=<SCHEMA_PREFIX> #Refer password policies

• After adding the above properties, run python odiADWConfiguration.py.

Chapter 2Starting ODI Studio

2-4

Page 20: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

• From the same location /home/opc/oracle/odi/common/scripts locate andedit 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)

• Save the file and use the following command to start the agent:

sudo systemctl start agentodi.service

• Test the standalone agent from ODI studio to see if the agent has startedsuccessfully. Then execute the packages/mappings using the standaloneagent.

Note:

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

Note:

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

8. If you want the desktop and the VNC server to start every time you reboot theinstance, run the following commands one time, to tell the instance to restart whenthe instance is rebooted:

sudo systemctl enable graphical.targetsudo systemctl enable vncserver@:1

Chapter 2Starting ODI Studio

2-5

Page 21: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Configuring Data Sources and TargetsThe physical components that store and expose structured data in Oracle DataIntegrator (ODI) are defined as data servers. Each data server is always linked to asingle technology. It stores information according to a specific technical logic, which isdeclared in the physical schemas attached to it.

For example -

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

Reverse Engineering Data ModelsTo automatically populate datastores into the model, you reverse-engineer the model.A standard reverse-engineering uses the capacities of the JDBC driver used toconnect the data server to retrieve the model metadata. A customized reverse-engineering uses a reverse-engineering Knowledge Module (RKM), to retrievemetadata for a specific type of technology and create the corresponding datastoredefinition in the data model.

For example -

Chapter 2Configuring Data Sources and Targets

2-6

Page 22: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

For more information, refer to Creating and Reverse-Engineering a Model chapter inDeveloping Integration Projects with Oracle Data Integrator guide.

Creating MappingsMappings in Oracle Data Integrator (ODI) are the logical and physical organization ofyour data sources, targets, and the transformations through which the data flows fromsource to target. Mappings are made up of several parts, datastores, datasets, re-usable mappings, connectors, knowledge modules, variables, sequences, userfunctions, and other components. Optionally, you can specify a staging schema. Youcreate and manage mappings using the mapping editor, which opens whenever youopen a mapping. Mappings are organized in folders under individual projects, foundunder Projects in the Designer Navigator.

For example -

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

Chapter 2Creating Mappings

2-7

Page 23: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Monitoring ODI ExecutionsMonitoring your development executions consists of viewing the execution results andmanaging the development executions when the executions are successful or in error.Through Operator Navigator, you can view your execution results and manage yourdevelopment executions in the sessions, as well as the Scenarios and Load Plans inproduction. Operator navigator stores this information in a work repository, while usingthe topology defined in the master repository.

For example -

For more information, refer to Monitoring Integration Processes chapter inAdministering Oracle Data Integrator guide.

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

Table 2-1 Installation Locations

Area Location on Server

Oracle Home

(HOME of the ODI installation for patching)./home/opc/oracle

OPatch Home /home/opc/oracle/OPatch

MySQL Home /home/opc/mysql_home

Chapter 2Monitoring ODI Executions

2-8

Page 24: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Note:

To retrieve the password stored in wallet, execute the following command -

/home/opc/oracle/odi/common/scripts/getPassword.sh

.

If you had changed the ODI Repo schema user password for any reason, run thefollowing script so that the ODI Agent can connect to the repo using new credentials.

• Create a new file updateCredentials.sh in the location /home/opc/oracle/odi/common/scripts.

• In this file, add the below commands:

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>

Note:

In the above commands, change the values for <supervisorPassword><schemaPassword> fields with your respective ODI supervisor passwordand ADW Repository schema password.

• Save the file and stop the ODI agent.

• Run the script ./updateCredentials.sh.

• Restart the ODI agent.

PatchingThe ODI image on the Oracle Cloud Marketplace contains an Enterprise installation ofODI.

Patching is manual using OPatch.

Chapter 2Patching

2-9

Page 25: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

You can upgrade your existing ODI image to the latest version available on the OracleMarketplace directly, by either reusing your existing repository database or by creatinga 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 upgradationprocess.

Chapter 2Patching

2-10

Page 26: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

3Configuring ODI Marketplace Repositorieson DBCS Instance

This chapter helps you to create a new DBCS instance and set up ODI master andwork 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 andwork 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 BareMetal, VM and Exadata.

2. Select the required compartment and click Create DB System. DB SystemInformation screen appears. It allows you to configure all the required details forcreating a DB instance, such as compartment, Database name, username andpassword. All the default values are auto-populated.

3. In the Add SSH keys section, select the option Paste SSh key and provide thegenereated SSH key in the SSH key text box.

4. In the Specify the network information section, click the Virtual Cloud Networkin ODI drop-down arrow to select the required virtul cloud network.

5. Provide the required details in Hostname Prefix, Host domain name and Hostdomain URL text boxes. Click Next.

6. Create Administrator Credentials screen appears allowing you to configure thepassword 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 lowercase, two special characters (which includes _, # or -) and two numericcharacters.

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 toinstall ODI schemas using RCU. After installing the schemas you can set up ODI onDBCS by providing the DBaaS connection credentials.

3-1

Page 27: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

For more information on creating schemas using RCU, refer to Creating the Masterand Work Repository Schemas chapter of Installing and Configuring Oracle DataIntegrator guide.

Configuring the Domain for a Standalone Agent

Create and configure a standalone domain for a standalone agent using theConfiguration Wizard. For more information on configuring ODI Domain($ODI_DOMAIN_HOME) with Standalone/JEE Agent template, refer to Configuring theDomain for a Standalone Agent chapter of Installing and Configuring Oracle DataIntegrator 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 thelocation $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 andConfiguring Oracle Data Integrator guide.

Chapter 3

3-2

Page 28: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

4Configuring Oracle Enterprise Manager forOracle Fusion Middleware on Oracle CloudMarketplace

This chapter helps you to access Oracle Enterprise Manager Fusion MiddlewareControl Console on Oracle Cloud Marketplace, and display WebCenter-related pagesfrom where you can perform all necessary configuration, monitoring, and managementtasks.

Prerequisites

Ensure to configure the following prerequisites before configuring Oracle EnterpriseManager 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 inOracle Cloud Marketplace and the default STB schema name isADW11_STB. Check with support team to know the exact schema name.You can also find the schema name in odi-setup.properties file.

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

Note:

This is a Java EE Agent and when you create it in ODI studio it worksonly after completing all the configurations in the configuration wizardand starting admin and manager servers.

Configuring Oracle Enterprise Manager

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

1. Navigate to /home/opc/oracle/oracle_common/common/bin and execute the fileconfig.sh using the command /home/opc/oracle/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 clickBrowse to select the desired domain location. The selected location appears inthe Domain Location text box. Click Next.

4-1

Page 29: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

3. From the Templates screen, select Create Domain Using Product Templatesoption. Available Templates appear. Select Oracle Data Integrator - Console,Agent and Enterprise Manager Plugin. All the dependent templates are selectedautomatically. Click Next.

4. From the Application Location screen, click Browse to select the desiredlocation for the application. The selected location appears in ApplicationLocation text box. Click Next.

5. From the Administrator Account screen, provide the admin server logincredentials in the following fields:

• Name

• Password

• Confirm Password and click Next.

6. From the Domain Mode and JDK screen, for JDK, select Oracle HotSpot1.8.0_191/home/opc/jdk1.8.0_191 option and click Next.

7. From the Database Configuration Type screen, for Specify AutoConfigurationOptions Using parameter, select RCU Data option and fill-in the required detailsfor the following fields:

• Connection URL

• Schema Owner

• Schema Password

Click Connection Properties. The Connection Properties screen displays thefollowing details:

oracle.net.authentication_service TCPSoracle.net.ssl_server_dn_match falsejavax.net.ssl.trustStore /home/opc/wallet/cwallet.sso (Path of the wallet location)javax.net.ssl.keyStoreType SSOjavax.net.ssl.keyStore /home/opc/wallet/cwallet.sso(Path of the wallet location)javax.net.ssl.trustStoreType SSO

Note:

Make sure to provide the path for truststore and keystore parameterssame as the path of your wallet file.

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

8. Provide the essential details in Component Datasources screen.

Note:

Make sure to change the connection string, connection properties foreach component schema, as they are not carried forward from theprevious screens.

Chapter 4

4-2

Page 30: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Figure 4-1 Sample for Component Datasources

This image is a sample with changes for component LocalSvcTblSchema and youhave to make changes for the following:

• WLS Schema

• ODI Master Schema

• ODI Work Schema

• OPSS Audit Schema

• OPSS Audit Viewer Schema

• OPSS Schema

Figure 4-2 Sample for OPSS Audit Schema

Chapter 4

4-3

Page 31: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

Figure 4-3 Sample JDB Test Configuration

10. From the Credentials screen, enter the Supervisor password for your ODIinstance and click Next.

11. From the Advanced Configuration screen, select the check boxes for thefollowing servers/services:

• Administration Server

• Node Manager

• Topology

• Deployments and Services and click Next.

12. The Administration Server screen displays the port number in which the adminserver listens. It is auto-populated by default. Click Next.

13. From the Node Manager screen, provide the node manager login credentials inUsername, Password and Confirm Password fields and click Next. Nodemanager login credentials can be same as Admin server login credentials, whichmeans you can use the same username and password for logging into both Nodemanager and Admin server.

14. From the Managed Servers screen, provide the server name and port details inServer 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. ClickAdd, to add new server templates, if required, else, click Next. Assign the requiredserver template to the newly created Cluster.

Chapter 4

4-4

Page 32: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

17. The Coherence Cluster screen displays the available cluster name and portnumber. Click Next.

18. In the Machines screen, click Add, to add a machine and provide the name, portand address of the Node Manager. After adding a machine, add Admin serverand 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 andport offset. Click Next.

20. The Partitions screen displays the details of all the available partitions. ClickNext.

21. The Deployments screen displays a list of all the Deployments and DeploymentTargets. Click Next.

22. The Service Targets screen displays a list of all the Services and DeploymentTargets. Click Next.

23. The Configuration Summary screen displays a summary of all the performedconfigurations. Click Create. Configuration Process screen appears displayingthe status of the process and configurations.

24. Upon completion, End of Configuration screen appears, displaying theConfiguration Succeeded message along with the configured Domain Locationand 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 thislocation is based on the created base domain.

<property name="javax.net.ssl.trustStore" value="/home/opc/wallet_ADWSAT1/cwallet.sso"/> <property name="oracle.net.authentication_service" 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="/home/opc/wallet_ADWSAT1/cwallet.sso"/>

Chapter 4

4-5

Page 33: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Figure 4-4 JPS Configuration File

2. In the command prompt, navigate to Node manager properties file /home/opc/oracle/user_projects/domains/base_domain/nodemanager/nodemanger.properties and edit the property SecureListener= false and makesure the listener port is matching with the configured port. Save the file andnavigate to the domain creation path and start the node manager using thefollowing command :

/home/opc/oracle/user_projects/domMains/base_domain/bin>./startNodeManager.sh

3. In the command prompt, navigate to the domain creation path (configured in theabove steps) and perform the following:

• Start the Admin server using the following command:

/home/opc/oracle/user_projects/domains/base_domain/bin> ./startWebLogic.sh

• Start the Managed server using the following command:

/home/opc/oracle/user_projects/domains/base_domain/bin> ./startManagedWebLogic.sh ODI_server1 http://localhost:7001

The command /startManagedWebLogic.sh helps you to start the managedserver which is required to start the ODI Console and Oracle DIAgent.

After performing all the above configurations, navigate to a web browser and accessthis URL http://<<hostname>>:<<port>>/em.

For example,

http://localhost:7001/em/

Provide your login credentials and click Sign In, to access the newly configured OracleEnterprise Manager Fusion Middleware Control Console on Oracle CloudMarketplace.

After logging in, you can check the health of the servers. From the Oracle EnterpriseManager Fusion Middleware Control Console you can start and stop the servers and

Chapter 4

4-6

Page 34: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

agents. You can also check if, the console is working by logging into the consolehttp://localhost:managedserverport/odiconsole.

Chapter 4

4-7

Page 35: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

5Configuring High Availability for ODI onOracle Cloud Marketplace

This chapter helps you to configure High Availability (HA) topology for Oracle DataIntegrator on Oracle Cloud Marketplace. The sections in this chapter outline theconcepts 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

Setting Up 2-Node Cluster for High AvailabilityFollow 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 HighAvailability. Make sure you have the following before setting up 2-Node Cluster forHigh Availability:

1. OCI Virtual Cloud Network (VCN) setup that supports communication with all thecompute 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 inStep 1.

3. ODI compute instance 1 created in the same subnet and VCN as described inStep 1.

4. ODI compute instance 2 created in the same subnet and VCN as described inStep 1.

5. Firewall configurations in all the compute instances that are part of the cluster.

• Enabling Incoming Ports and Services (through firewall commands).

Configuring Horizontal ClusteringFollow the below steps for configuring Horizontal 2-Node Clustering for ODI on OracleCloud Marketplace.

5-1

Page 36: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

1. Node-1 and Node-2 have middleware home installed on the same path and havethe 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 Clusteringusing JEE Agent template.

• RCU association - STB schemas created in step (2)

• Managed Servers - ODI_Server1 on Node1 with port 8001 ; ODI_Server 2 onNode 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.propertiesfile, set the property SecureListener=false and make sure thelistner 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 managedserver port address (8001 in the example)

b. Listener : This the front-end address that ODI repository queries forcommunicating with the agent. Based on your need it can be any of thefollowing :

– 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 followingparameters :

a. OracleDIAgent with Load Balancer Listener Host Address

b. Load Balancer Port Address

Chapter 5Configuring Horizontal Clustering

5-2

Page 37: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

c. webapp(context)- oraclediagent

d. agent work repository (workrep)- jdbc/odiMasterRepository orjdbc/odiWorkRepository

• Node-1 or Node-2 through WLS Console : Configure Coherence cacheconfiguration.

– Through WLS Admin Console - Configure Coherence cache properties forUNICAST clustering in JAVA_OPTIONS for managed server startup.

a. tangosol.coherence.localport configuration parameter defines theport which a node in the cluster can use for coherence cluster. It isconnected by agent nodes to detect coherence cluster existence andother coherence communication.

b. All the ODI Agents deployed on a cluster must be connected to thesame Coherence cluster cloud. This enables the agents to share theknowledge of the tasks performed by each of them as well as allow forScheduling Service migration when needed. Following properties areintroduced to configure the Coherence listen addresses.

* oracle.odi.coherence.wkaN : The host name of a ManagedServer.

* oracle.odi.coherence.wkaN.port : Coherence Unicast portconfigured 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.

Chapter 5Configuring Horizontal Clustering

5-3

Page 38: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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 inthe cluster.

2. Load balancer created can either be private or public. It is alwaysrecommended to configure public end-points with SSL. For moreinformation on this, refer to Overview of Load Balancing.

3. The subnets can be regional or specific to an Availability domain. Formaximum availability, Oracle recommends you to configure regionalsubnets. For more information, refer to VCNs and Subnets.

Enabling Incoming Ports and ServicesFor establishing communication between the instances, you need to ensure that theunderlying Security List (associated with VCN), has all the IP protocols enabled.

The following is an example of security list that enables communication within theinstances participating in High Availability (HA) cluster:

Note:

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

Table 5-1 Ingress and Egress Rules Table

Stateless Source IPProtocol

SourcePortRange

Destination PortRange

Type andCode

Allows Comments

No 0.0.0.0/0 TCP All 22 Nil TCP trafficfor ports:22 SSHRemoteLoginProtocol

For SSHcommunication weneed toopen port# 22.

Chapter 5Enabling Incoming Ports and Services

5-4

Page 39: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

Stateless Source IPProtocol

SourcePortRange

Destination PortRange

Type andCode

Allows Comments

No 0.0.0.0/0 ICMP Nil Nil 3,4 ICMPtraffic for:3, 4DestinationUnreachable:FragmentationNeededand Don'tFragmentwas Set

ICMP is asupportingprotocoland at theminimum,ingressrulesshouldallow fortype 3, 4and 8. Formoreinformation on ICMPprotocols,refer tothe IANAlist.

No 10.0.0.0/16

ICMP Nil Nil 3 ICMPtraffic for:3DestinationUnreachable

ICMP is asupportingprotocoland at theminimum,ingressrulesshouldallow fortype 3, 4and 8. Formoreinformation on ICMPprotocols,refer tothe IANAlist.

Chapter 5Enabling Incoming Ports and Services

5-5

Page 40: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

Stateless Source IPProtocol

SourcePortRange

Destination PortRange

Type andCode

Allows Comments

No 0.0.0.0/0 ICMP Nil Nil 8 ICMPtraffic for:8 Echo

ICMP is asupportingprotocoland at theminimum,ingressrulesshouldallow fortype 3, 4and 8. Formoreinformation on ICMPprotocols,refer totheIANAlist.

No 0.0.0.0/0 TCP All 1521 Nil TCP trafficfor ports:1521

Port 1521is fordatabasetraffic.

No 0.0.0.0/0 TCP All 443 Nil TCP trafficfor ports:443HTTPS

Port 443is the SSLtraffic.

No 0.0.0.0/0 TCP All 7001 Nil TCP trafficfor ports:7001

WLSAdminServercommunication port.

No 0.0.0.0/0 TCP All 8001 Nil TCP trafficfor ports :8001

ManagedServercommunication portfor allnodes.

No 0.0.0.0/0 TCP All 5556 Nil TCP trafficfor ports :5556

NodeManagerPort inNode1.

No 0.0.0.0/0 TCP All 5557 Nil TCP trafficfor ports :5557

NodeManagerPort inNode2.

No 0.0.0.0/0 UDP All 7574 Nil UDPtraffic forports :7574

WLSClusterport

Chapter 5Enabling Incoming Ports and Services

5-6

Page 41: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

Stateless Source IPProtocol

SourcePortRange

Destination PortRange

Type andCode

Allows Comments

No 0.0.0.0/0 TCP All 8095 Nil TCP trafficfor ports :8095

OracleCoherence port onNode1.

No 0.0.0.0/0 TCP All 8096 Nil TCP trafficfor ports :8096

OracleCoherence port onNode2.

Firewall Rules

Even after setting the ingress and egress rules, in some cases the instances may notallow 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 bothmachines):

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

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

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

sudo firewall-cmd --permanent --new-service=odiwlsnodemgr2sudo firewall-cmd --permanent --service=odiwlsnodemgr --set-description="ODI WLS Node Manager2"sudo firewall-cmd --permanent --service=odiwlsnodemgr --add-port=5557/tcpsudo firewall-cmd --permanent --add-service=odiwlsnodemgr2sudo firewall-cmd --reload

Chapter 5Enabling Incoming Ports and Services

5-7

Page 42: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

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

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

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

Chapter 5Enabling Incoming Ports and Services

5-8

Page 43: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

6Troubleshooting ODI on OCI

This chapter describes about various services associated with ODI on OCI and waysto troubleshoot them when you encounter issues while using them.

Note:

If you are facing issues connecting to ADW dataserver and MySQLrepository after long hours of inactivity, try reconnecting to ODI repository toovercome this problem.

For ODI Repository on ADB

Service available in ODI VIM:

agentodi.service

Essential commands necessary for troubleshooting these services are:

• Use the following command to check the status of agentodi service:

systemctl status agentodi.service

• Use the following command to check the log of agentodi service:

In a commandline type: journalctl -u agentodi.service -f

systemd-journald can be configured to persist your systemd logs on disk, and italso provides controls to manage the total size of your archived logs. Thesesettings are defined in /etc/systemd/journald.conf. To start persisting your logs,uncomment the Storage line in/etc/systemd/journald.conf and set its value topersistent. Your archived logs will be held in /var/log/journal. If this directorydoes not already exist in your file system, systemd-journald will create it. Afterupdating your journald.conf, load the change: sudo systemctl restart systemd-journald

• Use the following command to restart the agentodi service:

systemctl daemon-reloadsystemctl restart agentodi.service

6-1

Page 44: Using Oracle Data Integrator on Oracle Cloud Marketplace · Marketplace Oracle Data Integrator on Oracle Cloud Marketplace is a product offering that enables customers to quickly

Note:

Use the following commands to start or stop any of the services:

sudo systemctl start <service_name>sudo systemctl stop <service_name>

For Embedded Repository

Service available in ODI VIM:

agentodi.servicemysqlodi.service

• Use the following command to restart mysql service:

systemctl daemon-reloadsystemctl restart mysqlodi.service

• While connecting to your ODI repository, if you had closed your MySQL instanceby mistake,use the following commands to restart it:

sudo systemctl stop mysqlodi.servicesudo systemctl start mysqlodi.service

• Use the following command to get the MySQL user password:

/home/opc/oracle/odi/common/scripts/getPassword.sh

This command helps you to get the default password for all MySQL users (root/DEV_ODI_REPO).

Note:

Do not change the default password for DEV_ODI_REPO user.

Chapter 6

6-2