Resource wizard: Object type synchronization

Last modified 21 Jan 2025 16:24 +01:00

Since 4.9

This functionality is available since version 4.9.

Table of Contents

Configuration of resource wizard panels
How to Use Lifecycle States

This part of object type wizard allows you to define synchronization situations and reactions. These situations represent state of the resource object (e.g. account) in relation to midPoint and appropriate action that should be executed by midPoint.

For the situations you need to configure:

Name of the situation/reaction configuration. This is technically not mandatory, but helps a lot during troubleshooting and when using resource template inheritance.
Situation allows you to select an appropriate situation:
- Linked refers to situation when the resource object is linked to its midPoint owner
- Unlinked refers to situation when a new resource object has been found and its owner can be determined, but there is no link between the midPoint owner and resource object
- Deleted refers to situation when the resource object was references by midPoint owner but the resource object has been deleted
- Unmatched refers to situation when a new resource object has been found but midPoint cannot determine any owner for the account
- Disputed refers to situation when the midPoint has determined more potential midPoint owners for a single resource account or if the correlation of the resource object is not definitive (not fully trusted)
Action allows you to select midPoint behavior if the resource object is in the defined Situation
- Add focus allows to create a new object in midPoint based on the resource data
- Synchronize allows to synchronize data between midPoint object and resource data based on the mappings. This action is typical for linked situation.
- Link allows to link previously not linked resource object to midPoint object
- Delete resource object allows to delete resource object
- Inactivate resource object allows to inactivate (disable) resource object
- Inactivate focus allows to inactivate (disable) midPoint object
- Delete focus allows to delete midPoint object
- Create correlation case allows to resolve the situation interactively (useful for Disputed situation)
Lifecycle state allows you to define the lifecycle state of the situation/reaction configuration. This can be used during Simulations, e.g. specifying lifecycle state as Proposed will be used only to simulate the synchronization/reaction configuration, Draft disables the synchronization/reaction configuration etc.

The logic of situation and action is up to you. E.g. it is perfectly OK to have reaction Add focus for Unmatched situation for an authoritative source system such as HR. For target system, however, probably more appropriate reaction for Unmatched situation would be Inactivate resource object.

Please refer to Focus and Projections for explanation of the term Focus. In the most basic scenarios when synchronizing users and their accounts, focus corresponds to User object in midPoint.

Figure 1. Table of synchronization actions

More complex configuration is possible by clicking btn:[Edit] button:

Figure 2. Basic configuration of synchronizatio rule

Figure 3. Action for synchronization rule

Figure 4. Optional attributes for synchronization rule

Situation/reaction configuration can be deleted by clicking btn:[Delete] button.

Click btn:[Save synchronization settings] when done to return to the previous page from which you started the synchronization editor.

Configuration of resource wizard panels

Some wizard panels are configurable, for more information see Wizard panels.

How to Use Lifecycle States

You can use different lifecycle states for resources, object types, attributes, mappings, synchronization situations, and other aspects of resource configuration. You can use the lifecycle state property for simulations. Resources are created in the Proposed lifecycle state by default, and don’t work in normal deployment before switching the state to Active.

You can use the Proposed lifecycle state to test (simulate) the configuration without causing any damage to your target system data. When the simulation results are satisfactory, you can switch the lifecycle state to Active.

You can set different lifecycle states for various configuration items, which lets you put specific parts of configuration to production incrementally.

For example, after you switch your resource to the Active lifecycle state, you can add new mappings in Proposed lifecycle state first. You can simulate the new mapping safely and switch it to Active when it’s ready.