Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,24 @@ requires administrator permissions.
- [**Data Lists**](./adminDataLists.md)<br />
Manage customizable dropdown lists used throughout the application.

- [**Assigned To Management**](./adminAssignedTo.md)<br />
Maintain standardized assignee names for work orders and records.

- [**Employee Management**](./adminEmployees.md)<br />
Maintain a list of employees for work orders, shifts, and timesheets.

- [**Employee List Management**](./adminEmployeeLists.md)<br />
Create predefined employee groups for quick selection.

- [**Equipment Management**](./adminEquipment.md)<br />
Manage vehicles, tools, and other equipment.

- [**Location Management**](./adminLocations.md)<br />
Maintain predefined locations for quick selection.

- [**Notification Configuration**](./adminNotificationConfigurations.md)<br />
Configure automated notifications for events in ShiftLog.

---

## Best Practices
Expand Down
17 changes: 14 additions & 3 deletions docs/adminApiAuditLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
83 changes: 83 additions & 0 deletions docs/adminAssignedTo.md
Original file line number Diff line number Diff line change
@@ -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)
12 changes: 8 additions & 4 deletions docs/adminDataLists.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
109 changes: 109 additions & 0 deletions docs/adminEmployeeLists.md
Original file line number Diff line number Diff line change
@@ -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)
13 changes: 9 additions & 4 deletions docs/adminEmployees.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
13 changes: 9 additions & 4 deletions docs/adminEquipment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
13 changes: 9 additions & 4 deletions docs/adminLocations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading