Resource wizard: Object type synchronization
|
Since 4.9
This functionality is available since version 4.9.
|
This describes how to set up synchronization reactions in the resource wizard.
Introduction
Synchronization in midPoint is the mechanism that keeps identity data consistent between midPoint and connected systems. It reacts to changes based on the defined synchronization reactions.
You can use the synchronization wizard to define reactions to synchronization situations. These situation–action pairs represent the state of resource objects (e.g., accounts) in relation to midPoint and appropriate actions to be executed by midPoint in the particular situation.
For more technical details, refer to Synchronization.
Set up synchronization reactions
-
In Resources > All Resources, select your resource.
-
In Accounts, click Configure > Synchronization.
-
You can:
-
Add synchronization reactions manually by clicking Add reaction and setting up situations and actions.
-
Generate synchronization reactions as described in Generate synchronization reactions.
-
-
Click Save synchronization settings when done.
You can delete a reaction using the Delete button.
You can access a more complex configuration for each reaction using the Edit button:
Figure 1. Basic configuration of a synchronization reaction
|
Figure 2. Action for a synchronization reaction
|
Figure 3. Optional attributes for a synchronization reaction
|
Situations and actions
For each reaction, you need to configure the following options:
-
Name of the reaction configuration. This is not mandatory but it helps when troubleshooting and using resource template inheritance.
-
Situation contains the following options:
-
Linked: The resource object is linked to its midPoint owner (focus object).
-
Unlinked: A new resource object has been found and its owner (focus) can be determined but there is no link between them.
-
Deleted: There is a focus in midPoint for the resource object but the resource object no longer exists.
-
Unmatched: A new resource object has been found but midPoint cannot determine any owner (focus) for the account.
-
Disputed: MidPoint has determined multiple potential midPoint owners (foci) for a single resource account. Alternatively, this may be a result of a correlation with an outcome that is not fully trusted.
-
-
Action defines what to do in a particular situation:
-
Add focus: Create a new object in midPoint based on the resource data.
-
Synchronize: Synchronize data between midPoint object (focus) and resource data based on object type mapping. Typically used for the linked situation.
-
Link: Link previously not linked resource object to focus.
-
Delete resource object: Delete resource object.
-
Inactivate resource object: Inactivate (disable) resource object.
-
Inactivate focus: Inactivate (disable) midPoint object.
-
Delete focus: Delete midPoint object.
-
Create correlation case: Create a case to let midPoint administrator resolve the situation interactively (useful for the Disputed situation).
-
-
Lifecycle state defines the lifecycle state of the reaction. Useful for simulations.
|
For example, for authoritative resources, you can set action to Add focus for the Unmatched situation. For non-authoritative target systems, you would then use the Inactivate resource object action for the same situation. |
Refer to Focus and Projections for an explanation of the term focus. In the most basic scenarios, when synchronizing users and their accounts, focus corresponds to the user object in midPoint.
Generate synchronization reactions
For higher efficiency, you can generate synchronization reactions as opposed to creating them manually.
-
Click Generate reactions button to generate synchronization reactions.
-
Select the synchronization direction:
-
Source - If a resource provides data to midPoint.
Figure 5. Synchronization direction: Source -
Target - If midPoint provides data to a resource.
Figure 6. Synchronization direction: Target
-
-
Answer the questions for the given synchronization direction to help the midPoint understand your requirements and generate appropriate synchronization reactions.
-
Click Confirm and generate.
-
Review the generated synchronization reactions and make any necessary adjustments as described in Set up synchronization reactions.
-
Click Save synchronization settings when done.
See also
Here are additional resources to explore:
-
Object Lifecycle: Gain a deeper understanding of object lifecycle management in midPoint.
-
Admin GUI Configuration: See configuration options for certain wizard panels and the GUI in general.