Skip to main content
Skip table of contents

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

Boolean

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

Enum

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

String

NO

The relative path to the error report file. May be null, its default value becomes then: {original_filename}-errors-{timestamp}.

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: domino.sync.task-report-root-dir. When running in multi-tenancy mode, the tenant name is always appended to the root directory, such as: /{root-directory}/{tenant}.

The file path is "configurable" via placeholders whose values are dynamically substituted. Available placeholders are:

  • {original_filename}: the complete path to the original CSV file (minus the file extension)

  • {timestamp}: a timestamp of millisecond precision formatted as follows: yyyyMMddHHmmssSSS

  • {tenant}: the current tenant

The original file extension is preserved. An example of such a relative path could be: import-errors/{original_filename}-{timestamp}. In the case, the import-errors sub directory will be automatically created.

-

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 :

  • status

  • numberOfEntriesToProcess

  • numberOfProcessedEntries

  • numberOfIgnoredEntries

  • numberOfGeneratedWarnings

  • startDate

  • processingTimeMillis

  • endDate

  • fatalErrorMessage: the full message that way contain sensitive technical information

  • fatalErrorSafeMessage: a message devoid of sensitive information

  • fatalErrorCode: the codified error

  • simulation_tag

And specific variables for synchronization tasks :

  • numberOfCreatedIdmObjects

  • numberOfUpdatedIdmObjects

  • numberOfDeletedIdmObjects

  • numberOfInactivatedApplicationObjects

  • numberOfDeletedApplicationObjects

  • numberOfSoftDeletedIdmObjects

  • numberOfDeactivatedIdmObjects

XML
<notificationDefinitionIds>
   <notificationDefinitionId>report</notificationDefinitionId>
</notificationDefinitionIds>

reportActors

-

NO

The set of the report notification actors.
Their 'role' attribute must correspond to those expected by DOMINO_SYNC_REPORT_PUBLICATION Notification Event Type.
If defined, it overrides the default recipients configured in the "global Settings"

Available 'role' are :

  • domino_task_report_sender

  • domino_task_report_replyto

  • domino_task_report_recipient

If configured with Global Settings, their corresponding keys are :

  • domino.task.report.sender

  • domino.task.report.replyto

  • domino.task.report.recipient

XML
<reportActors>
  <reportActor>
      <email>administrator@memority.com</email>
      <language>fr</language>
      <name>Reporting</name>
      <role>domino_task_report_sender</role>
      <uid>REP</uid>
   </reportActor>
</reportActors>

attachErrorReport

Boolean

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

String

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
{original_filename}: the complete path to the original CSV file (minus the file extension)
{original_extension}: the extension of the original CSV file
{timestamp}: a timestamp of millisecond precision formatted as follows: yyyyMMddHHmmssSSS
{tenant}: the current tenant

Example : {original_directory}/{original_filename}-{tenant}-{timestamp}.{original_extension}

overwriteExistingArchive

Boolean

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.

Synchronization Task Post Processing Definition
XML
<dmn:SynchronizationTaskPostProcessingDefinition id="postProcessingTask">
    <name>postProcessingTask</name>
    <description>Description of postProcessingTask</description>
    <reportDefinition>
        <errorPublicationDefinition>
            <errorDetails>
                <errorDetail>ERROR_CODE</errorDetail>
                <errorDetail>ERROR_LABEL</errorDetail>
            </errorDetails>
            <reportFilePath>{original_directory}/{original_filename}-errors-{timestamp}</reportFilePath>
        </errorPublicationDefinition>
        <reportPublicationDefinition>
            <attachErrorReport>true</attachErrorReport>
       <notificationDefinitionIds>
                <notificationDefinitionId>report_publication_test</notificationDefinitionId>
        </notificationDefinitionIds>
        <reportActors>
          <reportActor>
              <email>administrator@memority.com</email>
              <language>fr</language>
              <name>Reporting</name>
              <role>domino_task_report_sender</role>
              <uid>REP</uid>
          </reportActor>
        </reportActors>
        </reportPublicationDefinition>
    </reportDefinition>
    <fileArchivingDefinition>
        <archiveRelativeFilePath>{original_directory}/{original_filename}-{timestamp}.{original_extension}</archiveRelativeFilePath>
        <overwriteExistingArchive>false</overwriteExistingArchive>
    </fileArchivingDefinition>
</SynchronizationTaskPostProcessingDefinition>

Read Next

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.