Creating an Oracle E-Business Suite Development Environment in Oracle Cloud Infrastructure Compute Classic


Options



Before You Begin

Purpose

In this tutorial, you will learn how to deploy an Oracle E-Business Suite Release 12.2 or 12.1.3 development environment on Oracle Cloud Infrastructure Compute Classic, which you can use to develop customizations in Oracle Application Framework, using Oracle JDeveloper. For legacy purposes, you can also configure and use Oracle Forms or Reports.

You will create a development tools instance (virtual machine), and then integrate that with an existing Oracle E-Business Suite instance in Oracle Cloud Infrastructure Compute Classic.

Time to Complete

A minimum of 1 hour.

What Do You Need?

To perform the steps in this tutorial, you must have:

    Description of Requirements Number of Virtual Machines (VM) OCPUs Memory Storage External IPs
    Development tools instance 1 1 7.5 GB 100 GB (Block) 1
  • An existing Oracle E-Business Suite Release 12.2 or 12.1.3 installation in Oracle Cloud Infrastructure Compute Classic. If you have not already established such an environment, and plan to do so, review My Oracle Support Knowledge Document 2066260.1, Getting Started with Oracle E-Business Suite on Oracle Cloud to understand various provisioning and cloning options.

Process Overview

To create and access an Oracle Cloud Infrastructure Compute Classic (or just "Compute Classic") development tools instance for Oracle E-Business Suite, you must complete the following tasks in the order shown below:

  1. Generate an SSH key pair on your local system and upload the public key to Oracle Cloud Infrastructure Compute Classic.
  2. Create an Oracle E-Business Suite development tools instance.
  3. Configure the instance for SSH access.
  4. Set up VNC connectivity.
  5. Configure Oracle JDeveloper to work with your existing Oracle E-Business Suite instance.
  6. (Optional) Configure Oracle Forms and Reports to work with your existing Oracle E-Business Suite instance.

Generating an SSH Key Pair

Before you create your Oracle Cloud Infrastructure Compute Classic instance (in a subsequent section), you must:

  1. Generate an SSH key pair on your local system (UNIX or Windows).
  2. Upload the SSH public key to Compute Classic. This SSH public key is used for authentication when you log in to the instance.
Note: Be sure to record the public and private key names, where you saved them, and your key passphrase.

