Synchronization Task Post Processing
Synchronization Task Post Processing Definition allows to configure the settings used to launch the post processing task.
Definition
Synchronization Task Post Processing Definition configures the settings used to launch the post processing task.

Configuration
You can access the Post-Synchronization Tasks configuration :
by clicking on "Synchronization" → "Post-Synchronization Tasks"
by clicking on "System" → "Configurations"->”Synchronization Service” and perform an import/export.
Properties
Property Name | Type | Mandatory | Description | Values (default value in bold) |
---|---|---|---|---|
reportDefinition | - | NO | The report post processing task definition (see Synchronization Task Report Definition) | - |
fileArchivingDefinition | - | NO | The definition of the archiving of the input CSV file (see File Archiving Definition) | - |
overwriteExistingArchive |
| NO | Should archive file be overwritten or not if it already exists | true, false |
Synchronization Task Report Definition
Synchronization Task Report Definition configures the settings used to launch the report post processing task.
Property Name | Type | Mandatory | Description |
---|---|---|---|
errorPublicationDefinition | - | NO | The error report post processing task definition (see Synchronization Task Error Publication Definition) |
reportPublicationDefinition | - | NO | The summary report post processing task definition (see Synchronization Task Report Publication Definition) |
Synchronization Task Error Publication Definition
Synchronization Task Error Publication Definition configures the settings used to launch the error report post processing task.
Properties
Property Name | Type | Mandatory | Description | Values (default value in bold) |
---|---|---|---|---|
errorDetails |
| NO | The list of error details that will be displayed in the error report. | SHADOW_OBJECT_ID, SHADOW_KIND, SHADOW_ID, SHADOW_OBJECT_CLASS IDM_OBJECT_ID, IDM_OBJECT_KIND ERROR_STEP, ERROR_CODE, ERROR_LABEL, ERROR_DESCRIPTION, ERROR_DETAILS, ERROR_DATE, ERROR_LOG_TRACKING_ID, APP_ID, IDM_OBJECT_TYPE |
reportRelativeFilePath |
| NO | The relative path to the error report file. May be null, its default value becomes then: This relative path is appended to the root directory under which all report files must be located. The root directory is defined by the configuration property: The file path is "configurable" via placeholders whose values are dynamically substituted. Available placeholders are:
The original file extension is preserved. An example of such a relative path could be: | - |
Error details available values
Name | Example |
---|---|
ERROR_STEP | IDM_REQUEST_EXECUTION |
ERROR_CODE | KIT-C0100021 |
ERROR_LABEL | AGGREGATE_ALREADY_EXISTS |
ERROR_DESCRIPTION | An Aggregate 'Identity' with id '3219' already exists! |
ERROR_DETAILS | The attribute is mandatory: it must have a value! |
ERROR_DATE | 2018-04-01T17:17:28.298Z |
ERROR_LOG_TRACKING_ID | d9c1fc9c-1af6-4440-875e-5dd81882a6ea |
APP_ID | SRHM |
SHADOW_KIND | ACCOUNT |
SHADOW_ID | 0c14aed5-1307-4078-9943-33736929b311 |
SHADOW_OBJECT_ID | I3245 |
SHADOW_OBJECT_CLASS | __ACCOUNT__ |
IDM_OBJECT_KIND | IDENTITY |
IDM_OBJECT_ID | P324734 |
IDM_OBJECT_TYPE | employee |
A default "standard" error formatting is applied if none is explicitly configured. : SHADOW_OBJECT_ID, IDM_OBJECT_ID, ERROR_STEP, ERROR_CODE, ERROR_LABEL, ERROR_DESCRIPTION
.
Synchronization Task Report Publication Definition
Synchronization Task Report Publication Definition configures the settings used to launch the summary report post processing task.
Properties
Property Name | Type | Mandatory | Description | Values |
---|---|---|---|---|
notificationDefinitionIds | - | YES | A list of Notification Definition ID existing with associated Notification Definition and Notification Templates. Available variables that can be used in Notification Templates are :
And specific variables for synchronization tasks :
|
XML
|
reportActors | - | NO | The set of the report notification actors. Available 'role' are :
If configured with Global Settings, their corresponding keys are :
|
XML
|
attachErrorReport |
| NO | Whether the error report is attached or not to the summary. | true,false |
Notifications additionals informations are described in the notification parts.
File Archiving Definition
File Archiving Definition configures the settings used to archive a CSV file after the execution of an import task.
Property Name | Type | Mandatory | Description | Values (default value in bold) |
---|---|---|---|---|
archiveRelativeFilePath |
| YES | Relative file path on disk where to archive the input file. The archive relative file path is "configurable" via placeholders whose values are dynamically substituted. Available placeholders are: {original_directory}: the complete directory path to the original CSV file | Example : {original_directory}/{original_filename}-{tenant}-{timestamp}.{original_extension} |
overwriteExistingArchive |
| NO | Should archive file be overwritten or not if it already exists | true, false |
Example
Here is a simple XML representation of a Synchronization Task Post Processing Definition.