Skip to content
English
More support Ticket overview
  • There are no suggestions because the search field is empty.

Understanding and configuring the notification system

Overview

The Shoreline Execution Platform includes a comprehensive notification system that keeps users informed about important updates, changes, and events across planning and execution workflows. Notifications are delivered both in-app and optionally via email to ensure users never miss critical information.

How Notifications Work

Real-Time In-App Notifications

The notification system uses Socket.io technology to deliver updates instantly to your browser without requiring a page refresh. When important events occur in the system, notifications are:

  1. Created by the backend when specific events trigger

  2. Delivered in real time via WebSocket connections

  3. Displayed in the notification bell icon in the top navigation bar

  4. Stored for later review in the Notification Center

Email Notifications

When enabled, notifications are also sent to your registered email address, ensuring you stay informed even when away from the platform. Email notifications include:

  • The notification title

  • Full notification content

  • A prompt to log in to Shoreline for additional details

Accessing Notifications

Notification Bell Icon

Located in the top navigation bar of the planning interface:

  • Bell Icon: Click to open the Notification Center

  • Badge Counter: Shows the number of unread notifications

  • Real-time Updates: New notifications appear immediately

Notification Center Modal

The Notification Center provides:

  • Paginated list of all your notifications

  • Read/Unread status for each notification

  • Quick actions to open related items (work orders, assets, reports, etc.)

  • Dismiss options to remove notifications you’ve addressed

  • Mark all as read functionality

  • Access to Reminders: toggle between notifications and reminders

Notification Center Actions

From the Notification Center footer, you can:

  • Manage Reminders: Switch to view and manage your reminders

  • Notification Settings: Open your user settings to configure preferences

Complete List of Notification Types

1. Status Change Notifications

Receive alerts when assets, components, or subassemblies change status (e.g., operational, maintenance, decommissioned).

Available Options:

  • Assets Status Changes: Notifications for asset status updates

  • Components Status Changes: Notifications for component status updates

  • Subassemblies Status Changes: Notifications for subassembly status updates

Typical Use Cases:

  • Asset moved to maintenance

  • Component marked as defective

  • Subassembly status updated to operational

2. Reporting Notifications

Stay informed about report submissions, approvals, and rejections.

Notification Triggers:

  • Report submitted for approval

  • Report approved

  • Report rejected (includes rejection reason)

  • Report requires your review

Example Scenarios:

  • Field personnel submits a progress report for manager approval

  • Manager approves or rejects submitted reports

  • Reports awaiting your action

3. Work Order Notifications

Critical updates about work order lifecycle and execution.

Available Options:

Work Order Completion

  • Notifies when work orders are marked as complete

  • Useful for managers tracking project progress

Work Order Approval Flow (requires permission)

  • Alerts when work orders require approval

  • Notifications for work order approval or rejection

Work Order Advance Notification

  • Proactive reminder before work orders are scheduled to start

  • Configurable timing: Set how many weeks in advance you want to be notified (default: 3 weeks)

  • Helps with planning and resource preparation

4. Timesheet Notifications

Track timesheet submissions and approvals.

Available Options:

Timesheet Approval Pending

  • Notifies managers when timesheets are submitted for approval

  • Ensures timely timesheet review

Timesheet Rejected or Approved

  • Alerts personnel when their timesheets are approved or rejected

  • Includes feedback for rejected timesheets

5. Permit to Work Notifications (feature-flag enabled)

For organizations using the Permit to Work module.

Available Options:

Permit to Work Approval Pending

  • Notifies approvers when permits require review

  • Critical for safety compliance workflows

Permit to Work Rejected or Approved

  • Alerts requesters about permit approval status

  • Includes reasons for rejection if applicable

6. Site Overview Notifications (Marine Coordination feature)

For marine coordination and site monitoring (feature-flag enabled).

Available Options:

Area Entry/Exit Alerts

  • Notifications when vessels or personnel enter or exit designated areas

  • Real-time situational awareness

Speed Limit Alerts in Area

  • Alerts when speed limits are exceeded within monitored areas

  • Safety and compliance monitoring

7. System Notifications

Automatically generated by the platform for various events:

  • Export Generated: Your requested data export is ready for download

  • Optimization Schedule Errors: Issues encountered during schedule optimization

  • Optimization Schedule Warnings: Warnings from the scheduling engine

  • Resource Requests: Updates on resource request status

Configuring Your Notification Preferences

Accessing Notification Settings

  1. Click your user profile icon in the top-right navigation bar

  2. Select User Settings from the dropdown

  3. Navigate to the Settings tab

  4. Scroll to the Notifications section

Configuring Notification Types

Notification settings are organized by category with toggle switches and checkboxes.

Category Toggles (Master Switches)
Each category has a master switch that enables/disables all notifications in that category:

  • Status Changes: Toggle all asset, component, and subassembly notifications

  • Work Orders: Toggle all work order-related notifications

  • Timesheet Complete: Toggle all timesheet notifications

  • Permits: Toggle all permit to work notifications (if enabled)

  • Site Overview: Toggle all marine coordination notifications (if enabled)

Individual Notification Checkboxes
When a category is enabled, you can fine-tune which specific notification types you want to receive by checking or unchecking individual options.

