Working with Agents
Right-clicking an Agent opens a context-menu with all its available functions, which depend on whether it is active or not.
This topic describes those functions or provides links to the corresponding descriptions:
Adding and Downloading an Agent in AWI
You can create a new Agent and download a pre-configured Agent in Client 0 in the Process Assembly perspective.
You can also do the same in directly from the Administration perspective in any Client in the system. However, the Agent object is always also available in Client 0. When you download a pre-configured Agent, you don not have to make any additional definitions. However, you can change them as needed in Client 0.
This applies to UNIX, Windows, all Java based Agents (also in containers) and the TLS Gateway.
Make sure that the certificate the Agent or ingress needs is available. You can store the certificate in the Automation Engine by uploading it to the UC_TRUSTEDCERTS storage object. For more information, see UC_TRUSTEDCERTS Storage Object.
Important! You have to upload the relevant certificate with the name JCP_CERT, otherwise, the system does not recognize which certificate to use for the downloaded Agent.
Once the certificate is uploaded it is available on the trustedCertFolder, which is the one defined in the INI file of the Agent.
For more information, see Adding and Configuring Agents.
Starting an Stopping an Agent
Prerequisite: Enable the relevant ports in your firewall, so that the server process will be able to connect to the ServiceManager. You have to use the ports defined in the INI file of the ServiceManager, see Service Manager Service.
Right click one or more Agents and select Start to initiate them via the ServiceManager.
Right-click one or more active Agents and select Stop to deactivate it/them. The agent stops immediately, however, processes that are currently running will continue.
Disconnecting the Agent
This option is available for active Agents.
When you start a new Communication Process and the Agents rearrange themselves to improve their workload balance, you may want to temporarily cut the connection between the Automation Engine and the Agents.
For this purpose, right-click one or more active Agents and select Disconnect Agent Connection. The Agents reconnect to the Automation Engine as soon as the next signal for Agent checking is sent.
Initiating Log Rotation
This option is available for active Agents.
The Automation Engine logs large amounts of information. To be able to handle your log files easily, you can define system-wide settings that break the information to be logged in smaller chunks and thus produce also smaller log files.
For example, you can determine the maximum size of the log file; or you can specify the number of days that may elapse before a new file starts. You do so in the UC_SYSTEM_SETTINGS variable using the CHANGE_LOGGING_DAYS and CHANGE_LOGGING_MB keys. For more information, see CHANGE_LOGGING Parameters and UC_SYSTEM_SETTINGS - Systemwide Settings.
You can also change the log settings via the Automic Web Interface. For this purpose, right-click one or more records and select Initiate Log Rotation; this causes a new log file to be written. A dialog prompts you to confirm your action.
Updating the Service Manager Link
Prerequisite: Enable the relevant ports in your firewall, so that the server processes will be able to connect to the ServiceManager. You have to use the ports defined in the INI file of the ServiceManager, see Service Manager Service.
This option is available for active Agents.
To be able to start Agents either manually from the Administration perspective or via the script element MODIFY_SYSTEM using a ServiceManager, the connection settings between Agent and ServiceManager must be up-to-date. There can be situations in which this is not the case, for example, it can happen that the service name which has been entered in the Agent object does not comply with the corresponding service name in the ServiceManager anymore.
Right-click one or more Agents and select Update Service Manager Link to refresh their ServiceManager connection settings. Alternatively, you can enter the relevant values manually in the Service Manager section of the Agent definition page. For more information, see Agents (HOST).
Replacing Agents
This option is available for active and inactive Agents, provided no tasks are running on them.
You can replace an Agent with another one of the same type and have the new Agent take over all tasks immediately. All references to the replaced agent are automatically changed in the settings of the objects that use it.
Important! Replacing Agents does not work for Scripts. After automatically replacing an Agent using this function, you still have to replace the references to the Agent(s) in Scripts manually.
To Replace the References to an Agent in Objects
- Right-click the Agent that must be replaced and select Replace.
-
The Replace Agent dialog is displayed.
The list in the lower part of the dialog displays all objects in which the selected Agent is being used.
- From the Replacement dropdown list select the Agent with which you want to replace it.
-
By default all objects are selected; if you leave it so, the reference to the "old" Agent will be replaced with the "new" one in all of them.
If you do not want to replace the Agent in all the objects but only in some of them, do one of the following:
- Deactivate the checkbox in the table header; this deselects all checkboxes. Now activate the checkboxes next to the objects in which you want to replace the Agent.
- Deactivate the checkboxes next to the objects in which you do not want to replace the Agent.
- When replacing an Agent with a different one, you may want to also modify some of the other settings of the affected objects. For this purpose, select one or more object in the list and click Open in new Window. This opens the definition pages of the selected objects in a new browser window each.
- Click the Replace button.
If you select an Agent Group in the Replacement dropdown list, all Agent Groups in the list below are disabled because it is not possible to assign an Agent group to another Agent Group.
Renaming/Deleting an Agent
You can rename and/or delete Agents from the Agents list
- You have write (W) permissions on the Agent
- No tasks are running on the Agent
- The Agent is inactive
- The Agent is not used in multiple Clients
Note: If you try to rename or delete an Agent that is used in multiple Clients, an error message is displayed.
To rename and/or delete an Agent, right-click it and select Rename/Delete.
See also:
- Editing Objects
- Search for Use
- Advanced Options - Tracing
- Advanced Options - Workload Balancing in Agents
- Advanced Options - Agent Settings
- Agent Job Messenger
- CAU - Upgrade Process
- Agent Authentication
- Renaming Objects and Folders
- Duplicating Objects
- Moving Objects or Folders within a Client
- Object Links
- Last Report
- Execution Data
- Show in Process Monitoring