assets/img/logo.svg
Configurator

Data Acquisition

This guide explains how to configure and manage data acquisition instances in a simple and practical way.

What is an instance

An instance is a saved connection that tells the system:

  • where to get the data from
  • with which credentials
  • which databases to use
  • number of available databases

You can think of an instance as a connection profile to a data source.

Each instance:

  • it is independent of others
  • can be modified at any time
  • can be deleted if no longer needed

Overview of Data Acquisition page

When you open the Data Acquisition page, you see the list of all configured instances, each instance is displayed as a card.

Information shown on the card

  • Instance name
  • Source address
  • Data source type
  • Connection status
  • Enabled databases

Main actions

  • Check connection status → verifies if the connection works
  • Click on the card → edit the instance
  • Delete → remove the instance
Deleting an instance is permanent and only possible if none of the databases associated with it are used in the system.

Adding a new instance

To create a new instance, click on Add instance. The procedure is guided and consists of 3 steps.


Step 1 – Data source selection

Choose the data source:

  • VireoXgateway
  • Vega
You can choose only one source.
This choice affects the available databases later. Only databases compatible with the selected source will be displayed.

Step 2 – Instance details

Enter the connection data:

  • Instance name
  • Source address
  • Username
  • Password

Source address format

The address field accepts multiple formats:

FormatExample
IPv4 address192.168.1.100
Hostnameserver.domain.com or my_server
URL with protocolhttps://server.domain.com:1433
SQL Server formathostname,1433\SQLEXPRESS
The address can include:
  • Underscores in hostnames (e.g., my_sql_server)
  • Port numbers (e.g., server:1433 or server,1433)
  • SQL Server instance names (e.g., server\SQLEXPRESS)

Connection test (mandatory)

Before continuing you must run the connection test.

  • If the test succeeds, you can proceed
  • If the test fails, you must correct the entered data
Without a successful test, it's not possible to save the instance.

Step 3 – Databases

Select the databases to use:

  • you can choose individual databases
  • or use Select all / Deselect all

Finish by clicking on Save associations.


Editing an existing instance

To edit an instance:

  • click on the instance card

A window opens with two sections.


Instance parameters

Here you can modify:

  • name
  • address
  • credentials
After each modification, the status returns to Connection not tested. New verification is required.

Database associations

Here you can:

  • add or remove databases
  • change associations without touching the connection

Connection status: what it really means

One of the most important points to understand is how the connection status works.

Available status values

StatusDescription
ConnectedConnection successful - the source is reachable and credentials are valid
ErrorConnection failed - the source is unreachable or credentials are invalid
Not testedConnection has not been verified yet
TestingConnection test in progress

Connection isn't tested

This status indicates that:

  • the connection has not been verified yet
  • the system doesn't know if it works or not
It's normal to see this status when the page is reloaded.

Why does this happen?

  • The system does not automatically test connections
  • The status is updated only on user request

This behavior prevents showing unreliable information.


Check connection status

Check a single instance

Use Check connection status on the instance card to verify:

  • if the source is reachable
  • if the credentials are correct

The status is updated immediately.

Check all instances

The Check connections status button (global) verifies all instances in one operation.

It's useful:

  • after infrastructure changes
  • for periodic checks
  • for quick general verification

Frequently asked questions

Why do I always see "Connection not tested"?

Because the status is not updated automatically. You must use Check connection status to get a real status.

I already configured the instance: why do I need to test it?

The test confirms that:

  • the source is reachable
  • the credentials are correct. Without testing, the system cannot know if the connection works.

Do I need to enter the password again when editing?

Only if you change the connection parameters (address or username). If you only modify the name or database associations, the password is not required.

What address formats are supported?

The system accepts IPv4 addresses, hostnames (with or without underscores), URLs with protocol, and SQL Server format with port and instance name. See the "Source address format" section for examples.

Can I use underscores in hostnames?

Yes. Hostnames like my_sql_server or db_server_01 are valid.

Why did the connection test fail?

Common causes include:

  • Incorrect server address or port
  • Wrong username or password
  • Firewall blocking the connection
  • Server not running or unreachable

The error message will provide specific details about the failure.