2 Get Started

To get started with Oracle Data Integration Platform Cloud, subscribe to Oracle Cloud, create a Data Integration Platform Cloud instance, add users, and then provide access to your users.

Before You Begin with Oracle Data Integration Platform Cloud

Before you begin with Oracle Data Integration Platform Cloud, you should have:
  1. An Oracle Cloud account. See About Oracle Cloud Accounts.
  2. Your Oracle Cloud account details. You can locate your Oracle Cloud account details in the post-activation email that you receive on creating the account.
  3. Service Administrator role for your Oracle Cloud services. When the service is activated, Oracle sends the sign-in credentials and URL to the designated Account Administrator. The Account Administrator then creates an account for each user who needs access to the service.
  4. A supported browser, such as:
    • Microsoft Internet Explorer 11.x+

    • Mozilla Firefox ESR 38+

    • Google Chrome 42+

    • Apple Safari 8.x and 7.x

How to Begin with Oracle Data Integration Platform Cloud

Here’s how to get started with free Oracle Data Integration Platform Cloud promotions and subscriptions:

  1. Sign up for a free credit promotion or purchase a subscription.

    See Requesting and Managing Free Oracle Cloud Promotions or Buying an Oracle Cloud Subscription in Getting Started with Oracle Cloud

  2. Access the Oracle Data Integration Platform Cloud service.

    See Access Oracle Data Integration Platform Cloud.

To grant access to others:

Access Oracle Data Integration Platform Cloud

You can access Oracle Data Integration Platform Cloud through emails that you receive after subscribing or through the service web console.

To access Oracle Data Integration Platform Cloud:

  1. Sign in to your Oracle Cloud account. If this is your first time signning in, refer to the Welcome email you received when you purchased your subscription for more information.

  2. Open the navigation menu in the upper left corner, select Platform Services, and then Data Integration Platform or Data Integration Platform Classic, depending on the type of service you have.

  3. You can either create a new Data Integration Platform Cloud instance, or if there are instances available, select one to access.

Assign Oracle Data Integration Platform Cloud Roles

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Data Integration Platform Cloud is integrated with Oracle Identity Cloud Service for security and access management. You can use this service to create users and assign roles to them.

Assign Roles for the Data Integration Platform Cloud Classic Service

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Service roles determine what a user can do within the Data Integration Platform Cloud Classic service, such as create and delete instances.
Assign the following roles to users who will create and delete instances:
  • DICS_ENTITLEMENT_ADMINISTRATOR: This role enables users to create and delete Data Integration Platform Cloud service instances and perform all tasks available in the Services, Activity and SSH pages of Data Integration Platform Cloud.
  • Compute.Compute_Operations: For the Compute service, this role enables users to create Oracle Public Cloud service instances.
To assign roles to the service:
  1. Log in to Oracle Cloud as a user with the IDCS Administrator role.
  2. From the navigation menu in the upper left corner, select Identity, Federation, and then your Identity Cloud Service provider.
  3. Select a user, and then click Manage Service Roles.
  4. Click the menu for DICS, and then select Manage service access.
  5. Select DICS_ENTITLEMENT_ADMINISTRATOR, and then click Save Role Selections.
  6. Click the menu for Compute, and then select Manage service access.
  7. Select Compute.Compute_Operations, and then click Save Role Selections.
  8. Click Apply Service Role Settings.

Assign Roles for Data Integration Platform Cloud Classic Instances

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Instance roles to determine what a user can do within a specific Data Integration Platform Cloud instance.

You can access the following with each Data Integration Platform Cloud instance:

  • Data Integration Platform console, available through the action menu of any Data Integration Platform Cloud instance

  • Oracle Data Integrator console, available through the user menu of Data Integration Platform Cloud console

  • Enterprise Data Quality console (available with Governance edition), available through the user menu of Data Integration Platform Cloud console

  • WebLogic Server console, available through the action menu of any Data Integration Platform Cloud instance

  • Fusion Middleware console, available through the action menu of any Data Integration Platform Cloud instance

The following table lists the instance level roles that you can assign to your users.

Role in Identity Cloud Service Equivalent ODI Profile Description Is Admin?

Administrator

Profiles ending in ADMIN

Service application administrator role

Yes

Developer

DESIGNER (Use in ODI Studio for ELT designs)

Service application developer role

No

User

OPERATOR (Use in ODI console for job execution and status review)

Service application user role

No. For example, this user will not have the Management tab in the ODI console available to them.

To assign roles to instances:

  1. Log in to Oracle Cloud as a user with the IDCS Administrator role.

  2. From the navigation menu in the upper left corner, select Identity, Federation, and then your Identity Cloud Service provider.

  3. Select a user, and then click Manage Service Roles.

  4. Click the menu for DICS, and then select Manage instance access.

  5. Select the roles to assign.

  6. Click Save Instance Settings, and then Apply Service Role Settings.

For more information, see Manage Security for Service Instances.

Create Instances for Data Integration Platform Cloud