Work Order Advance Notification Timing
For the “Work Order Advance Notification” option:

  1. Check the box to enable advance notifications

  2. Enter the number of weeks before the work order start date

  3. Default is 3 weeks; adjust based on your planning needs

Enabling Email Notifications

How to Enable Email Notifications

Email notifications are disabled by default and must be explicitly enabled by each user.

Step-by-Step Instructions:

  1. Click your user profile icon in the top-right corner

  2. Select User Settings

  3. In the General tab, locate the checkbox:

    • Allow email notifications

  4. Check the box to enable email notifications

  5. Click Save to apply changes

Important Notes:

  • Feature Flag Required: Email notifications must be enabled for your organization (feature flag: EMAIL_NOTIFICATIONS)

  • Email Address: Notifications are sent to your registered user email address

  • Email Format:

    • Subject: Notification title

    • Body: Notification content plus link to log in for full details

    • Plain text format for compatibility

What Gets Emailed:
When email notifications are enabled, you’ll receive emails for:

  • All notification types you’ve configured in your notification settings

  • Only notifications you haven’t dismissed

  • Real-time delivery as events occur

Notification Settings Best Practices

For Planners and Managers

Recommended Settings:

  • Enable Work Order Completion to track project progress

  • Enable Work Order Approval Flow to stay on top of approval requests

  • Enable Timesheet Approval Pending to ensure timely timesheet reviews

  • Enable Report submissions to review field reports promptly

  • Configure Work Order Advance Notification to 2–4 weeks for planning buffer

  • Consider enabling email notifications for high-priority events when away from desk

For Field Personnel

Recommended Settings:

  • Enable Work Order Completion for confirmation of submitted work

  • Enable Timesheet Rejected or Approved to know timesheet status

  • Enable Work Order Advance Notification to 1–2 weeks for upcoming assignments

  • Consider keeping email notifications disabled if you’re constantly in the platform

For Safety Officers (Permit to Work)

Recommended Settings:

  • Enable Permit to Work Approval Pending for immediate awareness of pending permits

  • Enable Permit to Work Rejected or Approved to track permit lifecycle

  • Enable email notifications for critical safety compliance even after hours

For Marine Coordinators

Recommended Settings:

  • Enable Area Entry/Exit Alerts to monitor vessel movements

  • Enable Speed Limit Alerts for safety compliance monitoring

  • Enable email notifications to stay informed during extended monitoring periods

Managing Notifications

Reading Notifications

  • Click on any notification in the Notification Center to mark it as read

  • Read notifications remain visible but are styled differently

  • Use Mark all as read to clear all unread notifications at once

Dismissing Notifications

  • Click the dismiss icon on individual notifications to remove them from your list

  • Use Dismiss all to clear all notifications

  • Dismissed notifications cannot be recovered

Notification Persistence

  • Notifications are stored in the database

  • Accessible from any device where you’re logged in

  • Paginated view (20 notifications per page) for easy browsing

Reminders vs. Notifications

The system includes both Notifications and Reminders.

Notifications:

  • Triggered by system events

  • Generated automatically

  • Cannot be created manually by users

Reminders:

  • Can be created by users

  • Personal task management

  • Toggle between notifications and reminders in the Notification Center

Troubleshooting

Not Receiving In-App Notifications?

  1. Check notification settings: Ensure the specific notification type is enabled

  2. Verify internet connection: Real-time notifications require an active connection

  3. Check permissions: Some notifications require specific user permissions (e.g., Manage Work Orders)

  4. Browser issues: Try clearing cache or using a different browser

  5. Contact support: If issues persist, provide your user ID and example missing notifications

Not Receiving Email Notifications?

  1. Verify email toggle: Confirm “Allow email notifications” is checked in User Settings

  2. Check feature flag: Ensure your organization has email notifications enabled

  3. Verify email address: Confirm your user profile has the correct email

  4. Check spam folder: Email notifications may be filtered as spam

  5. SMTP configuration: Contact your system administrator to verify email server settings

Too Many Notifications?

  1. Disable categories: Turn off entire categories you don’t need using master toggles

  2. Fine-tune settings: Uncheck specific notification types while keeping categories enabled

  3. Adjust advance notification timing: Reduce the weeks for work order advance notifications

  4. Disable email notifications: Keep in-app only if you check the platform regularly

Notification Bell Not Updating?

  1. Refresh the page: Force a page reload

  2. Check WebSocket connection: Ensure Socket.io connection is active (check browser console)

  3. Clear browser cache: Old cached data may cause display issues

  4. Logout/Login: Re-authenticate to establish fresh connections

Notification Permissions Required

Certain notification types require specific user permissions:

  • Status Changes (Assets): readAssets

  • Status Changes (Components): readComponent

  • Status Changes (Subassemblies): readSubAssembly

  • Reporting: readReporting

  • Work Orders: readWorkorders

  • Work Order Approval Flow: manageWorkorder + feature access

  • Permit to Work: managePermitToWork

  • Timesheets: registerTimeForOthers (for managers)

If you don’t see certain notification options, contact your administrator to verify you have the required permissions.

Need Help?

If you have questions about notifications or need assistance configuring your preferences:

  1. Knowledge Base: Visit our support portal for additional articles

  2. Email Support: Contact your Shoreline support representative

  3. System Administrator: Reach out to your organization’s Shoreline administrator for company-specific configuration