Agent
Overview
Most ERPs do not offer open and comprehensive APIs that allow these systems to integrate seamlessly with other applications and solutions. As an alternative, many ERP vendors allow or tolerate integration at the data level. In this type of integration, an external agent—typically a service installed on the same machine as the database—has access to the database and can execute queries on system tables or views.
Based on this concept, we created the Agent, a secure extension of Skyone Studio that can be installed in on-premises environments, using secure communication mechanisms. When in use, the Agent acts as a passive component, executing only requests sent by external software or automated within Skyone Studio.
General characteristics of the "Agent":
Connect locally to a database or REST resource
Support for multiple database types
Restful support
Processing requests coming from any Skyone Studio Integration, with different users and permissions
Connecting to Skyone Studio and keeping a communication channel open to receive calls immediately
Receiving "RPC like" calls from Skyone Studio, which are mapped into actions in the database or into REST calls
Responding asynchronously to Skyone Studio calls
Automatically restarting itself if the computer on which it is installed is restarted, without the need to re-enter authentication data.
Minimum Requirements
The minimum requirements for the Agent:
Disk: 1GB free
Memory: 512MB
CPU: 1 core 1.5GHz
Installation
To download and install "Agent" :
Click on "Terminals" and then click on "Download Agent".
Note that there are three download options: Windows, Linux and Docker. Choose the most suitable option and click on "Download".
Follow the instructions according to your operating system:
For the Windows operating system:
On the screen that appears when you run the application, click on "Next". Wait for the installation to finish.
Once the installation has been successful, click on the "Launch application" option and then on the "Finish" button to complete the installation.
The Agent will start up and you will be presented with some steps for configuring it. Click on "Next".
Enter your Skyone Studio access credentials and click "Next".
Select the organization (workspace) you want to use the "Agent" for and enter a name and location for it.
Done! Your "Agent" is configured and ready to be used in Windows environments. Click on "Finish" to end the configuration procedure.
To install the Agent on Linux, follow these steps:
Access Administrator Mode
You need to enter root mode. Use the following command:
sudo suDownload the Installer
Download the Agent .deb file using the curl command:
curl https://skyone-integrasky-inventory-hml.s3.amazonaws.com/agent/linux/IntegraSkyAgentSetup_v0.0.0.114.deb --output IntegraSkyAgentSetup_v<version>.debInstall the Agent
Once the file is downloaded, run the installation of the .deb package:
apt install -f ./IntegraSkyAgentSetup_v<version>Open the installation folder
Navigate to the folder where the Agent was installed:
cd /usr/local/bin/skyone-solutions/integrasky-agent Run the Agent
Start the Agent using the following command:
./IntegraSkyRegister the Agent
Register the terminal with the provided credentials:
register -u <user@email> -p <password>Your workspaces will be listed and you will be asked to select which one you want to connect:
For Docker, first make sure you have Docker installed on your machine. If not, follow the procedure here.
After installing Docker on your machine, you need to download the image:
Once the download is complete, you can run the "Agent" using the command below.
docker run -e "INTEGRA_ENV_USER=<email>" -e "INTEGRA_ENV_PASSWORD=<password>" -e "INTEGRA_ENV_ORGANIZATION_ID=<code?" -e "INTEGRA_ENV_AGENT_NAME=<agent name>" -e "INTEGRA_ENV_AGENT_LOCATION=<agent location>" integrasky/agent:latest -v /caminho/para/dados:/data/integraNa plataforma Skyone, você tem acesso ao comando acima já com o seu email e seu Organization ID inclusos.
Check all the configuration options below in the Docker tab under Settings.
Settings
Follow the instructions to configure your "Agent" according to your operating system:
When you click on the "Agent" in Windows, Settings is the first tab to appear in the window, as shown in the image below:
These include:
Integration service status: it is possible to Start, Stop, and Restart the integration service. When the service is stopped, operations in Skyone Studio involving accounts connected to a registered Terminal cannot be executed.
Internet connection test: identifies whether the "Agent" is connected to the internet.
Server connection: identifies whether the "Agent" is connected to plataform's servers.
Concurrency process limit: allows the capacity for parallel processing to be set between the range of 1 and 100. The default value is 50. The default value is 50. After making any changes, click "Apply". After that, confirm the restart of the "Agent" services by clicking "Yes", so that the new settings are activated.
Allow untrusted SSL certificates in REST/SOAP requests: by activating this option, the "Agent" will allow communication between systems, even if the SSL certificate is not considered secure by conventional standards. By sliding the button, a window will appear for you to confirm the restart of the "Agent" services and the new settings will be activated.
When either of the two services (integration or server) is working, the colored icon will be green. If there is a problem with the connection, it will turn red. If the "Agent" is waiting to connect to one of the services, the icon will turn gray.
Once the "Agent" has been registered, it will soon appear in the "Terminals" tab.
It is possible to close the Agent window without compromising the use of Skyone Data. However, the computer must be powered on for communication to take place.
To configure the "Agent" on Linux, access the Linux terminal after installation.
You can run the following commands:
global_settings -view : allows you to view the Agent's global settings, such as server status, integration status, etc.
global_settings -concurrency_limit (1..100) : sets the number of parallel processes that the agent can handle in the range 1 to 100. The default value is 50.
global_settings -allow_unsafe_ssl_certificate true|false : enable/disable checking the destination's SSL certificate before making a REST/SOAP call.
After making any changes, you will need to restart the "Agent" for the new settings to be applied.
To configure the "Agent" in Docker, change the fields previously filled in during installation.
Where:
INTEGRA_ENV_USER=<email>: The email used to log in to Skyone Studio.INTEGRA_ENV_PASSWORD=<password>: The password associated with your Skyone Studio account.INTEGRA_ENV_ORGANIZATION_ID=<organization_id>: Your Organization ID, available in the Docker Installation section of Skyone Studio.INTEGRA_ENV_AGENT_NAME=<agent_name>: The name assigned to the agent.INTEGRA_ENV_AGENT_LOCATION=<agent_location>: The location or environment where the agent is installed.INTEGRA_ENV_CONCURRENCY_LIMIT=<concurrency_limit>: Sets the number of parallel processes the agent can handle, ranging from 1 to 100. The default value is 50.INTEGRA_ENV_ALLOW_UNSAFE_SSL_CERTIFICATES=<allow_unsafe_ssl_certificates>: Enables or disables SSL certificate verification when making REST/SOAP calls.
Logs
Windows:
There is a read-only Logs tab, which shows all the Agent's logs. These logs will be updated as new events occur.
Linus e Docker
You can access the logs folder from the directory where the application is running.
Example: cat /logs/log20231206.txt
Agent Registration: Possible Errors
The following errors are possible in the return of the registration request:
Agent already configured on host
The plataform has identified that there is an "Agent" previously configured on the workstation.
You can either abort the installation or, if you are so authorized, you can enter the plataform panel and delete the "Terminal" associated with the old "Agent". Doing that allows you to retry the operation.
If you do not have permission to delete the "Terminal", you might be trying to install the "Agent" in the wrong workspace.
Note: the same "Agent" can be used by several Integrations; therefore, there is no need for multiple installations.
Agent name already exists
The plataform has identified that there is already an "Agent"with the same name available in the workspace.
It is possible that this happened because you want to move the "Agent" from one workstation to another, without losing all the work already done in the Integrations that point to the Agent Terminal. In this case, you must install the Agent on the new station and use the same name to replace the previous one. Therefore, Skyone Data alerts you that the previous Agent with the same name will be deactivated and replaced by the new one and also asks for your confirmation to proceed with this change.
Control channel is not configured
It only appears while the "Agent" is being configured, before its data is entered, and it means that the "Agent" has not yet been configured. There no action required.
Last updated