Platform header with tenant identifier

Introduction

It is possible to enable a platform mechanism that will add a header with the tenant identifier (partnerId, bank settlement number) to all REST requests made from scripts and script tasks.

Configuration

The following properties are used to enable the mechanism, to be set in webforms applications (for scripts, depending on the deployment, in env to application.yml or in webforms.xml) and process-handler-executor-camunda (for script tasks):

Property	Description	Default value
script-service.tenant.interceptor.enabled	A boolean value indicating whether the header-adding mechanism should be enabled.	false
script-service.tenant.interceptor.header-name	A string specifying what the header name should be.	x-tenant-id

For the mechanism to work correctly:

• for the script - on the request on which it will be called, a partnerId variable must be defined; its value is placed in the header,
• for the script task - the Tenant ID value for which the process instance is running is placed in the header.

No additional action is needed from the script/handler itself.