QR Code Issue Module

Overview

The QR Code Issue Module allows you to create and manage QR codes that enable quick issue reporting. Users can scan these QR codes with their mobile devices to directly access a pre-configured issue creation form, streamlining the issue reporting process for your organization.

What are Issue QR Codes?

Issue QR Codes are special QR codes that, when scanned, automatically direct users to an issue creation form. These QR codes can be pre-configured with specific settings such as:

• Issue Category: Pre-fill the type of issue being reported
• Site Location: Pre-assign the specific site where the issue occurs
• Resources: Link to specific equipment or resources related to the issue

Types of QR Codes

• General QR Codes: Not tied to specific sites or resources
• Site-Specific QR Codes: Pre-configured for specific locations
• Resource-Specific QR Codes: Linked to particular equipment or assets

Getting Started

Accessing the QR Code Module

1. Navigate to Issues from the main menu
2. Click on the QR Code tab
3. You'll see a list of all existing QR codes in your organization

Required Permissions

To work with QR codes, you need the following permissions:

• View Issue Qr Codes: View the QR code list
• Create Issue Qr Codes: Create new QR codes
• Edit Issue Qr Codes: Modify existing QR codes
• Delete Issue Qr Codes: Remove QR codes
• Show Issue Qr Codes: View QR code details and download/share

Creating QR Codes

Step 1: Start Creating a New QR Code

1. Click the "New" button in the QR Code management interface
2. A creation dialog will open

Step 2: Configure Basic Settings

1. QR Code Name: Enter a descriptive name for your QR code
   • Example: "Warehouse Equipment Issues" or "Office Maintenance"

Step 3: Configure Category Settings

1. Category Pre-fill Toggle: Enable this to pre-select an issue category
2. Issue Category: If pre-fill is enabled, select the appropriate category

Step 4: Add Site Configuration (Optional)

1. Click "Add Site Field" if you want to link the QR code to a specific location
2. Site Pre-fill Toggle: Enable to pre-select a site
3. Site Selection: Choose the specific site from the tree structure
4. To remove: Click the trash icon next to the site field

Step 5: Add Resource Configuration (Optional)

1. Click "Add Resource Field" if you want to link to specific equipment
2. Resource Pre-fill Toggle: Enable to pre-select resources
3. Resource Selection: Choose from available resources
4. You can select multiple resources
5. To remove: Click the trash icon next to the resource field

Step 6: Review Security Notice

Step 7: Save Your QR Code

Click "Save" to create your QR code. The system will generate:

• A unique QR code image
• A unique URL for each QR code
• Assignment records for site/resource-specific codes

Managing QR Codes

Viewing QR Codes

The QR Code list displays:

• Name: The descriptive name you assigned
• Category: Pre-filled issue category (if any)
• Status: Active/Inactive toggle
• Actions: Edit, Delete, and View QR code options

Viewing QR Code Details

1. Click the QR code icon (📱) in the Actions column
2. A detailed view opens showing:
   • QR code image(s)
   • Associated URLs
   • Download and copy options

QR Code Types and Display

General QR Codes:

• Single QR code for general issue reporting
• Not tied to specific locations or resources

Site-Specific QR Codes:

• Separate QR code for each assigned site
• Displays site name and location-specific information

Resource-Specific QR Codes:

• Individual QR code for each assigned resource
• Shows resource title and specific details

Downloading QR Codes

1. In the QR code details view, click "Download QR code"
2. The QR code image will be saved as a PNG file
3. File naming convention:
   • General: qr-code-name.png
   • Site-specific: site-location-name.png
   • Resource-specific: resource-equipment-name.png

Copying QR Code URLs

1. Click the copy icon (📋) next to the URL field
2. The URL is copied to your clipboard
3. Share this URL directly or embed it in other systems

Editing QR Codes

1. Click the edit icon (✏️) in the Actions column
2. Modify the configuration as needed
3. Save changes to update the QR code

Deleting QR Codes

1. Click the delete icon (🗑️) in the Actions column
2. Confirm the deletion

Enabling/Disabling QR Codes

Use the toggle switch in the Status column to activate or deactivate QR codes:

• Active: QR code can be scanned and used
• Inactive: QR code scanning is disabled

Using QR Codes

For End Users

1. Scan the QR Code: Use any QR code scanner app or built-in camera app
2. Access Issue Form: The QR code automatically opens the issue creation form
3. Pre-filled Information: Relevant fields (category, site, resources) are automatically filled
4. Complete Report: Fill in remaining required information and submit

Deployment Options

Physical Placement:

• Print QR codes and place them at relevant locations
• Laminate for durability in industrial environments
• Use weatherproof materials for outdoor installations

Digital Distribution:

• Share QR code URLs via email or messaging apps
• Embed in digital displays or kiosks
• Include in maintenance schedules or work orders

Best Practices

QR Code Creation

Use Descriptive Names:

Make QR code names clear and specific

• ✅ Good: "Building A HVAC Issues"
• ❌ Bad: "QR Code 1"

Strategic Pre-filling:

• Pre-fill category for specific equipment types
• Pre-fill site for location-specific issues
• Leave general for flexible reporting

Resource Management:

• Create resource-specific QR codes for high-value equipment
• Group similar resources under one QR code when appropriate

Security Considerations

1. Limit Exposure: Only share QR codes with authorized personnel
2. Regular Review: Periodically audit active QR codes
3. Deactivate Unused: Turn off QR codes that are no longer needed
4. Monitor Usage: Track issue creation patterns from QR codes

Physical Deployment

1. Visibility: Place QR codes where they're easily visible and accessible
2. Protection: Use protective materials to prevent damage
3. Size: Ensure QR codes are large enough to scan easily (minimum 2cm x 2cm)
4. Lighting: Ensure adequate lighting for scanning

Maintenance

1. Regular Testing: Periodically test QR codes to ensure they work
2. Update Information: Keep pre-filled information current
3. Replace Damaged Codes: Replace worn or damaged physical QR codes
4. Document Locations: Keep records of where QR codes are placed

Troubleshooting

Common Issues

QR Code Won't Scan:

• Check lighting: Ensure adequate light for scanning
• Clean surface: Remove dirt or scratches from printed codes
• Try different scanner: Use various QR code reader apps
• Size issues: Ensure QR code is large enough (minimum 2cm x 2cm)

Wrong Information Pre-filled:

• Check configuration: Verify QR code settings in the admin panel
• Update QR code: Edit the QR code configuration and regenerate
• Clear cache: Clear browser cache if using web-based scanning

Access Denied:

• Check permissions: Ensure user has proper permissions to create issues
• Verify status: Confirm QR code is active/enabled
• Network issues: Check internet connectivity

Pre-filled Fields Not Working:

• Browser compatibility: Try different browsers
• URL parameters: Verify the QR code URL contains proper parameters
• Configuration check: Review QR code settings

Getting Help

If you continue experiencing issues:

1. Check System Status: Verify the system is operational
2. Contact Administrator: Reach out to your system administrator
3. Document Issues: Provide specific error messages and screenshots
4. Test Environment: Try in different devices/browsers to isolate issues

Permissions

Required Permissions for QR Code Management

Related Permissions

• View Sites: Required to select sites for QR codes
• View Resources: Required to select resources for QR codes
• View Issue Categories: Required to select issue categories
• Create Issues: End users need this to report issues via QR codes