---
title: 'Celum User and Group Sync'
url: 'https://doc.brix.ch/camunda/for-camunda/celumuserandgroupsync'
markdown: 'https://doc.brix.ch/camunda/for-camunda/celumuserandgroupsync.md'
lang: en
date: '2026-10-26'
description: 'Technical documentation for the Camunda project "Celum User and Group Sync" – Software developed by brix'
taxonomy:
  category:
    - docs
---

[](#) 

  [ Welcome ](https://doc.brix.ch/)     [ Camunda ](https://doc.brix.ch/camunda)     [ For Camunda ](https://doc.brix.ch/camunda/for-camunda)      Celum User and Group Sync    

# Celum User and Group Sync

The *Celum User and Group Sync* project synchronizes the configured Celum users and groups hourly by running its simple workflow.

#### Table of Contents

- [Installation](#installation)
- [Properties](#properties)
- [Compatibility Matrix](#compatibility-matrix)
- [Release Notes](#release-notes)

## Installation

1. Install the [Celum User Service](https://docs.brix.ch/celum_extensions/celumuserservice) in Celum
2. Make sure the environment variable CAMUNDA\_HOME is set and pointing to the correct location
3. Create the CelumUserAndGroupSync.properties file in {CAMUNDA\_HOME}/config
4. Deploy the .war file in Camunda

## Properties

To be configured in {CAMUNDA\_HOME}/config/CelumUserAndGroupSync.properties

##### token

> type: string, **required: yes**, default: -

The security token configured for the [Celum User Service](https://docs.brix.ch/celum_extensions/celumuserservice).

##### url

> type: string, **required: yes**, default: -

The URL for the [Celum User Service](https://docs.brix.ch/celum_extensions/celumuserservice), e.g. http://localhost:8881/celumUserService

##### groups

> type: comma-separated list of Celum group ids, required: no, default: - (all groups)

Only synchronize the specified Celum groups.

##### recursive

> type: boolean, required: no, default: false

Also synchronize sub-groups of the specified groups.

##### excludeGroups

> type: comma-separated list of Celum group ids, required: no, default: -

Groups to exclude. This property is somewhat problematic and it is recommended not to use it. If a sub-group of a group is excluded then the collection of users in sub-groups is stopping there.

##### excludeUsers

> type: comma-separated list of Celum user ids, required: no, default: -

Users to exclude.

##### userIdPrefix

> type: string, required: no, default: CelumUser

The prefix to use for the Celum users in Camunda.

##### groupIdPrefix

> type: string, required: no, default: CelumGroup

The prefix to use for the Celum groups in Camunda.

##### groupNameFormat

> type: string, required: no, default: {name}

The group name format for groups in Camunda.

##### groupTypeFormat

> type: string, required: no, default: CELUM

The group type format for groups in Camunda.

##### userFirstNameFormat

> type: string, required: no, default: {firstName}

The first name format for users in Camunda.

##### userLastNameFormat

> type: string, required: no, default: {lastName}

The last name format for users in Camunda.

##### userEmailFormat

> type: string, required: no, default: {email}

The email format for users in Camunda.

### User format properties

The following strings will be replaced automatically by the value coming from Celum:

- {id}
- {username}
- {firstName}
- {middleName}
- {lastName}
- {email}
- {street}
- {city}
- {country}
- {phone}
- {phoneMobile}
- {description}
- {company}
- {zip}
- {domain}
- {homepage}
- {fax}
- {kind}

### Group format properties

The following strings will be replaced automatically by the value coming from Celum:

- {id}
- {name}
- {description}

## Compatibility Matrix

| Camunda Core | CELUM |
|---|---|
| 1.0.0 | 5.13.4 (tested with 6.4) |

## Release Notes

##### 1.0.0

> Released 2020-03-09

Initial version

 [ ](https://doc.brix.ch/camunda/for-camunda) [](https://doc.brix.ch/dam)

---

## Navigation

- Parent: [For Camunda](https://doc.brix.ch/camunda/for-camunda.md)