On-Premise Agent Requirements
Note: If your Agent is running in a virtual machine and you revert to an earlier snapshot or if it is running on a computer and you revert to an earlier image, you must reinstall the Agent. If you do not reinstall, the Agent and the cloud are out of sync, causing incorrect data to display in Execution History.
If your Agent is running in a virtual machine and you clone that virtual machine, an exact duplicate of the Agent is generated with the same internal ID. This can cause incorrect data to display in TIBCO Scribe® Online because the Cloud cannot distinguish between the two Agents. On the original virtual machine, shut down the Agent before cloning. In the new virtual machine, install a new Agent, move your Solutions to that Agent, and then delete the copied Agent.
Operating Systems
On-Premise Agents are supported on computers running 64-bit operating systems supported by Microsoft .NET Framework:
Note: Install all Windows updates before you begin installing an Agent.
When setting up your production environment, install Agents in a Windows Server environment.
The following Microsoft® components are also required:
- Microsoft .NET Framework 4.7.2 (full version).
- Microsoft Windows Identity Foundation (WIF).
Note: If Microsoft .NET Framework or WIF are not already installed, you are prompted to install them before you can install the TIBCO Scribe® Online Agent. However, the configuration process run more smoothly if these applications are already available.
If your site will be using the Dynamics CRM Connector, you may need to enable WIF 3.5.
To Enable WIF:
- Open the Turn Windows features on or off dialog box.
- Scroll to and select the checkbox for Windows Identity Foundation 3.5.
- Select OK.
- Windows will turn on WIF 3.5.
Ports
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 the TIBCO Scribe® Online website. TIBCO Scribe® Online can respond to Agent communication using port 443. If this port is not open, the TIBCO Scribe® Online Agent is not fully accessible from the TIBCO Scribe® Online 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.
Important: 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 Scribe® Online, the computer where your TIBCO Scribe® Online 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.
Agent Performance
TIBCO Scribe® Online On-Premise Agent performance is influenced by many factors. TIBCO Scribe® Online Agents process Solutions containing multiple Maps that access data from many source and target datastores. Data sets being integrated could be very large, in the millions of records, or smaller, in the thousands of records. Solutions can be run manually, on a schedule, or be triggered by an external event, therefore, some Solutions may attempt to run simultaneously. The speed of the API for those datastores influences the performance of any given Map. In addition, you must consider the capacity of the server where the Agent is installed along with other software competing for resources on that server. This complex list of factors varies from customer to customer making it difficult to recommend a one-size-fits-all installation option. Some options for better performance include:
- Upgrade to a more powerful server with the following minimum capacity:
- Quad Core CPU or better with a 24/7 business grade internet connection
- 8 GB of RAM
- At least 8 GB of free hard disk space for each installed Agent
- Use filters in Query and Fetch Blocks to reduce the amount of data being processed.
- Merge Maps that retrieve the same data so the Query is run only once.
- Update multiple target datastores with a single Map.
- Use an Integration Event Solution containing a Message Map. This type of Solution executes only when a message is received from an external application, therefore, it executes and processes records only when needed.
- Use Batch Processing if the Connector supports it. This feature processes data in bulk and speeds up the integration process.
