General guidelines for customizing alerts

This topic lists some of the general guidelines for customizing alerts.

• Sterling Store Engagement supports only order fulfillment alerts by default. Any custom alerts must be grouped under Order fulfillment menu only. Support for adding alerts to other menu options, including custom menus, will be added in subsequent releases.
• It is recommended NOT to override any of the out-of-the-box alert UI components, services, and mashup. Instead, you can define new custom alert components and services, and associate them with the out-of-the-box alertTypes.
• It is recommended to use the prefix Extn while defining custom components, services, providers, or classes that are newly created for customizations.
• Alert configuration is an instance level change. Any change that is made affects all the users.
• You cannot hide out-of-the-box alert types, YCD_HOT_PICK and YCD_NEAR_SLA.
• The value defined for exceptionType property in alertTypes object within extensionAlertConfig property in store-customization-impl.ts file must be a valid Exception_Type in the YFS_EXCEPTION_TYPE table. This value is passed as input to fetch open alerts count and alert details.
• When includeAlertsOwnedByUsersOrganization is enabled, Sterling Store Engagement fetches all the alerts for the user's organization, which are defined in the alertTypes object within extensionAlertConfig property in store-customization-impl.ts file. The alerts that are fetched are not limited to alerts that are assigned to the user or user-subscribed queues.