Configuration Overview

Magento FreeAgent Integration configuration is organized into several sections, each managing different aspects of the Magento-FreeAgent integration. This page provides an overview of all configuration areas and how they relate to each other.

Configuration Sections

1. FreeAgent Integration

Path: Stores > Configuration > Byte8 > FreeAgent Integration

Controls the connection between Magento and FreeAgent:

Section	Purpose
Authentication	OAuth credentials, client mode (production/sandbox)
API Settings	Connection retry, timeouts, request settings
Contact Configuration	API logging for contact sync
Invoice Configuration	API logging for invoice sync
Credit Memo Configuration	API logging for credit memo sync

Learn more: Client Configuration

2. Profile Configuration

Path: Stores > Configuration > Byte8 > Profile Configuration

Controls how synchronization profiles operate:

Section	Purpose
Profile Settings	History retention period
Profile Notifications	Notification system, email alerts, log levels

Learn more: Profile Configuration

3. Profile-Specific Configuration

Path: Byte8 > FreeAgent > Profiles > [Profile Name]

Each synchronization profile has its own configuration:

Section	Purpose
Client	FreeAgent client connection for this profile
Schedule	Cron scheduling, batch size, retry settings
HTTP API	API behavior configuration
Entity Settings	Entity-specific export/import settings

Configuration Hierarchy

Magento FreeAgent Integration follows Magento's standard configuration scope hierarchy:

Global (Default)
    └── Website
         └── Store View

Most FreeAgent-specific settings operate at the Global scope since there is a single FreeAgent client connection per installation.

Configuration Flow

For a new installation, configure in this order:

1. Client Connection (Authentication)
       ↓
2. API Settings (Timeouts, retry)
       ↓
3. Profile Settings (History, notifications)
       ↓
4. Create Profiles (Contact, Invoice, Credit Memo)
       ↓
5. Profile Schedules (Automation)

Best Practices

Security

• Store API credentials securely (they are encrypted in the database)
• Use sandbox mode for development and testing
• Restrict admin access to configuration sections via ACL roles

Performance

• Set appropriate API timeouts for your network
• Configure retry attempts based on API reliability
• Use queue-based processing for large data volumes
• Adjust profile batch sizes based on server resources

Maintenance

• Set appropriate history retention periods
• Enable email notifications for production environments
• Monitor log files regularly
• Keep the extension updated for latest improvements

Environment-Specific Configuration

Development

# Use sandbox mode
bin/magento config:set freeagent/auth/mode 1

# Short history retention
bin/magento config:set byte8_profile/profile_config/history_lifetime 3

# Verbose logging
bin/magento config:set freeagent/contact_config/is_api_log_enabled 1
bin/magento config:set freeagent/invoice_config/is_api_log_enabled 1
bin/magento config:set freeagent/creditmemo_config/is_api_log_enabled 1

Production

# Use production mode
bin/magento config:set freeagent/auth/mode 0

# Extended history retention
bin/magento config:set byte8_profile/profile_config/history_lifetime 30

# Disable verbose API logging
bin/magento config:set freeagent/contact_config/is_api_log_enabled 0
bin/magento config:set freeagent/invoice_config/is_api_log_enabled 0
bin/magento config:set freeagent/creditmemo_config/is_api_log_enabled 0

Next Steps

1. Client Configuration - Set up FreeAgent API connection
2. Profile Configuration - Configure profile settings
3. About Profiles - Understand profile types