Installing A TIBCO Cloud™ Integration - Connect On-Premise Agent

The TIBCO Cloud™ Integration - Connect agent facilitates communication between the data sources used by an app. It provides secure communications to TIBCO Cloud™ Integration - Connect without opening security holes in your corporate firewall. The agent is required to communicate with both your source and target data as well as with TIBCO Cloud™ Integration - Connect in the cloud.

Note: Determining which agent type to select varies depending on the TIBCO Scribe® Online Connector being used and the location of the data being accessed, either on-premise or in the cloud.

The Connect on-premise agent can be used in apps with any Connection and with both cloud and local datastores.
The Connect cloud agent can only be used when all Connections in an app and associated datastores support the Connect cloud agent.

Refer to the documentation for the specific Connector for additional information. See the Table of Contents in the Connectors Guide for a list of TIBCO Scribe® Online Connectors.

Note: If your site uses proxy servers, see Installing a Connect On-Premise Agent with Proxy Servers or Firewalls for information.

Port Requirements

Make sure that all of the following TCP ports are open. If needed, talk to your IT Administrator:

Port 443. This port is required for outbound agent communication with TIBCO Cloud™ Integration - Connect. TIBCO Cloud™ Integration - Connect can respond to agent communication using port 443. If this port is not open, the TIBCO Cloud™ Integration - Connect agent is not fully accessible from the TIBCO Cloud™ Integration - Connect website.
Port 80. This port is required for outbound communication for SSL Certificate validation.
Ports 5671 and 5672, and 9350 through 9354. These are outbound ports used by the agent to communicate with the Enterprise Service Bus (ESB). The ESB can respond to agent communication using the same port. If your network policies prohibit you from opening these outbound ports, contact TIBCO Support for assistance with an alternate configuration.
Warning: Performance is slower when the Enterprise Service Bus (ESB) is not used.
If you have not configured your inbound and outbound ports correctly or if you have not added an exception to your firewall for TIBCO Cloud™ Integration - Connect, the computer where your Connect on-premise agent is installed may experience very high CPU usage.
See the Check Ports In Agent Environment Knowledge Base article for instructions on determining whether or not the appropriate ports can be accessed by the Agent.

Start The Connect On-Premise Agent Installation

Note: If scheduled maintenance is in progress and the software being deployed involves changes to the Agent, Agent installations are temporarily disabled and a message similar to the following is displayed:

Agent installs are disabled temporarily. Check the TIBCO Cloud Services status page for more information.

From the menu, select Environment & Tools.
Under Environment Settings, select Agents to display the Agents page.
Select the New Agent button and choose Connect On-Premise.

Run The Agent Installer

On the Install Connect On-Premise Agent dialog, select Install Connect On-Premise Agent to download the agent installer.
Select Copy to copy the Connect On-Premise Agent Key. The Agent Key is required in a later step.
Note: If you have a problem with the Agent Key, you can move the installation Wizard page aside to copy it again.
Locate the ScribeInstaller.exe file in your default downloads folder.
Right-click the installer file and select Run to begin the installation. You may see one or more Security Warning messages. Select Run or Yes as needed to open the System Configuration Check page.

Check The System Configuration

The System Configuration Check page displays, ensuring that all of the TIBCO Cloud™ Integration - Connect prerequisites have been met:

If any Connect On-Premise Agent Requirements have not been met, you are prompted to install them now.
Note: If Microsoft .NET Framework 4.7.2 or later is not installed, an error message displays. If needed, install .NET Framework 4.7.2 (full version).
Note: When you obtain third-party software or services, it is your responsibility to ensure you understand the license terms associated with such third-party software or services and comply with such terms.
Select the End User License Agreement link and review the license file. Check the I agree to the End User License File check box to accept the license agreement.
If all of the prerequisites have been met, select Next. The Agent Setup wizard opens.

Install The Connect On-Premise Agent

From the Welcome page, select Next.
Paste in the Agent Key that you copied earlier, then select Next.
Note: If necessary, move the Wizard window to copy the key.
Decide where to install the Connect on-premise agent.
- To use the default location, select Next.
- To select a different location, select Change, browse to the new location, and select Next.
Select Install Agent to install the Connect on-premise Agent, then select Finish.
After you select Finish, the agent connects with the TIBCO Cloud™ Integration - Connect cloud, which may take a few minutes. When the connection is successful, the new agent displays on the Agents page.
After an agent is installed or provisioned, its status displays in the Agents page and the agent drop-down list in apps and Connections. Agents that are ready to use display with a green Running status .

Working With Multiple Agents

While you can install multiple Connect on-premise agents on a single computer, best practice is to only use multiple agents if your site is supporting multiple Organizations, such as an ISV. In this case, you may want to install one agent for each Organization your site supports.

Note: Each agent and agent Windows Service requires additional computer resources and memory. Using multiple agents may not improve performance for a single Organization.