Skip to main content

Upgrading to New Connector

With the introduction of the new PlentyONE - Magento connector, we recommend that you upgrade your existing extension to benefit from the latest advancements.

Why Upgrade?

Upgrading your connector is critical to ensuring that your system stays compatible with new changes introduced in PlentyONE.

Key Benefits

  • Magento 2.4.4+ Support - Compatible with latest Magento versions
  • PHP 8.1+ Support - Modern PHP features and improved performance
  • Updated Dependencies - All project libraries updated for latest compatibility
  • Enhanced Performance - Optimized code and better resource management
  • Improved Error Handling - Better logging and debugging capabilities
  • New Features - Access to latest integration features
  • Security Updates - Regular security patches and updates
  • Better MSI Support - Enhanced Multi-Source Inventory integration
Legacy Support Ending

The old PlentyMarkets connector is no longer maintained and does not receive updates or security patches. Upgrade as soon as possible to ensure continued compatibility and security.

Before You Begin

Important Notes

Data Loss Risk

This is a major upgrade that requires uninstalling the old module and installing the new one. You must backup your database and files before proceeding.

Profile Reconfiguration Required

Due to the complexity of profile configuration data setup, you must re-configure all your profiles after installing the new connector module. The old profile configurations are not compatible with the new system.

System Requirements

Before upgrading, ensure your system meets the requirements for the new connector:

  • Magento: 2.4.4 or higher
  • PHP: 8.1 or higher
  • Database: MySQL 8.0 or MariaDB 10.6
  • Composer: 2.2 or higher

See System Requirements for complete details.

Upgrade Process

Step 1: Backup

Create Database Backup

Create a complete backup of your database. You can use Magento's built-in backup command:

# Backup database
bin/magento setup:backup --db

# Or backup everything (db + media + code)
bin/magento setup:backup --db --media --code

Alternatively, use mysqldump utility directly:

mysqldump -u username -p database_name > backup_$(date +%Y%m%d).sql
Backup Location

Magento stores backups in var/backups/. Move these to a secure location outside your web root.

Create Filesystem Backup

Back up your PlentyMarkets extension files:

If installed manually:

# Backup app/code/Plenty directory
tar -czf plenty_backup_$(date +%Y%m%d).tar.gz app/code/Plenty/

If installed via Composer:

# Backup vendor/plenty directory
tar -czf plenty_vendor_backup_$(date +%Y%m%d).tar.gz vendor/plenty/

Export Current Configuration

Before removing the old module, document your current configuration:

  1. Take screenshots of all configuration pages in Magento Admin
  2. Export profile configurations if possible
  3. Document custom integrations or modifications
  4. Note any third-party extensions that depend on PlentyMarkets modules

Step 2: Uninstall Existing Module

Pre-Uninstallation

If your store is set to production mode, enable maintenance mode:

bin/magento maintenance:enable

Remove Extension Filesystem (Manual Installation)

If you installed the extension manually using FTP, remove the directory:

rm -rf app/code/Plenty

Verify removal:

ls app/code/ | grep -i plenty
# Should return nothing

Remove Extension Filesystem (Composer Installation)

If you installed the extension using Composer, remove all PlentyMarkets modules.

For Magento Open Source:

composer remove \
plenty/module-core \
plenty/module-customer \
plenty/module-item \
plenty/module-order \
plenty/module-stock \
plenty/module-stock-reservation \
plenty/module-stock-source-selection

For Adobe Commerce:

composer remove \
plenty/module-core \
plenty/module-customer \
plenty/module-item \
plenty/module-order \
plenty/module-stock \
plenty/module-stock-reservation \
plenty/module-stock-source-selection \
plenty/module-giftcard
Check Dependencies

Ensure to remove any extensions that depend on the core Plenty modules. Check with:

composer show | grep -i plenty

Clean Up Database

Run Magento's setup upgrade to remove database tables and configuration:

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

Verify Removal

Verify that Plenty modules are completely removed:

# Check filesystem
ls app/code/ vendor/ | grep -i plenty

# Check Magento modules
bin/magento module:status | grep -i plenty

# Should return no results

Step 3: Install New Extension

Now install the new Mage2Plenty connector.

Choose Installation Method

Depending on where you purchased the extension:

Option A: Direct Purchase (Private Packagist)

Follow the Composer Installation Guide:

# For Magento Open Source
composer require softcommerce/mage2plenty-os

# For Adobe Commerce
composer require softcommerce/mage2plenty-ac

Option B: Marketplace Purchase

Follow the Marketplace Composer Installation Guide:

# For Magento Open Source
composer require softcommerce/mage2plenty-os

# For Adobe Commerce
composer require softcommerce/mage2plenty-ac

Post Installation

Run the setup commands:

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Verify Installation

Check that the new modules are installed:

bin/magento module:status SoftCommerce_PlentyCore

