Manage notes

A user must be able to save important information as notes for an order, customer, return order, alert, and others.

Solution

The following section describes APIs, user exits, services, and other components.

Adding notes: A user can view and add notes in the context of orders, customers, alerts, return orders, and others. The user can add notes during order creation and modification from the Notes tab or by using the "View/Add Notes" button. When the View/Add Order Notes window loads, the following fields are displayed:

Note Type: The getCommonCodeList API is called with the CodeType as NOTES_REASON.
Contact Type: The getCommonCodeList API is called with the CodeType as CONTACT_TYPE.
Customer Satisfaction Indicator: The customer satisfaction indicators cannot be configured through the user interface. Therefore, you must pass the CodeType as SAA_CUST_SAT and the appropriate values for the CodeValue attribute in the manageCommonCode API to create the customer satisfaction indicators. For more information, see Javadoc.
Note: A mandatory field.
Contact Details: Based on the contact type that is selected, the user can enter the appropriate details.
The user can select appropriate options to classify the note as internal, high priority, or both.

When the user adds a note to an order or an order line, the changeOrder API is called to save the note to the order.
When the user adds a note to a customer record, the manageCustomer API is called to save the note to the customer.
When the user adds a note to an alert, the changeException API is called to save the note to the alert. If the alert is associated with an order, the changeOrder API is called to save the note to the associated order. Similarly, if an alert is associated with the customer, the manageCustomer API is called to save the note to the associated customer.

Viewing and filtering notes: After notes are added, the user can also view and filter notes. The getNoteList or getParticipantNoteList API is called to retrieve the existing notes. The API also retrieves details such as the user who added or modified the note along with the corresponding date and time. Users can also retrieve the required notes by using the filter options that include Note Type, Contact Type, and others.

Editing and deleting notes: The user can edit or delete the existing notes. When the user chooses to edit an existing note, the fields are pre-populated with the details of the note. The logic that is used to add notes is applicable even when the user modifies a note. When the user deletes a note, the getNoteList or getParticipantNoteList API is called to update the list of notes.

Implementation

The following section describes the rules that you must configure.

You must configure notes reasons to allow the user to select a note type. For more information, see the Sterling Business Center System Configuration.

To populate the contact types required to add notes, you must configure customer contact types. For more information, see the Sterling Business Center System Configuration.

End-user impact

The user can record and track critical information that is associated with orders, customers, return order, alerts, and others. Notes are also helpful when multiple users work on same orders or work with same customers.