ProcessMaker API Documentation
Script Central

Get Notified of Save Search Result Changes

Receive notifications when a Saved Search's results change.

Overview

Receive a notification each time search results change based on your Saved Search parameters. For example, suppose that you have a Saved Search for all in-progress Requests for a particular Process, such as for a Purchase Request Process. Each time a Request starts for that Process, your Saved Search results change. If your Saved Search is configured to send notifications each time your Saved Search results change, you receive a notification.

Below are other examples to receive a notification when the Saved Search results change:

  • If your Saved Search parameters include when a new self-service Task is available, receive a notification.

  • If a record ID in a ProcessMaker Collection changes, receive a notification. Note that the ProcessMaker Collections package must be installed in your ProcessMaker instance to use ProcessMaker Collections.

Saved Search notifications can be enabled or disabled only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.

Enable Notification of Saved Search Result Changes

ProcessMaker Package Required

To enable notifications for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. The Saved Search package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Saved Search package can be installed in your ProcessMaker instance.

Saved Search notifications can be enabled only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.

Follow these steps to enable notifications when the results for your Saved Search changes:

  1. View the search results for a Saved Search in which to enable notifications for its changed results.

  2. Click the Enable Notifications buttonto enable notifications for this Saved Search.

Disable Notification of Saved Search Results

ProcessMaker Package Required

To disable notifications for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. The Saved Search package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Saved Search package can be installed in your ProcessMaker instance.

Saved Search notifications can be disabled only for your own Saved Searches.

Follow these steps to disable notifications when the results for your Saved Search changes:

  1. View the search results for a Saved Search in which to disable notifications for its changed results.

  2. Click the Disable Notifications buttonto disable notifications for this Saved Search.

Related Topics