Last updated
Last updated
A terminal is a logical entity that represents the connection of a single "Agent", installed on a machine and linked to a user, to that user's "Workspace" on the platform.
A "Workspace" can contain multiple terminals, as long as each terminal is connected to an Agent.
On a computer where an "Agent" is installed, the application can access a company's Database or the REST interface of an ERP, and therefore one terminal can intermediate the execution of several integrations, without the need for a public API. This way, several distinct flows within a "Workspace" can reference the same terminal through one or more user accounts.
After installing and configuring an "Agent" in a local environment (On Premises), a terminal is automatically created on the Skyone Studio platform. From then on, you can choose and use this terminal on the platform to configure REST or Database accounts. When you select a terminal in the configuration of these accounts, the account credentials are sent to the Agent to be used locally.
Multiple connected accounts can be associated with the same terminal. This way, you can create multiple users in a database to be used by different integrations. Each user can be configured under a different account, but all accounts will point to the same terminal.
An "Agent's" terminal is permanently monitored, so the platform always knows when it is connected and operational. On the other hand, the collapse of a terminal, noticed through the disconnection of the "Agent" connected to it, implies the collapse of all the accounts connected to it.
By default, the "Terminal" field of a REST or Database account is left blank, which means that the "Agent" is not used during the connection. To use a previously installed "Agent", you must select one of the terminals (active or not) that are configured in the system:
In the "Terminals" tab you will see all the terminals connected to the selected "Workspace". If you have not yet installed and configured an agent, you can download the "Agent" by clicking "Download Agent".
Once one or more "Agents" have been configured, the list of available terminals and their respective details and status will be displayed on the screen:
Each line corresponds to an "Agents" entry with its basic information. The information on this screen is dynamic, updating automatically in a few seconds.
Fields:
ID: unique "Agent" identifier
Agent Name: name assigned in the "Agent" configuration
Username: name of the user who configured the "Agent"
Connected at: last time the "Agent" connected
Agent IP: IP address of the computer where the "Agent" was installed; displayed only when it is connected
Host ID: host signature that uniquely identifies the machine where the "Agent" is installed
Status: "Agent" connection status
To view detailed information on a terminal:
At "Terminals", choose the Agent that you want to view and click the "More Options" icon;
Select "View";
The Terminal Information window will be displayed an you will view the following fields:
Host ID: host signature, which uniquely identifies the machine where the "Agent" is installed
Agent Name: name provided in the "Agent" configuration
Agent localization: localization provided in the "Agent" configuration
Agent IP: IP address of the machine where the "Agent" is installed
Connected at: date of last connection, in the format DD/MM/YYYY HH:MM:SS
Last APC control: the last time Integra.Sky sent an APC (Agent Procedure Call)
Last APC data: last time Integra.Sky received messages
Controls delivered by the APC: number of messages sent
Data received by the APC: number of messages received
Connected accounts: accounts that point to the "Terminal"
The connection status ensures that there is an established connection, but does not guarantee full operation. The connection test performs a complete test involving the Agent.
To test the connection:
At "Terminals", choose the "Agent" whose connection you want to test and click "More Options" (three-dot icon).
Select "Test Connection"
Wait for the connection to be tested and the result.
To view the logs of a terminal:
At "Terminals", choose the "Agent" you want to view the logs for and click on the "More Options" icon;
Select "Logs";
The Terminal logs will be displayed (if any).
If you delete an "Agent" from the "Terminals" tab and then want to use the application again, you will need to uninstall and reinstall the application. This is also necessary if you want to change the initial installation settings (Workspace, Skyone Studio account, Agent Name and Location).
To delete an "Agent", follow these steps:
At "Terminals", choose the Agent you want to delete and click on the "More Options" icon;
Select "Delete Agent";
Enter the name of the terminal you want to delete and then confirm the action by clicking "Delete";
Back to the "Agent", the connection to the Server will be broken. To set up the "Agent" again, you’ll have to uninstall and reinstall it.