There are several ways that you can create a Data Integration Platform Cloud instance, depending on your requirements and experience level.

Create Data Integration Platform Cloud Instances

Only ADIPC This topic does not apply to Data Integration Platform Cloud Classic. It applies only to Data Integration Platform Cloud.

Follow these steps to create a Data Integration Platform Cloud instance.
You can also refer to the Create a Data Integration Platform Cloud Instance tutorial.
  1. Log in to Oracle Cloud.
  2. In the console, open the navigation menu in the upper left corner, and select Platform Services, and then Data Integration Platform.
  3. On the Instances page, click QuickStarts.
  4. Select a Data Integration Platform Cloud service edition, and then click Create.

QuickStart Data Integration Platform Cloud Classic Instances

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Get started with Data Integration Platform Cloud Classic quickly and easily using the QuickStart option on your Service Overview page.

The QuickStart option provisions a Database Cloud Service instance followed by a Data Integration Platform Cloud Classic instance with the following details:

  • Database Cloud Service: Oracle Database 12.1.0.2, Enterprise Edition. 1 PDB, 1 OCPU, 15 GB Memory

  • Data Integration Platform Cloud Classic: Enterprise Edition, 1 OCPU, 15 GB Memory

Each of these instances are configured on one virtual machine. These two instances are configured to see each other and the schemas for the Data Integration Platform Cloud Classic instance are stored in the database instance. Neither of these instances have a backup option.

These instances are typically used for creating sandbox environments or in cases that don't require backup and recovery. The QuickStart templates give you the fastest and easiest way to create a Data Integration Platform Cloud Classic instance. All you need to do is provide an instance name and then click Create.

Note:

QuickStart instances are offered through Oracle Cloud Stack, which is an Oracle Cloud service that allows several Oracle Cloud instances stacked and created together.

QuickStart a user-managed instance:

  1. Log in to Oracle Cloud.

  2. In the console, open the navigation menu in the upper left corner, select Platform Services, and then Data Integration Platform Classic.

  3. On the Data Integration Platform Cloud Classic Instances page, click QuickStarts.

  4. On the QuickStarts page, enter a name for your instance in the Instance Name field, and then click Create.

  5. In the Confirmation dialog, click Download to download the credential file that you’ll need if you want to access your database and Data Integration Platform Cloud Classic VMs, and then click Create.

  6. Click Navigation Menu to access the navigation pane, and then select Cloud Stack.

  7. On the Stacks page, confirm that your instance appears in the list.

Allow some time to pass before using your QuickStart instance. When you refresh the page and the Status: Creating Instance no longer appears, you’ll know your instance is ready to use.

Create Data Integration Platform Cloud Classic Instances

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

To create Data Integration Platform Cloud Classic instances, you must first provision an Oracle Database Cloud Service instance and optionally an Oracle Storage Classic container (for backup and recovery).
Find Your User-Managed Services and Backup Location

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Before you provision Storage Classic, Database, and Data Integration Platform Cloud instances, it may be helpful to determine the REST Endpoint url that you’ll use for your Storage Classic container.
  1. Log in to Oracle Cloud.
  2. From the navigation menu, select Storage Classic, and then click Account.
  3. Under Account Information, copy the REST Endpoint URL and paste it into a text editor to use later.
Create an Object Storage Classic Container

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

A container is a storage compartment that provides a way to organize the data stored in Oracle Cloud Infrastructure Object Storage Classic.

Any user with the Service Administrator role can create containers. You should create at least one container for your account. Containers are similar to a directory structure but with a key distinction, unlike directories, containers cannot be nested. By default, all containers are of the standard storage class (as opposed to the archive storage class). You can also create containers when provisioning an Oracle Database Cloud Service deployment or Data Integration Platform Cloud instance.

Note:

Before you create your first container, make sure that the replication policy has been set for your account. See Selecting a Replication Policy for Your Service Instance

Interface Resources

Web Console

(Not available on Oracle Cloud at Customer)

Creating a Container Using the Web Console

RESTful API

Creating Containers Using the REST API

Java Library

See createContainer in Java API Reference for Oracle Cloud Infrastructure Object Storage Classic.

File Transfer Manager API

See createContainer in Java API Reference for Oracle Cloud Infrastructure Object Storage Classic File Transfer Manager.

File Transfer Manager CLI

See Create Container in Command-Line Reference for Oracle Cloud Infrastructure Object Storage Classic.

To create an archive container, you must set the X-Storage-Class header to Archive. For more information, see Creating Archive Containers. (Not available on Oracle Cloud at Customer)

Creating a Container Using the Web Console

(Not available on Oracle Cloud at Customer)

  1. Log in to the Oracle Cloud Infrastructure Object Storage Classic console.

  2. Click Create Container.

    The Create Container dialog box is displayed.

  3. Enter a name for the container.

    Note:

    Ensure that the container name complies with the input restrictions mentioned in Character Restrictions.
  4. Select Standard in the Storage Class field.

  5. Click Create.

    The container is created and displayed in the console.

