diff --git a/docs/admin.md b/docs/admin.md index 4d597746..a342e17f 100644 --- a/docs/admin.md +++ b/docs/admin.md @@ -33,15 +33,24 @@ requires administrator permissions. - [**Data Lists**](./adminDataLists.md)
Manage customizable dropdown lists used throughout the application. +- [**Assigned To Management**](./adminAssignedTo.md)
+ Maintain standardized assignee names for work orders and records. + - [**Employee Management**](./adminEmployees.md)
Maintain a list of employees for work orders, shifts, and timesheets. +- [**Employee List Management**](./adminEmployeeLists.md)
+ Create predefined employee groups for quick selection. + - [**Equipment Management**](./adminEquipment.md)
Manage vehicles, tools, and other equipment. - [**Location Management**](./adminLocations.md)
Maintain predefined locations for quick selection. +- [**Notification Configuration**](./adminNotificationConfigurations.md)
+ Configure automated notifications for events in ShiftLog. + --- ## Best Practices diff --git a/docs/adminApiAuditLogs.md b/docs/adminApiAuditLogs.md index 7e8e8861..310e179a 100644 --- a/docs/adminApiAuditLogs.md +++ b/docs/adminApiAuditLogs.md @@ -142,6 +142,17 @@ All API endpoints are automatically logged, including: ## Related Documentation -- [API Documentation](https://cityssm.github.io/shiftlog/docs/api.md) (if available) -- [User Management](./adminUsers.md) - Managing user API keys -- [Application Settings](./adminSettings.md) - Configuring API features +- [Administrator Tools](./admin.md) - Main admin documentation +- [API Audit Logs](./adminApiAuditLogs.md) +- [Application Settings](./adminSettings.md) +- [Assigned To Management](./adminAssignedTo.md) +- [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) +- [Employee Management](./adminEmployees.md) +- [Equipment Management](./adminEquipment.md) +- [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminAssignedTo.md b/docs/adminAssignedTo.md new file mode 100644 index 00000000..f456e703 --- /dev/null +++ b/docs/adminAssignedTo.md @@ -0,0 +1,83 @@ +[Home](https://cityssm.github.io/shiftlog/) +• +[Help](https://cityssm.github.io/shiftlog/docs/) +• +[Administrator Tools](https://cityssm.github.io/shiftlog/docs/admin.html) + +# Assigned To Management + +The Assigned To Management section maintains a list of assignees that can be +associated with work orders and other records. This feature helps standardize +who work is assigned to, making it easier to track assignments and filter +records by assignee. + +![Assigned To Management](./images/adminAssignedTo.png) + +## Adding an Assigned To Item + +1. Navigate to **Administrator Tools** > **Assigned To**. +2. Click the **Add Assigned To Item** button. +3. Enter the assignee name (e.g., person name, department, team, or role). +4. Optionally, select a **User Group** to restrict visibility to specific users. +5. Click **Add** to create the item. + +## Editing an Assigned To Item + +1. Navigate to **Administrator Tools** > **Assigned To**. +2. Find the item you want to edit. +3. Click the **Edit** button. +4. Update the assignee name or user group restriction as needed. +5. Click **Update** to apply changes. + +## Reordering Assigned To Items + +The order of assigned to items determines how they appear in dropdown lists +throughout the application. + +1. Navigate to **Administrator Tools** > **Assigned To**. +2. Use the drag-and-drop handle (grip icon) to reorder items. +3. Changes are saved automatically. + +## Deleting an Assigned To Item + +1. Navigate to **Administrator Tools** > **Assigned To**. +2. Find the item you want to delete. +3. Click the **Delete** button. +4. Confirm the deletion. + +⚠️ **Note**: Deleting an assigned to item will not remove it from existing +records. It will only make it unavailable for future assignments. + +## User Group Restrictions + +You can restrict the visibility of assigned to items to specific user groups. +When a user group is assigned to an item: + +- Only users in that group will see the item in their dropdown lists +- All administrators can see all items regardless of user group +- Existing records with that assignment remain visible to all users + +This feature is useful for: + +- Departmental or team-specific assignees +- Role-based assignment options +- Limiting options to relevant choices for different user groups + +--- + +## Related Links + +- [Administrator Tools](./admin.md) - Main admin documentation +- [API Audit Logs](./adminApiAuditLogs.md) +- [Application Settings](./adminSettings.md) +- [Assigned To Management](./adminAssignedTo.md) +- [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) +- [Employee Management](./adminEmployees.md) +- [Equipment Management](./adminEquipment.md) +- [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminDataLists.md b/docs/adminDataLists.md index 31610b90..2a9f15ad 100644 --- a/docs/adminDataLists.md +++ b/docs/adminDataLists.md @@ -43,12 +43,16 @@ to maintain consistency in data entry. ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminEmployeeLists.md b/docs/adminEmployeeLists.md new file mode 100644 index 00000000..149d2069 --- /dev/null +++ b/docs/adminEmployeeLists.md @@ -0,0 +1,109 @@ +[Home](https://cityssm.github.io/shiftlog/) +• +[Help](https://cityssm.github.io/shiftlog/docs/) +• +[Administrator Tools](https://cityssm.github.io/shiftlog/docs/admin.html) + +# Employee List Management + +The Employee List Management section allows administrators to create and +maintain predefined lists of employees. These lists can be quickly selected +when recording shift activities or timesheets, making data entry faster and +more consistent. + +![Employee List Management](./images/adminEmployeeLists.png) + +## Overview + +Employee lists are useful for: + +- **Recurring shifts** - Save frequently-used employee groups +- **Department teams** - Maintain lists for each department +- **Rotation schedules** - Manage different shift rotations +- **Project teams** - Track employees working on specific projects + +## Adding an Employee List + +1. Navigate to **Administrator Tools** > **Employee Lists**. +2. Click the **Add Employee List** button. +3. Enter a descriptive name for the list (e.g., "Night Shift Crew", "Roads Department", "Weekend Team"). +4. Select employees to include in the list. +5. Optionally, select a **User Group** to restrict visibility to specific users. +6. Click **Save** to create the list. + +## Editing an Employee List + +1. Navigate to **Administrator Tools** > **Employee Lists**. +2. Find the list you want to edit. +3. Click the **Edit** button. +4. Update the list name, employees, or user group restriction as needed. +5. Click **Save** to apply changes. + +## Managing Employees in a List + +### Adding Employees + +1. Open the employee list for editing. +2. Select additional employees from the available employees list. +3. Use the drag-and-drop interface to reorder employees if needed. +4. Click **Save** to apply changes. + +### Removing Employees + +1. Open the employee list for editing. +2. Click the **Remove** button next to the employee you want to remove. +3. Click **Save** to apply changes. + +### Reordering Employees + +The order of employees in a list can be customized: + +1. Open the employee list for editing. +2. Use the drag-and-drop handle (grip icon) to reorder employees. +3. Click **Save** to apply the new order. + +## Deleting an Employee List + +1. Navigate to **Administrator Tools** > **Employee Lists**. +2. Find the list you want to delete. +3. Click the **Delete** button. +4. Confirm the deletion. + +⚠️ **Note**: Deleting an employee list will not affect existing shift or +timesheet records. It only removes the list template for future use. + +## User Group Restrictions + +You can restrict the visibility of employee lists to specific user groups. +When a user group is assigned to a list: + +- Only users in that group will see the list when recording shifts or timesheets +- All administrators can see all lists regardless of user group +- This helps keep lists organized and relevant to each user's role + +## Using Employee Lists + +Once created, employee lists appear: + +- In the shift recording interface as quick-select options +- In the timesheet entry interface for batch entry +- As shortcuts for adding multiple employees at once + +--- + +## Related Links + +- [Administrator Tools](./admin.md) - Main admin documentation +- [API Audit Logs](./adminApiAuditLogs.md) +- [Application Settings](./adminSettings.md) +- [Assigned To Management](./adminAssignedTo.md) +- [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) +- [Employee Management](./adminEmployees.md) +- [Equipment Management](./adminEquipment.md) +- [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminEmployees.md b/docs/adminEmployees.md index 527ec82b..21e8c5f9 100644 --- a/docs/adminEmployees.md +++ b/docs/adminEmployees.md @@ -44,11 +44,16 @@ It will only make them unavailable for future records. ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) +- [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminEquipment.md b/docs/adminEquipment.md index 7b2a2624..c397be30 100644 --- a/docs/adminEquipment.md +++ b/docs/adminEquipment.md @@ -42,11 +42,16 @@ The Equipment Management section maintains a list of equipment ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) +- [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminLocations.md b/docs/adminLocations.md index 4caa8f04..6902c920 100644 --- a/docs/adminLocations.md +++ b/docs/adminLocations.md @@ -40,11 +40,16 @@ quickly selected when creating work orders. ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) +- [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminNotificationConfigurations.md b/docs/adminNotificationConfigurations.md new file mode 100644 index 00000000..3a9fe7ac --- /dev/null +++ b/docs/adminNotificationConfigurations.md @@ -0,0 +1,140 @@ +[Home](https://cityssm.github.io/shiftlog/) +• +[Help](https://cityssm.github.io/shiftlog/docs/) +• +[Administrator Tools](https://cityssm.github.io/shiftlog/docs/admin.html) + +# Notification Configuration + +The Notification Configuration section allows administrators to set up +automated notifications for various events in ShiftLog. This feature ensures +that the right people are notified about important activities, assignments, +and updates in real-time. + +![Notification Configuration](./images/adminNotificationConfigurations.png) + +## Overview + +Notification configurations determine: + +- **What** triggers a notification (notification queue type) +- **How** the notification is sent (notification type/protocol) +- **Who** receives the notification (assigned to item) +- **When** notifications are active (active/inactive status) + +## Notification Queue Types + +Different events in ShiftLog can trigger notifications: + +- **Work Order Created** - When a new work order is created +- **Work Order Update** - When a work order is changed + +## Notification Types (Protocols) + +ShiftLog supports multiple notification delivery methods: + +- **Email** - Send notifications via email. +- **Ntfy** - Send phone and browser notifications through the ntfy notification service. +- **MS Teams** - POST notification data to a webhook URL. + +⚠️ **Note**: Notification protocols must be configured in the application +settings before they can be used in notification configurations. + +## Adding a Notification Configuration + +1. Navigate to **Administrator Tools** > **Notification Configuration**. +2. Click the **Add Notification Configuration** button. +3. Select a **Notification Queue** (the event that triggers the notification). +4. Select a **Notification Type** (how the notification will be sent). +5. Select an **Assigned To** item (who should receive the notification). +6. Set the **Active** status (whether the notification is enabled). +7. Click **Add** to create the configuration. + +## Editing a Notification Configuration + +1. Navigate to **Administrator Tools** > **Notification Configuration**. +2. Find the configuration you want to edit. +3. Click the **Edit** button. +4. Update the notification settings as needed. +5. Click **Save** to apply changes. + +## Activating/Deactivating Notifications + +Notification configurations can be temporarily disabled without deleting them: + +1. Navigate to **Administrator Tools** > **Notification Configuration**. +2. Find the configuration you want to enable or disable. +3. Toggle the **Active** checkbox. +4. Click **Save** to apply the change. + +**Active configurations** will send notifications when triggered. +**Inactive configurations** will not send notifications, but remain in the system. + +## Deleting a Notification Configuration + +1. Navigate to **Administrator Tools** > **Notification Configuration**. +2. Find the configuration you want to delete. +3. Click the **Delete** button. +4. Confirm the deletion. + +## Understanding Assigned To Items + +The **Assigned To** field determines who receives the notification: + +- Must match an item from the **Assigned To Management** section +- Can represent individuals, departments, teams, or roles +- The actual delivery addresses (email, phone) are configured separately + in the notification protocol settings + +## Testing Notifications + +To verify that notifications are working correctly: + +1. Create a test notification configuration +2. Trigger the event (e.g., create a test work order) +3. Verify that the notification is received +4. Review logs if notifications are not being delivered + +## Troubleshooting + +### Notifications Not Sending + +1. **Check configuration is active** - Ensure the Active checkbox is checked +2. **Verify protocol setup** - Confirm notification protocols are configured in settings +3. **Check assigned to mapping** - Verify the assigned to item has delivery addresses +4. **Review system logs** - Check application logs for error messages + +### Duplicate Notifications + +- Multiple configurations for the same queue type will send multiple notifications +- Review and consolidate configurations if receiving duplicates + +--- + +## Best Practices + +1. **Start with test configurations** - Test notifications before deploying widely +2. **Use descriptive names** - Choose clear assigned to names for easy identification +3. **Limit notifications** - Only notify for critical events to avoid alert fatigue +4. **Monitor delivery** - Regularly check that notifications are being delivered +5. **Document recipients** - Keep records of who receives what notifications +6. **Review periodically** - Audit notification configurations regularly + +--- + +## Related Links + +- [Administrator Tools](./admin.md) - Main admin documentation +- [API Audit Logs](./adminApiAuditLogs.md) +- [Application Settings](./adminSettings.md) +- [Assigned To Management](./adminAssignedTo.md) +- [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) +- [Employee Management](./adminEmployees.md) +- [Equipment Management](./adminEquipment.md) +- [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminSettings.md b/docs/adminSettings.md index c75433bd..d6df70f6 100644 --- a/docs/adminSettings.md +++ b/docs/adminSettings.md @@ -23,11 +23,16 @@ system-wide options. ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [API Audit Logs](./adminApiAuditLogs.md) +- [Application Settings](./adminSettings.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminTags.md b/docs/adminTags.md index 8a2f890e..64ca6376 100644 --- a/docs/adminTags.md +++ b/docs/adminTags.md @@ -110,12 +110,16 @@ Tags created in the Tag Management interface can be applied to work orders: ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [Work Orders](./workOrders.md) - Work order documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminUserGroups.md b/docs/adminUserGroups.md index bfeed818..6b2edb8c 100644 --- a/docs/adminUserGroups.md +++ b/docs/adminUserGroups.md @@ -39,11 +39,16 @@ For example: ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminUsers.md b/docs/adminUsers.md index 39415d5d..5bce5178 100644 --- a/docs/adminUsers.md +++ b/docs/adminUsers.md @@ -51,11 +51,16 @@ Users can have different levels of access for each section: ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Work Order Types](./adminWorkOrderTypes.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/adminWorkOrderTypes.md b/docs/adminWorkOrderTypes.md index dce4dadf..a0faf1b4 100644 --- a/docs/adminWorkOrderTypes.md +++ b/docs/adminWorkOrderTypes.md @@ -48,11 +48,16 @@ It will only prevent future use of the type. ## Related Links - [Administrator Tools](./admin.md) - Main admin documentation -- [User Management](./adminUsers.md) -- [User Group Management](./adminUserGroups.md) +- [API Audit Logs](./adminApiAuditLogs.md) - [Application Settings](./adminSettings.md) -- [Tag Management](./adminTags.md) +- [Assigned To Management](./adminAssignedTo.md) - [Data Lists](./adminDataLists.md) +- [Employee List Management](./adminEmployeeLists.md) - [Employee Management](./adminEmployees.md) - [Equipment Management](./adminEquipment.md) - [Location Management](./adminLocations.md) +- [Notification Configuration](./adminNotificationConfigurations.md) +- [Tag Management](./adminTags.md) +- [User Group Management](./adminUserGroups.md) +- [User Management](./adminUsers.md) +- [Work Order Types](./adminWorkOrderTypes.md) diff --git a/docs/images/adminAssignedTo.png b/docs/images/adminAssignedTo.png new file mode 100644 index 00000000..35a51c34 Binary files /dev/null and b/docs/images/adminAssignedTo.png differ diff --git a/docs/images/adminEmployeeLists.png b/docs/images/adminEmployeeLists.png new file mode 100644 index 00000000..7de9b5d4 Binary files /dev/null and b/docs/images/adminEmployeeLists.png differ diff --git a/docs/images/adminNotificationConfigurations.png b/docs/images/adminNotificationConfigurations.png new file mode 100644 index 00000000..c0c2cff5 Binary files /dev/null and b/docs/images/adminNotificationConfigurations.png differ diff --git a/views/admin/apiAuditLogs.ejs b/views/admin/apiAuditLogs.ejs index a9280409..5fd43c8a 100644 --- a/views/admin/apiAuditLogs.ejs +++ b/views/admin/apiAuditLogs.ejs @@ -24,6 +24,19 @@ +
+ + + + + Help + +
@@ -44,6 +57,13 @@
+
+
+ Track and monitor all API endpoint access for security auditing and troubleshooting. + Review API requests and identify unauthorized access attempts. +
+
+
diff --git a/views/admin/assignedTo.ejs b/views/admin/assignedTo.ejs index 14f474de..38be55bc 100644 --- a/views/admin/assignedTo.ejs +++ b/views/admin/assignedTo.ejs @@ -55,6 +55,13 @@
+
+
+ Maintain standardized assignee names for <%= configFunctions.getConfigProperty('workOrders.sectionName').toLowerCase() %> and records. + Create assignees for individuals, departments, teams, or roles to streamline assignment tracking. +
+
+ diff --git a/views/admin/dataLists.ejs b/views/admin/dataLists.ejs index 9717a725..736a9d13 100644 --- a/views/admin/dataLists.ejs +++ b/views/admin/dataLists.ejs @@ -47,6 +47,12 @@ +
+
+ Manage customizable dropdown lists used throughout the application to ensure consistency in data entry. Add, edit, reorder, and organize items for each data list. +
+
+ <% for (const dataList of dataLists) { %>
diff --git a/views/admin/employeeLists.ejs b/views/admin/employeeLists.ejs index 2bc93d02..710ffb31 100644 --- a/views/admin/employeeLists.ejs +++ b/views/admin/employeeLists.ejs @@ -55,6 +55,13 @@ +
+
+ Create predefined employee groups for quick selection. + Organize lists by department, shift rotation, crews, or seniority for faster data entry. +
+
+ <% if (employees.length === 0) { %>
diff --git a/views/admin/employees.ejs b/views/admin/employees.ejs index bb4e8247..fd466363 100644 --- a/views/admin/employees.ejs +++ b/views/admin/employees.ejs @@ -71,6 +71,13 @@
+
+
+ Maintain a comprehensive list of employees that can be associated with records. + Add employees manually or synchronize from external systems. +
+
+
diff --git a/views/admin/equipment.ejs b/views/admin/equipment.ejs index 78159a3a..8537dc2d 100644 --- a/views/admin/equipment.ejs +++ b/views/admin/equipment.ejs @@ -71,6 +71,12 @@ +
+
+ Manage equipment records including vehicles, tools, and machinery that can be associated with work. Track equipment names, serial numbers, and other identifying details. +
+
+
diff --git a/views/admin/locations.ejs b/views/admin/locations.ejs index 6c48131c..dd9c9611 100644 --- a/views/admin/locations.ejs +++ b/views/admin/locations.ejs @@ -71,6 +71,13 @@ +
+
+ Maintain predefined locations with addresses and coordinates for quick selection when creating <%= configFunctions.getConfigProperty('workOrders.sectionName').toLowerCase() %>. + Standardize location data across the application. +
+
+
diff --git a/views/admin/notificationConfigurations.ejs b/views/admin/notificationConfigurations.ejs index 4152f698..c7c935b0 100644 --- a/views/admin/notificationConfigurations.ejs +++ b/views/admin/notificationConfigurations.ejs @@ -24,6 +24,19 @@ +
@@ -42,6 +55,12 @@
+
+
+ Configure automated notifications for important events. Set up who receives notifications, when they're sent, and how they're delivered. +
+
+
diff --git a/views/admin/settings.ejs b/views/admin/settings.ejs index 5d314844..63969261 100644 --- a/views/admin/settings.ejs +++ b/views/admin/settings.ejs @@ -64,6 +64,12 @@ +
+
+ Configure application-wide settings. Changes take effect immediately after saving. +
+
+
diff --git a/views/admin/tags.ejs b/views/admin/tags.ejs index ee0e8bef..7a53acb9 100644 --- a/views/admin/tags.ejs +++ b/views/admin/tags.ejs @@ -24,6 +24,19 @@ +
+ + + + + Help + +
@@ -89,6 +102,13 @@
+
+
+ Create and manage color-coded tags for categorizing and organizing <%= configFunctions.getConfigProperty('workOrders.sectionName').toLowerCase() %>. + Configure custom colors for visual identification and promote ad-hoc tags to system tags. +
+
+
diff --git a/views/admin/userGroups.ejs b/views/admin/userGroups.ejs index cbbcb912..48d6455c 100644 --- a/views/admin/userGroups.ejs +++ b/views/admin/userGroups.ejs @@ -57,6 +57,12 @@ +
+
+ Organize users into groups for permission management and content filtering. User groups can be assigned to data lists, employees, and other resources to control visibility and access. +
+
+
diff --git a/views/admin/users.ejs b/views/admin/users.ejs index 1dcd5f57..99cd2add 100644 --- a/views/admin/users.ejs +++ b/views/admin/users.ejs @@ -53,6 +53,13 @@ +
+
+ Create and manage user accounts. + Configure section-specific access levels and user settings. +
+
+
diff --git a/views/admin/workOrderTypes.ejs b/views/admin/workOrderTypes.ejs index 1603252e..89e5fe48 100644 --- a/views/admin/workOrderTypes.ejs +++ b/views/admin/workOrderTypes.ejs @@ -55,6 +55,13 @@ +
+
+ Configure <%= configFunctions.getConfigProperty('workOrders.sectionNameSingular').toLowerCase() %> types to categorize and organize work across different departments or functions. + Define custom fields, forms, and workflows for each <%= configFunctions.getConfigProperty('workOrders.sectionNameSingular').toLowerCase() %> type. +
+
+