Configuration of system hooks, split in AMQP hooks and webhooks.

Characteristics

Profile Name	`systemHookConfiguration.json`
Referenced by Services	`authentication,api,commander`
Storage Location	Git system directory

Parameters

Parameter Section	Parameter	Type	Description
`amqp`		List of mappings in JSON format.	List of single AMQP Hook configurations each of them defined via following parameters. Read by API gateway and COMMANDER service. As of version 2021 Summer, placeholders can be used as provided by spring. They can reference values in the system environment including configuration files and command line arguments. The placeholders will be replaced by the referenced values of the environment variable during the starting process of the corresponding service. The syntax follows the spring placeholders: `${<reference>}`.
	`bulkSize`	`integer`	Maximum bulk size for a message.
	`enable`	`boolean`	Specified whether this configuration is active/enabled (`true`) or inactive/disabled (`false`).
	`password`	`string`	Password for the AMQP server.
	`predicate`	`string`	Condition that specifies when the AMQP hook is used. supported scripting languages: SpEL (Spring Expression Language) and Javascript.
	`queue`	`string`	Name of the queue to which the messages are written. Only one messaging queue can be used. The messaging queue specified for the first defined AMQP hook will apply to all following AMQP hook definitions as well. The messaging system needs to support AMQP 1.0.
	`type`	`string`	Defines the processing step during which the AMQP hook will be trigger.
	`url`	`string`	AMQP server endpoint, e.g. `127.0.0.1:5672`
	`user`	`string`	Username for the AMQP server.
`webhooks`		List of mappings in JSON format.	List of single Webhook configurations each of them defined via following parameters. Read by AUTHENTICATION service and API gateway. If multiple Webhooks are registered for the same Webhook type, the predicate is applied to the original predicate target for each of them and in the order of definition.
	`enable`	`boolean`	Specified whether this configuration is active/enabled (`true`) or inactive/disabled (`false`).
	`predicate`	`string`	Condition that specifies when the webhook is used. supported scripting languages: SpEL (Spring Expression Language) and Javascript.
	`type`	`string`	Defines the processing step during which the webhook will be trigger.
	`url`	`string`	Endpoint to be called by the webhook if the `predicate` matches.

Example

The following example configures both an AMQP hook and a webhook.

The AMQP hook applies to object imports and checks the contentStreams for the presence of a range attribute. If the range attribute is detected, the AMQP hook recognizes the imported content to be a compound document and initiates asynchronous text extraction of all parts of the content.
This concrete example webhook triggers at every login and retrieves the roles of the user trying to authenticate.

To activate this configuration, both the API-gateway and the Authentication service need to be restarted.

Example System Hook Configuration

{
    "systemhooks": {
        "amqp": [
            {
                "bulkSize": 10,
                "enable": true,
                "password": "secret",
                "predicate": "spel:(contentStreams != null && contentStreams.size() > 0 && contentStreams[0]['range'] != null && contentStreams[0]['range'].length() > 0) ? true : false",
                "queue": "lc.textextraction",
                "type": "object.insert.document",
                "url": "10.10.6.242:5672",
                "user": "clouduser"
            }
        ],
        "webhooks": [
            {
                "enable": true,
                "predicate": "spel:true",
                "type": "user.info",
                "url": "http://organization/api/userinfo/${tenant}/${userId}"
            }
        ]
    }
}

systemHookConfiguration.json

Characteristics

Parameters

Example