Creating a Container Using the REST API

cURL Command Syntax

curl -v -X PUT \
     -H "X-Auth-Token: token" \
     accountURL/containerName

Note:

When you send a REST API request to Oracle Cloud Infrastructure Object Storage Classic, all non-ASCII characters in container names, object names and metadata values must be URL-encoded. For example, my container should be encoded as my%20container, where %20 is the HTML encoding for the space character. Similarly, my Über Container should be encoded as my%20%C3%9Cber%20Container, where %20 represents the space character and %C3%9C is the Ü character.

HTTP Response Codes

cURL Command Example

Sample Cloud account with the following details:
  • Account name: acme
  • REST Endpoint URL: https://acme.storage.oraclecloud.com/v1/Storage-acme
  • REST Enpoint (Permanent) URL: https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365

    Note:

    The REST Enpoint (Permanent) URL is displayed for accounts created after November 2017.
  • Using the REST Enpoint URL obtained from the REST Endpoint field:
    curl -v -X PUT \
         -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
         https://acme.storage.oraclecloud.com/v1/Storage-acme/FirstContainer
    

    The following is an example of the output of this command:

    > PUT /v1/myservice-bar/FirstContainer HTTP/1.1
    > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.14.0.0 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
    > Host: foo.storage.oraclecloud.com
    > Accept: */*
    > X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b
    >
    < HTTP/1.1 201 Created
    < Date: Fri, 06 Mar 2015 10:34:20 GMT
    < Content-Length: 0
    < Content-Type: text/html; charset=UTF-8
    < X-Trans-Id: tx23a1084b8c674fdeae8d4-0054f982ac
    < Cache-Control: no-cache
    < Pragma: no-cache
    < Content-Language: en
    
  • Using the Service Permanent REST Endpoint URL from the REST Endpoint (Permanent) field:
    curl -v -X PUT \
         -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
         https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365/FirstContainer

    The following is an example of the output of this command:

    > PUT /v1/Storage-7b16fede61e1417ab83eb52e06f0e365/FirstContainer HTTP/1.1
    > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.14.0.0 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
    > Host: storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com
    > Accept: */*
    > X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b
    >
    < HTTP/1.1 201 Created
    < Date: Fri, 06 Mar 2015 10:34:20 GMT
    < Content-Length: 0
    < Content-Type: text/html; charset=UTF-8
    < X-Trans-Id: tx23a1084b8c674fdeae8d4-0054f982ac
    < Cache-Control: no-cache
    < Pragma: no-cache
    < Content-Language: en

For informationa bout setting the replication policy in the container, see Selecting a Replication Policy Using the REST API.

For information about getting details of a container, see Getting Container Metadata.

Provision Oracle Database and Exadata Cloud Instances

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Learn how to create Oracle Database Cloud and Oracle Exadata Cloud instances.
Create an Oracle Database Cloud Service Instance

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Using Data Integration Platform Cloud Classic requires a subscription to Oracle Database Cloud Service and instance created. Learn how to create an Oracle Database Cloud Service instance for use with Data Integration Platform Cloud Classic.

Before You Begin

An SSH public/private key pair (Optional)

An SSH public key is used for authentication when you use an SSH client to connect to a compute node associated with the deployment. When you connect, you must provide the private key that matches the public key.

You can have the wizard create a public/private key pair for you, or you can create one beforehand and upload or paste its private key value. If you want to create a key pair beforehand, you can use a standard SSH key generation tool. See Generating a Secure Shell (SSH) Public/Private Key Pair.

After Your Database Deployment Is Created

After your database deployment is created, you should perform the following actions:

  • Update cloud tooling

    While the base images used to create Database Cloud Service database deployments are updated regularly, it is possible that even more recent updates to the cloud tooling are available. Therefore, you should check for and apply any updates to the cloud tooling. See Updating the Cloud Tooling on Database Cloud Service.

  • Apply database patches

    While the base images used to create Database Cloud Service database deployments are updated regularly, it is possible that a newer patch set update (PSU) or bundle patch (BP) is available. Therefore, you should check for and apply any database patches that are available. See Applying a Patch.

Create an Oracle Database Exadata Cloud Service Instance

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Oracle Data Integration Platform Cloud supports capturing from, and delivering to Exadata Cloud Service. The replication is based on the remote capture and delivery architecture. Oracle Data Integration Platform Cloud captures from on-premises Oracle Databases and sends data to a Data Integration Platform Cloud instance. This instance connects to Database Cloud Service in Exadata Service through SQL*Net and performs remote delivery (integrated delivery).

You must create an Exadata Cloud Service database deployment that is properly configured for use as a Data Integration Platform Cloud replication target before you create a Data Integration Platform Cloud instance.

Before you can create a database deployment, you must have an active Exadata Cloud Service instance in place.

Note:

If you do not have an active service instance in place, then the Create Service wizard will not show the options required to create a deployment on Exadata Cloud Service.

Review Creating an Exadata Cloud Service Instance

