Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

You must download an execution agent installer from the Agent Groups page of Oracle Integration Cloud Service to your on-premises host and run the installer to install on-premises Oracle Integration Cloud Service. This installation provides you with an expanded domain that consists of one administration server and up to two managed server on the same host. You must install an Oracle Database prior to installing on-premises Oracle Integration Cloud Service.

Restrictions

The File Adapter is not supported with on-premises Oracle Integration Cloud Service. When creating a connection, do not select this adapter in the Create Connection - Select Adapter dialog.

Note:

For Oracle CPQ Cloud Adapter to work, you must open up a port for external clients to call the services hosted on on-premises Oracle Integration Cloud Service.

System Requirements

Ensure that you satisfy the following prerequisites on your on-premises host before installing on-premises Oracle Integration Cloud Service:

  • Operating system: Oracle Enterprise Linux 6 UC4 or above

  • CPUs: 2

  • Physical memory: 8 GB

  • Hard disk space: 100 GB

  • Database: Oracle Database (XE or Standard).

  • Hostname on which to perform the installation must be entered in the /etc/hosts file. Without this entry, you receive an error during installation.

  • User performing the installation must be a member of the sudoers file. If the user is not, the chef client portion of the on-premises Oracle Integration Cloud Service installation fails.

  • The chef client must not already be installed on the host and must not be manually installed.

Note:

If you previously installed and used on-premises Oracle Integration Cloud Service, you must export your integrations and lookups and import them into Oracle Integration Cloud Service after completing installation.

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

If you previously installed on-premises Oracle Integration Cloud Service, you must perform the following steps:
  • Stop the Oracle WebLogic Server before installing the execution agent from the agenthome/userprojects/domains/agent-domain/bin directory.

    ./stopWebLogic.sh
  • Specify a new directory location during installation. The installation must be done in a new location and not over the previous installation.

To download and run the on-premises Oracle Integration Cloud Service installer.

Note:

The user installing the execution agent must be configured for sudo access to run the rpm command.
  1. Log in to the instance of Oracle Integration Cloud Service to which you are subscribed.

  2. On the Oracle Integration Cloud Service home page, click Agents.

    The Agent Groups page is displayed.

  3. Click Download.

  4. Select Execution Agent. The execution agent is used for on-premise installations of Oracle Integration Cloud Service.

  5. Select Save File when prompted to save the ZIP file to a directory location on your on-premises host.

  6. Unzip the ZIP file. The ics-executionagent-installer.bsx execution agent file is included in the ZIP file.

  7. Change the file permissions of the ics-executionagent-installer.bsx file to be executable.
    chmod 755 ics-executionagent-installer.bsx
  8. Execute the installer.

    ./ics-executionagent-installer.bsx

    This starts the authentication part of the installation. During authentication, you are prompted to specify configuration details.

  9. Enter the following authentication information when prompted:
    When Prompted With the Following... Enter...

    Enter your ICS subscription URL for authentication

    Enter the URL for the Oracle Integration Cloud Service instance to which you are subscribed. For example:
    https://podserver.us.oracle.com:7002/ics

    Ensure that you specify the correct URL. During installation, files are downloaded from this host instance. Specifying an incorrect URL causes authentication to fail.

    Enter ICS subscription Username

    Enter the user name for the Oracle Integration Cloud Service instance to which you are subscribed. For example:

    weblogic

    Enter ICS subscription Password

    Enter the password for the user name of the Oracle Integration Cloud Service instance to which you are subscribed.

    Enter HTTPS Proxy Server Host Name

    If you have a proxy server configured in your local environment, enter the server URL. For example:

    www-myproxy.us.mycompany.com

    If you do not have a proxy server, press Enter without entering a value to bypass this step.

    Enter HTTPS Proxy Server Port Number

    If you have a proxy server configured in your host environment, enter the port value. For example:

    80

    If you do not have a proxy server, press Enter without entering a value to bypass this step.

    If the information you enter is correct, the following message is displayed.
    Authentication Successful. Starting ICS On Premise Install!!

    If authentication was not successful, review the log file in the directory path shown on-screen to identify which information was incorrect.

  10. Enter the following installation information when prompted:

    When Prompted With the Following... Enter...

    What Do You Want to call this Execution Agent?

    Enter a name that you want to use for the agent ID.

    Ensure that you specify the correct value. Specifying an incorrect value causes installation to fail.

    Press enter to accept the default path or enter a new install path

    Accept the default path or enter a different directory location in which to install the on-premises Oracle Integration Cloud Server. If you enter a different directory path, it must already exist.

    Enter the user name (cannot be root) to be used for install

    Enter the UNIX user name to use for performing this installation. For example:

    builder

    Enter the group (groups <user> will list the groups of a user) of the user to be used for install

    Enter the group of the user who is performing this installation. For example:

    dba

    Press enter to accept the default value or enter a new port number

    Press Enter to accept the default non-SSL port value. Do not enter a new value. By default, the following message is displayed.
    Default HTTP Port for ICS Execution Agent: 7001

    Press enter to accept the default value or enter a new port number

    Press Enter to accept the default SSL port value. Do not enter a new value. By default, the following message is displayed.
    Default HTTPS Port for ICS Execution Agent: 7002

    Enter the password for the default user weblogic

    Enter the password for the weblogic user. After installation, you use this user name and password combination to log in to Oracle Integration Cloud Service for the first time to create additional users and assign roles to those users under the Users tab.

  11. Provide the following information for the Oracle Database:
    When Prompted With the Following... Enter...

    Database host name

    Enter the host name for the server on which the Oracle Database is installed.

    Database Port

    Enter the port number of the host.

    Database user name with the SYSDBA role

    Enter the database user name. This user is used by the Repository Creation Utility (RCU) to create the necessary schemas.

    Database user password

    Enter the password for the database user name.

    Password for on-premises schemas Oracle Integration Cloud Service

    Enter the password for the on-premises Oracle Integration Cloud Service schemas created by the RCU.

    Database SID/service name

    Enter the database system identifier (SID)/service name.

  12. Provide the following information if you want to use a front end host:

    When Prompted With the Following... Enter...
    Enter front end host

    Enter the front end host to use.

    Enter front end port

    Enter the port number of the front end host.

    Enter front end ssl port

    Enter the SSL front end port number.

    The installer connects to the Oracle Integration Cloud Server instance you specified during the authentication part of installation to verify installation details, identify heartbeat information, download files, and install components, including Oracle WebLogic Server and Oracle Integration Cloud Service. Messages are displayed on-screen.

    If installation is not successful, review the log file in the directory path shown on-screen to identify the issue.

    If installation completes successfully, the following message is displayed. The installation log file location is also displayed.
    Chef Client finished

    The on-premises installation submits a heartbeat message to the cloud version of Oracle Integration Cloud Service every five minutes to indicate that the on-premises installation is running.

  13. Log in to on-premises Oracle Integration Cloud Service with the Oracle Integration Cloud Service subscription username and password you entered in Step 10 of the installation process.

    Note that there is a Users tab on the home page for creating users and assigning roles to these users. See Creating Users and Assigning Roles. Unlike the cloud version of Oracle Integration Cloud Service, there is no Agents box for managing agents on the home page. Those management tasks are not required in on-premises Oracle Integration Cloud Service.

  14. Log in to the cloud version of the Oracle Integration Cloud Service that you specified during the authentication part of installation. This is the host from which you downloaded the execution agent at the beginning of these instructions.

  15. Click Agents.

  16. Note that Execution Agent Group is displayed. The number of agents is 1 to identify the on-premises installation of Oracle Integration Cloud Service.
    Description of ics_exec_agent.png follows
    Description of the illustration ics_exec_agent.png

  17. Click the number above Number of Agents to display the agent ID that you specified during installation. This is the agent ID of your on-premises installation.

  18. Click Monitor, then click Agents to also see details about agent health based on the heartbeat.

