Terminals

Concept

A terminal is a logical entity that represents the connection between a single Agent—installed on a machine and linked to a user—and that user's Workspace in Skyone Studio.

A Workspace can contain multiple terminals. Additionally, any user within the workspace can run the Agent.

On a machine with an Agent installed, a terminal acts as a bridge, allowing an application to access a company's Database or an ERP's REST interface. This enables multiple types of integrations without requiring a public API. As a result, different flows within a workspace can share the same terminal, connected through one or more user accounts.

Once you install and configure an Agent in an on-premises environment, a terminal is automatically created in Skyone Studio. From there, you can select and use that terminal to configure REST or Database account types. When you select a terminal during account setup, the account credentials are sent to the Agent to be used locally.

You can associate multiple accounts with a single terminal. This means you can create several users in a database to be used across different integrations. Each user can be configured in a separate account, but all accounts will point to the same terminal.

An Agent’s terminal is continuously monitored, ensuring that Skyone Studio always knows when it is connected and operational. Conversely, if a terminal goes offline—detected through the disconnection of the associated Agent—all accounts linked to that terminal are considered offline as well.

You can install as many Agents as you want for the same user or Workspace, as long as they are installed on different devices with distinct names and locations. Each Agent will appear as a separate terminal in Skyone Studio.

Connected Accounts

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:

Example of connected account configuration

When you use a "Terminal" on an account, the execution of operations on a module (tests) or on a flow (tests or execution) will only occur if the "Agent" is running and the "Terminal" status is active (green).

Terminal Management

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

Terminal Information

To view detailed information on a terminal:

  1. At "Terminals", choose the Agent that you want to view and click the "More Options" icon;

  2. Select "View";

  1. 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"

Testing the Connection

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:

  1. At "Terminals", choose the "Agent" whose connection you want to test and click "More Options" (three-dot icon).

  2. Select "Test Connection"

  1. Wait for the connection to be tested and the result.

Terminal Logs

To view the logs of a terminal:

  1. At "Terminals", choose the "Agent" you want to view the logs for and click on the "More Options" icon;

  2. Select "Logs";

  1. The Terminal logs will be displayed (if any).

Deleting an Agent

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:

  1. At "Terminals", choose the Agent you want to delete and click on the "More Options" icon;

  2. Select "Delete Agent";

  1. Enter the name of the terminal you want to delete and then confirm the action by clicking "Delete";

  1. 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.

PreviousHow to back up Agent filesNextData Management

Last updated