Create Connector Synchro Incremental

This scaffolding generates a synchronization job (in Incremental mode) for the given connector.

The tasks created in the Scaffoldings are sorted by level. The levels are visible via the tools: Usercube-Get-JobSteps.exe

Examples

Code attributes enclosed with <> need to be replaced with a custom value before entering the script in the command line.

<CreateConnectorSynchroIncremental DisplayName_L1="10: Microsoft Entra ID (formerly Azure Active Directory) - Synchronization Incremental (scaffolding)" Connector="MicrosoftEntraID" JobIdentifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding"/>

Properties

Property	Type	Description
Connector required	String	Identifier of the connector involved in the job to be generated.
DisplayName_L1 optional	String	Display name of the scaffolding in language 1 (up to 16).
JobIdentifier optional	String	For job scaffoldings, identifier of the job to be generated. If not defined, the job identifier is calculated.
OldAlgorithm optional	Boolean	Internal use.

Child Elements

AddTask (optional) — Add a task before or after another in the job.
CronTabExpression (optional) — Schedule the job.
FormatPropertiesInResource (optional) — Converts string properties to their corresponding types in the 'Resource' section of the provisioning order.
FulfillInternalWorkflowsPath (optional) — Add the path of the json configuration for a connector with IsWorkflowProvisioning set to true.
LinkDependTask (optional) — Link a child Task with a parent to not launch the child if the parent has finish with state warning.
NoProvisioning (optional) — Avoid provisioning.
NoSynchronization (optional) — Avoid collect.
OpenIdIdentifier (optional) — Add a OpenID to the job and the tasks.

AddTask

Property	Type	Description
Task required	String	Identifier of the task to add.
TaskToCompareWith required	String	The identifier of the task before or after which the new task will be inserted
After default value: false	Boolean	For the Argument AddTask the property after define the place of the task to add with the TaskCompareWith.
Before default value: false	Boolean	For the Argument AddTask the property before define the place of the task to add with the TaskCompareWith.
CopyOccurence default value: 0	Int32	For Argument AddTask, Specify the Occurence to copy and add the Task in a specify Job.
Occurence default value: 0	Int32	Occurrence of the TaskToCompare after or before which the task will be added.

CronTabExpression

Property	Type	Description
CronTab required	String	Represents the argument value.
CronTimeZone optional	CronTimeZone	For Argument AddTask, Occurrence of the TaskToCompare after or before which the task will be added.

FulfillInternalWorkflowsPath

Property	Type	Description
ConnectorIdentifier required	String	Identifier of the connector involved in the following arguments: `NoConnectorSynchronization`; `NoConnectorProvisioning`; `NotUsed`; `FulfillInternalWorkflowsPath`; `PrincipalDataConnector`.
Path required	String	Represents the argument value.

LinkDependTask

Property	Type	Description
DependOn required	String	Identifier of parent Task.
Task required	String	Identifier of child Task.
ChildOccurence default value: 0	Int32	Search the occurrence x to link with the parent.
ParentOccurence default value: 0	Int32	Occurrence of the parentTask which the task will be linked

OpenIdIdentifier

Property	Type	Description
Identifier required	String	Identifier of the OpenId

Generated XML

Our example generates the following configuration:

Code attributes enclosed with <> need to be replaced with a custom value before entering the script in the command line.

