Create alerts

Edit online

Typically, alerts are generated by the system. However, a user can also create alerts manually. A manager can assign a special task to a user; a user notices a problem that is not identified by the system or a customer wants the user to take specific actions on an order. In such scenarios, users must be allowed to create alerts.

Solution

This section describes APIs, user exits, services, and other components.

The user can create an alert by using the Create Alert related task on the home page. The APIs called to retrieve the relevant information are described in the following list:
  • Enterprise: If the user has access to multiple enterprises, the Enterprise list is displayed. The user can select an enterprise from the list. The getOrganizationList API retrieves the list of enterprises.
  • Alert Type: The user can select the type of alert. The getExceptionTypeList API retrieves the alert types.
  • Assigned to User: The user can search another user and assign the alerts. The getUserList API is called to retrieve the list of users.
  • Assigned to Queue: The user can select a queue to which the alert must be assigned. The getQueueList API retrieves the list of queues.
  • Association: The user can associate an alert with an order, return order, customer, or choose not to have any association. When the user creates an alert in the context of an order, the alert is associated with the order by default.
    • No Association: The user can select this option if it is not required to associate an alert with the entity.
    • Order: The users must select this option to associate the alert with an order. When the user does a search for the order, the getOrderList API is called to retrieve the list of orders.
    • Customer: Users must select this option to associate the alert with a customer. When the user does a search for the customer, the getCustomerList API is called to retrieve the list of customers.
    • Return: Users must select this option to associate the alert with a return order. When the user does a search for the return order, the getOrderList API is called to retrieve the list of return orders.
When the user saves the changes to the alert, The createException API is called to save the changes.

The YCPBeforeCreateExceptionUE user exit is called by the createException API before running any application logic. If you are extending the application, you can use this user exit to provide a standard XML input as required by the createException API.

You can define alert types as needed. When configuring an alert type, in the alert type configuration, you can specify a java class that is an instance of the SWT composite class (org.eclipse.swt.widgets.Composite) as the resolution form. You must create this composite and include components that helps the users to resolve alerts for that specific alert type. You can call APIs within the composite if you require additional information in that panel. If you do not want to design a new composite for any of the custom alert types, you can leave the Resolution Form field blank in the alert type configuration. If you do not enter any information in this field, the default resolution panel are used. The default resolution panel displays the data from the Alert Details column of the alert table (YFS_INBOX).

For every alert type, it is possible to default the alert description whenever an alert of that type is raised. Do the following steps to implement a default description for an alert type:
  1. Create a bundle entry for the alert type in the com.yantra.pca.ycd_bundle.properties bundle file present in the <INSTALL_DIR> folder.
  2. The key of the bundle entry must be of the format, <Alert Type>_DEFAULT_DESC. For example, if the alert type is YCD_VERIFY_ADDRESS, the bundle key must be named as YCD_VERIFY_ADDRESS_DEFAULT_DESC.
  3. Enter a value for the bundle key. The value is the description that must be displayed when the alert type is selected. However, if you do not enter a value for the bundle key, the description is empty.

Implementation

The following section describes the rules that you must configure.

This task is permission-controlled. You can assign permissions to the user groups in the Applications Manager. For more information about administering user group permissions, refer to the Administering user group permissions.

End-user impact

By creating alerts, the user can follow up pending tasks that are associated with an order or a customer.