Map System Manual¶
This comprehensive manual covers all features of the Map System - a powerful campaign management platform with interactive mapping, volunteer coordination, data management, and communication tools. (Insert screenshot - feature overview)
1. Getting Started¶
Logging In¶
- Go to your map site URL (e.g.,
https://yoursite.comorhttp://localhost:3000). - Enter your email and password on the login page.
- Click Login.
- If you forget your password, use the Reset Password link or contact an admin.
- Password Recovery: Check your email for reset instructions if SMTP is configured. (Insert screenshot - login page)
User Types & Permissions¶
- Admin: Full access to all features, user management, and system configuration
- User: Access to map, shifts, profile management, and location data
- Temp: Limited access (add/edit locations only, expires automatically after shift date)
2. Interactive Map Features¶
Basic Map Navigation¶
- After login, you'll see the interactive map with location markers.
- Use mouse or touch to pan and zoom around the map.
- Your current location may appear as a blue dot (if location services enabled).
- Use the zoom controls (±) or mouse wheel to adjust map scale. (Insert screenshot - main map view)
Advanced Search (Ctrl+K)¶
- Press Ctrl+K anywhere on the site to open the universal search.
- Search for:
- Addresses: Find and navigate to specific locations
- Documentation: Search help articles and guides
- Locations: Find existing data points by name or details
- Click results to navigate directly to locations on the map.
- QR Code Generation: Search results include QR codes for easy mobile sharing. (Insert screenshot - search interface)
Map Overlays (Cuts)¶
- Public Cuts: Geographic overlays (wards, neighborhoods, districts) are automatically displayed.
- Cut Selector: Use the multi-select dropdown to show/hide different cuts.
- Mobile Interface: On mobile, tap the πΊοΈ button to manage overlays.
- Legend: View active cuts with color coding and labels.
- Cuts help organize and filter location data by geographic regions. (Insert screenshot - cuts interface)
3. Location Management¶
Adding New Locations¶
- Click the Add Location button (+ icon) on the map.
- Click on the map where you want to place the new location.
- Fill out the comprehensive form:
- Personal: First Name, Last Name, Email, Phone, Unit Number
- Political: Support Level (1-4 scale), Party Affiliation
- Address: Street Address (auto-geocoded when possible)
- Campaign: Lawn Sign (Yes/No/Maybe), Sign Size, Volunteer Interest
- Notes: Additional information and comments
- Address Confirmation: System validates and confirms addresses when possible.
- Click Save to add the location marker. (Insert screenshot - add location form)
Editing and Managing Locations¶
- Click on any location marker to view details.
- Popup Actions:
- Edit: Modify all location details
- Move: Drag marker to new position (admin/user only)
- Delete: Remove location (admin/user only - hidden for temp users)
- Quick Actions: Email, phone, or text contact directly from popup.
- Support Level Color Coding: Markers change color based on support level.
- Apartment View: Special clustering for apartment buildings. (Insert screenshot - location popup)
Bulk Data Import¶
- Admin Panel β Data Converter β Upload CSV
- Supported Formats: CSV files with address data
- Batch Geocoding: Automatically converts addresses to coordinates
- Progress Tracking: Visual progress bar with success/failure reporting
- Error Handling: Downloadable error reports for failed geocoding
- Validation: Preview and verify data before final import
- Edmonton Data: Pre-configured for City of Edmonton neighborhood data. (Insert screenshot - data import interface)
4. Volunteer Shift Management¶
Public Shift Signup (No Login Required)¶
- Visit the Public Shifts page (accessible without account).
- Browse available volunteer opportunities with:
- Date, time, and location information
- Available spots and current signups
- Detailed shift descriptions
- One-Click Signup:
- Enter name, email, and phone number
- Automatic temporary account creation
- Instant email confirmation with login details
- Account Expiration: Temp accounts automatically expire after shift date. (Insert screenshot - public shifts page)
Authenticated User Shift Management¶
- Go to Shifts from the main navigation.
- View Options:
- Grid View: List format with detailed information
- Calendar View: Monthly calendar with shift visualization
- Filter Options: Date range, shift type, and availability status.
- My Signups: View your confirmed shifts at the top of the page.
Shift Actions¶
- Sign Up: Join available shifts (if spots remain)
- Cancel: Remove yourself from shifts you've joined
- Calendar Export: Add shifts to Google Calendar, Outlook, or Apple Calendar
- Shift Details: View full descriptions, requirements, and coordinator info. (Insert screenshot - shifts interface)
5. Advanced Map Features¶
Geographic Cuts System¶
What are Cuts?: Polygon overlays that define geographic regions like wards, neighborhoods, or custom areas.
Viewing Cuts (All Users)¶
- Auto-Display: Public cuts appear automatically when map loads.
- Multi-Select Control: Desktop users see dropdown with checkboxes for each cut.
- Mobile Modal: Touch the πΊοΈ button for full-screen cut management.
- Quick Actions: "Show All" / "Hide All" buttons for easy control.
- Color Coding: Each cut has unique colors and opacity settings. (Insert screenshot - cuts display)
Admin Cut Management¶
- Admin Panel β Map Cuts for full management interface.
- Drawing Tools: Click-to-add-points polygon creation system.
- Cut Properties:
- Name, description, and category
- Color and opacity customization
- Public visibility settings
- Official designation markers
- Cut Operations:
- Create, edit, duplicate, and delete cuts
- Import/export cut data as JSON
- Location filtering within cut boundaries
- Statistics Dashboard: Analyze location data within cut boundaries.
- Print Functionality: Generate professional reports with maps and data tables. (Insert screenshot - cut management)
Location Filtering within Cuts¶
- View Cut: Select a cut from the admin interface.
- Filter Locations: Automatically shows only locations within cut boundaries.
- Statistics Panel: Real-time counts of:
- Total locations within cut
- Support level breakdown (Strong/Lean/Undecided/Opposition)
- Contact information availability (email/phone)
- Lawn sign placements
- Export Options: Download filtered location data as CSV.
- Print Reports: Generate professional cut reports with statistics and location tables. (Insert screenshot - cut filtering)
6. Communication Tools¶
Universal Search & Contact¶
- Ctrl+K Search: Find and contact anyone in your database instantly.
- Direct Contact Links: Email and phone links throughout the interface.
- QR Code Generation: Share contact information via QR codes.
Admin Communication Features¶
- Bulk Email System:
- Rich HTML email composer with formatting toolbar
- Live email preview before sending
- Broadcast to all users with progress tracking
- Individual delivery status for each recipient
- One-Click Communication Buttons:
- π§ Email: Launch email client with pre-filled recipient
- π Call: Open phone dialer with contact's number
- π¬ SMS: Launch text messaging with contact's number
- Shift Communication:
- Email shift details to all volunteers
- Individual volunteer contact from shift management
- Automated signup confirmations and reminders. (Insert screenshot - communication tools)
7. Walk Sheet Generator¶
Creating Walk Sheets¶
- Admin Panel β Walk Sheet Generator
- Configuration Options:
- Title, subtitle, and footer text
- Contact information and instructions
- QR codes for digital resources
- Logo and branding elements
- Location Selection: Choose specific areas or use cut boundaries.
- Print Options: Multiple layout formats for different campaign needs.
- QR Integration: Add QR codes linking to:
- Digital surveys or forms
- Contact information
- Campaign websites or resources. (Insert screenshot - walk sheet generator)
Mobile-Optimized Walk Sheets¶
- Responsive Design: Optimized for viewing on phones and tablets.
- QR Code Scanner Integration: Quick scanning for volunteer check-ins.
- Offline Capability: Download for use without internet connection.
8. User Profile Management¶
Personal Settings¶
- User Menu β Profile to access personal settings.
- Account Information:
- Update name, email, and phone number
- Change password
- Communication preferences
- Activity History: View your shift signups and location contributions.
- Privacy Settings: Control data sharing and communication preferences. (Insert screenshot - user profile)
Password Recovery¶
- Forgot Password link on login page.
- Email Reset: Automated password reset via SMTP (if configured).
- Admin Assistance: Contact administrators for manual password resets.
9. Admin Panel Features¶
Dashboard Overview¶
- System Statistics: User counts, recent activity, and system health.
- Quick Actions: Direct access to common administrative tasks.
- NocoDB Integration: Direct links to database management interface. (Insert screenshot - admin dashboard)
User Management¶
- Create Users: Add new accounts with role assignments:
- Regular Users: Full access to mapping and shifts
- Temporary Users: Limited access with automatic expiration
- Admin Users: Full system administration privileges
- User Communication:
- Send login details to new users
- Bulk email all users with rich HTML composer
- Individual user contact (email, call, text)
- User Types & Expiration:
- Set expiration dates for temporary accounts
- Visual indicators for user types and status
- Automatic cleanup of expired accounts. (Insert screenshot - user management)
Shift Administration¶
- Create & Manage Shifts:
- Set dates, times, locations, and volunteer limits
- Public/private visibility settings
- Detailed descriptions and requirements
- Volunteer Management:
- Add users directly to shifts
- Remove volunteers when needed
- Email shift details to all participants
- Generate public signup links
- Volunteer Communication:
- Individual contact buttons (email, call, text) for each volunteer
- Bulk shift detail emails with delivery tracking
- Automated confirmation and reminder systems. (Insert screenshot - shift management)
System Configuration¶
- Map Settings:
- Set default start location and zoom level
- Configure map boundaries and restrictions
- Customize marker styles and colors
- Integration Management:
- NocoDB database connections
- Listmonk email list synchronization
- SMTP configuration for automated emails
- Security Settings:
- User permissions and role management
- API access controls
- Session management. (Insert screenshot - system config)
10. Data Management & Integration¶
NocoDB Database Integration¶
- Direct Database Access: Admin links to NocoDB sheets for advanced data management.
- Automated Sync: Real-time synchronization between map interface and database.
- Backup & Migration: Built-in tools for data backup and system migration.
- Custom Fields: Add custom data fields through NocoDB interface.
Listmonk Email Marketing Integration¶
- Automatic List Sync: Map data automatically syncs to Listmonk email lists.
- Segmentation: Create targeted lists based on:
- Geographic location (cuts/neighborhoods)
- Support levels and volunteer interest
- Contact preferences and activity
- One-Direction Sync: Maintains data integrity while allowing email unsubscribes.
- Compliance: Newsletter legislation compliance with opt-out capabilities. (Insert screenshot - integration settings)
Data Export & Reporting¶
- CSV Export: Download location data, user lists, and shift reports.
- Cut Reports: Professional reports with statistics and location breakdowns.
- Print-Ready Formats: Optimized layouts for physical distribution.
- Analytics Dashboard: Track user engagement and system usage.
11. Mobile & Accessibility Features¶
Mobile-Optimized Interface¶
- Responsive Design: Fully functional on phones and tablets.
- Touch Navigation: Optimized touch controls for map interaction.
- Mobile-Specific Features:
- Cut management modal for overlay control
- Simplified navigation and larger touch targets
- Offline capability for basic functions
Accessibility¶
- Keyboard Navigation: Full keyboard support throughout the interface.
- Screen Reader Compatibility: ARIA labels and semantic markup.
- High Contrast Support: Compatible with accessibility themes.
- Text Scaling: Responsive to browser zoom and text size settings.
12. Security & Privacy¶
Data Protection¶
- Server-Side Security: All API tokens and credentials kept server-side only.
- Input Validation: Comprehensive validation and sanitization of all user inputs.
- CORS Protection: Cross-origin request security measures.
- Rate Limiting: Protection against abuse and automated attacks.
User Privacy¶
- Role-Based Access: Users only see data appropriate to their permission level.
- Temporary Account Expiration: Automatic cleanup of temporary user data.
- Audit Trails: Logging of administrative actions and data changes.
- Data Retention: Configurable retention policies for different data types. (Insert screenshot - security settings)
Authentication¶
- Secure Login: Password-based authentication with optional 2FA.
- Session Management: Automatic logout for expired sessions.
- Password Policies: Configurable password strength requirements.
- Account Lockout: Protection against brute force attacks.
13. Performance & System Requirements¶
System Performance¶
- Optimized Database Queries: Reduced API calls by over 5000% for better performance.
- Smart Caching: Intelligent caching of frequently accessed data.
- Progressive Loading: Map data loads incrementally for faster initial page loads.
- Background Sync: Automatic data synchronization without blocking user interface.
Browser Requirements¶
- Modern Browsers: Chrome, Firefox, Safari, Edge (recent versions).
- JavaScript Required: Full functionality requires JavaScript enabled.
- Local Storage: Uses browser storage for session management and caching.
- Geolocation: Optional location services for enhanced functionality.
14. Troubleshooting¶
Common Issues¶
- Locations not showing: Check database connectivity, verify coordinates are valid, ensure API permissions allow read access.
- Cannot add locations: Verify API write permissions, check coordinate bounds, ensure all required fields completed.
- Login problems: Verify email/password, check account expiration (for temp users), contact admin for password reset.
- Map not loading: Check internet connection, verify site URL, clear browser cache and cookies.
- Permission denied: Confirm user role and permissions, check account expiration status, contact administrator.
Performance Issues¶
- Slow loading: Check internet connection, try refreshing the page, contact admin if problems persist.
- Database errors: Contact system administrator, check NocoDB service status.
- Email not working: Verify SMTP configuration (admin), check spam/junk folders.
Mobile Issues¶
- Touch problems: Ensure touch targets are accessible, try refreshing page, check for browser compatibility.
- Display issues: Try rotating device, check browser zoom level, update to latest browser version.
15. Advanced Features¶
API Access¶
- RESTful API: Programmatic access to map data and functionality.
- Authentication: Token-based API authentication for external integrations.
- Rate Limiting: API usage limits to ensure system stability.
- Documentation: Complete API documentation for developers.
Customization Options¶
- Theming: Customizable color schemes and branding.
- Field Configuration: Add custom data fields through admin interface.
- Workflow Customization: Configurable user workflows and permissions.
- Integration Hooks: Webhook support for external system integration.
16. Getting Help & Support¶
Built-in Help¶
- Context Help: Tooltips and help text throughout the interface.
- Search Documentation: Use Ctrl+K to search help articles and guides.
- Status Messages: Clear feedback for all user actions and system status.
Administrator Support¶
- Contact Admin: Use the contact information provided during setup.
- System Logs: Administrators have access to detailed system logs for troubleshooting.
- Database Direct Access: Admins can access NocoDB directly for advanced data management.
Community Resources¶
- Documentation: Comprehensive online documentation and guides.
- GitHub Repository: Access to source code and issue tracking.
- Developer Community: Active community for advanced customization and development.
For technical support, contact your system administrator or refer to the comprehensive documentation available through the help system. (Insert screenshot - help resources)