You must complete the following fields when using the wizard.

  • Service level: Oracle Database Exadata Cloud Service.

  • Database release: This selection determines the version of Oracle Grid Infrastructure that is configured.

    Database releases Version of Oracle Grid Infrastructure

    Oracle Database 11g Release 2 or Oracle Database 12c Release 1

    Oracle Grid Infrastructure 12c Release 1 is installed and can only be used to support version 11.2 or version 12.1 database deployments. In this case, you cannot later use the Create Service wizard to create a version 12.2 database deployment.

    Oracle Database 12c Release 2

    Oracle Grid Infrastructure 12c Release 2 is installed and used to support all of your database deployments, including subsequent deployments that use an earlier Oracle Database release version.

    If you wish to deploy Oracle Database 12c Release 2 on a system that is already configured with Oracle Grid Infrastructure 12c Release 1, then you must manually upgrade to Oracle Grid Infrastructure 12c Release 2 and manually create the version 12.2 database deployment. For details see My Oracle Support note 2206224.1.

  • Database edition: The only valid option for use with Exadata Cloud Service is Enterprise Edition — Extreme Performance.

Configure the database deployment for use as a replication database by setting the Enable Oracle GoldenGate option on the Service Details page of the wizard.

The target database must be network accessible on the listener port by:

Once you have created and properly configured an Exadata Cloud Service database deployment for use as a replication target, you can create an Oracle Data Integration Platform Cloud instance that uses it.

When provisioning your Database, you can select any Oracle Database Exadata Cloud Service you already have.

  1. You first create the Oracle Database Exadata Cloud Service instance by launching the wizard. The wizard is invoked through the Open Service Console button on the Cloud My Services Dashboard related to the Exadata Cloud Service.

  2. Provide all the Instance Details:

    Instance Details fields Description

    Name

    The name for your service instance is no longer than 25 characters, starts with a letter, not contains spaces or other special characters and is unique within the identity domain.

    Data Center

    The data center that will host your Exadata Cloud Service instance.

    Plan

    A plan is associated with a set of attributes that apply to a service. For Exadata Cloud Service only one plan is available.

    Rack size

    Select the option that describes the number of compute nodes and Exadata Storage Servers that you have.

    Extra number of OCPUs (Cores)

    Optionally you can enter a number of additional CPU cores that you want to enable.

    Exadata System Name

    The Exadata Database Machine environment. This name is also used as the cluster name for the Oracle Grid Infrastructure installation.

    Database backups on Exadata Storage (Yes or No)

    Check this option to configure the storage to enable local database backups on Exadata storage.

    Administrator Details

    Provide information about the administrator of your Exadata Database Machine environment

  3. Create the Service instance by clicking in the Create Service Instance button.

  4. In the Overview you can also review additional information: (like the Service Start Date and the Version).

    Note:

    When you run the Oracle Database Cloud Service provisioning wizard, always select an Oracle Database Exadata Cloud Service option. This action is to have the Oracle Database software pre-installed on an Oracle Exadata machine. Using this option, Database Service instances are created on available Exadata infrastructure.

  5. When configuring your Oracle Database Cloud Service, you select Exadata System for your service instance.

  6. Finally, when configuring your Oracle Data Integration Platform Cloud instance, you select the Database Cloud Service that has Exadata.

Follow the steps through the tutorial Get Started with Oracle GoldenGate Cloud Service

To enable Oracle Data Integration Platform Cloud replication, you need to file an SR to whitelist the GGCS IP address so that GGGCS can communicate with the Exadata DB instance with the SQL*Net connection. The SR would typically include the following information:

  • IdentityDomain ID -xxxxxx of the GGCS VM

  • Source Compute instance - GGCS VM IP address

  • Exadata CS SQL*Net Port: 1521

You can find additional Exadata Cloud Service documentation at: Enabling Access to a Compute Node Port

Note:

  • Oracle Data Integration Platform Cloud doesn't support Oracle database 12.2 capture yet.

  • With Exadata CS X6, you can complete the whitelist operation using the UI interface.

Provision and Access an Oracle Data Integration Platform Cloud Classic Service Instance

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Learn how to create Data Integration Platform Cloud Classic instances, access a VM through SSH, and create access rules.
Create an Oracle Data Integration Platform Cloud Classic Service Instance

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You can provision an Data Integration Platform Cloud Classic service instance after you’ve created your Database Cloud Service instance.

To create a Data Integration Platform Cloud Classic service instance, you can either use the Create Service wizard as described here, or you can follow the steps in the Create a Data Integration Platform Cloud Classic instance on Oracle Cloud Infrastructure Classic tutorial.

Before you Begin

When you create a Data Integration Platform Cloud Classic service instance, you provide information about the instance itself and its related resources. Therefore, make sure you have the required information about the following resources available:

  • Your Database Cloud Service instance

  • Your Oracle Cloud Storage container

Create an Oracle Data Integration Platform Cloud Classic Service Instance