Creating an Oracle E-Business Suite Development Tools Instance

  1. Navigate to the Oracle Cloud Infrastructure Compute Classic console by following these steps:
    1. Sign in to the Oracle Cloud My Services application by navigating to https://cloud.oracle.com/sign-in.
    2. In the Cloud Account region, select the "Traditional Cloud Account" option in the account type drop-down list.
    3. Then, select your data center from the data center drop-down list.
    4. Click My Services.
    5. On the next screen, enter your identity domain. Click Go.
    6. Enter your sign in credentials. Click Sign In. This takes you to the Oracle Cloud My Services Dashboard.
    7. Click the menu button near the upper left corner of the Dashboard page to bring up the Navigation menu.
    8. Select Compute Classic to view the Compute Classic console.
  2. On the Compute Classic console, click the Instances tab, and then click Create Instance. The Create Instance wizard starts.
  3. This will bring up the Image screen. On this screen:
    1. Select Marketplace in the side navigation menu.
    2. In the Search field to the right of the side navigation menu, enter "EBS Development" and then click on the magnifying glass or press <Return>.
    3. Click the Select button below the EBS Development Tools Image.
    4. In the popup window that appears, accept the terms of use and click the Install button.
    5. When the image is available in your account, you will see a confirmation message and receive a confirmatory email.
    6. Proceed to the Shape screen by clicking the > button at the top right.
  4. On the Shape screen, select an appropriate shape for your instance. The shape specifies the number of CPUs and amount of memory your instance will have.
    1. For this tutorial, select oc1m (OCPUs: 1, Memory: 15 GB).
    2. Click the > button to proceed to the Instance screen.
  5. On the Instance screen, perform the following steps:
    1. In the <instance_name> field, enter an appropriate name. If you don’t specify a name, the instance name will be generated automatically based on the date and time.
    2. In the Label field, enter a description to help identify the instance. If you provide a label, the label is used to list the instance on the Instances tab.
    3. In the SSH Keys field, if you have already uploaded your SSH Public Key you created earlier, select it from the drop-down list.
    4. Otherwise, click on Add SSH Public Key, then:
      1. In the Add SSH Public Key dialog box, enter a name and the value of the SSH public key you generated earlier.
      2. Click Add to add your SSH public key and associate it with the instance being created. Paste the key value exactly as it was generated. Do not append or insert any extra characters, line breaks, or spaces.
    5. Click the > button to proceed to the Network screen.
  6. On the Network screen, perform the following steps:
    1. In the DNS Hostname Prefix field, enter a string that will be used as a prefix in the domain host name for your instance. For the purpose of this tutorial, you can leave this blank.
    2. For Network Options, select Shared Network. Ensure that IP Network is not selected.
    3. Using the Public IP Address drop-down, choose Persistent Public IP Reservation.
    4. An IP Reservation drop-down list will appear. If you have reserved an IP address, choose it from the list.
    5. Otherwise, click Create IP Reservation, then:
      1. In the Create Public IP Reservation dialog box, enter the desired name of your IP reservation
      2. Click Create.
    6. In the Security Lists field, either specify an existing security list (substep 1 below) or create a new one (substep 2 below).
      1. If you created a security list previously, enter its name.
      2. If you did not create a security list earlier, click Create Security List. In the dialog box, supply the following and then click Create:
        • Name: Enter the desired name of your security list. For example, you could enter ebs-net.
        • Inbound Policy: Retain the default policy, Deny (Drop Packets, No Reply).
          Note: Never set Inbound Policy to Permit, as this setting will disable the firewall and will allow any traffic into the VM instance. For more information, refer to About Security Lists in Using Oracle Compute Cloud Service (for PaaS).
        • Outbound Policy: Retain the default policy, Permit (Allow packets).
        • Description: Enter a description.
    7. Click the > button to proceed to the Storage screen.
  1. On the Storage screen:
    1. Under the Name column, you will see one volume listed, called <instance_name>_storage. The value of <instance_name> is the name you previously entered (or accepted) on the Instance screen. Do not make any changes to this name.
    2. Click the > button to proceed to the Review screen.
  1. On the Review screen, check your selections and make any necessary edits.
    1. When you are ready, click Create to start creation of your provisioning tools instance. You will see the message: "Starting orchestration <instance name>_master".
    2. The instance creation process goes through several phases, and may take a total of around 15 minutes to complete.
      Note: You can monitor progress by selecting the Orchestrations tab.
    3. When the process is complete, you will be able to click on the Instances tab to view your running instance.

Configuring Instance for SSH Access

Perform the following steps to enable SSH access to your instance.
  1. Select the Network tab.
  2. Select Security Rules from the navigation menu on the left.
  3. Select Create Security Rule and then do the following:
    • Name: Enter a name for the rule. For example, allow_ssh
    • Status: Select Enabled
    • Security Application: Select ssh
    • Source: Select the Security IP List radio button and select public-internet from the drop-down list.
    • Destination: Select the Security List radio button. Then, from the Security List drop-down list, select the security list (for example, ebs-net) you created earlier.
    • Description: Enter a description for the rule (for example, Allow SSH access to instance).
  4. Click Create.

Setting Up VNC Connectivity

Now that the development tools instance has been created, you will set it up to enable connections from a local desktop.

The VNC protocol normally uses port 59xx, where xx is the display number of the server. Most UNIX VNC servers use display numbers such as 1, 2, and so on, and may listen on ports such as 5901, 5902 and so on. If you forward these ports to a remote machine, you can make the remote VNC server appear to be a server running on your local machine.

Suppose you have a UNIX VNC server running as display :1 on a machine named testserver1, and you want a secure connection to it from your local machine. You can start the SSH session using:

$ ssh -L 5902:localhost:5901 testserver1

Note that any references to display :2 on your local machine will actually connect to display :1 on testserver1.

Note that the above SSH command line example deliberately accepts incoming connections only from the local machine. This means that to use this particular SSH connection, you must connect to it from the same machine, using the special name 'localhost', rather than using the machine's own unique name.

