Skip to content

Commit

Permalink
Updating FAQ for upgrade from 4.4 LTS to 4.8 LTS and mapping document…
Browse files Browse the repository at this point in the history
…ation, MID-9310
  • Loading branch information
dejavix committed Jan 9, 2024
1 parent e5715bd commit 9f5d6df
Showing 1 changed file with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions docs/upgrade/faq-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ It is intended to help you to solve problems that may occur during the upgrade p

NOTE: Always upgrade to the latest midPoint 4.4-based release before attempting to upgrade to 4.8 LTS. At the time of writing this document, the latest 4.4-based release is https://docs.evolveum.com/midpoint/release/4.4.6/[midPoint 4.4.6].

[#_resource_schema_change]
=== Do I need to update my 4.4-based resources after upgrade to 4.8 LTS?

midPoint 4.8 LTS uses an updated resource definition.
Some parts of resource definition are marked as *DEPRECATED* and the functionality will be eventually removed, e.g. `<objectSynchronization>` element defined in resource synchronization.

The old resources should still work in 4.8 LTS, but cannot be edited using xref:/midpoint/reference/admin-gui/resource-wizard/[resource wizard].
Also, `<auxiliaryObjectClass>`, `<baseContext>`, `<searchHierarchyScope>` in the resource object type definition are *DEPRECATED*.
They were moved to the new xref:/midpoint/reference/resources/resource-configuration/schema-handling/changes-in-4.6/#resource-object-type-delineation[`<delineation>`] item.

The old resources should still work in 4.8 LTS (while the deprecated elements are still in midPoint schema), but cannot be edited using xref:/midpoint/reference/admin-gui/resource-wizard/[resource wizard].

Please refer to xref:/midpoint/reference/resources/resource-configuration/schema-handling/changes-in-4.6/[schema handling changes documentation] for more information how to change your resource definitions after you upgrade midPoint to 4.8 LTS.

Expand All @@ -24,11 +28,52 @@ The old query-only-based correlation is still supported, but it is *DEPRECATED*

We recommend to upgrade your resource definitions to use the new mechanism, especially the easy-to-use xref:/midpoint/reference/correlation/items-correlator/[Items correlator] after you upgrade midPoint to 4.8 LTS.

=== Do I need to update my 4.4-based synchronization situations and reactions in resources after upgrade to 4.8 LTS?

The synchronization situations and reactions are now much more human-readable.

|===
|midPoint 4.4 LTS |midPoint 4.8 LTS

a|
[source,xml]
----
. . .
<reaction>
<situation>unlinked</situation>
<synchronize>true</synchronize>
<action>
<handlerUri>http://midpoint.evolveum.com/xml/ns/public/model/action-3#link</handlerUri>
</action>
</reaction>
. . .
----

a|
[source,xml]
----
<synchronization>
<reaction>
<situation>unlinked</situation>
<actions>
<link/>
</actions>
</reaction>
. . .
</synchronization>
----

|===

The new recommendation for `deleted` situation is *synchronize* (instead of *unlink* used in midPoint 4.4 LTS).

See also answer for xref:#_resource_schema_change[Do I need to update my 4.4-based resources after upgrade to 4.8 LTS?].

=== Can I use the resource wizard in 4.8 LTS to create the same configuration as using midPoint XML language?

xref:/midpoint/reference/admin-gui/resource-wizard/[midPoint resource wizard] can be currently used to create and update resource definitions mainly for your first steps midPoint.
There are limitations in supported expressions (e.g. it supports "As is", "Literal", "Script" and "Generate" expressions) and correlation (e.g. it does not support "correlation by query" yet).
Also, mapping ranges are not currently supported.
Also, mapping domain / ranges are not currently supported.

If the resource wizard does not meet your expectations, feel free to define your resources using midPoint XML language.

Expand All @@ -51,9 +96,6 @@ They are also used for merging configuration if you use xref:/midpoint/reference

We recommend to use mapping names and this is why resource wizard displays the mapping names as the first (prominent) column in the resource mappings table.

// TODO new synchronization parameters, e.g delineation
// .. and new recommendations for this synchronization section (we already mentioned correlation)

=== Why is the audit log getting bigger after upgrade to 4.8 LTS? / What is the new RESOURCE audit stage?

In midPoint 4.8 LTS, there is a new `Resource` phase in auditing subsystem (and audit log).
Expand Down

0 comments on commit 9f5d6df

Please sign in to comment.