Implementing alerts

Alerts are displayed based on the currently logged-in user as well as the queues to which the user has subscribed. You can review the APIs, services, and other components that are used to implement alerts.

Note: If you do not want to view alerts, you an hide the Alert menu option in the navigation bar. For information about modifying the application-provided navigation bar, see how to map the application-provided navigation bar menu options with the custom component.

Solution

The alerts icon displays the count of open alerts assigned to the currently logged-in user or queue subscribed by the user. The getAlertStatisticsForUser API is called to retrieve the count. When the store associate clicks the alerts icon, a panel displays the open alerts. By default, the count includes only open order fulfillment alerts of type Nearing SLA and High priority.

The getExceptionList API is called with the ExceptionType as YCD_HOT_PICK or YCD_NEAR_SLA to display the alerts.

The store associate can take appropriate actions to resolve each open alert. For orders that are in the Ready for picking or Backroom pick in progress status, the store associate can click Pick order or Continue to open the Pick orders portlet and start or continue the backroom pick task. In case of alerts where the order is in a status that requires no further action, the store associate can click the delete icon to remove the alert from the alerts list.

When the store associate clicks Pick order or Continue, or deletes an alert, the resolveException API is called to resolve the alert and start the backroom pick process.

Implementation

The following section describes the configuration required for the feature.

Enable the following resource permissions to view, delete, and take appropriate actions on the open alerts:
- Order fulfillment alert
- Delete/Remove alerts
- Backroom pick BOPIS
- Backroom pick SHIP
For more information about administering user group permissions, see Administering user group permissions.
Configure the polling interval appropriately to fetch the open alerts for the currently logged-in user. User alert notifications can be configured only at the enterprise level. For more information about configuring the polling interval, see Configuring the polling interval.
Actions are displayed only for alerts that are issued for shipments that are in the Ready for backroom pick or Backroom pick in progress statuses. Pick order and Continue are the only actions that are available by default. You can add customizations to add any other actions as per your business requirements.
Alerts that are assigned to the current user's organization are not included in the open alerts count or displayed in the alerts list. You can customize your alerts configuration to include alerts that are assigned to the user's organization. For more information, see Extending alerts.
A user must be subscribed to a queue to be able to view the alerts assigned to that queue. For more information about subscribe the user to an alert queue or remove the user from an alert queue, see Creating a user.