Issue
Customers may require dynamic logging of alarm events, including specific values or metadata at the time of the event. Substitution codes provide a flexible way to embed such data directly into the file output.
Product Line
EcoStruxure Building Operation
Environment
EcoStructure Building Operation
Cause
When using write to file notification objects it may be desirable to have dynamic text containing actual values etc.
Resolution
Write-to-file notification objects in EcoStruxure Building Operation can be configured to include dynamic content using substitution codes. These codes allow insertion of real-time alarm properties into the message body written to the file, enabling more informative and context-aware logging.
Summary
-
Substitution codes are supported only in the message body, not in the file name.
-
The syntax for substitution codes is:
@([property])where
[property]corresponds to a valid alarm attribute. -
If an invalid or unsupported property is used, the system will replace the substitution code with an empty string.
Example:
Alarm triggered at @([TimeStamp]) with value @([Value]) from source @([Source]).
Important Notes
- Ensure that the substitution code used is applicable to the specific alarm event type.
- For email-based alarm notifications, refer to: Displaying different properties of an alarm in an email notification.
