Welcome to the Maintenance Page of RentalTide! This guide will help you navigate and utilize all the features available on the Maintenance Page, ensuring you effectively log, track, and manage maintenance schedules for your boat inventory.
Introduction
The Maintenance Page is your centralized hub for managing all maintenance-related activities for your boats. Whether you're logging routine maintenance, tracking upcoming schedules, or handling special maintenance tasks like dry docking, this page provides the tools you need to maintain a well-organized and efficient maintenance system.
Dashboard Overview
Upon accessing the Maintenance Page, you'll encounter the following key components:
Dashboard Header: Displays the page title and a brief description of its purpose.
Boat Selector: Allows you to select a specific boat to view and manage its maintenance records.
Action Buttons:
Add Maintenance Record: Opens a dialog to create a new maintenance record.
Refresh Records: Reloads the current maintenance records.
Maintenance Records Tables:
Upcoming Maintenance Table: Shows maintenance tasks that are approaching or scheduled soon.
Maintenance Records Table: Displays a paginated list of all maintenance records for the selected boat.
Modals and Dialogs:
Maintenance Dialog: Facilitates adding or editing maintenance records.
Delete Confirmation Dialog: Confirms deletion of maintenance records.
Dry Dock Confirmation Dialog: Handles scheduling and confirming dry dock periods.
Loading Indicators: Visual cues to inform you when data is being fetched or actions are in progress.
Error Messages: Notifications to alert you of any issues during data retrieval or processing.
Managing Maintenance Records
Efficiently manage your boat maintenance records with the intuitive features available on the Maintenance Page. This section covers viewing existing records, adding new records, editing existing ones, and deleting records when necessary.
Viewing Maintenance Records
The Maintenance Records Table displays all maintenance activities associated with the selected boat, allowing you to monitor and review maintenance history comprehensively.
Features:
Paginated List: Navigate through multiple pages of maintenance records.
Record Details: Each record includes information such as maintenance type, description, date, performed by, and more.
Action Buttons: Quick access to edit or delete maintenance records directly from the table.
Usage Tips:
Filter by Boat: Use the Boat Selector to view maintenance records specific to a particular boat.
Pagination: Adjust the number of records displayed per page using the pagination controls for easier navigation.
Adding a New Maintenance Record
Adding a new maintenance record ensures that all maintenance activities are logged and tracked effectively.
How to Add a New Maintenance Record:
Select a Boat:
Use the Boat Selector dropdown to choose the boat you wish to add a maintenance record for.
Open the Add Maintenance Dialog:
Click on the "Add Maintenance Record" button (represented by the AddCircle icon) to open the Maintenance Dialog.
Fill in Maintenance Details:
Maintenance Type: Select the type of maintenance from predefined options (e.g., Engine Oil Change, Filter Replacement).
Description: Provide a detailed description of the maintenance performed.
Performed By: Enter the name of the technician or person who performed the maintenance.
Maintenance Date: Select the date when the maintenance was performed.
Next Scheduled: Optionally, set the next scheduled maintenance date.
Hours: Enter the number of hours spent on the maintenance task.
Cost Details:
Labor Cost: Specify the cost associated with labor.
Parts Used: List any parts used during maintenance.
Total Cost: Enter the total cost incurred.
Tax: Specify any applicable taxes.
Tax Percentage: Define the tax rate applied.
Upload Maintenance Images (Optional):
Use the "Upload ID Image" button to upload images related to the maintenance task. Files are securely uploaded to Amazon S3.
Save the Record:
After filling in all required fields, click the "Save" button to create the maintenance record.
A confirmation message will appear, indicating the successful addition of the new record.
Usage Tips:
Mandatory Fields: Ensure all required fields are completed to prevent submission errors.
Accurate Information: Double-check maintenance details for accuracy before saving.
Image Uploads: Attach relevant images to provide visual documentation of maintenance tasks.
Editing a Maintenance Record
Updating existing maintenance records allows you to keep your records accurate and up-to-date.
How to Edit a Maintenance Record:
Locate the Record:
In the Maintenance Records Table, find the maintenance record you wish to edit.
Open the Edit Dialog:
Click on the "Edit" icon (usually represented by a pencil) associated with the maintenance record to open the Maintenance Dialog with pre-filled details.
Modify Maintenance Details:
Update any of the maintenance details as needed, such as changing the maintenance type, description, dates, or cost details.
Save Changes:
After making the desired changes, click the "Save" button to apply the updates.
A confirmation message will notify you of the successful update.
Usage Tips:
Selective Editing: Only modify fields that require changes to maintain data integrity.
Review Changes: Ensure that all updates accurately reflect the maintenance activity performed.
Deleting a Maintenance Record
Removing a maintenance record is necessary when a record is entered in error or is no longer relevant.
How to Delete a Maintenance Record:
Locate the Record:
In the Maintenance Records Table, find the maintenance record you wish to delete.
Initiate Deletion:
Click on the "Delete" icon (usually represented by a trash bin) associated with the maintenance record to open the Delete Confirmation Dialog.
Confirm Deletion:
In the Delete Confirmation Dialog, confirm that you want to delete the maintenance record by clicking the "Delete" button.
Click "Cancel" to abort the deletion process.
Post-Deletion:
Upon successful deletion, the maintenance record will be removed from the table, and a success message will be displayed.
Usage Tips:
Data Backup: Ensure that any important data related to the maintenance record is backed up or exported before deletion.
Impact Assessment: Understand the implications of deleting a record, such as its effect on maintenance history and reporting.
Handling Dry Dock Periods
Scheduling maintenance periods like dry docking ensures that boats remain in optimal condition and minimizes operational disruptions.
How to Schedule a Dry Dock Period:
Locate the Boat:
Use the Boat Selector to choose the boat you wish to schedule for dry docking.
Open the Dry Dock Dialog:
Click on the "Dry Dock" icon on the boat card to open the DryDockConfirmationDialog.
Set Dry Dock Dates:
In the Dry Dock Confirmation Dialog, select the Start Date and End Date for the dry dock period.
Confirm Scheduling:
Click the "Confirm" button to schedule the dry dock period.
A confirmation message will appear, indicating the successful scheduling of maintenance.
Post-Scheduling Actions:
The system will automatically email customers with bookings during the dry dock period, cancel their reservations, and issue refunds if applicable.
Usage Tips:
Advance Planning: Schedule dry dock periods well in advance to minimize booking conflicts.
Customer Communication: Ensure that automated emails effectively communicate the changes to affected customers.
Uploading Maintenance Images
Documenting maintenance activities with images provides visual proof of work done and helps in maintaining accurate records.
How to Upload Maintenance Images:
Open the Maintenance Dialog:
While adding or editing a maintenance record, locate the "Upload ID Image" button within the Maintenance Dialog.
Select Images:
Click on the "Upload ID Image" button to open the file selection dialog.
Choose the image files you wish to upload from your device.
Upload to Amazon S3:
Selected images are securely uploaded to your Amazon S3 bucket, ensuring safe and reliable storage.
The system generates a public URL for each uploaded image, which is associated with the maintenance record.
View Uploaded Images:
After successful upload, uploaded images will be displayed within the maintenance record for easy reference.
Usage Tips:
Supported Formats: Ensure that images are in supported formats (e.g., JPEG, PNG) for successful uploads.
File Size: Be mindful of file sizes to prevent upload issues; compress images if necessary.
Security: Only upload relevant and necessary images to maintain privacy and data security.
Searching and Pagination
Efficiently navigate through your maintenance records using the search and pagination features.
Searching Boats
The Boat Selector allows you to quickly find and select boats by name, enhancing navigation and management efficiency.
How to Use the Boat Selector:
Locate the Boat Selector:
Found at the top of the Maintenance Page, the Boat Selector dropdown lists all available boats.
Select a Boat:
Click on the dropdown to view the list of boats.
Type the boat's name to filter the list dynamically.
Click on the desired boat to select it.
View Maintenance Records:
Once a boat is selected, the Maintenance Records Tables will update to display records specific to that boat.
Usage Tips:
Quick Search: Use partial names to quickly locate boats without typing the full name.
Default Selection: If "All Locations" is selected, ensure that the Boat Selector is set to the desired location to view relevant boats.
Pagination Controls
Manage large inventories with ease using the pagination controls to navigate through multiple pages of maintenance records.
How to Use Pagination Controls:
Locate Pagination Controls:
Positioned below the Maintenance Records Table, the pagination component allows you to navigate between pages.
Navigate Between Pages:
Click on the page numbers or use the "Next" and "Previous" buttons to move between pages.
Adjust Records Per Page:
Use the "Records per page" dropdown to select the number of records displayed on each page (e.g., 10).
View Current Page Information:
The pagination component displays the range of records being viewed and the total number of records.
Usage Tips:
Optimal Viewing: Choose a records-per-page setting that best fits your screen size and personal preference.
Quick Navigation: Use the page numbers for direct access to specific pages without excessive clicking.
Permissions and Access Control
The Maintenance Page utilizes a robust permissions system to ensure that only authorized users can perform certain actions.
Key Permissions:
maintenance_access: Grants access to the Maintenance Page.
maintenance_add_record: Allows adding new maintenance records.
maintenance_delete_record: Permits deleting existing maintenance records.
Managing Permissions:
Role-Based Access: Permissions are typically assigned based on user roles (e.g., Admin, Manager).
Verification: The page verifies user permissions before rendering action buttons or modals to prevent unauthorized access.
Usage Tips:
Check Permissions: Ensure that your account has the necessary permissions to perform desired actions. Contact your system administrator if you require additional access.
Audit Trails: Maintain logs of actions performed, especially for critical operations like deleting records or scheduling dry docks.
Frequently Asked Questions (FAQs)
1. How do I add a new maintenance record?
Answer: Select the desired boat using the Boat Selector, then click on the "Add Maintenance Record" button (AddCircle icon). Fill in the required maintenance details in the dialog that appears and click "Save" to add the record.
2. Why can't I see the "Add Maintenance Record" button?
Answer: The availability of the "Add Maintenance Record" button depends on your user permissions. Ensure that your account has the maintenance_add_record permission. If you believe you should have access, contact your system administrator or support team.
3. How can I mark a maintenance record as completed?
Answer: In the Maintenance Records Table, locate the maintenance record you wish to mark as completed and click on the "Complete" button. This action will update the record's status to completed and remove it from the upcoming maintenance list.
4. Why am I seeing an error message when fetching maintenance records?
Answer: The error message indicates an issue with fetching maintenance data. This could be due to server issues, incorrect boat selection, or network problems. Try refreshing the page, selecting a different boat, or checking your internet connection. If the issue persists, contact support for assistance.
5. How do I delete a maintenance record?
Answer: In the Maintenance Records Table, locate the maintenance record you wish to delete and click on the "Delete" icon (trash bin). Confirm the deletion in the Delete Confirmation Dialog that appears.
6. Can I upload images related to maintenance tasks?
Answer: Yes, when adding or editing a maintenance record, you can upload relevant images by clicking on the "Upload ID Image" button within the Maintenance Dialog. Uploaded images are securely stored in Amazon S3.
7. How do I schedule a dry dock period for a boat?
Answer: Select the desired boat using the Boat Selector, then click on the "Dry Dock" icon on the boat card. In the Dry Dock Confirmation Dialog, set the start and end dates for the dry dock period and confirm the scheduling.
Troubleshooting
Issue 1: "Add Maintenance Record" Button Is Missing
Possible Cause: Lack of necessary permissions.
Solution:
Verify that your user account has the maintenance_add_record permission.
If you believe you should have access, contact your system administrator or support team to adjust your permissions.
Issue 2: Error Occurs When Fetching Maintenance Records
Possible Cause: Server-side issues, incorrect boat selection, or network problems.
Solution:
Refresh the Page: Click the refresh button in your browser to reload the Maintenance Page.
Select a Different Boat: Use the Boat Selector to choose another boat and see if the issue persists.
Check Internet Connection: Ensure that your device is connected to the internet.
Contact Support: If the error continues, reach out to the support team with specific error details.
Issue 3: Cannot Mark Maintenance as Completed
Possible Cause: Missing permissions or backend processing errors.
Solution:
Verify Permissions: Ensure that your account has the maintenance_edit_record permission.
Retry the Action: Refresh the page and attempt to mark the maintenance as completed again.
Check Record Status: Ensure that the maintenance record is eligible to be marked as completed.
Contact Support: If the problem persists, report the issue to support with relevant details.
Issue 4: Maintenance Images Are Not Uploading
Possible Cause: File format or size issues, or S3 configuration errors.
Solution:
Check File Format: Ensure that images are in supported formats (e.g., JPEG, PNG).
Verify File Size: Ensure that the image files are within the allowed size limits.
Retry Upload: Attempt to upload the images again after verifying the above.
Contact Support: If the issue remains, contact support to check S3 configurations and permissions.
Issue 5: Dry Dock Scheduling Not Working Properly
Possible Cause: Incorrect date selections or backend processing errors.
Solution:
Verify Dates: Ensure that the start date is before the end date.
Check Boat Availability: Ensure that there are no conflicting bookings during the dry dock period.
Retry Scheduling: Attempt to schedule the dry dock period again after correcting any issues.
Contact Support: If scheduling still fails, report the issue to support for further assistance.
Issue 6: Delete Confirmation Dialog Not Appearing
Possible Cause: JavaScript errors or UI rendering issues.
Solution:
Refresh the Page: Reload the Maintenance Page to reset UI components.
Clear Browser Cache: Sometimes, cached data can cause UI issues. Clear your browser's cache and try again.
Try a Different Browser: Access the Maintenance Page using an alternative browser to check for browser-specific issues.
Report the Issue: If the dialog still doesn't appear, contact support with specific details.
Issue 7: Pagination Controls Are Not Responsive
Possible Cause: UI rendering issues or JavaScript errors.
Solution:
Refresh the Page: Reload the Maintenance Page to reset UI components.
Clear Browser Cache: Clear your browser's cache and try accessing the page again.
Use a Different Browser: Test the page in another browser to determine if the issue is browser-specific.
Contact Support: If pagination remains unresponsive, report the issue to support with relevant information.