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.
This section describes APIs, user exits, services, and other components.
- Enterprise: If the user has access to multiple enterprises, the
Enterprise list is displayed. The user can select an enterprise from
the list. The
getOrganizationListAPI retrieves the list of enterprises.
- Alert Type: The user can select the type of alert. The
getExceptionTypeListAPI retrieves the alert types.
- Assigned to User: The user can search another user and assign
the alerts. The
getUserListAPI 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
getQueueListAPI 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
getOrderListAPI 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
getCustomerListAPI 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,
getOrderListAPI is called to retrieve the list of return orders.
createExceptionAPI is called to save the changes.
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
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 (
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 (
- Create a bundle entry for the alert type in the
com.yantra.pca.ycd_bundle.propertiesbundle file present in the
- 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
- 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.
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.
By creating alerts, the user can follow up pending tasks that are associated with an order or a customer.