Platform header with tenant identifier

Introduction

It is possible to enable a platform mechanism that will add a header with the tenant identifier (partnerId, the bank's settlement number) to all REST requests 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 deployment via env in 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 a script - on the application (request) where it will be invoked there must be a variable partnerId defined; its value is placed into the header,

• for a script task - the Tenant ID value for which the process instance is running is placed into the header.

Nothing additional needs to be done from within the script/handler itself.