# Should show as enabled

Step 4: System Configuration

After installation, configure the new connector:

  1. Navigate to Stores → Configuration → SoftCommerce → PlentyONE Client
  2. Enter your PlentyONE API credentials
  3. Configure connection settings
  4. Test the connection

See System Configuration for detailed instructions.

Step 5: Profile Configuration

Reconfigure All Profiles

Profile configurations from the old connector are not compatible with the new system. You must set up all profiles from scratch.

For each profile you had configured:

  1. Navigate to SoftCommerce → PlentyONE → Profiles
  2. Create a new profile for each entity type (Products, Orders, Inventory, etc.)
  3. Configure the profile settings based on your previous configuration
  4. Set up field mappings and synchronization rules
  5. Test each profile before enabling

See Profile Configuration for detailed guidance.

Step 6: Testing

Before disabling maintenance mode, thoroughly test the new installation:

  1. Test Connection: Verify PlentyONE API connection
  2. Test Profiles: Run each profile in test mode
  3. Check Logs: Review logs for any errors
  4. Verify Data: Ensure data is syncing correctly
  5. Test Admin: Confirm all admin features work
# Test connection
bin/magento plenty:client:test

# Run system check
bin/magento plenty:system:check

# Test specific profile (dry run)
bin/magento plenty:profile:run --profile-id=1 --dry-run

Step 7: Go Live

Once testing is complete:

# Disable maintenance mode
bin/magento maintenance:disable

# Clear all caches
bin/magento cache:flush

# Reindex if needed
bin/magento indexer:reindex

Post-Upgrade Checklist

After upgrading, verify the following:

  • All modules are enabled and functioning
  • PlentyONE API connection is working
  • All profiles are configured correctly
  • Product synchronization works
  • Order export functions properly
  • Inventory updates are syncing
  • Customer data syncs correctly
  • Cron jobs are running
  • Logs are being created properly
  • Admin interface is accessible
  • No PHP errors in system logs

Common Issues and Solutions

Profile Data Not Migrating

Issue: Old profile configurations don't carry over

Solution: This is expected. The new system uses a completely different data structure. You must reconfigure all profiles manually.

Authentication Fails

Issue: Can't connect to PlentyONE after upgrade

Solution:

  1. Re-enter your API credentials
  2. Regenerate access tokens in PlentyONE if needed
  3. Check firewall and network settings

Missing Dependencies

Issue: Composer reports missing packages

Solution:

  1. Ensure all old modules were completely removed
  2. Clear Composer cache: composer clear-cache
  3. Update Composer: composer self-update
  4. Try again with fresh authentication

Performance Issues

Issue: New connector seems slower

Solution:

  1. Enable Redis for cache and sessions
  2. Configure RabbitMQ for async processing
  3. Optimize database indexes
  4. Review profile schedules to avoid conflicts

Rollback Procedure

If you need to rollback to the old connector:

  1. Restore Database: Restore from your backup

    mysql -u username -p database_name < backup_file.sql
  2. Restore Files: Restore the backed-up files

    tar -xzf plenty_backup_file.tar.gz -C /
  3. Run Setup:

    bin/magento setup:upgrade
    bin/magento cache:flush
Consider Carefully

Rollback should only be used as a last resort. The old connector will not receive updates or support.

Getting Help

If you encounter issues during the upgrade:

  • 📧 Email Support: support@softcommerce.io
  • 📞 Phone: +44 2080 587 795 (GMT working hours)
  • 📖 Documentation: Review our comprehensive guides
  • 🐛 Bug Reports: GitHub Issues
  • 💬 Migration Assistance: We offer professional migration services

Professional Migration Service

Need help with the upgrade? We offer professional migration services:

  • ✅ Complete backup and safety planning
  • ✅ Expert installation and configuration
  • ✅ Profile migration and setup
  • ✅ Testing and validation
  • ✅ Training on new features
  • ✅ Post-migration support

Contact us at support@softcommerce.io for a quote.

Next Steps

After successfully upgrading:

  1. 📋 Initial Setup - Complete the configuration
  2. 📊 Profile Setup - Configure synchronization profiles
  3. 📈 Monitoring - Set up monitoring and alerts
  4. 🔄 Schedule Sync - Configure automated synchronization

FAQ

How long does the upgrade take?

Typically 2-4 hours including backup, installation, and configuration. More complex setups may take longer.

Will I lose my data?

No, if you backup properly. The database data remains intact. Only module-specific configuration needs to be reconfigured.

Can I upgrade without downtime?

For production sites, we recommend using a staging environment first, then migrating to production during a maintenance window.

Is the new connector backward compatible?

No, the new connector uses a completely different architecture. You cannot run both connectors simultaneously.

What happens to my order history?

All order history in Magento remains intact. You just need to reconfigure how new orders sync to PlentyONE.