Browse Source

Help page for new platform version notification template

pull/8334/head
ViacheslavKlimov 4 years ago
parent
commit
c5ebedecd8
  1. 46
      ui-ngx/src/assets/help/en_US/notification/new_platform_version.md

46
ui-ngx/src/assets/help/en_US/notification/new_platform_version.md

@ -0,0 +1,46 @@
#### New platform version 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:
* *recipientEmail* - email of the recipient;
* *recipientFirstName* - first name of the recipient;
* *recipientLastName* - last name of the recipient;
* *latestVersion* - the latest platform version available;
* *latestVersionReleaseNotesUrl* - release notes link for latest version;
* *upgradeInstructionsUrl* - upgrade instructions link for latest version;
* *currentVersion* - the current platform version
* *currentVersionReleaseNotesUrl* - release notes link for current version;
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 that new 3.5.0 version is released but currently deployed version is 3.4.4. The following template:
```text
New version ${latestVersion} is available. Current version is ${currentVersion}
{:copy-code}
```
will be transformed to:
```text
New version 3.5.0 is available. Current version is 3.4.4
{:copy-code}
```
<br>
<br>
Loading…
Cancel
Save