$ vncviewer localhost:2
  1. Connect to the instance using the Secure Shell (SSH) protocol.
  2. UNIX

    Use a command such as the following to allow the VNC client to connect on a defined port, where 127.0.0.1 is the localhost:

    $ ssh -L 5901:127.0.0.1:5901 opc@<public IP Address of instance>

    This allows the VNC client to connect to the instance from 127.0.0.1:5901.

    Linux session

    Windows

    If you are using Windows, connect from PuTTY:

    1. Open PuTTY and enter the public IP address of the cloud instance.
    2. PuTTY Configuration dialog

    3. Select your SSH private key under Connection > SSH > Auth.
    4. PuTTY Configuration dialog

    5. Specify the source and remote port numbers (including IP address). Go to Connection > SSH > Tunnels.
      PuTTY Configuration dialog

    6. Select Add, then select Open.
    7. This allows the VNC client to connect the instance with 127.0.0.1:5901.

  3. The opc user needs to be given the required access to the /u01/install/APPS location where the applications are installed on this instance. Switch from the opc user to the oracle user:
  4. $ echo $USER
    opc
    $ sudo su - oracle
    $ echo $USER
    oracle
  5. Start the VNC server:
  6. $ vncserver :1
    New <name of desktop> is <path to desktop>
    Starting applications specified in /home/oracle/.vnc/xstartup
    Log file is <path to log file>

    This creates a VNC session :1 on port 5901. The VNC password should be set for the first time when you start the VNC server. If you are not asked to set the password, use the default password oracle. You can then change the VNC password with the command vncpasswd.

    $ vncpasswd
    Password:
    Verify:
  7. Set a new password for the oracle user.
  8. $ sudo su - root
    $ passwd oracle
    $ Changing password for user oracle.
    New password:
    Retype new password:
    passwd: all authentication tokens updated successfully.
  9. Open the VNC client on your host and connect to the host by entering either localhost:5901 or 127.0.0.1:5901.
  10. VNC Viewer: Connection Details dialog

    Enter the VNC password that was set in Step 4:

    VNC authentication dialog

    This connects and opens the VNC session created in Step 3 by the VNC server.

    VNC session window

Configuring Oracle JDeveloper

Copy DBC File From Existing Oracle E-Business Suite Instance to Development Tools Instance

  1. From your local host, connect to an existing 12.2 or 12.1.3 Oracle E-Business Suite instance in Oracle Compute Cloud Service. For more information, see "What Do You Need?"
  2. $ ssh opc@<IP address of EBS instance>
  3. Log in as the root user to get the required dbc file.
  4. $ sudo su
  5. For Release 12.2, the environment file is available at /u01/install/APPS/EBSapps.env. Source the run file system environment as shown in the following example.
  6. $ . /u01/install/APPS/EBSapps.env run

    For Release 12.1.3, the environment file is available at /u01/install/APPS/apps_st/appl/APPS_<CONTEXT_NAME>.env. Source the environment as shown in the following example:

    $ . /u01/install/APPS/apps_st/appl/APPS_<CONTEXT_NAME>.env run
  7. Copy the contents of the file EBSDB.dbc, located in $FND_SECURE.
  8. $ cd $FND_SECURE
    $ cat EBSDB.dbc |
  9. Go to the Oracle E-Business Tools instance and navigate to the directory <JDeveloper installation path>/jdevbin/oaext/dbc_files/secure.
  10. Create a new file called EBSDB.dbc with the text copied on step 4.

    Session window

Create Users

After an administrator creates users and adds them to the group oinstall, they will then be able to log on with their credentials and access the Oracle JDeveloper installation.

  1. Connect to the instance using the Secure Shell (SSH) protocol.
  2. UNIX

    Use the following command to allow the VNC client on the defined port:

    $ ssh -L 5901:127.0.0.1:5901 opc@<public IP Address of instance>

    This allows the VNC client to connect to the instance with 127.0.0.1:5901.

    Windows

    For Windows users, connect from PuTTY:

    1. Open PuTTY and enter the public IP address of the cloud instance.
    2. PuTTY Configuration dialog

    3. Select your SSH private key under Connection > SSH > Auth.
    4. PuTTY Configuration dialog

    5. Enter the source and remote port numbers (including IP address). Go to Connection > SSH > Tunnels.
    6. PuTTY Configuration dialog

    7. Select Add, then select Open.
  3. Log in as the root user.
  4. $ sudo su
  5. Create a new user in the group oinstall.
  6. $ /usr/sbin/useradd -g oinstall <userid>
  7. Create a .ssh directory in the new user’s home directory.
  8. $ mkdir /home/<userid>/.ssh
  9. Get the SSH public key of the user machine. Copy the user's SSH public key to the /home/<userid>/.ssh/authorized_keys file.
  10. $ echo "key" > /home/<userid>/.ssh/authorized_keys

    Here, key is the SSH public key value from the key pair that you got from the user earlier, enclosed in double quotation marks.

  11. Add the new user to the list of allowed users in the /etc/ssh/sshd_config file on your instance, by editing the AllowUsers parameter, as shown in the following example:
  12. $ AllowUsers opc <userid>

    In this example, the AllowUsers parameter already has the opc user and the <userid> user is now added.

  13. Change the owner and group of the /home/username/.ssh directory to the new user:
  14. $ chown -R <userid>:oinstall /home/<userid>/.ssh
  15. Set the required permissions on the authorized_keys file.
  16. $ chmod 700 /home/<userid>/.ssh/authorized_keys
  17. Restart the SSH daemon on your instance.
  18. $ /sbin/service sshd restart
  19. This step is required only if the new user requires sudo privileges. To enable sudo privileges for the new user, edit the /etc/sudoers file by running the visudo command.
  20. In /etc/sudoers, look for the following line:

    %opc ALL=(ALL) NOPASSWD: ALL

    And add the following line immediately after it:

    <userid> ALL=(ALL) NOPASSWD: ALL
  21. Set the password for the new user.
  22. $ passwd <userid>
  23. Give access permissions to the root directory of the Oracle JDeveloper installation. This allows the new user to launch the tool.
  24. $ chmod -R 755 /u01

