Question Type Categories

Overview

The Question Types Module provides a comprehensive categorization system for different types of questions that can be used in inspections, forms, and surveys. This guide covers all question type categories, their specific question types, use cases, and configuration options.

Question Type Categories Overview

Category Structure

The question types are organized into three main categories:

1. Text Category - Text-based input questions
2. Choice Category - Selection-based questions with predefined options
3. Other Category - Specialized question types for specific use cases

Category Properties

Each question type has the following properties:

• Type: Category classification (Text, Choice, Other)
• Name: Human-readable name
• Key: Unique identifier for the question type
• Icon: Visual representation icon

Text Category

Overview

The Text category includes question types that require text-based responses from users. These are ideal for collecting descriptive information, contact details, and numerical data.

Text Question Types

1. Document Number

• Key: document_number
• Icon: pi pi-clipboard
• Description: Auto-generated document numbers with customizable formatting
• Use Cases: Inspection reports, compliance documents, reference numbers
• Features:
  • Customizable number format
  • Auto-incrementing sequences
  • Format validation

2. Long Text

• Key: long_text
• Icon: pi pi-file
• Description: Multi-line text input for detailed responses
• Use Cases: Detailed descriptions, observations, comments
• Features:
  • Multi-line input
  • Character limits
  • Rich text formatting options

3. Short Text

• Key: short_text
• Icon: pi pi-file-edit
• Description: Single-line text input for brief responses
• Use Cases: Names, titles, brief descriptions
• Features:
  • Single-line input
  • Character validation
  • Quick data entry

4. Phone Number

• Key: phone_number
• Icon: pi pi-phone
• Description: Phone number input with format validation
• Use Cases: Contact information, emergency contacts
• Features:
  • Phone number validation
  • Format masking
  • International format support

5. Number

• Key: number
• Icon: pi pi-hashtag
• Description: Numerical input with validation
• Use Cases: Quantities, measurements, scores
• Features:
  • Number validation
  • Decimal support
  • Range limits
  • Unit specifications

6. Email

• Key: email
• Icon: pi pi-at
• Description: Email address input with validation
• Use Cases: Contact information, notifications
• Features:
  • Email format validation
  • Domain verification
  • Auto-completion

7. Website

• Key: website
• Icon: pi pi-link
• Description: URL input with validation
• Use Cases: Reference links, documentation URLs
• Features:
  • URL format validation
  • Protocol specification
  • Link preview

8. Currency

• Key: currency
• Icon: pi pi-money-bill
• Description: Currency amount input
• Use Cases: Cost estimates, budget tracking
• Features:
  • Currency formatting
  • Decimal precision
  • Currency symbol display

9. Instruction

• Key: instruction
• Icon: pi pi-exclamation-circle
• Description: Instructional text display
• Use Cases: Guidelines, procedures, warnings
• Features:
  • Rich text formatting
  • Media attachments
  • Visual emphasis

Choice Category

Overview

The Choice category includes question types that present users with predefined options to select from. These are ideal for standardized responses and data collection.

Choice Question Types

1. Multiple Choice

• Key: multiple_choice
• Icon: pi pi-list-check
• Description: Radio button or checkbox selection from predefined options
• Use Cases: Yes/No questions, preference selection, compliance checks
• Features:
  • Single or multiple selection
  • Custom option colors
  • Scoring capabilities
  • Flagged response marking

2. Picture Choice

• Key: picture_choice
• Icon: pi pi-images
• Description: Visual selection using images or icons
• Use Cases: Equipment identification, visual assessments, preference selection
• Features:
  • Image upload and management
  • Custom image sizing
  • Visual feedback
  • Accessibility support

3. Emoji Choice

• Key: emoji_choice
• Icon: pi pi-discord
• Description: Selection using emoji expressions
• Use Cases: Mood assessment, satisfaction ratings, quick feedback
• Features:
  • Emoji picker integration
  • Custom emoji sets
  • Visual appeal
  • Universal understanding

4. DropDown

• Key: dropdown
• Icon: pi pi-align-justify
• Description: Dropdown menu selection from a list of options
• Use Cases: Category selection, status updates, classification
• Features:
  • Hierarchical options
  • Search functionality
  • Multi-level selection
  • Dynamic option loading

Choice Category Configuration

Option Management

• Option Creation: Add, edit, and delete choice options
• Option Ordering: Drag-and-drop reordering
• Option Grouping: Organize options into categories
• Option Scoring: Assign numerical values to options

Advanced Features