<Job Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding" DisplayName_L1="10: Microsoft Entra ID - Synchronization Incremental (scaffolding)" Agent="Local" IsIncremental="true">
  <ExportTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_Export_MicrosoftEntraID_Incremental_MicrosoftEntraIDExportFulfillment" DisplayName_L1="Microsoft Entra ID - Extract Changes" DisplayName_L2="Microsoft Entra ID - Extraction des modifications" Agent="Local" Connector="MicrosoftEntraID" Level="0" OpenIdClient="Job" Connection="MicrosoftEntraIDExportFulfillment" ContinueOnError="true" />
  <PrepareSynchronizationTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_PrepareSynchronizationChanges_MicrosoftEntraID_Incremental" DisplayName_L1="Microsoft Entra ID - Incremental Synchronization (agent side)" DisplayName_L2="Microsoft Entra ID - Synchronisation incrémentale (côté agent)" Agent="Local" Connector="MicrosoftEntraID" Level="1" OpenIdClient="Job" SynchronizationMode="Incremental" Type="Changes">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_Export_MicrosoftEntraID_Incremental_MicrosoftEntraIDExportFulfillment" />
  </PrepareSynchronizationTask>
  <SynchronizeTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_SynchronizeChanges_MicrosoftEntraID_DoNotDeleteChanges" DisplayName_L1="Microsoft Entra ID - Synchronization (changes server side)" DisplayName_L2="Microsoft Entra ID - Synchronisation (changements côté serveur)" Connector="MicrosoftEntraID" Level="2" Type="Changes" DoNotDeleteChanges="true">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_PrepareSynchronizationChanges_MicrosoftEntraID_Incremental" />
  </SynchronizeTask>
  <SetRecentlyModifiedFlagTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_SetRecentlyModifiedFlag" DisplayName_L1="Tag Modified Objects" DisplayName_L2="Marquage des objets modifiés" Level="3">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_SynchronizeChanges_MicrosoftEntraID_DoNotDeleteChanges" />
  </SetRecentlyModifiedFlagTask>
  <UpdateEntityPropertyExpressionsTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_UpdateEntityPropertyExpressions1_WithDirty" DisplayName_L1="Update Computed Properties" DisplayName_L2="Mise à jour des propriétés calculées" Level="4" Dirty="true">
    <TaskEntityType EntityType="MicrosoftEntraID_DirectoryObject" />
    <TaskEntityType EntityType="Directory_Guest" />
    <TaskEntityType EntityType="Directory_User" />
  </UpdateEntityPropertyExpressionsTask>
  <ComputeCorrelationKeysTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_ComputeCorrelationKeys1_AllEntities_WithDirty" DisplayName_L1="Compute all Correlations" DisplayName_L2="Calcul des corrélations" Level="5" Dirty="true">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_SetRecentlyModifiedFlag" />
    <TaskEntityType EntityType="MicrosoftEntraID_DirectoryObject" />
    <TaskEntityType EntityType="Directory_Guest" />
    <TaskEntityType EntityType="Directory_User" />
  </ComputeCorrelationKeysTask>
  <ComputeRoleModelTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_ComputeRoleModel1_WithDirty" DisplayName_L1="Apply the Role Model" DisplayName_L2="Evaluation du modèle de rôles" Level="6" Dirty="true">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_SetRecentlyModifiedFlag" />
    <TaskEntityType EntityType="Directory_Guest" />
    <TaskEntityType EntityType="Directory_User" />
  </ComputeRoleModelTask>
  <GenerateProvisioningOrdersTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_GenerateProvisioningOrders1" DisplayName_L1="Generate Provisioning Orders - Microsoft Entra ID" DisplayName_L2="Génération des ordres de provisioning - Microsoft Entra ID" Level="7">
    <TaskResourceType ResourceType="MicrosoftEntraID_DirectoryObject_Guest" />
    <TaskResourceType ResourceType="MicrosoftEntraID_DirectoryObject_NominativeUser" />
  </GenerateProvisioningOrdersTask>
  <FulfillTask Identifier="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_Fulfill1" DisplayName_L1="Fulfillment - Microsoft Entra ID" DisplayName_L2="Alimentation - Microsoft Entra ID" Agent="Local" Level="8" OpenIdClient="Job" Dirty="true" ContinueOnError="true">
    <TaskDependsOnTask ParentTask="MicrosoftEntraID_Synchronize_Incremental_Scaffolding_GenerateProvisioningOrders1" />
    <TaskResourceType ResourceType="MicrosoftEntraID_DirectoryObject_Guest" />
    <TaskResourceType ResourceType="MicrosoftEntraID_DirectoryObject_NominativeUser" />
  </FulfillTask>
</Job>

Examples​

Properties​

Child Elements​

AddTask​

CronTabExpression​

FulfillInternalWorkflowsPath​

LinkDependTask​

OpenIdIdentifier​

Generated XML​