Configure User Access to Instance

  1. A new user can connect to the instance using SSH as follows:
  2. UNIX

    $ ssh -L 5901:127.0.0.1:5902 <userid>@<public IP Address of instance>

    In the above example, 5901 is a source port of the local host and 5902 is the remote host port number.

    Windows

    1. Start PuTTY. The PuTTY Configuration window is displayed, showing the Session panel.
    2. In the Host Name (or IP address) field, enter the public IP address of your instance.
    3. Note: If you don't know the public IP address of your instance, you can find it by going to the Instances tab on the Oracle Compute Cloud Service console and selecting your instance to get to the details page.

    4. In the Connection type field underneath the Host Name (or IP address) field, select the SSH radio button if it is not already selected.
      PuTTY Configuration dialog
    5. Select your SSH private key under Connection > SSH > Auth.
      PuTTY Configuration dialog
    6. Enter the source and remote port numbers (including IP address). In the Category region, navigate to Connection > SSH > Tunnels.
    7. In the Destination field, enter the dedicated remote host port number that is assigned to you. Contact your Admin, if necessary, for your dedicated remote host port number.

      PuTTY Configuration dialog
    8. Click Add, then click Open.
    9. Note that the above SSH connection is deliberately meant to accept incoming connections only from the local machine. To use this SSH connection, you must connect to it from the same machine, using the special name 'localhost', rather than using the machine's own unique name.

      Dedicate a new port number to the newly created user and recommend the user connect by always using the same port number.

      For example:

      • 5901 port to Admin
      • 5902 to user1
      • 5903 to user2

      This allows multiple users to access the instance simultaneously.

  3. Start the VNC server on the port dedicated to the user. For example, use :02 if the port assigned to the user is 5902, or :03 if the port assigned is 5903.
  4. $ vncserver :<session-number>

    In the above command, <session-number> is the last two digits of the port number. If the dedicated port number to the user is 5902 then <session-number> is 02. This creates a VNC session :02 or :03 depending on the port dedicated to the user. The VNC password should be set for the first time when a user starts the VNC server.

  5. Open VNC client on your host and connect to the VNC session by specifying either localhost:5901 or 127.0.0.1:5901.
  6. VNC Viewer: Connection Details dialog

    Enter the VNC password that was set in step 2:

    VNC authentication dialog
  7. Change the password by running the following command:
  8. $ passwd

    If you have sudo permissions, you can also set the password by running the following command:

    $ sudo passwd <userid>

Launch Oracle JDeveloper Tool

The readMe file, as shown below, is available at /home/oracle/readMe and indicates the list of applications installed and how to launch JDeveloper. Please refer to it for detailed information.

Readme file
  1. Launch JDeveloper using one of the following methods:
    • Start the script from /u01/install/APPS/scripts/startJdev.sh.
    • Use the launcher icon available on the desktop.
  2. You will be prompted for a JDeveloper workspace path. Create a workspace in your home directory. In this example, the workspace is /home/xxxxxx/toolbox.
  3. Provide the workspace path and press Enter.

    xterm Session window
  4. JDeveloper launches with a splash screen. When launching for the first time, a dialog message requesting you to confirm and continue the JDeveloper launch appears.
  5. Select the "Skip the Message Next Time" check box and click Yes.

    xterm Session window
  6. JDeveloper now launches.

(Optional) Configuring Forms and Reports

In this section, we'll describe what you need to do to run the Oracle Forms and Oracle Reports builders from the application tier of an existing Release 12.2 or 12.1.3 Oracle E-Business Suite instance in Oracle Cloud Infrastructure Compute Classic. For more information, see "What Do You Need?"

