Download and Install the Connectivity Agent

Download and install the connectivity agent on a local host, which is typically a computer or virtual machine. If needed, you can run the agent installer as a background process and install a security certificate on the local host.

Installation Requirements

Install the connectivity agent to the instance with the minimal privilege. Do not install it as root.
Make sure you install the connectivity agent with the privileges that it needs to run.
Configure the connectivity agent to scan only the specified directories at the specified frequency.
Verify that ports or proxy are set up correctly to only allow for the connectivity agent connection to Oracle Cloud Infrastructure.
After successfully installing the connectivity agent, delete the installation key.

Download and Install the Agent

During installation, associate the connectivity agent with the agent group identifier you generated when creating an agent group in Oracle Integration. Ensure that you restrict access to the folder in which you install the connectivity agent to only those users who need to stop and start the agent.

The connectivity agent comes preseeded with the credentials that it needs to access your Oracle Integration instance.

Prerequisites:

Create one or more agent groups. See Create an Agent Group.
If you restrict access to the internet based on the target IP address, you must allowlist the Oracle Integration runtime and design-time IP addresses and the Oracle Identity Cloud Service IP address before installing the connectivity agent.
You must ensure that the directory paths to poll/read/write files are accessible to any agents in an agent group.

To download and install the agent:

Ensure that you have the required roles and permissions to install the connectivity agent.
- You must have the Java execute permission to install and restart the agent.
- You must have the ServiceAdministrator role to download the agent.
  
  See What Users Can Do in the Integrations Design Section by Role of Provisioning and Administering Oracle Integration 3.
Create a directory for connectivity agent installation on your on-premises host.

Note the following restrictions:
- Do not install the agent in a directory path that includes /tmp.
  
  The agent must never be installed in /tmp. Per the Filesystem Hierarchy Standard version 3.0, /tmp is meant for temporary files. Even though the install and agent work, it is not a recommended location for agent installation because the directory in /tmp may be deleted after the reboot of the system or agent virtual machine.
- Agent installation is not supported with use of an SSL proxy.
In the navigation pane, click Design, then Agents.
Click Download, then Connectivity Agent.
Download the connectivity agent installer to a directory on your on-premises host.
Extract oic_conn_agent_installer.zip.
If you need to add any third party JARs (for example, for the Siebel Adapter or MySQL Adapter), copy them under the agenthome/thirdparty/lib directory.

Note:
If you perform this step after installing the connectivity agent, you must restart the agent. See Restart the Connectivity Agent.
Hover over the agent group.
Click Actions , then select Download config.
This step downloads a preconfigured InstallerProfile.cfg file to use during installation. The following message is displayed.
```
BootStrap configuration downloaded for Agent Group agent_group_name. 
Replace the file in agent install location before proceeding with agent setup.
```
Replace the existing InstallerProfile.cfg template file in the oic_conn_agent_installer directory that was created when you extracted the agent installation file in Step 5 with the preconfigured InstallerProfile.cfg file you downloaded in Step 7.

The preconfigured InstallerProfile.cfg file automatically includes values for all required parameters such as oic_URL and agent_GROUP_IDENTIFIER and OAuth 2.0 token-based authentication parameters such as client ID, client secret, and scope. This eliminates the need to manually specify values for these parameters.
1. Optionally set proxy parameter values. These parameters are only required if the connectivity agent is used with a proxy in the on-premises environment.
2. If you have multiple hosts that must be 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
```
3. If you use a proxy user for Windows, 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.
Set the JAVA_HOME property to the location of the JDK installation.
Set the PATH property. For example, if csh is your shell:
```
setenv PATH = $JAVA_HOME/bin:$PATH
```
Run the connectivity agent installer from the command prompt. If you want to copy and paste this command, ensure that it does not have any special characters.
```
java –jar connectivityagent.jar
```
Wait for a successful installation message to appear.
```
Done with Agent installation & configuration... Starting agent for message processing.
Agent started successfully... listening for new messages... 
```
The agent group associated with this connectivity agent now has its own InstallerProfile.cfg file and OAuth client application in Oracle Identity Cloud Service. If you delete the agent group, the OAuth client application is also deleted in Oracle Identity Cloud Service.

If errors occur, review the agent diagnostic logs.

See Monitor Agents.

After Installation

After installing the connectivity agent, you can create a connection that uses the agent, run the agent as a service, and install a certificate.

When you create a connection that uses a connectivity agent, associate its agent group with your adapter connection in the Access type section of the Connections page. See Create a Connection with an Agent Group.
To run the connectivity agent as a service, see Run the Connectivity Agent as a Service.
Some services require you to install a certificate on the agent host. If you need to install a certificate, see Install a Certificate on the Agent Host.