ViacheslavKlimov
4 years ago
16 changed files with 192 additions and 62 deletions
@ -0,0 +1,56 @@ |
|||
/** |
|||
* Copyright © 2016-2023 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.common.data.util; |
|||
|
|||
import org.apache.commons.lang3.StringUtils; |
|||
|
|||
import java.util.Map; |
|||
import java.util.function.UnaryOperator; |
|||
import java.util.regex.Pattern; |
|||
|
|||
import static com.google.common.base.Strings.nullToEmpty; |
|||
import static org.apache.commons.lang3.StringUtils.removeStart; |
|||
|
|||
public class TemplateUtils { |
|||
|
|||
private static final Pattern TEMPLATE_PARAM_PATTERN = Pattern.compile("\\$\\{(.+?)(:[a-zA-Z]+)?}"); |
|||
|
|||
private static final Map<String, UnaryOperator<String>> FUNCTIONS = Map.of( |
|||
"upperCase", String::toUpperCase, |
|||
"lowerCase", String::toLowerCase, |
|||
"capitalize", StringUtils::capitalize |
|||
); |
|||
|
|||
private TemplateUtils() {} |
|||
|
|||
public static String processTemplate(String template, Map<String, String> context) { |
|||
return TEMPLATE_PARAM_PATTERN.matcher(template).replaceAll(matchResult -> { |
|||
String key = matchResult.group(1); |
|||
if (!context.containsKey(key)) { |
|||
return "\\" + matchResult.group(); |
|||
} |
|||
String value = nullToEmpty(context.get(key)); |
|||
String function = removeStart(matchResult.group(2), ":"); |
|||
if (function != null) { |
|||
if (FUNCTIONS.containsKey(function)) { |
|||
value = FUNCTIONS.get(function).apply(value); |
|||
} |
|||
} |
|||
return value; |
|||
}); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,54 @@ |
|||
#### Rule engine notification templatization |
|||
|
|||
<div class="divider"></div> |
|||
<br/> |
|||
|
|||
Notification subject and message fields support templatization. The list of available templatization parameters depends on the template type. |
|||
See the available types and parameters below: |
|||
|
|||
Available template parameters: |
|||
|
|||
* values from the incoming message metadata; |
|||
* values from the incoming message data; |
|||
* *originatorType* - type of the originator, e.g. 'Device'; |
|||
* *originatorId* - id of the originator |
|||
* *msgType* - type of the message |
|||
* *recipientEmail* - email of the recipient; |
|||
* *recipientFirstName* - first name of the recipient; |
|||
* *recipientLastName* - last name of the recipient; |
|||
|
|||
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. |
|||
You may also modify the value of the parameter with one of the suffixes: |
|||
|
|||
* `upperCase`, for example - `${recipientFirstName:upperCase}` |
|||
* `lowerCase`, for example - `${recipientFirstName:lowerCase}` |
|||
* `capitalize`, for example - `${recipientFirstName:capitalize}` |
|||
|
|||
<div class="divider"></div> |
|||
|
|||
##### Examples |
|||
|
|||
Let's assume the incoming message to Rule node has the following data: |
|||
```json |
|||
{ |
|||
"building_1": { |
|||
"temperature": 24 |
|||
} |
|||
} |
|||
``` |
|||
|
|||
The following template: |
|||
|
|||
```text |
|||
Building 1: temperature is ${building_1.temperature} |
|||
{:copy-code} |
|||
``` |
|||
|
|||
will be transformed to: |
|||
|
|||
```text |
|||
Building 1: temperature is 24 |
|||
``` |
|||
|
|||
<br> |
|||
<br> |
|||
Loading…
Reference in new issue