...
Parameter | Description |
---|---|
| The workflow alarm value name, as defined in the Alarm Detection Editor |
| Any value to be associated with the name |
Returns | Nothing |
Info | ||
---|---|---|
Example - Using dispatchAlarmValue The following code example displays a situation and syntax useful for the
|
...
Parameter | Description |
---|---|
| A main message appearing in the log |
| Name of an optional parameter. If declared, |
| Value of an optional parameter. If declared, |
Returns | Nothing |
Info | ||
---|---|---|
Example - Using logWarning The following code example logs a warning message, which when displayed in the System Log will look like the following figure:
|
...
These functions invokes logging with log4j. For information about how to configure the logging, see Customizing APL Logging for ECDs (4.23).
Code Block |
---|
void log.fatal (any message, any tag ) //optional void log.error (any message, any tag ) //optional void log.warn (any message, any tag ) //optional void log.info (any message, any tag ) //optional void log.debug (any message, any tag ) //optional void log.trace (any message, any tag ) //optional |
Parameter | Description |
---|---|
| A value that will be appear in the |
tag | Objects(s) that will appear in the |
Returns | Nothing |
Info | ||
---|---|---|
Example - Using log.debug
|
...
Sends an email to a configured recipient. In order to operate, the system must have an email remitter and an SMTP mail server defined.
Warning |
---|
Warning! If used within the |
...
Parameter | Description | ||
---|---|---|---|
| Email address to the recipient on the form: "user@xxx.com" | ||
| Text ending up as the email subject | ||
| Message string ending up as the body of the email Note | Note! This field will be sent as plain text. For sending in HTML format, refer to the mailNotifyHtml function. | |
| Name or address of the sender of the email
| ||
attachment | A list that will contain one or many attachments to be sent with the email. Each list entry will be the full directory path of the attachment.
| ||
Returns | Nothing |
...
Sends an email in HTML format to a configured recipient. In order to operate, the system must have an email remitter and an SMTP mail server defined.
Warning |
---|
Warning! If used within the |
...
Parameter | Description | ||
---|---|---|---|
| Email address to the recipient on the form: "user@xxx.com" | ||
| Text ending up as the email subject | ||
| Message string ending up as the body of the email infoNote! Supports standard HTML content. | ||
| Name or address of the sender of the email
| ||
attachment | A list that will contain one or many attachments to be sent with the email. Each list entry will be the full directory path of the attachment.
| ||
Returns | Nothing |
...