• Conditional Logic: Show/hide options based on other responses
• Dynamic Options: Load options from external data sources
• Response Validation: Ensure valid selections
• Response Tracking: Monitor option selection patterns

Other Category

Overview

The Other category includes specialized question types that don't fit into the Text or Choice categories. These provide unique functionality for specific use cases.

Other Question Types

1. Site

• Key: site
• Icon: pi pi-tag
• Description: Site or location selection
• Use Cases: Site-specific inspections, location-based assessments
• Features:
  • Site hierarchy navigation
  • Site search functionality
  • Site-specific data loading

2. User

• Key: user
• Icon: pi pi-user
• Description: User selection from system users
• Use Cases: Assignee selection, responsible person identification
• Features:
  • User search and filtering
  • Role-based filtering
  • User profile integration

3. CheckBox

• Key: checkbox
• Icon: pi pi-check-square
• Description: Simple checkbox for yes/no responses
• Use Cases: Confirmation questions, checklist items
• Features:
  • Default state configuration
  • Conditional display
  • Response tracking

4. Date and Time

• Key: date_and_time
• Icon: pi pi-calendar-minus
• Description: Date and time selection
• Use Cases: Scheduling, timestamp recording, deadline tracking
• Features:
  • Date picker interface
  • Time selection
  • Date range validation
  • Timezone support

5. Media

• Key: media
• Icon: pi pi-image
• Description: File upload and media attachment
• Use Cases: Photo documentation, file attachments, evidence collection
• Features:
  • Multiple file types
  • File size limits
  • Image compression
  • Preview functionality

6. Slider

• Key: slider
• Icon: pi pi-sliders-h
• Description: Range selection using a slider interface
• Use Cases: Rating scales, measurement ranges, preference levels
• Features:
  • Customizable range
  • Step increments
  • Visual feedback
  • Value display

7. Signature

• Key: signature
• Icon: pi pi-id-card
• Description: Digital signature capture
• Use Cases: Approval signatures, compliance documentation
• Features:
  • Touch and mouse input
  • Signature validation
  • Digital certificate support
  • Audit trail

8. Location

• Key: location
• Icon: pi pi-map-marker
• Description: GPS location capture
• Use Cases: Field inspections, location verification, route tracking
• Features:
  • GPS integration
  • Map display
  • Location accuracy
  • Offline support

9. Rating

• Key: rating
• Icon: pi pi-star
• Description: Star-based rating system
• Use Cases: Satisfaction surveys, quality assessments, performance reviews
• Features:
  • Customizable star count
  • Half-star ratings
  • Rating labels
  • Average calculation

10. Resource

• Key: resource
• Icon: pi pi-book
• Description: Resource or resource selection
• Use Cases: Equipment inspection, resource management, resource allocation
• Features:
  • Resource categorization
  • Resource type filtering
  • Resource details display
  • Availability checking

Other Category Configuration

Specialized Features

• Integration Options: Connect with external systems
• Validation Rules: Custom validation for specialized data
• Display Options: Custom rendering and formatting
• Access Control: Permission-based access to features

Recommended Question Types

Overview

The system includes a "Recommended" category that highlights commonly used question types for quick access and improved user experience.

Recommended Types

Based on the system configuration, the following question types are marked as recommended:

• Long Text
• Short Text
• Phone Number
• Number

Benefits

• Quick Access: Frequently used question types are easily accessible
• User Guidance: Helps users choose appropriate question types
• Efficiency: Reduces time spent searching for question types
• Best Practices: Promotes use of proven question formats

Category Management

Category Organization

Grouping Logic

• Automatic Grouping: Questions are automatically grouped by type
• Recommended Section: Special section for frequently used types
• Custom Grouping: Ability to create custom categories

Navigation

• Tab-based Interface: Easy switching between categories
• Search Functionality: Quick search across all question types
• Filtering Options: Filter by category, features, or use cases

Category Customization

Adding New Categories

• Category Creation: Create new question type categories
• Category Assignment: Assign question types to categories
• Category Ordering: Customize category display order

Category Properties

• Category Name: Human-readable category name
• Category Icon: Visual representation
• Category Description: Detailed explanation of category purpose
• Category Permissions: Access control for category management

Question Type Configuration

Basic Configuration

Question Type Properties

• Name: Display name for the question type
• Key: Unique identifier for system integration
• Icon: Visual representation icon
• Description: Detailed explanation of functionality

Validation Rules

