Installation Steps

You must have the connectivity agent file (this is normally named oic_connectivity_agent.zip) and install it in your on-premise environment. The connectivity agent is also associated with what is called “agent group identifier” and OIC URL. The connectivity agent must also authenticate itself, which requires you to have the agent’s credentials. Reach out to your Oracle contact to get the connectivity agent file, your agent group identifier, your OIC URL, and your agent's respective credentials. You can install the agent on up to two separate environments for redundancy. To do this, repeat the same steps in both environments.

  1. Create a directory for the connectivity agent installation on your on-premises host. Consider this folder as the %AGENT_ROOT%.
  2. Unzip the connectivity agent file (that is, oic_connectivity_agent.zip) in this folder.
  3. Modify InstallerProfile.cfg to include the following information:
    # Required Parameters
    # oic_URL format should be https://hostname:sslPort
    oic_URL=https://oic_host:ssl_port
    agent_GROUP_IDENTIFIER=my_agent_group
    
    oic_USER=my_user
    oic_PASSWORD=my_password
    
    #Proxy Parameters
    proxy_HOST=
    proxy_PORT=
    proxy_USER=
    proxy_PASSWORD=
    proxy_NON_PROXY_HOSTS=
    1. oic_URL: This parameter is required. This is the HTTPS URL for the Oracle Integration host. The port is 443.
    2. agent_GROUP_IDENTIFIER: This parameter is required. This is the identifier for the connectivity agent group created in Oracle Integration. The identifier name is case-sensitive.
    3. oic_USER: This parameter provides the Oracle Integration user name. When the agent runs for the first time, this field will be encrypted in the properties file for secure persistence. The connectivity agent supports basic authentication. You cannot use the Oracle Cloud Infrastructure API key or OAuth parameters.
    4. oic_PASSWORD: This parameter provides the Oracle Integration password. When the agent runs for the first time, this field will be encrypted in the properties file for secure persistence.
    5. Proxy Parameters: These parameters are only required if the connectivity agent is used behind a proxy in the on-premises environment. If you have multiple hosts that need configured in a nonproxy host environment, you must separate each IP address or host with a pipe symbol (|) in the proxy_NON_PROXY_HOSTS parameter. For example: proxy_NON_PROXY_HOSTS=localhost|127.0.0.1|*.myorg.com.
      If your proxy user is part of a domain, the user name must include the MS domain name in front of the user name, along with double backslashes before the user name (for example, MS_domain\\username). If you do not specify the double backslashes, you receive a 407 Proxy Authentication Required error.
  4. Open a command line and run the following command to confirm that your default active Java version is 17.

    Note:

    To comply with Oracle security standards, JDK 8 and JDK 11 are being deprecated for use with the on-premises connectivity agent. You must upgrade to JDK 17 as soon as possible following the instructions in this guide.

    java --version

    If you can not set Java 17 as your default active version because you have legacy applications running old Java versions, please navigate to the bin folder under the JDK 17 installation folder before running the following commands.

    # The standdar folder in Windows
    cd "C:\Program Files\Java\jdk-17\bin"
    # The standard folder in Linux
    cd "/usr/java/jdk-17.*"
  5. Run the connectivity agent installer from the command prompt. Ensure that it does not have any special characters. 
    java –jar connectivityagent.jar
  6. Wait for a successful installation message to appear. For example:
    “Done with Agent installation & configuration... Starting agent for message processing. Agent started successfully... listening for new messages...”