ETL database configuration

[JLehr]

The import and export database can be located either Internal on the EcoStruxure IT Advisor or in an External database setup (server, etc.). Both configurations are done from the same configuration interface.

Configuration and management of ETL databases is done using the server configuration interface.

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

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.

Webmin 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, it can be uploaded using the Upload database driver functionality
• 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.

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

When using external databases of other types than postgreSQL, it may be necessary to upload a JDBC driver to the IT Advisor server. Note: The JDBC driver must be Java 6 compatible.

This is done from the server configuration interface EcoStruxure IT Advisor->ETL Integration Management in the tab Upload JDBC Driver.

The required JDBC driver should be downloaded from the database vendors support site (or other trusted support site), and stored locally on the client computer.

After upload completes, the IT Advisor server must be restarted.

See an example using MS SQL Server here.