Setting up an ETL integration

JLehr · ‎2023-11-10

There are three parts to setting up an ETL configuration:

Setting up a database where you can either import data from or export data to. The import and export database can be located either Internal in IT Advisor or in an External database setup. Both configurations are done from the same configuration interface.
Setting up the ETL transformation, that moves the data either from the database to IT Advisor (import) or from IT Advisor to the database (export).
Setting a schedule for when the configuration should run.

To start setting up an ETL configuration login to web client with a user with the 'System Administration' permission, and navigate to Cogwheel > Manage ETL Integration.

Internal Database

An Internal Database is a PostgreSQL instance running on the same server as IT Advisor.
The database is created and deleted by IT Advisor.
To create an internal database, you must provide the following:

Configuration Name - the name that will later be shown inside the IT Advisor client to distinguish between different databases, when configuring External Systems.
Database Type - databases are used for either Import or export of data
Database Name - the unique name used when creating the database. Import databases are always prefixed with 'staging_' and Export databases with 'export_'
Username - unique username. The username is prefixed by 'etluser_'
Password - password of the user. No special requirements.
Allowed IP addresses - When integrating with external systems, it may be necessary to allow direct database access to the database. It is mandatory to enter the specific ip or range of ip addresses allowed to access the database. Information regarding IP ranges can be found here

Note: Double byte characters are not supported in the configuration of the database

ETL config internal.png

Once saved, the database is created and will subsequently be available inside the IT Advisor client.

The internal database connection can be paused/started using the pause/start management button. This can be used in order to pause/start the scheduled communication with the database.

Pressing start will not force the communication to run but enable the scheduled communication to run according to schedule.

External Database

An External Database is located outside of the IT Advisor server. We have tested with PostgreSQL, MS Sequel Server and MySql database types and generally the only requirement is the existence of a JDBC4 compliant database driver.

The database must be created, deleted and managed outside of IT Advisor. The database must be set up using a UTF8 character encoding.

The same UI is used to create a configuration defining how to access the external database, and must include the following:

Configuration Name - the name that will later be shown inside the IT Advisor client to distinguish between different databases, when configuring External Systems.
Database Type - databases are used for either Import or export of data
Database Driver - choose what JDBC driver to use when connecting to the database. If the required driver does not appear in the list, you can upload a custom driver for the connection to your external database following the guidelines here.
Database Dialect - some databases speak several different dialects, choose the one the matches your setup.
Database Name - the name used when connecting to the database. External databases are never prefixed.
Port Number - specify what port is used to communicate with the external database. Please note that it may be necessary to open ports in firewalls between the IT Advisor server, and the server hosting the remote database.
Username - unique username. The username is prefixed by 'etluser_'
Password - password of the user. No special requirements.
Database URL - entered values from the previous fields are combined into a database URL, if extra parameters are needed, they may be inserted into the URL.

Note: Double byte characters are not supported in the configuration of the database.

ETL config external.png

Once saved, the configuration is created and will subsequently be available as an external database inside the IT Advisor client.

The internal database connection can be paused/started using the pause/start management button. This can be used in order to pause/start the scheduled communication with the database.

Pressing start will not force the communication to run but enable the scheduled communication to run according to schedule.

Database Driver Upload

If you need to use a custom driver for the connection to your external database, please follow the guidelines found here.

Configuring the transformation and synchronization schedule

After setting up the database click Next, and choose the wanted transformation or upload one, and select related Transformation Parameter(s) to be used for the ETL integration.

With ETL import databases it is also possible to specify whether name or serial number should be imported from ETL asset to the associated item in ITA. You can import the name in 2 ways:

From the name of ETL asset. The value is imported from the column ci_name in the configuration_item table.
From the asset property of the ETL asset. You must specify the name of the property, which is imported from the cip_name column in the configration_item_property table. Only properties of type 4 are imported (meaning the row must have pt_id = 4 = 'ASSETPROPERTY').

Serial numbers are imported from the column ci_serial_number in the table configuration_item.

Click Next to move to configuration of the schedule. The ETL configuration will synchronize data with a given interval, daily, weekly or monthly depending on the schedule defined here.

Scheduling or pausing ETL Integrations is done from Web client > Cogwheel -> Manage ETL integrations.