Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idDONE

Product Version2021 Summer
Report Note
AssigneeAntje

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje07 MAY 20212021 SummerPage created and filled with content already reviewed by Marco.
Antje26 APR 20222022 Summeradd information on app-specific configuration possibility
Agnieszka29 APR 20222022 SummerrLANG



Excerpt

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

...

Parameter SectionParameterTypeDescription
amqpList 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>}.


bulkSizeintegerMaximum bulk size for a message.
enablebooleanSpecified Specifies whether this configuration is active/enabled (true) or inactive/disabled (false).
passwordstring

Password for the AMQP server.

predicatestringCondition that specifies when the AMQP hook is used.
supported scripting languages: SpEL (Spring Expression Language) and Javascript.
queuestring

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.

typestringDefines the processing step during which the AMQP hook will be trigger.
urlstringAMQP server endpoint, e.g. 127.0.0.1:5672
userstringUsername for the AMQP server.
webhooksList 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.


enablebooleanSpecifies whether this configuration is active/enabled (true) or inactive/disabled (false).
predicatestring

Condition that specifies when the webhook is used.
Supported scripting languages: SpEL (Spring Expression Language) and JavaScript.
All properties that are available in the corresponding webhook's JSON request body can be referenced. Especially, the options section including the property tenant is available at each webhook entry point.
>> Predicate Evaluation

typestringDefines the processing step during which the webhook will be trigger.
urlstringEndpoint to be called by the webhook if the predicate matches.

...

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

...