Message field codes
- Last UpdatedNov 29, 2024
- 2 minute read
Message field codes for customized messages
A modified user message for a Customer business rule can contain predefined field codes.
The field code will be replaced with an actual value when the message displays.
Guidelines
You can do the following with field codes:
-
Add new field codes to a modified message.
-
Remove field codes from a modified message.
-
Replace field codes in a modified message.
-
Place field codes anywhere in the modified message.
-
Use multiple field codes in a modified message.
Example 1—An example of an original and modified message text and result.
|
Message syntax |
Displayed message |
|
|
Original message |
Work permit "[entity_number]" is not active. |
Work permit "WP-345" is not active. |
|
Modified message |
This work permit is not active ([entity_number]). |
This work permit is not active (WP-345). |
Example 2—An example of an original and modified message text and result.
|
Message syntax |
Displayed message |
|
|
Original message |
Work permit "[entity_number]" is not active. |
Work permit "WP-34567" is not active. |
|
Modified message |
Permit [entity_number] on "[site_code]" is not active. |
Permit WP-34567 on "NZ12" is not active. |
Field codes
These are the field codes you can insert into customized messages.
|
Field code |
Description |
Example of result |
|---|---|---|
|
[entity_number] |
Number for entity. |
WP-012345 |
|
[entity_numberasset] |
Number and asset code for entity. |
WP-012345 (WFM1) |
|
[entity_info] |
Number, asset code and title for entity. |
WP-012345 (WFM1) / Change water pump |
|
[process_name] |
Name of process. |
Activate |
|
[process_username] |
Name of user that is performing process. |
Arne Beyer |
|
[process_usernamelogon] |
Name and logon for user that is performing process. |
Arne Beyer (AB) |
|
[site_code] |
Site code. |
WFM1 |
|
[statusfrom_info] |
Code and description for From status. |
200-For approval |
|
[statusto_info] |
Code and description for To status. |
300-Active |