User Sync Field

For the most up-to-date documentation, please visit


When a new user is created, a node of the same name is created in a configurable root node. This can then be used in an information field such as "responsible user" (because there are only node-referencing, but no user-referencing information fields).

When a user is deleted, the existing node in the root node will be moved to the archive node (if it exists).

The Task "Initial User Sync" creates nodes of existing users in the root node.

The Task "Initial Deactivated User Sync" moves
a) existing nodes of deactivated users from the root node to the archive node and
b) existing nodes of reactivated users from the archive node to the root node.


To be configured in {home}/appserver/conf/


type: String, required: yes, default: -

Provided by brix (product: userSyncField)


type: long, required: yes, default: -

The ID of the node beneath which the new node will be created.


type: boolean, required: no, default: true

Whether to include the user's middle name in the node name.


type: long, required: no, default: -

Whether to set an information field value on the created node to the ID of the corresponding user. Useful to then consume the information with another extension, e.g. AssetOrder


type: long, required: no, default: -

The ID of the node where nodes of deleted users are moved to. If not defined, nothing happens.


type: boolean, required: no, default: false

If set to true, only users that are provisioned by an identity provider (e.g. AD, SCIM) are synchronised.


type: list of long (comma separated), required: no, default: -

If onlyProvisioned is true, users in syncableGroups are synchronised regardless of whether they are provisioned or not. If onlyProvisioned is false and syncableGroups are defined, only users in syncableGroups are synchronised.


type: quartz-expression, required: no, default: 0 0 1 ?

Task to archive node names that belong to users that have been deactivated.

Compatibility Matrix

User Sync Field CELUM (min. version)
1.0.0 5.12.4
1.1.0 5.13.3
1.2.0 6.4.0
1.3.0 6.4.0 (tested with 6.8)
1.4.0 6.4.0 (tested with 6.8)
1.5.1 6.4.0 (tested with 6.11)

Release Notes


  • Initial Version


  • Update SDK level to 5.13.3 (in order to use async subscribe)


  • Updated SDK to 6.4, added userIdToNodeInfofieldId


Release: 2020-12-10

  • Added archiveNodeId
  • Added userSyncTask and userSyncDeacTask


Release: 2021-02-10

  • Added findById if userIdToNodeInfofieldId is set and node has userID
  • Added CacheLoader


Release: 2022-03-16

  • Added onlyProvisioned and syncableGroups