Configure web service sync

If you have created a synchronization instance, you must configure it accordingly via the properties. To open the properties, click on the gear icon next to the synchronization instance:

See also: You can find out how to create a synchronization instance under Create synchronization instance.

Requirements: The Rules for CSV files must be observed for correct synchronization in Aeneis.

The configuration is divided into two steps:

  1. General configuration of the web service sync

  2. Configure synchronization categories

General configuration of the web service sync

You can configure the synchronization instance across files as follows:

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 third-party system to Aeneis.

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 store a job that is executed after the synchronization has been triggered via the trigger.
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.
Web Service
Endpoint The link to the web server that you defined when creating the synchronization instance is entered here.
Ignore header of import file If you enable this option, the first line in the CSV files is ignored during synchronization.

Configure synchronization categories

In Aeneis, each CSV file forms a synchronization category. A property group is created for each synchronization category in the properties of the synchronization instance. The property groups correspond to the CSV files by name. In these property groups, you set how the individual CSV files are synchronized with Aeneis.

Property Description

Name of the synchronization category

Reference an Aeneis category here with which the synchronization category is to be synchronized:

Note: A rule-compliant CSV file must be stored for each category that is to be synchronized.

Note: The name of the synchronization category cannot be edited and corresponds to the name of the CSV file.

Example: If you want to synchronize employees, reference the Employees category here.

Key column

Here you can select a column in the third-party system that uniquely identifies the record (primary key). The field name is made up of the name of the data unit and the column number.

Example: If the second column of the synchronization category Employee is to be the primary key, select Employee 1.

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

If you enable this option, objects that were deleted in the external system before a new synchronization are also deleted in Aeneis.

If this property is disabled, objects that have been deleted in the external system are only marked as deleted in Aeneis.

Create new objects

If you enable this option, new objects are created in Aeneis during synchronization with the external system.

Create version on delete

If you enable this option, a new version is created in Aeneis before synchronization if objects were deleted in the external system before a new synchronization.

Create version on changes

If you enable this option, a new version of the object is created and released in Aeneis after synchronization if objects were changed in the external system before a new 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)

Here you can enter the separator of the columns. By default, semicolons are used as column separators during synchronization.

Column name

Here you assign an Aeneis attribute to the columns of the CSV file by referencing it. During synchronization, the values of the column are transferred from the third-party system to the attribute in Aeneis.

Note: The numbering of the columns starts at 0.

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

If you enable this option, only attributes that do not yet have a value are filled during synchronization.
Allow references only If you enable this option, the attribute is only referenced in the objects of the category and is 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.