Organization Settings Guide
Overview
Section titled “Overview”This guide explains how to manage organization-specific settings in the ERP-Unlocked platform. Organization settings allow each organization to customize their experience according to their specific business needs and requirements.
Accessing Organization Settings
Section titled “Accessing Organization Settings”Prerequisites
Section titled “Prerequisites”- You must be an organization administrator
- You must be logged into the ERP-Unlocked platform
- Your organization must be properly configured in Clerk
Navigation
Section titled “Navigation”- Log into the ERP-Unlocked web app
- Navigate to Organization Settings from the main menu
- Select the specific settings category you want to configure
Available Settings Categories
Section titled “Available Settings Categories”1. Fuzzy Matching Configuration
Section titled “1. Fuzzy Matching Configuration”Configure how the system matches product IDs and handles fuzzy matching for your organization.
Thresholds
Section titled “Thresholds”- Trigram Similarity: Controls how similar product IDs need to be for trigram matching (0.0 - 1.0)
- Full Text Similarity: Controls full-text search matching threshold (0.0 - 1.0)
- Max Levenshtein Distance: Maximum character differences allowed (0 - 10)
- Base Similarity Threshold: Overall similarity threshold for matches (0.0 - 1.0)
Prefix Compatibility Rules
Section titled “Prefix Compatibility Rules”Define which product ID prefixes are considered incompatible:
- Incompatible Pairs: Specify which prefixes cannot be matched together
- Severity Levels: Set whether incompatible matches should be blocked, warned about, or allowed
- Categories: Organize rules by category (e.g., material_type, product_type)
Validation Settings
Section titled “Validation Settings”- Dynamic Validation: Enable additional validation checks during fuzzy matching
- Custom Rules: Define custom validation rules for your specific use case
2. Sync Schedules (Planned)
Section titled “2. Sync Schedules (Planned)”Configure when and how often your data is synchronized with ERP systems.
Data Types
Section titled “Data Types”- Customers: Sync frequency for customer data
- Products: Sync frequency for product catalog
- Inventory: Sync frequency for inventory levels
Schedule Options
Section titled “Schedule Options”- Frequency: Hourly, daily, weekly, or custom cron expressions
- Batch Size: Number of records to process in each batch
- Retry Attempts: Number of retry attempts for failed syncs
- Business Hours: Define when syncs should run based on business hours
3. Alerting Configuration (Planned)
Section titled “3. Alerting Configuration (Planned)”Set up custom alerts and notifications for various events.
Notification Channels
Section titled “Notification Channels”- Email: Configure email addresses and frequency
- Slack: Set up Slack webhook integration
- Webhooks: Configure custom webhook endpoints
Alert Rules
Section titled “Alert Rules”- Event Types: Choose which events trigger alerts
- Conditions: Define conditions for alert triggering
- Severity Levels: Set alert severity (low, medium, high, critical)
- Thresholds: Configure thresholds for various metrics
4. Feature Flags (Flagsmith)
Section titled “4. Feature Flags (Flagsmith)”Feature flags are managed via Flagsmith, enabling gradual rollouts, A/B testing, and user-specific targeting.
Note: Feature flags are now centrally managed through Flagsmith rather than per-organization database settings. See Flagsmith Feature Flags Configuration for details.
How It Works
Section titled “How It Works”- Feature flags are defined in Flagsmith with targeting rules
- The
@repo/feature-flagspackage evaluates flags based on user/organization context - Flags can be targeted by:
- User: Specific Clerk user IDs
- Organization: Clerk organization ID
- Segment: Internal team, beta users, enterprise orgs, etc.
- Percentage: Gradual rollout to X% of users
Current Feature Flags
Section titled “Current Feature Flags”| Flag | Description | Status |
|---|---|---|
email_enabled | Enable email-based order processing | Available |
dagster_enabled | Use Dagster for data synchronization | Available |
typesense_search | Use Typesense for enhanced search | Available |
new_order_editor | New React-based order editor UI | Beta |
Enabling Features for Your Organization
Section titled “Enabling Features for Your Organization”Contact your account administrator to enable specific features for your organization. Features can be enabled based on:
- Subscription tier (Professional, Enterprise)
- Beta program enrollment
- Custom organization targeting
5. Business Rules (Planned)
Section titled “5. Business Rules (Planned)”Define custom business logic and validation rules.
Validation Rules
Section titled “Validation Rules”- Order Validation: Custom validation for orders
- Product Validation: Custom validation for products
- Field Requirements: Define required fields for different entities
Workflows
Section titled “Workflows”- Order Approval: Configure approval workflows
- Price Validation: Set up price validation rules
- Custom Logic: Define custom business logic
6. Integration Configuration (Planned)
Section titled “6. Integration Configuration (Planned)”Configure integrations with external systems.
ERP Connections
Section titled “ERP Connections”- Connection Management: Manage multiple ERP connections
- Default Connection: Set default ERP connection
- Failover: Configure failover connections
API Configuration
Section titled “API Configuration”- Rate Limits: Set API rate limits
- Webhooks: Configure webhook endpoints
- Authentication: Set up API authentication
7. UI Configuration (Planned)
Section titled “7. UI Configuration (Planned)”Customize the user interface and user experience.
Branding
Section titled “Branding”- Logo: Upload organization logo
- Colors: Set primary and secondary colors
- Custom CSS: Add custom styling
Layout Preferences
Section titled “Layout Preferences”- Default View: Set default view for different pages
- Items Per Page: Configure pagination settings
- Sidebar: Configure sidebar behavior
User Preferences
Section titled “User Preferences”- Date Format: Set date display format
- Time Format: Set time display format
- Currency: Set default currency
- Language: Set interface language
- Timezone: Set organization timezone
8. Security Configuration (Planned)
Section titled “8. Security Configuration (Planned)”Configure security policies and access controls.
Authentication
Section titled “Authentication”- Password Policy: Set password requirements
- Multi-Factor Authentication: Configure MFA requirements
- Session Management: Set session timeout and limits
Authorization
Section titled “Authorization”- Role-Based Access: Configure custom roles and permissions
- IP Whitelist: Restrict access by IP address
- API Access: Configure API access controls
- Logging: Configure audit logging
- Retention: Set log retention periods
- Alerts: Set up security alerts
Best Practices
Section titled “Best Practices”Configuration Management
Section titled “Configuration Management”- Start with Defaults: Begin with default configurations and adjust as needed
- Test Changes: Test configuration changes in a development environment first
- Document Changes: Keep track of configuration changes and their reasons
- Backup Configurations: Export configurations before making major changes
- Gradual Rollout: Implement changes gradually to minimize impact
Performance Considerations
Section titled “Performance Considerations”- Threshold Tuning: Adjust thresholds based on your data characteristics
- Batch Sizes: Optimize batch sizes for your data volume
- Sync Frequency: Balance sync frequency with system performance
- Resource Usage: Monitor resource usage when changing configurations
Security Best Practices
Section titled “Security Best Practices”- Principle of Least Privilege: Only grant necessary permissions
- Regular Reviews: Regularly review and audit configurations
- Secure Storage: Ensure sensitive configuration data is properly secured
- Access Control: Limit access to configuration management
Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Configuration Not Saving
Section titled “Configuration Not Saving”- Check if you have administrator permissions
- Verify the configuration is valid
- Check for network connectivity issues
- Review error messages in the browser console
Performance Issues
Section titled “Performance Issues”- Review threshold settings
- Check batch size configurations
- Monitor system resource usage
- Consider reducing sync frequency
Validation Errors
Section titled “Validation Errors”- Review validation rules
- Check data format requirements
- Verify field requirements
- Test with sample data
Getting Help
Section titled “Getting Help”- Documentation: Check this guide and other documentation
- Support: Contact support through the platform
- Community: Engage with the user community
- Training: Attend training sessions and webinars
API Reference
Section titled “API Reference”Configuration Management API
Section titled “Configuration Management API”Get Configuration
Section titled “Get Configuration”GET /api/organizations/settings/{config-type}?clerkOrganizationId={org-id}Update Configuration
Section titled “Update Configuration”PUT /api/organizations/settings/{config-type}?clerkOrganizationId={org-id}Content-Type: application/json
{ "config": { // Configuration object }}Export All Configurations
Section titled “Export All Configurations”GET /api/organizations/settings/export?clerkOrganizationId={org-id}Import Configurations
Section titled “Import Configurations”POST /api/organizations/settings/import?clerkOrganizationId={org-id}Content-Type: application/json
{ "configs": { // All configuration objects }}Configuration Types
Section titled “Configuration Types”fuzzy-matching: Fuzzy matching configurationsync: Sync schedule configurationalerting: Alerting configurationfeature-flags: Feature flags configurationbusiness-rules: Business rules configurationintegration: Integration configurationui: UI configurationsecurity: Security configuration
Migration and Upgrades
Section titled “Migration and Upgrades”Configuration Migration
Section titled “Configuration Migration”When upgrading the platform, configurations are automatically migrated to new versions. However, you should:
- Backup Configurations: Export configurations before upgrades
- Review Changes: Review any configuration changes after upgrades
- Test Functionality: Test all configured features after upgrades
- Update Documentation: Update any custom documentation
Version Compatibility
Section titled “Version Compatibility”- Configurations are backward compatible within major versions
- Breaking changes are communicated in advance
- Migration tools are provided for major version upgrades
- Support is available for configuration migration
Conclusion
Section titled “Conclusion”Organization settings provide powerful customization capabilities for the ERP-Unlocked platform. By following this guide and best practices, you can optimize your organization’s experience and maximize the value of the platform.
For additional support or questions, please contact the ERP-Unlocked support team or refer to the comprehensive documentation available in the platform.