Create a live sync task how-to

Last modified 12 Aug 2026 12:17 UTC

This guide shows how to create a minimal live synchronization task in midPoint which polls a resource for changes and propagates them into midPoint.

Prerequisites

  • A running midPoint instance (4.4 or later).

  • A configured, tested resource whose connector supports live synchronization. Verify the green Live Sync capability indicator on the resource detail page before proceeding.
    You can do this by going to Resources > resource > Details and checking Live Sync is enabled (green).

  • The OID of that resource. This is visible in:

    • The resource URL - Following objectId=, for example ebd0bf7b-7e80-4175-ba5e-4fd5de2ecd62.

    • The resource XML - Open the resource, click Edit raw, and check the oid attribute of the <resource> element.

  • For verification, the ability to create or modify accounts directly on the resource (LDAP browser, DB client, etc.).

Configuration overview

A live sync task is a TaskType object with an activity of type liveSynchronization. It references a resource and one specific object class on that resource (kind + intent).

Approach Best suited for

GUI

First-time setup, manual creation, ad-hoc tasks for short-term troubleshooting.

XML

Reproducible deployments where the task definition is part of the system configuration package.

Create live sync task

Option A — GUI

  1. Navigate to Resources > resource > Defined Tasks

  2. Click New task.

    Defined tasks tab on a resource, showing the New task button

  3. Click Live synchronization task.

  4. Set the following and click Next:Resource objects:

    Attribute Value

    Name

    Live Sync — HR System

  5. Set the following and click Next:Schedule:

    Attribute Value

    Resource

    (select your resource)

    Kind

    account

    Intent

    default

  6. Set Interval to 10 (seconds) and click Next:Distribution.

  7. Click Save $ Run.

Option B — XML

  1. In the application main menu, navigate to Import object

  2. In the Get object from section, select Embedded editor.

  3. Paste the following XML into the editor:

    <task xmlns="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
      xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-3">
    <name>Live Sync — HR System</name>
    <executionState>runnable</executionState>
    <ownerRef oid="00000000-0000-0000-0000-000000000002" type="c:UserType"/>
    <activity>
        <work>
            <liveSynchronization>
                <resourceObjects>
                    <resourceRef oid="REPLACE-WITH-RESOURCE-OID" type="c:ResourceType"/>
                    <kind>account</kind>
                    <intent>default</intent>
                </resourceObjects>
            </liveSynchronization>
        </work>
        <distribution>
            <workerThreads>1</workerThreads>
        </distribution>
    </activity>
    <schedule>
        <interval>10</interval>
    </schedule>
</task>

  4. Replace REPLACE-WITH-RESOURCE-OID with the resource OID, and adjust kind/intent if the resource defines additional object types.

    Import object dialog with XML editor

  5. Click Import object.

Verification

  1. Confirm the task is running by going to Server tasks > All tasks. The new task should be listed there with a recent Last run timestamp.

  2. Create or modify an account on the source resource. For an LDAP resource, add a new entry under the search base.

  3. Wait for one polling interval (10 seconds in the example).

  4. In midPoint, navigate to Users > All users. The new account should be represented as a user (created, updated, or linked according to the resource’s synchronization reactions).

  5. Open the task and inspect the Operation statistics tab. The counters for processed objects should have advanced.

See also

Was this page helpful?
YES NO
Thanks for your feedback