Follow the steps below to set up communication between the development tools instance (virtual machine) and the Compute Classic instance (virtual machine) that includes the Oracle E-Business Suite primary application tier. We will refer to this as the "application tier VM" (note, however, that if you have a single-node system, this VM also contains the database tier).

  1. On the development tools instance, create an SSH key pair from the oracle account.
    1. Open a terminal window on the VNC session created in the previous section.
    2. Generate an SSH key by following the steps in the Generating SSH Key Pair section of the Using Oracle Cloud Infrastructure Compute Classic documentation.
  2. On the application tier VM, enable SSH access for the oracle account.
    1. Log in to the Oracle E-Business Suite application tier as the opc user.
    2. Add the oracle user to the AllowUsers list in the /etc/ssh/sshd_config file as shown in the following example:
    3. $ sudo vi /etc/ssh/sshd_config
      AllowUsers opc oracle
    4. Enable X11 forwarding via SSH by setting the parameter X11Forwarding to 'yes' in the /etc/ssh/sshd_config file:
    5. X11Forwarding yes
    6. Restart the SSH daemon:
    7. $ sudo service sshd restart
  3. Set up SSH access between the oracle accounts in the development tools instance and the application tier VM.
    • Add the contents of the public key file /home/oracle/.ssh/id_rsa.pub on the development tools VM to the /home/oracle/.ssh/authorized_keys file on the Oracle E-Business Suite application tier VM.
  4. Test SSH connectivity.
    1. From the VNC session, open a terminal window.
    2. Test the SSH connection from the oracle account by running the following command:
    3. $ ssh -X oracle@<EBS Application Tier internal IP address>
  5. Initialize your Oracle E-Business Suite environment and launch Oracle Forms Builder or Reports Builder from the same terminal window you used for testing the SSH connectivity.
    1. Source the Oracle E-Business Suite environment on the application tier, whether you have a single node or multi-node system.
    2. $ cd <Oracle E-Business Suite Install Base>
      • If you are using Oracle E-Business Suite Release 12.2, run the following command:
        $ . EBSapps.env run
      • If you are using Oracle E-Business Suite Release 12.1.3, run the following commands:
      • $ cd apps_st/appl
        $ . APPS<ebs environment name>.env  
    3. Launch the Oracle Forms or Report Builder from the terminal window used for testing communications.
      • Oracle Forms:
        $ frmbld
      • Oracle Reports:
      • $ rwbuilder

Want to Learn More?

Change Log

Date Description
2019-04-24
  • Updated footer.
2018-06-29
  • Minor formatting enhancements.

2017-11-20

  • Minor update to "What Do You Need?" section.

2017-11-08

  • Made various updates in document to reflect updates in product/service name changes as well as UI updates.
  • Removed "User Interface" section.

2017-10-02

  • Edited login instructions to match updated UI.
  • Included 12.1.3 information in "Copy DBC File from Existing Oracle E-Business Suite Instance to Development Tools Instance" section.
  • Minor edit to "Set Up VNC Connectivity" content.

2017-05-02

  • Updated steps in "Create an Oracle E-Business Suite Development Tools Instance" to match changes in UI.
  • Updated to 03/28/17 OBE template.

2017-03-09

  • Incorporated Compute UI changes.

2016-08-02

  • Amended title.

2016-07-15

  • Made enhancements to Configure Forms and Reports section.

2016-07-08

  • Added new sections on Configure JDeveloper and Configure Oracle Forms and Reports.
  • Updated resources information in the "What Do You Need?" section.

2016-06-21

  • Updated Step 4a of "Create an Oracle E-Business Suite Tools Instance" to indicate that an automatically chosen instance name is generated from the date and time.

2016-06-06

  • Updated several sections to reflect amended features.

2016-05-27

  • Added "User Interface" section.

2016-05-23

  • Updated instructions for "Upload SSH Public Key".

2016-05-12

  • Updated OBE title
  • Added minimum requirements for Oracle Compute Cloud resources needed to implement OBE flow in "What Do You Need" section

2016-04-25

  • In section "What do you need?", removed note mentioning obsolete requirement to use an oracle.com account.

2016-03-24

  • Made various refinements and updates to reflect latest offerings and features.

2016-02-05

  • Made changes throughout document to reflect modified Cloud Service UI.

2016-01-27

  • Updated information about creating storage volumes.
  • Made minor updates throughout document.

2015-12-21

  • Initial publication.