Skip to content

Commit

Permalink
Add async. update page
Browse files Browse the repository at this point in the history
  • Loading branch information
mederly committed Nov 26, 2021
1 parent 92287b8 commit 32a21fa
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/tasks/activities/work.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ As of midPoint 4.4, the following items are supported (MT means "Supports multi-
| What xref:../resource-object-set-specification/[resource objects] to reconcile.
| This is obligatory parameter.

| `asynchronousUpdate`
| xref:/midpoint/reference/tasks/synchronization-tasks/asynchronous-update/[`asynchronousUpdate`]
| Processes asynchronous updates for given resource objects (EXPERIMENTAL).
| Simple
| Y
Expand All @@ -47,7 +47,7 @@ As of midPoint 4.4, the following items are supported (MT means "Supports multi-
| What xref:../resource-object-set-specification/[resource objects] to receive updates for. (Not all configuration items are supported - TODO.)
| This is obligatory parameter.

.3+| xref:../synchronization-tasks/live-synchronization/[`liveSynchronization`]
.3+| xref:/midpoint/reference/tasks/synchronization-tasks/live-synchronization/[`liveSynchronization`]
.3+| Processes live synchronization events for give resource objects.
.3+| Simple
.3+| Y
Expand All @@ -56,10 +56,10 @@ As of midPoint 4.4, the following items are supported (MT means "Supports multi-
| What xref:../resource-object-set-specification/[resource objects] to synchronize.
| This is obligatory parameter.
| `batchSize`
| See xref:../synchronization-tasks/live-synchronization/[].
| See xref:/midpoint/reference/tasks/synchronization-tasks/live-synchronization/[].
| 0
| `updateLiveSyncTokenInDryRun`
| See xref:../synchronization-tasks/live-synchronization/[].
| See xref:/midpoint/reference/tasks/synchronization-tasks/live-synchronization/[].
| `false`

| `cleanup`
Expand Down
50 changes: 50 additions & 0 deletions docs/tasks/synchronization-tasks/asynchronous-update.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
= Asynchronous Update
:toc:
:experimental:

The asynchronous update activity/task processes a stream of so-called _change events_ coming from a resource.
These events represent changes related to _resource objects_: their creation, modification, or deletion.
The task ensures that these events are processed, so that changes on the resource objects are reflected
on midPoint objects (and propagated to other resources, if needed).

Unlike xref:../live-synchronization/[live synchronization], these change events are sent to midPoint asynchronously,
i.e. the transfer is driven by the resource, not by midPoint.

== Basic Configuration

The heart of the configuration is the specification of what xref:/midpoint/reference/tasks/activities/resource-object-set-specification/[resource objects]
we want to process updates for. The `resourceRef` is obligatory, all the other properties are optional. The `query` property
of the object set specification is not applicable for Asynchronous update tasks.

=== An example

.Asynchronous update task
[source,xml]
----
<task>
<name>Asynchronous update: Example Resource</name>
<ownerRef oid="00000000-0000-0000-0000-000000000002" type="UserType"/>
<executionState>runnable</executionState>
<activity>
<work>
<asynchronousUpdate>
<updatedResourceObjects>
<resourceRef oid="54102823-84c3-49f0-a350-3b5514c9b7b9"/>
</updatedResourceObjects>
</asynchronousUpdate>
</work>
</activity>
</task>
----

== Advanced Configuration

== Error Handling

The default behavior of Asynchronous update activity is to _stop_ when an error is encountered.
This is to ensure that no information is lost in such cases. This behavior can be changed via
custom xref:/midpoint/reference/tasks/task-error-handling/[error handling specification].

== See Also

* #TODO# link to information about asynchronous resources
3 changes: 3 additions & 0 deletions docs/tasks/synchronization-tasks/live-synchronization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ These events represent changes related to _resource objects_: their creation, mo
The task ensures that these events are processed, so that changes on the resource objects are reflected
on midPoint objects (and propagated to other resources, if needed).

The event stream is requested by midPoint: after a live synchronization activity starts, it asks the resource
for recent changes. Please see a discussion on change token below.

== Basic Configuration

The heart of the configuration is the specification of what xref:/midpoint/reference/tasks/activities/resource-object-set-specification/[resource objects]
Expand Down

0 comments on commit 32a21fa

Please sign in to comment.