Settings Management
Your centralized system for managing application behavior across all organizational levels.
Table of Contents
What is the Settings System?
The Settings system is your centralized configuration control center that manages how the entire application behaves across different organizational levels. Think of it as a sophisticated hierarchy of preferences and configurations that cascade from global defaults down to specific project requirements.
🏗️ Inheritance Model: The system follows a clear cascade: Global → Client → Branch → Project, where more specific settings override broader ones.
Settings Hierarchy:
🌍 Global Settings
├── 🏢 Client Settings
│ ├── 🏛️ Branch Settings
│ │ └── 📋 Project Settings
The Four-Column Hierarchical Structure
🌍 Column 1: Global Settings (Default)
System-wide defaults that apply everywhere, unless overridden by the client, branch or project levels.
| Aspect | Details |
|---|---|
| Scope | Entire application across all clients, branches and projects |
| Permissions | Only system administrators can modify (super-admin role) |
| Inheritance | Overridden by client, branch and project settings |
🏢 Column 2: Client Settings
Client-specific configurations that apply to an entire client structure, unless overriden by the branch or project levels.
| Aspect | Details |
|---|---|
| Scope | All branches and projects belonging to the selected client |
| Permissions | Only system administrators can modify (super-admin role) |
| Inheritance | Overrides global settings, overridden by branch and project settings |
🏛️ Column 3: Branch Settings
Branch-specific configurations that apply to all the projects of a branch, unless overriden by the project level.
| Aspect | Details |
|---|---|
| Scope | All projects within the selected branch |
| Permissions | Only system administrators can modify (super-admin role) |
| Inheritance | Overrides global and client settings, overridden by project settings |
📋 Column 4: Project Settings
Project-specific configurations for individual projects - this level cannot be overriden.
| Aspect | Details |
|---|---|
| Scope | Affects only the selected project |
| Permissions | Only system administrators can modify (super-admin role) |
| Inheritance | Overrides global, client and branch settings |
⚙️ Settings Categories and Their Functions
🔍 Auditing Settings Group
Controls quality assurance, verification, and compliance processes.
Key Settings Overview
| Setting | Range/Type | Purpose |
|---|---|---|
| 📊 Audit Quota | 0-100% | Percentage of work requiring quality auditing |
| 🗺️ Zone Quota | 0-100% | Percentage of zones needing additional verification |
| ✅ Quality Assurance Quota | 0-100% | Percentage of work subject to QA processes |
| 📋 Check All Required | Yes/No | Whether all mandatory checks must be completed |
| 🔒 Check Required on Close | Yes/No | Whether final verification is mandatory at closure |
💼 Business Impact: Directly affects work quality, compliance requirements, and project completion criteria.
⚙️ Audit Process Settings Group
Defines the technical processes for verification and quality control.
Key Technical Settings
| Setting | Type | Purpose |
|---|---|---|
| 📝 Verify Function | JavaScript | Custom verification logic definition |
| 📋 Verify Reasons | List | Predefined reasons for verification requirements |
| 🔄 Transform Scans | JavaScript | Processing and transforming scan data |
| 📊 Sample Mode | YAML | Sampling strategies and criteria configuration |
⚠️ Technical Note: These settings require technical expertise and affect core system behavior.
📧 Communication Settings Group
Manages email notifications, alerts, and external communications.
Key Communication Settings
| Setting | Type | Purpose |
|---|---|---|
| 📮 Export Email Address | Primary recipient for automated exports | |
| 📧 Export Email Address CC | Additional recipients for notifications | |
| 🚨 Email When Closed and Not Published | Yes/No | Alerts for unpublished completed projects |
| 📝 Email Template | Rich Text | Customizable templates (header, body, signature) |
| 👤 Email From Address | Default sender information | |
| 👥 Email Recipients | List | Notification recipient management |
| ⏱️ Trigger Time | Minutes | Delay before sending notifications |
📊 User Benefit: Ensures stakeholders stay informed about project progress and completion.
🔧 Configurations Settings Group
Advanced technical configurations that control core system behavior.
System Configuration Settings
| Setting | Format | Purpose |
|---|---|---|
| 📥 Import Config | YAML | How data is imported into the system |
| 📤 Export Config | YAML | How data is exported from the system |
| 🔄 Scan Flow Config | YAML | Scanning workflow process control |
| 📍 Position Verification Config | YAML | Location-based verification rules |
| 🗺️ Zone Verification Config | YAML | Zone-specific verification processes |
| 🔗 Zone Linking Config | YAML | How zones connect and relate |
| 🏷️ Zone Code Config | YAML | Zone identification and coding rules |
| 📋 Zonelist Config | YAML | Zone listing and display control |
| 🧪 Sandbox Variables | Key-Value | Custom variables and parameters |
| 👤 Registration Config | YAML | User registration and access control |
| 👆 Finger Scanner Config | Settings | Biometric scanning device settings |
⚠️ Technical Note: These are advanced configurations requiring YAML knowledge and system understanding.
🎯 QM Module Settings Group
Quality Management module-specific configurations for enhanced quality control.
Quality Management Settings
| Setting | Format | Purpose |
|---|---|---|
| 📊 Scan QM Config | YAML | Quality management during scanning |
| 🗺️ Zone QM Config | YAML | Zone-based quality management |
| ⚙️ Application | Config | Quality management processes and standards |
⚙️ Main Process Settings Group
Core operational settings that affect primary business processes.
Essential Process Settings
| Setting | Type | Purpose |
|---|---|---|
| 📊 Group Difference List By | Field | Organizing difference reports (e.g., "productCode") |
| 🏢 Possible Warehouse Codes | List | Valid warehouse identifiers |
| 🏷️ Possible Zone Prefixes | List | Acceptable zone naming prefixes |
| 🚩 Extra Zone Flags | YAML | Additional zone status flags |
| 🗄️ Match Database Name | String | Database name for matching operations |
| 📁 Match Database Path | Path | File path for match database location |
| 📋 Checklist Code | JavaScript | Custom checklist logic |
| 🔄 Reopen Project | Policy | Project reopening rules (allow/disallow/restrictions) |
| 👥 Include Temp Users on Live Statistics | Yes/No | Whether temporary users appear in live reporting |
💼 Operational Impact: These settings directly affect daily workflows and business operations.
📱 Scanner Settings Group
Hardware and scanning device configurations for optimal performance.
Scanner Configuration
| Setting | Purpose |
|---|---|
| 🏢 Possible Divisions | Valid organizational divisions for scanning operations |
| 🔧 Hardware Integration | Ensures scanning devices work correctly with organizational structure |
🔄 Scan Process Settings Group
Settings that control the scanning workflow and user interaction processes.
Scanning Workflow Settings
| Setting | Type | Purpose |
|---|---|---|
| 🎯 Logon to Zone with Function Button | Yes/No | Enables one-button zone access |
| 🔍 Match During Sync Query | Query String | Matching during synchronization |
| 🌐 Match Online | Yes/No | Enable real-time online matching |
| 🔄 Match Online After Local | Yes/No | Online matching as fallback after local matching |
⚡ Workflow Impact: Affects how users interact with scanning processes and system responsiveness.
🎛️ Setting Types and Input Methods
🎯 Interactive Controls Overview
Different setting types use specialized input methods for optimal user experience.
Control Types Summary
| Control Type | Appearance | Best For | Examples |
|---|---|---|---|
| 🔘 Toggle Switches | On/off switches with labels | Yes/No decisions | Email notifications, required checks |
| 🔢 Number Input | Text boxes with validation | Percentages, quantities | Audit quotas (0-100%), trigger times |
| 📝 Text Input | Single-line text boxes | Names, identifiers | Email addresses, warehouse codes |
| 📋 Dropdown Menus | Predefined choice lists | Limited specific options | Reopening policies, grouping criteria |
| 📄 Text Areas | Multi-line expandable boxes | Complex configurations | JavaScript, YAML, email templates |
🔘 Toggle Switches (Boolean Settings)
- 👀 Appearance: Clean on/off switches with clear labels
- 🎯 Use Cases: Yes/No decisions and feature enable/disable
- 🖱️ Interaction: Click to toggle between states
- 📚 Examples: Email notifications, required checks, online matching
🔢 Number Input Fields
- 👀 Appearance: Text boxes with numeric validation
- 🎯 Use Cases: Percentages, quotas, time intervals, quantities
- ✅ Validation: Automatic range checking and format validation
- 📚 Examples: Audit quotas (0-100%), trigger times, thresholds
📝 Text Input Fields
- 👀 Appearance: Single-line text boxes with validation
- 🎯 Use Cases: Names, addresses, identifiers, simple configurations
- ✅ Features: Real-time validation and format checking
- 📚 Examples: Email addresses, warehouse codes, database names
📋 Dropdown Selections (Option Settings)
- 👀 Appearance: Dropdown menus with predefined choices
- 🎯 Use Cases: Selecting from limited, specific options
- ✅ Benefits: Prevents invalid entries and ensures consistency
- 📚 Examples: Project reopening policies, grouping criteria
📄 Multi-line Text Areas
- 👀 Appearance: Expandable text boxes for longer content
- 🎯 Use Cases: Complex configurations, code, and detailed text
- ✨ Special Features: Syntax highlighting for code, YAML validation
- 📚 Examples: JavaScript functions, YAML configurations, email templates
📧 Email Template Editors
- 👀 Appearance: Specialized forms with multiple fields
- 🧩 Components: Header, body text, and signature sections
- ✨ Features: Rich text editing and template preview
- 🎯 Purpose: Creating professional, consistent email communications
🔧 Key-Value Pair Editors
- 👀 Appearance: Dynamic tables for adding custom properties
- 🎯 Use Cases: Sandbox variables and custom parameter definitions
- 🔄 Flexibility: Add, edit, or remove properties as needed
- 📊 Format: JSON structure for technical integrations
🔄 Inheritance and Override System
📊 How Settings Cascade
Settings flow from general to specific, with each level able to override the previous ones.
Cascade Flow:
🌍 Global Foundation
↓ (overridden by)
🏢 Client Override
↓ (overridden by)
🏛️ Branch Override
↓ (overridden by)
📋 Project Override (FINAL)
Cascade Hierarchy
| Level | Authority | Scope | Override Capability |
|---|---|---|---|
| 🌍 Global | System default | Entire application | Base foundation |
| 🏢 Client | Organization-specific | All client branches/projects | Overrides global |
| 🏛️ Branch | Location-specific | All branch projects | Overrides global + client |
| 📋 Project | Project-specific | Single project only | Overrides ALL levels |
🎨 Visual Indicators
The interface provides clear visual cues about setting customization and inheritance.
- ✅ Setting Presence: Settings show only when customized at that level
- ➕ Add Setting Button: "+" appears when setting isn't customized at current level
- ❌ Remove Setting Button: "×" allows removing customizations to inherit from higher levels
- 🎨 Color Coding: Each level has distinct colors showing inheritance hierarchy
💡 Practical Examples
See how settings inheritance works in practice.
Example 1: Audit Quota Inheritance
Setting Flow:
🌍 Global: 10% audit quota
└── 🏢 Client A: 15% audit quota
└── 🏛️ Branch B: 20% audit quota
Result: Branch B projects use 20%, other Client A branches use 15%, all other clients use 10%
Example 2: Email Notification Override
Setting Flow:
🌍 Global: Email notifications ENABLED
└── 🏢 Client A: (inherits) ENABLED
└── 🏛️ Branch C: (inherits) ENABLED
└── 📋 Project X: Email notifications DISABLED
Result: Project X has no email notifications, all other projects have them enabled
🔐 Permission System and Access Control
Access levels determine who can modify settings at each organizational level.
Permission Matrix
| Level | Who Has Access | Scope | Impact | Primary Use Cases |
|---|---|---|---|---|
| 🌍 Global | System administrators only | System-wide defaults | Entire application | System stability and default behaviors |
| 🏢 Client | Client + System administrators | Specific client organizations | All client branches/projects | Client-specific business rules |
| 🏛️ Branch | Branch managers + higher levels | Specific branches | All branch projects | Regional differences and requirements |
| 📋 Project | Project managers + higher levels | Specific projects | Single project only | Project-specific customizations |
🌍 Global Level Access
- 👤 Who: System administrators only
- 📊 Scope: Can modify system-wide defaults
- 💥 Impact: Changes affect entire application unless overridden
- 🎯 Responsibility: Maintaining system stability and default behaviors
🏢 Client Level Access
- 👤 Who: Client administrators and system administrators
- 📊 Scope: Can modify settings for specific client organizations
- 💥 Impact: Changes affect all branches and projects within that client
- 🎯 Use Cases: Client-specific business rules and preferences
🏛️ Branch Level Access
- 👤 Who: Branch managers, client administrators, and system administrators
- 📊 Scope: Can modify settings for specific branches
- 💥 Impact: Changes affect all projects within that branch
- 🎯 Use Cases: Regional differences and location-specific requirements
📋 Project Level Access
- 👤 Who: Project managers and higher-level administrators
- 📊 Scope: Can modify settings for specific projects
- 💥 Impact: Changes affect only that project
- 🎯 Use Cases: Project-specific requirements and customizations
🎯 Best Practices for Settings Management
🎯 Strategic Approach
Build a solid foundation and customize strategically for maximum effectiveness.
| Practice | Description | Benefit |
|---|---|---|
| 🌍 Start Global | Establish sensible system-wide defaults | Works for most situations |
| 🎯 Customize Strategically | Override only when clear business need exists | Maintains simplicity |
| 📝 Document Changes | Track why specific overrides were made | Historical understanding |
| 🧪 Test Carefully | Changes have widespread effects at higher levels | Prevents system issues |
🛠️ Maintenance Guidelines
Maintenance Checklist:
├── 📊 Regular Review
│ └── Ensure settings still meet business needs
├── 🧹 Clean Up
│ └── Remove obsolete customizations
├── 📢 Coordinate Changes
│ └── Communicate changes to affected teams
└── 💾 Backup Critical Settings
└── Maintain records of important configurations
🔍 Troubleshooting Quick Reference
Quick fixes for typical settings problems.
| Problem | Check | Solution |
|---|---|---|
| Setting not working | Check inheritance hierarchy | Verify all levels in cascade |
| Can't see the page | Verify permissions | Ensure appropriate access level |
| Technical setting errors | Validate configurations | Check in-app guidelines and JavaScript syntax |
| Unexpected behavior | Test in stages | Make changes at specific level first |
🚀 Ready to Configure Your System?
Next Steps: Start with global defaults, then strategically customize at client, branch, and project levels as needed for your specific requirements!