Starting and Stopping the Administration and Managed Servers

Use the following commands to start and stop the administration and managed servers:

  • Start the administration server:

    On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/expanded_domain/startWebLogic.sh
  • Stop the administration server:

    On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/expanded_domain/bin/stopWebLogic.sh
  • Start the managed server:

    On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/expanded_domain/bin/startManagedWebLogic.sh ics_server1
  • Stop the managed server:

    On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/expanded_domain/bin/stopManagedWebLogic.sh ics_server1

Adding Additional Managed Servers to a Cluster

When you install on-premises Oracle Integration Cloud Service, a cluster consisting of one administration server and one managed server is installed. You can install two additional managed servers in this cluster. These additional managed servers must be installed on a different host. The managed servers must be in the same subnet.

  1. Go to the installer home on the instance on which on-premises Oracle Integration Cloud Service is installed.

  2. Find and run the AddNewNode.sh script.

  3. Enter the following details when prompted:

    • New host name on which to install the additional managed server. This host must not have any old Oracle WebLogic Server installations.

    • Name for the node manager.

    • Name for the managed server (typically named ics_server1, ics_server2, and so on).

    • If you have your own load balancer, enter Y. It is recommended that you provide your own load balancer for production environments. Configure the load balancer to support SSL. Use the HTTP servlet only for testing environments, and not for a production environment.

      • Enter the load balancer server name.

      • Enter the ports.

    • If you do not have your own load balancer, enter N. This action installs an HTTP servlet that acts as a load balancer.

    The script runs and creates a ZIP file named AddNode.zip in the installation home.

  4. Copy the AddNode.zip file to the new host on which to install the managed server.

  5. Ensure that the directory path on the new host is the same as on the administration server.

  6. Unzip the file in that directory path.

    The AddNode folder is created.

  7. Change directories to that folder.

  8. Run the runOnNewNode.sh script.

    This sets up the new node and starts the new managed server.

    All managed servers must now be restarted.

  9. Start the node manager on all hosts in the cluster:

    ./Install_Home/ICSOP/data/user_projects/domains/expanded_domain/bin/startNodeManager.sh
  10. Start the administration server:

    ./Install_Home/ICSOP/data/user_projects/domains/expanded_domain/startWeblogic.sh
  11. Start the managed servers. You can start and stop the managed servers from Oracle WebLogic Server Administration Console if the node manager is running on the respective hosts.

Troubleshooting Execution Agent Installation

  • Do not log in as root.

  • Check if the database is running.

  • If setup fails, delete the ICSOPInstall folder and start a fresh setup.

  • Ensure that the download location has enough space because the installer is 3.1 GB (if it fails the browser does not provide any indication).

  • If the following error is displayed when reading any binary files or unzipping files during execution agent installation, you must remove the ics_generic.zip file from the ICSOPInstall\tmp directory and restart the installation.
    Error executing action `run` on resource 'execute[Unzipping /<PATH>/ics_generic.zip to: /<PATH>/ICSOPInstall/tmp]'