To create a new Data Integration Platform Cloud Classic service instance:

  1. Log in to Oracle Cloud.
  2. In the Oracle Cloud Infrastructure console, open the navigation menu in the upper left corner, select Platform Services, and then Data Integration Plaform Classic.

  3. Click Create Instance.

  4. On the Service page, enter a name and description for the Data Integration Platform Cloud Classic service instance, and provide information about its high-level characteristics.

  5. Click Next.

  6. On the Service Details page, complete the following sections, and then click Next.
    • Database Configuration

      • Oracle Database Cloud Service Instance Name: Select an available Database Cloud Service instance.

      • PDB Name: Specify the pluggable database name (PDB) associated with the Database Cloud Service instance chosen from the Associated DBAAS Service Name list.

      • Database Administrator Username and Password: Enter the user name and password of the administration account for this Database Cloud Service instance.

    • Backup and Recovery Configuration

      • Cloud Storage Container: Enter the object storage location where backups of the service instance must be stored.

        Enter the URL of a container in Oracle Cloud Infrastructure Object Storage Classic using the format rest_endpoint_url/containerName. You can find the REST endpoint URL of the Oracle Cloud Infrastructure Object Storage Classic service instance in the Oracle Cloud My Services portal; for example, https://acme.storage.oraclecloud.com/v1/MyService-acme/MyContainer.

        Note:

        If the container that you specify doesn’t exist, then select the Create Cloud Storage Container check box to create the container automatically.
      • Cloud Storage Username and Cloud Storage Password: Enter the user name and password of the Oracle Cloud Infrastructure Object Storage Classic service user who created the container you specified earlier. If the container doesn’t exist, then enter the user name of a service administrator.

      • Create Cloud Storage Container: Select this check box to create the container automatically if the container that you specified doesn’t exist.

    • Weblogic Server Configuration

      • Compute Shape: Select the compute shape for the Weblogic VMs.

      • SSH Public Key: Specify the Secure Shell (SSH) client public key that’s used for authentication when connecting to a node in your instance.

        Click Edit to display the SSH Public Key for VM Access dialog, and then specify the public key using one of the following methods:

        • Select Key file name and use your web browser to select a file on your machine that contains the public key.

        • Select Key value and paste the value of the public key into the text area. Be sure the value doesn’t contain line breaks or end with a line break.

        • Select Create a New Key if you want Oracle to generate a public/private key pair for you.

      • Administrator Username and Password: Specify the administration user name and password for Weblogic.

        The password:

        • Must start with a letter.

        • Must be between 8 to 30 characters long.

        • Must contain at least one number.

        • Can include any number of dollar signs ($), hash signs (#), or underscores (_).

  7. Click Next.

    On the Confirmation page, review the information listed. If you’re satisfied with the information, click Create.

Access a Virtual Machine Through a Secure Shell

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You access the services and resources provided by the virtual machine (VM) of a cloud service instance through a Secure Shell (SSH) connection.

The SSH protocol uses two keys, a public key and a private key, to provide secure communication between two computers. You can use any SSH utility to generate a public/private key pair and later, to log in to your Oracle Data Integration Platform Cloud instance. For example, you can use PuTTY or you can use OpenSSH.

For Windows you can follow the steps through the tutorial:

Configure Access Rules

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Use access rules to define sources, destinations and ports to control network access, to or from Data Integration Platform Cloud Classic components.

To control network access to your Oracle Service instances, you can define access rules. For example, you can create rules that:

  • Enable an Oracle Database node to access multiple ports on the WebLogic Managed Server nodes

  • Enable public Internet access to a specific port on the WebLogic Administration Server node

Data Integration Platform Cloud Classic creates several default rules on a new service instance, such as public access to the WebLogic Administration Server node on port 22 for Secure Shell (SSH). Some of these are system rules, which cannot be disabled.

Make sure you consider the possible security implications before you open ports to external access.

  1. Access your service console.

  2. For the service that you want to modify, click Manage this Service, and then select Access Rules.

  3. On the Access Rules page, click Create Rule.

  4. Enter a name in the Rule Name field.

  5. (Optional) Enter a description in the Description field.

  6. In the Source field, select a source for the rule. The available source options depend on the topology of your service instance and may include:

    • PUBLIC-INTERNET: Any host on the Internet
    • OTD_ADMIN_HOST: The first Oracle Traffic Director (OTD) load balancer node
    • OTD_OTD_SERVER: All OTD load balancer nodes
    • WLS_ADMIN_HOST: The WebLogic Administration Server node
    • WLS_ADMIN: All WebLogic Administration Server nodes
    • WLS_MS: All WebLogic Server nodes
    • DBaaS:Name:DB: The database service named Name
    • <custom>: A custom list of addresses from which traffic should be allowed. In the field that appears below this one, enter a comma-separated list of subnets (in CIDR format, such as 10.11.12.13/24) or IPv4 addresses for which you want to permit access).
  7. In the Destination field, select the destination node within this service instance.

    • WSL_ADMIN: The WebLogic Administration Server node
    • WLS_ADMIN_HOST: The WebLogic Administration Server node
    • WLS_MS: All WebLogic Server nodes
    • OTD_ADMIN_HOST: The Oracle Traffic Director (OTD) Administration Server node
    • OTD_OTD_SERVER: All Oracle Traffic Director (OTD) Manager Server nodes
  8. In the Destination Port(s) field, enter the port or range of ports through which the source will be granted access to the destination.

  9. In the Protocol field, select the TCP or UDP transport for this rule.

  10. Click Create.

