2.5 External Device Database Integration
External Device Database Integration
The external device database import configurations allow Single Connect to automatically detect and discover instances for relevant Device Groups based on their custom tags.
The following configuration is required in order to add/discover devices from external device databases;
- Log in to the Single Connect Web GUI
- Navigate to Administration > System Config Man.
- Set the following parameters
Parameter Name | Parameter Value | Encryption |
|---|---|---|
device.database.source | Database IP addresses. Multiple values must be separated by “;”. E.g: 10.10.10.10;20.20.20.20 | |
device.database.url_n | JDBC URL address for database connection. E.g: device.database.url_0 = jdbc:postgresql://10.10.10.10:5432/databasename | |
device.database.user_n | External database username | |
device.database.password_n | External database password | must be set as “yes” |
device.database.sql_n | SQL Query to import devices. IP address, hostname, element type specifier and one of the tag values are mandatory. E.g: device.database.sql_0 = SELECT "dynName" AS IP_ADDRESS, server AS HOSTNAME , os AS ELEMENT_TYPE_SPECIFIER , id AS PORT, os as TAG_OS, site as TAG_SITE FROM devicedatabase | |
device.database.driver_n | Database driver for external database connection E.g: device.database.driver_0 = org.postgresql.Driverdev | |
Add/Edit Element Type Properties for External Database Integration
Define the "Element Type" properties shown below, so that Single Connect can identify the element type of the discovered instances.
- Log in to the Single Connect Web GUI
- Navigate to Device Management > Element Type
- Click the “Options” button of the related element type and click “Show Properties”
- Set the “device.import.database.element.type.pattern” and “device.import.database.access.protocol” parameters.
Parameter Name | Parameter Value |
|---|---|
device.import.database.element.type.pattern | Mandatory. The pattern can be defined as multiple in one element. This pattern is checked against the “ELEMENT_TYPE_SPECIFIER” description of the instance in order to determine the element type. |
device.import.database.access.protocol | Mandatory. This property is used to determine the default access method for the discovered instances |
Enable External Device Database Import Job
Importing instances from an external database requires a Single Connect job for synchronization. The job will update the information on Single Connect periodically depending on the cron expression.
- Log in to the Single Connect Web GUI
- Navigate to Device Administration > Job Scheduler
- Click “Fire Job”
- Select “DeviceDatabaseImportJob” as the job
- Fill the, “Trigger Name”, “Fire Date”, “Cron expression” fields
- Save job