Overview
The Notification Setup service helps the user to get an alert generated by an application when the application is not open, notifying the user of a new message or an update related to the cargo.
User Access
User | Internal / External | Description |
MS Admin | Internal | To configure/manage notification management for all users |
Terminal Admin | Internal | To configure/manage notification management for all terminal sub users |
Prerequisites
The user must be registered with the Cargoes Community.
Only MS Admin has access to Event Configuration UI.
Only MS Admin can Search for an event.
Only MS Admin can Create an event.
Only MS Admin can link/unlink an event.
Steps
Login to your CCS account, and click Sign In.
Go to Configure > SETTINGS > Event Configuration.
To create notification, click on the Create icon.
The user is navigated to the Create Event page, specify the following details and click Apply.
Field Name | Action |
|---|---|
Add Event Code | Enter the code of the event. |
Event Name | Specify the event name. |
Event Description | Specify the description of the event. |
Select Service | Specify the service selected for the event. |
All the above fields are mandatory to create an event notification.
In the Channel and Template Section, the user can select any of the available channels by select the checkbox next to channel as depicted in the image below.
To upload the document, click Upload Template.
User has the option to download a sample template by clicking on the Download Template and hyperlink.
To add a file, the user can either:
a. Click on the BROWSE FILE button (or)
b. Drag and drop the file to be uploaded to the area marked by dotted lines.
The system performs the below validations on the uploaded file:
Size of the uploaded file must be less than the max allowed size for the selected Document Type.
Type of uploaded file must match the allowed type of the selected Document Type.
If any of the above validations fail user must remove the uploaded file and re-upload the correct file.
Users can download the uploaded document (if required by clicking on the name of the document).
Users can remove the uploaded document by clicking on the delete icon.
If the above validations are passed, the SUBMIT button is enabled. Click on the SUBMIT button to proceed.
Click the SUBMIT button.
User is navigated to the Search page. A success message appears on the screen.
The details of the new Notification Configuration are displayed as depicted in the image below.
Search
This section enables the user to search for the notifications created.
Prerequisites
There must be notification configuration already created.
Steps
Go to Configure > SETTINGS > Event Configuration.
In the SEARCH section, specify the following details.
Field Name | Action |
|---|---|
Event Name / Code | Enter and select the name or the code of the event. |
Service | Enter and select the service. |
Site | Click the drop-down icon and select the site. |
Role | Click the drop-down icon and select the role. |
Channel | Click the drop-down icon and select the channel. |
Click Search.
The event appears in the SEARCH RESULT section.
To view the details, click on the result.
The system navigates the user to the View Event page, and the Event Details of the notification configuration are displayed on the screen.
To modify or edit the details click Edit.
Click SAVE.
To confirm the request, click CONFIRM.
A success message appears on the screen.