To return to either the Service page or the Overview page for the select service instance, click the locator links at the top of the page.

Note:

OTD has the same admin/managed server architecture as WebLogic Server. You can configure zero, one, or two load balancer nodes. The first load balancer node (OTD_ADMIN_HOST) runs the OTD admin server and managed server. The 2nd LB node (OTD_OTD_SERVER) runs an OTD managed server.  OTD components can only be used as source, to allow traffic from them to other components.

To create custom access rules, refer to the Create Access Rules tutorial.

Configure VPN as a Service (VPNaaS)

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You can connect your on-premises Oracle Database to Oracle Public Cloud (OPC) by using Virtual Private Network as a Service (VPNaaS) on Data Integration Platform Cloud Classic.

Note:

When you configure VPNaaS, you must provision Data Integration Platform Cloud Classic to use IP Network instead of a Shared Network.

For details on how to configure IP Networks, see Configuring IP Networks.

Before you begin, you should already have your on-premises Oracle Database installed and configured, and instances for DIPC already provisioned on the IP network. For details on provisioning Data Integration Platform Cloud Classic instances, see Create an Oracle Data Integration Platform Cloud Classic Service Instance; or you can follow the steps in this tutorial, Create a Data Integration Platform Cloud Classic instance on Oracle Cloud Infrastructure Classic.

Create Public DVLBR and Mapping IP Networks

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You can create a parent Virtual Load Balancer Resource (VLBR) by using REST APIs, or from the Compute Classic service console. You can use a single VLBR (INTERNET_FACING) with multiple IPNetworks available in the same account. Here, you'll learn to create a child VLBR in the console.

Create a Child VLBR

  1. Log in to the Oracle Cloud Instrastructure Cloud Classic console.

  2. In the navigation menu, select Compute Classic.

  3. Log in to the Compute Classic console, and then click the Network tab.

  4. In the left navigation pane, click Load Balancers and then select Create Load Balancer.

  5. Enter a Name, an IPNetwork, and a Parent Load Balancer.

  6. Click Create.

After you create this child-load-balancer, you can create the JLS instances using this IPNetwork or you can use the IPNetwork (Primary) used in creating VLBR.

Finding IPNetwork used in creating the DVLBR

If you’ve already created a DVLBR ( Parent VLBR) pointing to an IPNetwork, you can find it from the Compute Classic console.

  1. Click the Network tab, and from the left navigation pane, click IP Networks.

    All the IP Networks are listed in the right pane.

  2. Click the Load Balancer, and then select Overview to find the details.

Updating IPExchange

If a DVLBR already exists, select the IPNetwork that you pointed to, to create a parent VLBR ( INTERNET_FACING). Update the IPExchange to point to an IPExchange used in the Parent VLBR IPNetwork.

Note:

The same applies for all other IPNetworks in the same account that you want to use to create any JLS ( DIPC)-based services.
  1. Click the Network tab, and from the left navigation pane, click IP Exchanges.
  2. From the right pane, click Create IPExchange.
  3. Enter a Name and a Description, and click Create.
  4. Go back to the left navigation pane, click IP Networks, and then select Create IP Network
  5. Select the IPExchange from the drop-down and click Create.
Set up VPNaaS

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

VPNaaS communicates with an on-premises network through a VPN gateway. You can use a third-party device to set up the VPN gateway.
For a list of supported third-party devices and configurations, see Setting Up a VPN Connection Using VPNaaS
Here are the high-level steps for configuring a VPN connection between an on-premises Oracle GoldenGate application and a Data Integration Platform Cloud Classic server by using VPNaaS.
  1. OPC – IP Network and DIPC Instance Check
  2. OPC – Provision a VPN Connection under VPNaaS
  3. Create and Configure On-Premises Third-Party VPN Device
  4. OPC and On-Premises – Verify Tunnel Status is Up
  5. OPC and On-Premises – Verify VPN Connection
OPC – IP Network and DIPC Instance Check

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

