Tracking Notification Setup
Overview
Tracking Notification Setup refers to the configuration process of automated alerts that are sent to customers, staff, or third parties based on specific tracking events (e.g., pickup, in transit, delivered) to keep them informed about the status of a consignment or delivery.
To see the Tracking Notification Setup page, navigate to Setup > Rules and Automation > Tracking Notification Setup, the Tracking Notification Setup will display as shown below.
Setup a Rule
1. To setup a rule for tracking notification, on tracking notification section, click on the New Rule button, a New Rule pop-up will appear as shown below.
2. Manually enter the Rule Name, select the Export Framework from the drop-down menu, and click the Create button. The rule will be added to the Notification Rules list, and its details will appear on the right side of the screen, as shown below.
Once you create a rule, it will be disabled by default.
2. Once the rule is created, several tabs will appear i.e., Details, Export Framework, Data Filter, and History. Each tab contains specific configuration options to help define how the rule behaves. Now, proceed to set up the rule by following the steps described below.
Add/Edit Rule Details
1. On rule detail section you can update/add the following details:
a. Rule Name: Update the name for the export rule, if necessary.
b. Enable: Click toggle to Yes to activate the rule.
c. Memo: Add notes or internal comments for reference.
d. Email Errors: Enter the email address where notifications should be sent if any issues occur while sending an email. These issues may include invalid email addresses or email server problems (e.g., SMTP configuration errors).
e. Rule ID: Rule ID is an identification number which is automatically assigned to each rule created in the system. It helps in tracking, referencing, and managing specific rules within the application.
2. Once you have updated the rule details, click on the Update button to save the changes, the final screen will appear as shown below.
3. As shown in the above screenshot, the Rule status is set to Enabled.
Export Framework
Export Framework defines the method used to export information from Transvirtual. In this example, we are selecting Email as the export method.
On Export details page, fill the details as described below.
1. Export Framework: Defines the method (e.g., Email, Message) used to export data from Transvirtual. Use the drop-down button to select the applicable export framework.
You can select either Email or Message.
2. Email Account (Optional): Specifies the email account used to send notifications, if different from the default.
3. Send to Consignment Sender Email: Sends the notification to the sender's email address listed on the consignment.
4. Send to Consignment Receiver Email: Sends the notification to the receiver's email address listed on the consignment.
5. Send to Consignment Creator Email: Sends the notification to the email address of the user who created the consignment.
6. Email To: Field used to enter the recipient's email address for sending notifications or messages.
7. Email Subject: Manually enter the title or subject line of the email, which appears at the top of the message.
Email Body
Email body is the main content area of the email where you write the message or information you want the recipient to read. To do this, click on Email Body tab, the Email Body screen will display as shown below.
- Email Message: Manually enter the main content of the email in this section. This is where you provide all relevant details, explanations, or instructions that you want the recipient to read.
- There are some pre-defined fields in the email message. To view these fields right-click within the email body. A contextual menu will appear, here select the desired field by clicking on it, as shown below.
4. To know more about how to use these tag(s), click here.
To know how to use these pre-defined fields, click on the Help button. A help pop-up will display as shown below.
4. Once you update/add the Email Subject and Message, click on the Validate button to see the mail preview.
5. Once you have added/updated the details, click on the Update button to save the changes.
Email Body (HTML)
The email body HTML is the same as the text-based email body as described above. To see the Email Body (HTML) page, click on Email Body (HTML) tab the Email Body (HTML) page will be displayed as shown below.
1. The "Email Body (HTML)" tab allows you to add/edit the HTML code of the email body. This lets you create nicer email format with images and custom layouts. This is more advanced setup and is not covered in this example.
Data Filter
Data filters are the key factor in determining when the system will and won't apply the rule.
1. To see the data filter section, click on Data Filter tab, the data filter will display as shown below.
2. In the Data Filter section, first choose the appropriate option for ‘Select Field’, then 'Select Type’, and finally enter the ‘Value’. Once all details are entered, click on the ‘Update’ button to save the rule, as shown below.
In this example, we used Additional Service in Select Field, Equal in Select Type and Dangerous Goods in Value field.3. The above data filter applies only when "Dangerous Goods" is selected under Additional Services. If needed, you can add multiple filters in a similar way by clicking on the Plus icon and follow the step 2.
4. If you want to delete the filter, click on delete icon, a confirmation pop-up will appear, here click on Yes, the rule will be deleted from the database.
History
This section shows the record of past actions, changes, or events related to a rule. To see the history page, click on History tab, the history page will display as shown below.
1. On History tab you can see the following details:
a. Date: The date on which the change was made.
b. Field: The specific field where the change(s) occurred.
c. Old Value: The data (such as a field description/field name etc.) before the change.
d. New Value: The data (such as a field description/field name etc.) after the change.
b. Field: The specific field where the change(s) occurred.
c. Old Value: The data (such as a field description/field name etc.) before the change.
d. New Value: The data (such as a field description/field name etc.) after the change.
e. User: The Username of the person who updated the rule.
Delete a Rule
1. If you wish to delete the rule, click on Delete icon, a confirmation pop-up to delete a rule will display as shown below:
2. Click on Yes, the rule will be deleted from the database.