NotifyWidget Action

The NotifyWidget action is a System Action that sends a notification to a Web Block widget. This action uses Ajax to send a custom notification to the Web Block widget itself.

The notification is effectively sent only when screen action flow ends.

Use this mechanism to implement distinct business logics depending on where the Web Block widget is being used, i.e., the Web Block widget instance. In the screen where the Web Block widget instance is, create a screen action, implement the local business logic for the notification, and map the screen action to the On Notify Ajax capability of the Web Block widget instance.

Only when the web block has at least a screen action flow using the NotifyWidget System action, the On Notify Ajax capability is available in the Properties pane of the web block widget instance.

You may send customized information along with the notification in the Message argument. The screen action that handles the notification obtains this customized information using the NotifyWidgetGetMessage built-in function.

Input parameters

Message: the custom information to be sent to the notified widget.

Text Type. Optional.

Executing NotifyWidget in JavaScript (for advanced users)

You may execute the NotifyWidget in your JavaScript code which enables you to send notifications to any Web Block widget instance in your web screen. For that, use the OsNotifyWidget function with the following parameters:

Input parameters

RunTimeId: Identifies the web block within the screen where it is running.

Text type. Mandatory.

Message: the custom information to be sent to the notified widget.

Text Type. Optional.

To have the On Notify Ajax capability available in the Properties Pane for you to handle the JavaScript execution of the NotifyWidget, go to the web block and create a dummy screen action that solely uses the NotifyWidget System action with no Message.