• Input Validation: Rules for acceptable input
• Format Requirements: Specific format requirements
• Range Limits: Minimum and maximum values
• Required Fields: Mandatory response requirements

Advanced Configuration

Conditional Logic

• Show/Hide Rules: Display questions based on other responses
• Skip Logic: Skip questions based on conditions
• Branching Logic: Navigate to different question paths

Integration Options

• External Data Sources: Connect to external databases
• API Integration: Real-time data updates
• Third-party Services: Integration with specialized services

Use Cases and Best Practices

Text Category Use Cases

Document Number

• Inspection Reports: Generate unique inspection report numbers
• Compliance Documents: Create reference numbers for compliance tracking
• Audit Trails: Maintain sequential numbering for audit purposes

Long Text

• Detailed Observations: Capture comprehensive inspection findings
• Procedure Descriptions: Document step-by-step procedures
• Issue Descriptions: Provide detailed problem descriptions

Short Text

• Quick Responses: Capture brief, specific information
• Identification Data: Names, titles, reference codes
• Status Updates: Brief status or condition descriptions

Choice Category Use Cases

Multiple Choice

• Compliance Checks: Yes/No compliance questions
• Preference Selection: User preference identification
• Standardized Responses: Consistent data collection

Picture Choice

• Equipment Identification: Visual equipment selection
• Condition Assessment: Visual condition evaluation
• Process Selection: Visual process flow selection

Emoji Choice

• Mood Assessment: Quick mood or satisfaction evaluation
• Feedback Collection: Rapid feedback gathering
• Status Indication: Visual status representation

Other Category Use Cases

Date and Time

• Scheduling: Appointment and task scheduling
• Timestamp Recording: Accurate time and date capture
• Deadline Tracking: Project and task deadline management

Media

• Photo Documentation: Visual evidence collection
• File Attachments: Supporting document uploads
• Evidence Collection: Compliance and audit evidence

Location

• Field Inspections: Location-specific inspections
• Route Tracking: Movement and route documentation
• Site Verification: Location accuracy verification

Best Practices

Question Design

• Clear Instructions: Provide clear, concise instructions
• Appropriate Question Type: Choose the most suitable question type
• Logical Flow: Organize questions in logical sequence
• Response Validation: Implement appropriate validation rules

User Experience

• Intuitive Interface: Design user-friendly interfaces
• Responsive Design: Ensure compatibility across devices
• Accessibility: Provide accessibility features
• Performance: Optimize for fast response times

Data Quality

• Validation Rules: Implement comprehensive validation
• Data Consistency: Ensure consistent data collection
• Error Handling: Provide clear error messages
• Data Integrity: Maintain data accuracy and reliability

Advanced Features

Conditional Logic

Show/Hide Conditions

• Response-based Display: Show questions based on previous responses
• User-based Display: Display questions based on user roles
• Time-based Display: Show questions based on time conditions

Skip Logic

• Conditional Skipping: Skip irrelevant questions
• Branching Paths: Navigate to different question sequences
• Dynamic Routing: Route users based on responses

Integration Capabilities

External Systems

• Database Integration: Connect to external databases
• API Connections: Real-time data exchange
• Third-party Services: Integration with specialized services

Data Synchronization

• Real-time Updates: Synchronize data in real-time
• Batch Processing: Process data in batches
• Conflict Resolution: Handle data conflicts

Customization Options

Branding

• Custom Styling: Apply custom CSS styling
• Logo Integration: Include organizational logos
• Color Schemes: Customize color schemes

Localization

• Multi-language Support: Support multiple languages
• Regional Formats: Adapt to regional preferences
• Cultural Considerations: Respect cultural differences

Troubleshooting

Common Issues

Question Type Not Available

• Permission Issues: Check user permissions
• Configuration Problems: Verify question type configuration
• System Updates: Ensure system is up to date

Validation Errors

• Input Format: Verify input format requirements
• Validation Rules: Check validation rule configuration
• Data Types: Ensure correct data type usage

Performance Issues

• Large Datasets: Optimize for large data volumes
• Complex Logic: Simplify conditional logic
• Resource Usage: Monitor system resource usage

Solutions

Configuration Issues

• Review Settings: Check all configuration settings
• Reset Defaults: Reset to default configurations
• Contact Support: Reach out to technical support

Data Issues

• Data Validation: Validate data integrity
• Backup Restoration: Restore from backups if needed
• Data Migration: Migrate data to correct formats

System Issues

• System Maintenance: Perform regular maintenance
• Update Installation: Install system updates
• Performance Monitoring: Monitor system performance