---
title: 'Forced Subscription'
url: 'https://docs.brix.ch/celum_extensions/forced_subscription'
markdown: 'https://docs.brix.ch/celum_extensions/forced_subscription.md'
lang: en
date: '2026-10-26'
description: 'Technical documentation for the CELUM Extension "Forced Subscription" – Software developed by brix'
taxonomy:
  category:
    - docs
---

[](#) 

  [ Welcome ](https://docs.brix.ch/)     [ CELUM Extensions ](https://docs.brix.ch/celum_extensions)      Forced Subscription    

# Forced Subscription

![No UI](https://img.shields.io/static/v1?label=UI&message=none&color=inactive)

Allows to configure subscriptions that will be added automatically, every 20 minutes the subscriptions will be renewed if they are deleted.

#### Table of Contents

- [Properties](#properties)
    - - - [forcedSubscription.subscription.1.nodes](#forcedsubscription-subscr)
            - [forcedSubscription.subscription.1.userGroups](#forcedsubscription-subscr-1)
            - [forcedSubscription.subscription.1.template=](#forcedsubscription-subscr-2)
            - [forcedSubscription.subscription.1.active=](#forcedsubscription-subscr-3)
            - [forcedSubscription.template.1.notificationTypes](#forcedsubscription-templa)
            - [forcedSubscription.template.1.notificationEvents](#forcedsubscription-templa-1)
            - [forcedSubscription.template.1.includingSubnodes](#forcedsubscription-templa-2)
            - [forcedSubscription.template.1.rootNodeIncluded](#forcedsubscription-templa-3)
            - [forcedSubscription.template.1.subNodesIncluded](#forcedsubscription-templa-4)
            - [forcedSubscription.template.1.recursiveSubNodes](#forcedsubscription-templa-5)
- [Compatibility Matrix](#compatibility-matrix)
- [Release Notes](#release-notes)
    - - [1.0](#1-0)

## Properties

To be configured in {home}/appserver/conf/custom.properties

##### forcedSubscription.subscription.1.nodes

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

Nodes for the subscription

##### forcedSubscription.subscription.1.userGroups

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

The subscription will be added for users in this group

##### forcedSubscription.subscription.1.template=

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

Defines the used subscription template (this refers to a notification template you created through `forcedSubscription.template.x...`)

##### forcedSubscription.subscription.1.active=

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

Defines if the subscription is active

##### forcedSubscription.template.1.notificationTypes

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

Subscription notification types:

- immediate
- daily
- weekly
- monthly

##### forcedSubscription.template.1.notificationEvents

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

Subscription notification events to trigger on, currently:

- AssetAvailableUnavailable
- AssetNameChanged
- AssetAdded
- AssetRemoved
- NodeNameChanged
- NodeAdded
- NodeRemoved
- AssetTypeChanged
- AssetAvailabilityChanged
- AssetVersionActivated
- AssetVersionAdded
- AssetVersionDeleted
- NodeIconChanged
- NodeValidationLevelChanged
- AssetInformationFieldChanged
- NodeInformationFieldChanged

##### forcedSubscription.template.1.includingSubnodes

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

Included subnodes

##### forcedSubscription.template.1.rootNodeIncluded

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

Defines if root node is included

##### forcedSubscription.template.1.subNodesIncluded

> type: boolean, required: \*\*required: no, default: -

Defines if subnodes are included

##### forcedSubscription.template.1.recursiveSubNodes

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

Defines if subnodes are recursively included

## Compatibility Matrix

| forcedSubscription | CELUM (min. version) |
|---|---|
| 1.0 0 | 5.11.4 |
| 1.0.1 | 5.13.4 |

## Release Notes

#### 1.0

> Released 2017-10-04
> 
> - Initial Version

 [ ](https://docs.brix.ch/celum_extensions/message_editor) [](https://docs.brix.ch/celum_extensions/search_util)

---

## Navigation

- Parent: [CELUM Extensions](https://docs.brix.ch/celum_extensions.md)
- Previous: [Message Editor](https://docs.brix.ch/celum_extensions/message_editor.md)
- Next: [Search util](https://docs.brix.ch/celum_extensions/search_util.md)