Errors and Notification

log “message”

Outputs a message to the system log. This message is not presented to the user but is intended to convey diagnostic information for the developer or administrator.

error “message”

Raises an error, displaying the specified message. Execution of the script aborts.

message “title”, “message”

Sets the message that will be displayed to the user when the operation completes.

Note: The message is only displayed if the script is running synchronously from an event or action. Messages won't be displayed from scheduled jobs, asynchronous actions or events or throttled events. Instead, 'log' should be used to place the message in the system log.

notify of [node] notification-name “message” at &path

Sends a configured notification (added through the Notifications drilldown from a field definition). The specified node, in square-brackets, is included in the email. Optionally a message can be specified, in parentheses after the notification name. The notification is sent via an email to all users who subscribe to that notification.

warning “message”

Stops execution and displays a warning message to the user. The user then has the option of accepting the warning and retrying the operation. If the warning was accepted by the user, the statement has no effect and execution continues.

Note : Warning messages have no effect if the warning is raised in an event that is executed asynchronously. However, warnings raised in synchronous events will be displayed to the user and will have to be accepted for the operation to execute.

Also : Warnings should be provided if it relates to a threat to something affecting the user of the system. If the warning relates to an action that might affects something more important, you should consider configuring conditional approval workflow instead. See Approval Workflow Rather than asking the user, this would ask a supervisor for authorization first.

ignore warning "warning text"

Ignores the warning with the text "warning text" if it is raised by any operations in that transaction.

on error prefix "text"

For any errors that occur after this statement, prefix the error message with "text". This is often used to add more contextual information to an error.

on error suppress description

Tells the system to not display the description of any errors that occur. The error description is still logged to the systemlog, but is not displayed to the user.

on error revert

Reverts the error handling back to the default behavior.

on error suppress line numbers

When an error occurs after this statement, the line number in the script will not be conveyed to the user.

[suppress errors]

This statement, in square brackets, can be put before any statement to stop errors from being shown to the user and stopping execution. Instead the execution continues even if an error is raised, but the error is put into #error.

Errors and Notification - WorkflowFirst Customer Support Server, Version 1.0.846 (beta)
[ Client.Wiki, Professional ]
Up Since 6/8/2019 12:09:47 PM