Configure a database (JDBC) sync

If data is to be synchronized to Aeneis via a database table or data is to be exported from Aeneis to a database, a synchronization instance must be created and configured accordingly. For each synchronization instance, either synchronization or export can be configured.

Requirements: For synchronization of data from a database, the database with the filled tables must be available. One table must be created in the database for each category that is to be synchronized. For each attribute of the corresponding category that is to be synchronized, a column must be created in the database table.

Requirements: To export data to a database, a template of a database with the table structure must be available. One table must be created in the database for each category that is to be exported. For each attribute of the corresponding category to be exported, a column must be created in the database table.

Possible databases:

Database system	Driver	Example connection
IBM DB2	com.ibm.db2.jcc.DB2Driver	jdbc:db2://[HOSTNAME]:[PORT]/[DATABASE]
MariaDB	org.mariadb.jdbc.Driver	jdbc:mariadb://[SERVERNAME]:[PORT]/[DATABASE]
Microsoft SQL Server	com.microsoft.sqlserver.jdbc.SQLServerDriver	jdbc:sqlserver://[SERVERNAME]:[PORT]
MySQL DB	com.mysql.jdbc.Driver	jdbc:mysql://[SERVERNAME]:[PORT]/[DATABASE]
Oracle	oracle.jdbc.driver.OracleDriver	jdbc:oracle:thin:@[SERVERNAME]:[PORT]:[DATABASE]
MSSQL (jTDS)	net.sourceforge.jtds.jdbc.Driver	jdbc:jtds:sqlserver://[SERVERNAME]:[PORT]
Sybase	com.sybase.jdbc4.jdbc.SybDriver	jdbc:sybase:Tds:[SERVERNAME]:[PORT]/[DATABASE]
HSQL	org.hsqldb.jdbcDriver	jdbc:hsqldb:hsql://[SERVERNAME]/[ALIAS]

Configuration:

Once you have created a synchronization instance, as described in Create synchronization instance, you can further configure it in the properties.

Property	Description
Configuration
Trigger	In this attribute you can store a trigger that controls when the synchronization is executed and the data is transferred from the database to Aeneis or exported from Aeneis to the database.
Group	This property is for internal use to bundle triggers and jobs and should not be changed!
Cron expression	Here you can enter a time pattern that controls when synchronization is performed automatically. See also: Time pattern (Cron)
Enabled	By default, synchronization instances are disabled after you created them. Via this property you can enable the synchronization instance.
Successor job	Here you can link jobs together. Once the execution of the job has been completed, the successor job referenced here is executed immediately. Note: If the successor job is deactivated, it is skipped and the next active successor job in the chain is executed. Note: Successor jobs do not require their own trigger or cron expression.
Database (JDBC)
Driver	The driver of the database that will be synchronized is entered here.
Connection	The connection for the database that will be synchronized is entered here.
User	This shows which user is used to access the database.
Export	This property allows you to control whether the data from Aeneis should be exported to the database table(s). Attention: The feature is outdated and will be discontinued in a later version. Please do not use this attribute anymore!
Other attributes
Log	As soon as a synchronization has been executed, the log entry of the synchronization appears in the Log property. The log entry shows whether the synchronization was successful and how many objects were created, updated, mapped, removed, moved and deleted.
DB table name	Reference here a category from Aeneis with which the database table is to be synchronized (e.g. the category Employees, if employees are to be synchronized) or whose objects are to be exported to the database table.
Key column	Here you can select a column in the third-party system that uniquely identifies the record (primary key). If no key column has been selected here, the first column in the third-party system is interpreted as a key column. Note: The key column in the third-party system data unit should be of type String. The key column must uniquely identify the data set. Key fields must consist of a single column and must not be composed of multiple keys.
Default ACL for new objects	Define here the access control list that will be set automatically for newly created objects.
ACL field (optional)	This property allows you to control whether the ACL is set via the synchronization with the third-party system. If there are IDs in a column in the third-party system that set the ACLs, you can assign the corresponding column in this property. During synchronization, the ACL is filled using the values of the stored column.
Delete removed objects	This property allows you to control that objects deleted between two synchronizations in the third-party system are also deleted in Aeneis. If this property is not enabled, the objects that were deleted in the third-party system are only marked as removed in Aeneis.
Create new objects	This property allows you to control whether new objects are created in Aeneis when synchronizing with the third-party system.
Create version on delete	This property allows you to control that if objects have been deleted in the third-party system between two synchronizations, a new version is created in Aeneis before the synchronization.
Create version on changes	This property allows you to control that if objects have been changed in the third-party system between two synchronizations, a new version is created in Aeneis after the synchronization.
Add unreferenced objects to	Here you can reference an object to which objects are assigned that are not assigned to any other object. Only objects under which objects of the corresponding category may be created can be referenced here.
Separator columns (CSV)	Only relevant for web service synchronizations.
Column name	In the properties with the names of the columns, reference a matching attribute of the category that was stored for the database table. During synchronization, the values of the column are transferred from the third-party system to the attribute in Aeneis. Note: You cannot reference an attribute here until you have referenced a category and already saved it.
Refers to	Here you can select a data unit for the column to which the column refers in the external system (relation). The column is always linked to the key column of the selected data unit.
Value when marked as deleted	Here you can store a value that will be written to the attribute if it is marked as deleted during a synchronization. This property can be used to fill a status field or to set the name of an object after deletion.
Fill empty attributes only	This property allows you to set that only attributes are filled during synchronization that do not have a value yet.
Allow only references	This property allows you to set that the attribute is only referenced in the objects of the category and not assigned as the main attribute. The main assignment of the attribute then takes place in the object of the category referenced in the Add unreferenced objects to property.
Object renderer	Here you can reference an object representation that determines the output of the reference (e.g. first name last name or last name, first name)