From the Oracle Cloud Infrastructrure Compute Classic console, you can check the IP Network where Data Integration Platform Cloud Classic is provisioned.
  1. In the Compute Classic console, and click the Network tab.
  2. From the left navigation pane, click IP Networks.
  3. Check the IP Network where Data Integration Platform Cloud Classic is provisioned.
  4. Double-check Data Integration Platform Cloud Classic instance to see if it’s provisioned on the correct IP Network.

    Note:

    You must create the Internet Facing Load Balancer, before provisioning a DIPC Classic instance on an IP Network.

    You can create the Internet Facing Load Balancer by using REST APIs for Load Balancer services.

    For more details on the Load Balancer REST Endpoints, see REST API for Oracle Cloud Infrastructure Load Balancing Classic.

    Here’s an example of the cURL command syntax that can be used to create the Load Balancer.

    curl -X POST -k -H 'X-ID-TENANT-NAME: gse00013735' -u 'cloud.admin:Pass1234' -H 'Content-Type: application/vnd.com.oracle.oracloud.lbaas.VLBR+json' -i 'https://lbaas-71bde0c0714f41cd9cea9a15f414ece3.balancer.oraclecloud.com/vlbrs' --data ' {
     "name":"dipc-manl-public-lbr-central-ipnet",
     "disabled":"false",
     "region":"uscom-central-1",
     "scheme":"INTERNET_FACING",
     "compute_site":"uscom-central-1",
     "ip_network_name":"/Compute-588688908/cloud.admin/DIPCIPN"
    }'| grep "{" | python -m json.tool
    
  5. After you execute the cURL command, ensure that the status has changed to Creation in Progress.
  6. To check the successful creation of the Internet Facing Load Balancer, execute this REST API example by using cURL.
    curl -X GET -k -H 'X-ID-TENANT-NAME: gse00013735' -u 'cloud.admin:Pass1234' -i 'https://lbaas-71bde0c0714f41cd9cea9a15f414ece3.balancer.oraclecloud.com/vlbrs' | grep "{" | python -m json.to
    The Load Balancer must display aHEALTHY status after it is created.
OPC – Provision a VPN Connection under VPNaaS

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Create the VPN connection by using the Oracle Cloud Compute Classic console under the VPN menu option.
  1. Navigate to the Compute Classic console, and click the Network tab.
  2. From the left navigation pane, click IP Networks, and then VPN.
  3. Click VPN, and then under VPNaaS, click VPN Connections.
  4. Enter a Name, and set the following:
    • IP Network: Select the IP network where Data Integration Platform Cloud Classic is provisioned.

    • Connected IP Networks: Displays the IP networks that are reachable over this VPN connection.

      The VPN connection allows you to access all IP networks that are added to the same IP network exchange as the specified IP networks. For example, if there’s only one IP Network and there’s no IP Exchange attached to that network, this field is blank.

    • vNICsets: Select the vNICsets that are associated with the DIPC instance.

    • Customer Gateway: Enter the WAN IP or public facing IP address of the VPN device in the on-premises network.

      Note:

      Sometimes, the WAN IP is different from the public IP address, especially if the VPN device has Network Address Translation (NAT). Therefore, you must enter the public facing IP address of the on-premises Gateway device.
    • Customer Reachable Routes: Enter (in CIDR format) the subnet for the on-premises database server.

    • Pre-shared Key: Enter the pre-shared key (PSK).

      The value is masked as you type it. The key here must match the key entered on the on-premises VPN gateway device.

    • IKE ID: If you leave this option blank, the public IP address of the cloud gateway is used.

      The public IP is set during provisioning process.

    • Phase 1 IKE Proposal Options: Specify Phase 1 IKE options.

      Leaving this blank tells the Gateway to let all possible values to be permitted.

    • Phase 2 ESP Proposal Options: Specify Phase 2 Encapsulating Security Payload (ESP) options.

      Leaving this blank tells the Gateway to let all possible values to be permitted.

    • Require Perfect Forward Secrecy: This option is selected by default.

  5. Click Create.
    A message appears showing that the VPN connection is added. Its status on the web console is displayed as Pending/Provisioning.

    Note:

    It takes anywhere from 20 minutes to 45 minutes, for a VPNaaS instance creation. During this process, the public IP address assigned to the VPNaaS gateway and its corresponding private IP address are displayed. To set up an on-premises VPN Gateway device, you must provide the public IP address. Make a note of this IP address. Refresh the page until the VPNaaS instance is ready.

Create and Configure On-Premises Third-Party VPN Device

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You can use a third-party VPN device for an on-premises environment. The following example uses pfSense VPN appliance. This section covers the VPN configuration required for the VPN appliance, for connecting to Oracle Public Cloud's VPNaaS.

To configure pfSense VPN appliance Phase 1 settings:

  1. Click the Tunnels tab, and edit the Phase 1 General Information.

  2. Enter the Authentication and Algorithms details.

  3. For Advanced Options, select the Responder Only and the Dead Peer Detection options.

  4. Click Save.

To configure pfSense VPN appliance phase 2 settings:

  1. Click the Tunnels tab, and edit the Phase 2 General Information.

  2. Enter the SA/Key Exchange details.

  3. Set the Advanced Configuration details, and click Save.

Note:

Make sure that the Shared Key for the on-premises VPN device and the Oracle Public Cloud's VPNaaS match.

OPC and On-Premises – Verify Tunnel Status is Up

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

