TIBCO Scribe® Online Agents

The TIBCO Scribe® Online Agent facilitates communication between the data sources used by a Solution. It provides secure communications to TIBCO Scribe® Online without opening security holes in your corporate firewall. An Agent is required to communicate with both your source and target data, and with TIBCO Scribe® Online in the cloud.

There are two types of Agents available:

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.

Refer to the documentation for the specific Connector for additional information. See Managing Connections for a list of TIBCO Scribe® Online Connectors.

Agents Page

Tip: For an Icon Key and tips on using screens, Widgets, tables, and menus in TIBCO Scribe® Online see Navigation.

The Agents page displays all Agents installed for the selected Organization. A reduced list of Agents also displays on the Dashboard in the Agents Widget. Select the Information icon next to the Agent name to view a list of Solutions configured to be executed by this Agent. The Agents page includes the following information about each Agent:

Field Definition

Name

Name of this Agent. Agent name can be modified by selecting Edit from the Gear menu . See Editing Agent Settings.

Status

Status of this Agent. After the Agent has started the first time it should run continuously. Status column displays both an icon and a text description as follows:

Running — Agent is running as expected.

Agent Updating — Agent is being updated to a new version.

Heartbeat Late — Agent failed to contact TIBCO Scribe® Online for 15 to 59 minutes.

Restarting — Agent is restarting.

Updating Connector — Agent is installing Connector updates.

Waiting to restart, memory limit reachedTIBCO Scribe® Online detects when an Agent's memory limits are being exceeded and requests an Agent restart. Agent completes any running Solutions and updates Execution History for those Solutions before restarting.

Waiting to restart, user requested — A user has requested an Agent restart. Depending on the type of restart selected by the user, the Agent restarts immediately or after all running Solutions are complete. See Restarting An On-Premise Agent.

Waiting to Update Agent — Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any Solutions or contact TIBCO Scribe® Online. Agent then goes to Updating Agent status.

Waiting to Update Connector — Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any new Solutions or contact TIBCO Scribe® Online. Agent then goes to Updating Connector status.

Heartbeat Failed — Agent failed to contact TIBCO Scribe® Online for 60 minutes or more.

Obsolete, install new Agent — Agent and installed Connectors cannot be automatically updated because the version of the installed Agent is too old. Install a new Agent manually and edit your Solutions to use that Agent.

Provision Error — An error occurred while attempting to provision a Cloud Agent.

Shutdown — On-Premise Agent has been shut down and has successfully contacted TIBCO Scribe® Online to communicate the shutdown.

Shutdown Cloud — Cloud Agent has been shut down and has successfully contacted TIBCO Scribe® Online to communicate the shutdown.

Machine Name

Name of the computer where the TIBCO Scribe® Online Agent is installed or provisioned.

Service

Name of the Windows Service that represents this Agent. This also indicates the name of the installation folder for the Agent and associated Connectors.

Version

Version of this Agent, which may be different than the version of TIBCO Scribe® Online.

Last Startup

Date and time the Agent last started.

Last Shutdown

Date and time the Agent was last shut down.

Last Contact

Date and time the Agent last contacted TIBCO Scribe® Online.

Button to add an Agent. You can only have one Cloud Agent, but you can install many On-Premise Agents.

Info Icon

Solutions

Names of any Solutions using the selected Agent.

Gear Menu

Edit

Edit the selected Agent. See Editing Agent Settings.

Delete

Delete the selected Agent. See Deleting An Agent.

Restart Now

Restarts the Agent immediately interrupting any Solutions that are currently running.

Restart Later

Restarts the Agent after currently running Solutions are completed. Scheduled Solutions are paused until the Agent restart is complete.

Request Agent Logs

Creates and downloads a zip file of On-Premise Agent Logs for the selected Agent. Depending on your browser settings the file is either saved to your default downloads location or you are prompted to save the file.

For On-Premise Agents, Agent logs are stored in the directory where your Agent is installed. The default location is: C:\Program Files (x86)\Scribe Software\TIBCO Scribe® Online Agent\logs

  Agent must be running to retrieve log files.

  Cloud Agent logs are accessed via the Gear menu for a Solution.

Note: Agent status also displays for each installed or provisioned Agent in the Agent drop-down list on the Solution Edit page.

Tasks that can be completed from the Agents page include:

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.

Notes:

Related Topics

Troubleshooting The TIBCO Scribe® Online Agent