Message provider config
20.1.5. Message provider configuration

Message formats

The message provider creates the transaction approval message from a message template, values from the transaction approval parameter step and the context data of the user. 

The following picture shows where the message template comes from. For each message provider a message translation key can be configured. The key can contain variables (of the form ${...}) that are replaced by values from the transaction approval parameter step or the user's context data. In the example below the variable is ${type} and is replaced by the value "payment" from the parameter step. Therefore the message template is taken from the string resource file under the key "mtan.payment.message". Default transaction string resources can be overwritten in the instance (specific or common), directory "transaction-approval-texts".

Airlock2FAMessageProvider

Message template example:

Approve payment:
${amount} ${currency} to account number ${accountNumber,mid,3,2}.

The ${..} specify the name of the variables and (optionally) how the variables can be shorted if the message exceeds its maximally allowed length.

This can be specified in the following way:

Syntax
Meaning
Example
${X}
The variable needs to be displayed in full and can not be abbreviated.
Input: ${X} with X="1234567890"
Result: 1234567890
${X,left,minSize}
Always displays at least minSize letters but may abbreviate the string on the RIGHT side if not enough space is available.
Input: ${X,left,3} with X="1234567890"
Result: 123..
${X,right,minSize}
Always displays at least minSize letters but may abbreviate the string on the LEFT side if not enough space is available.
Input: ${X,right,3} with X="1234567890"
Result: ..890
${X,mid,minSizeLeft,minSizeRight}
Always displays at least minSizeLeft and minSizeRight letters from the left and right side of the text but may abbreviate the string in the MIDDLE if not enough space is available.
Input: ${X,mid,3,2} with X="1234567890"
Result: 123..90

Message provider plugins may support specific additional variables. The ${TOKEN}, for example, is used in the mTAN message provider to display the involved OTP code.

If the overall message size still exceeds the configured maximally allowed length after shortening the variables, the transaction approval parameters REST call will fail and no message is sent.