After you set up an on-premises third-party VPN device and create a VPNaaS instance, then you must establish a tunnel session between the on-premises environment and OPC. You have a tunnel session if both ends have a running status.
To verify if the tunnel has a running status:
  1. Navigate to the Compute Classic console, and click the Network tab.
  2. From the left navigation pane, click IP Networks.
  3. Click VPN, then under VPNaaS, click VPN Connections.
  4. In the right pane, check if the Tunnel status is Up for VPNaaS on the OPC side.
  5. To check the on-premises side, go to the pfSense VPN Status page, and see if the status is Established.
OPC and On-Premises – Verify VPN Connection

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

Before you create a Data Integration Platform Cloud Classic Connection to an on-premises database, you must verify if data can flow between the on-premises database server and the DIPC server.

To verify if there is a VPN connection, do one of the following:

  • From the on-premises database, log in to the DIPC Server, by using its private IP address.

  • From the DIPC server, log in to the on-premises database server. Then verify the connection from the Data Integration Platform Cloud Classic VM to the on-premises database server listener port by using the netcat command, nc.

Configure DIPC Connection to On-Premises Database Server as a Data Source

Only DIPC Classic This topic only applies to Data Integration Platform Cloud Classic.

You can create a Connection within Data Integration Platform Cloud Classic to an on-premises database server by using the Data Integration Platform Cloud console.
To create a Connection:
  1. From the Data Integration Platform Cloud home screen, click Create Connection and enter the General Information.
  2. In the Connection Settings section, set the following:
    • Hostname: Enter the Host IP address of the on-premises database server.

    • Port: Enter the Database Listener Port. For Oracle databases, the default value is 1521.

    • Username and Password: Enter the database user name and password.

    • Service Name: Enter the Database Listener Service Name.

    • Schema Name: Enter a schema that's set up for the database or use the default one.

    • CDB Connection:Leave blank.

  3. Click Test Connection and Save if the connection is successful.

    After you save the Connection, it appears in the Catalog, in the Connection category.

  4. Click that Connection and check the summary information or metadata/tables attached to that connection source.

The Connection that you create for an on-premises database can now be used by any job to perform data synchronization, integration, or validation.

Understand the Information on the Home page

The Home page provides you with quick access to Agents, Connections, Tasks, and Jobs, as well as a summary of active components in your Data Integration Platform Cloud instance.

At the top of the page, the menu icon displays the navigation pane. Here, you can access the Catalog, Monitor, Agents, Policies, and Admin pages. Click Home to return to the Home page at any time. When you click the Notifications icon, you’re brought to the Notifications page, where you can review a list of system messages and alerts. Click the user icon to access context-sensitive help for any page that you’re on, tutorials, videos, information about Data Integration Platform Cloud, or sign out of your session.

There are three sections to the Home page, the Welcome carousel, the Summary, and the Getting Started section.

Welcome

When you log in to Data Integration Platform Cloud, you're brought to the Home page. If it's your first time, click Watch Video to tour the interface. Afterwards, you can download an Agent, or create Connections and Tasks from the tiles in the carousel.

Summary

The Summary section displays recent and active Tasks, Jobs, Connections, and Agents in your Data Integration Platform Cloud instance. Click the title of the tile to see a filtered view of the Catalog, which displays a full list of Tasks, Jobs, or Connections, or the Agents page. Click the name of any component, Task, Jobs, Connections, or Agents, in a tile to access its page and view its metadata.

Getting Started

The Getting Started section enables you to download an Agent, or create new Tasks or other system components. Here's a list of what you can download or create:

  • Add Data to Data Lake

    Store and organize large volumes of data from different sources in its raw format into the Oracle Data Lake for later use.

    For more information, see Add Data to Data Lake.

  • Agents

    Download a DIPC Agent that orchestrates data integration tasks on your data source.

    For more information, see Set up an Agent.

  • Connection

    Create connections to define the source and target data sources.

    For more information, see Create a Connection.

  • Data Lake

    Create a repository on the Oracle Cloud to store a vast amount of data from different sources in its raw data.

    For more information, see Create a Data Lake.

  • Data Preparation

    Harvest data from a data source, perform a variety of transformations to organize and cleanse your data, and then write the resultant data to a new data entity.

    For more information, see Prepare Data.

  • Execution Environment

    Use Spark Execution on Big Data Cloud or YARN to run the Add Data to Data Lake task.

    For more information, see Set Up an Execution Environment.

  • ODI Execution

    Invoke an existing Oracle Data Integrator (ODI) Studio Scenario to perform bulk data transformations.

    For more information, see ODI Execution.

  • Policy

    Create policies to stay informed about your job activities and to schedule jobs. Set conditions by using predefined, job-related metrics. You'll get notifications when the conditions are met. 

    For more information, see What is a Policy?

  • Replicate Data

    Capture new transactions in your source data source and replicate them to a target data source.

    For more information, see Replicate Data.

  • Synchronize Data

    Copy data from a source data source to target data source, and then keep both data sources in sync. Use filter rules to include or exclude specific data entities in your job. The synchronize data task captures any change in the source schema and replicates it in the target and vice versa.

    For more information, see Synchronize Data.