Get Started

User Import Export is a comprehensive Joomla component for managing user data through import and export operations. It provides a powerful yet user-friendly interface for exporting users to various file formats and importing users from external files.

Key Features

• Export users to CSV, Excel (XLSX), JSON, XML, and SQL formats
• Import users from CSV, Excel, JSON, and XML files
• Intelligent field mapping with auto-detection
• Pre-import validation to prevent errors
• Reusable export/import templates
• Complete operation logs with audit trail
• Export user groups, profiles, notes, and custom fields
• Flexible filtering by groups, status, and date range
• Dashboard with statistics and quick actions
• Joomla 5 & 6 compatible

Perfect For

• Migrating users between Joomla sites
• Backing up user data
• Bulk user creation from external systems
• Generating user reports
• Synchronizing user data with other platforms
• Creating user lists for marketing purposes

User Import Export simplifies user data management with an intuitive interface and powerful features, making it easy to move user data in and out of your Joomla site.

Downloading the Component

After purchasing the extension, you will receive a download link for the component file: com_userimportexport.zip

Installing the Component

1. Log in to your Joomla backend
2. Navigate to System > Install > Extensions
3. Drag and drop the com_userimportexport.zip file or click "Upload Package File" to browse
4. The installation will process automatically
5. A success message will be displayed once complete

System Requirements

• Joomla: 5.0 or higher (5.x, 6.x supported)
• PHP: 8.1 or higher (8.2+ recommended)
• MySQL: 5.7 or higher / MariaDB 10.3+

Optional Requirements

For Excel (XLSX) support:

• PhpSpreadsheet library is required
• Install via Composer: composer require phpoffice/phpspreadsheet
• If not installed, CSV format is still fully functional

After Installation

Access the component from Components > User Import Export

You will see the dashboard with:

• User statistics overview
• Quick action buttons for Export and Import
• Recent operations summary
• Template and log counts

Post-Installation Checklist

1. Review component options (Options button in toolbar)
2. Set default export format preferences
3. Configure password handling for security
4. Set log retention period
5. Configure user group access permissions

How to Export Users

Exporting users is a straightforward process with full control over the exported data.

Step 1: Access Export

1. Navigate to Components > User Import Export
2. Click Export in the submenu or dashboard

Step 2: Choose Export Format

Select your preferred format:

• CSV: Universal spreadsheet format with configurable delimiter
• Excel (XLSX): Professional spreadsheet with styled headers (requires PhpSpreadsheet)
• JSON: Structured data for APIs and applications
• XML: Standard data interchange format
• SQL: Database migration scripts with INSERT statements

Step 3: Select Fields

Choose which user data to include:

• Core Fields: ID, username, name, email, registration date, last visit, block status
• User Groups: Group names and IDs
• Profile Data: Address, city, country, phone, website, about me, DOB
• User Notes: Administrator notes for users
• Custom Fields: Any com_users custom fields

Step 4: Apply Filters (Optional)

Filter which users to export:

• User Groups: Export only specific user groups
• Status: Active, blocked, or all users
• Date Range: Filter by registration date

Step 5: Configure Options

• Password Handling: Exclude passwords, include hash, or use placeholder
• CSV Delimiter: Comma, semicolon, tab, or pipe

Step 6: Preview and Export

1. Click Preview to see sample data before exporting
2. Review the preview to confirm field selection
3. Click Export to download the file

Saving as Template

To save your export configuration for future use:

1. Configure your export settings (format, fields, filters)
2. Click Save as Template
3. Enter a template name and save
4. Access saved templates from Templates menu

How to Import Users

Import users from external files with intelligent field mapping and validation.

Step 1: Prepare Your Import File

Create or obtain a file in one of these formats:

• CSV: Comma-separated values file
• Excel (XLSX/XLS): Excel spreadsheet
• JSON: JSON array of user objects
• XML: XML file with user records

Tip: Download the sample template from the Import page to see the expected format.

Step 2: Upload File

1. Navigate to Components > User Import Export > Import
2. Drag and drop your file onto the upload area, or click to browse
3. Supported files: CSV, XLSX, XLS, JSON, XML

Step 3: Map Fields

After upload, you'll see the mapping interface:

• Auto-Detect: Click to automatically map fields based on column names
• Manual Mapping: Use dropdowns to map each file column to a Joomla field
• Preview: See sample data from your file

Required Fields

At minimum, you must map:

• Username (required)
• Email (required)
• Name (recommended)

Step 4: Configure Import Options

• Import Mode:
  • Add New Only: Only create new users, skip existing
  • Update Existing Only: Only update existing users, skip new
  • Add and Update: Create new and update existing users
• Default User Group: Assign users to a group if not specified
• Password Handling:
  • Generate Random: Create secure random passwords
  • Import from File: Use passwords from import file
  • Require Reset: Force password reset on first login

Step 5: Validate

1. Click Validate to check data before importing
2. Review validation results:
• Valid records count
• Duplicate emails/usernames
• Missing required fields
• Invalid data warnings
3. Fix any issues in your source file if needed

Step 6: Import

1. Click Import to begin the import process
2. Monitor progress during import
3. Review results showing created/updated/skipped counts

Sample CSV Format

Here's an example of a CSV file for importing users:

username,email,name,password,groups,block,profile_phone,profile_city
johndoe,john@example.com,John Doe,ChangeMe123!,Registered,0,+1234567890,New York
janedoe,jane@example.com,Jane Doe,SecurePass456!,"Registered, Author",0,+0987654321,Los Angeles
bobsmith,bob@example.com,Bob Smith,,Registered,0,,London

Field Explanations

JSON Format

[
  {
    "username": "johndoe",
    "email": "john@example.com",
    "name": "John Doe",
    "groups": ["Registered"]
  },
  {
    "username": "janedoe",
    "email": "jane@example.com",
    "name": "Jane Doe",
    "groups": ["Registered", "Author"]
  }
]

XML Format

<users>
  <user>
    <username>johndoe</username>
    <email>john@example.com</email>
    <name>John Doe</name>
    <groups>Registered</groups>
  </user>
</users>

Download Sample Template

Click the Download Sample Template button on the Import page to get a pre-formatted CSV file with example data.

Tips for Successful Import

• Ensure usernames are unique (3-150 characters)
• Use valid email addresses
• For multiple groups, separate with commas
• Leave password empty to auto-generate
• Use UTF-8 encoding for special characters
• Test with a small batch first

Saving and Using Templates

Templates allow you to save export/import configurations for repeated use, saving time and ensuring consistency.

What Templates Save

Export templates store:

• Selected export format (CSV, Excel, JSON, etc.)
• Selected fields to export
• Filter settings (groups, status, date range)
• Export options (password handling, delimiter)

Import templates store:

• Field mapping configuration
• Import mode settings
• Default user group
• Password handling options

Creating a Template

1. Configure your export or import settings
2. Click Save as Template
3. Enter a descriptive name (e.g., "Monthly User Report")
4. Click Save

Using a Template

1. Navigate to Components > User Import Export > Templates
2. Find your template in the list
3. Click the template name to view details
4. Click Run to execute the template immediately

Managing Templates

From the Templates list, you can:

• Edit: Modify template settings
• Delete: Remove templates no longer needed
• Run: Execute the template immediately
• Filter: Filter by export or import type
• Search: Find templates by name

Template Best Practices

• Use descriptive names that indicate purpose
• Create separate templates for different export needs
• Review templates periodically to remove outdated ones
• Document template purposes for team members

Common Template Use Cases

• Monthly User Report: Export all active users to Excel
• Newsletter Subscribers: Export email list for marketing
• Backup All Users: Full export including all fields
• New Staff Import: Import settings for HR bulk adds
• User Sync: Update existing users from external system

Understanding Operation Logs

Every export and import operation is logged for audit purposes and file recovery.

What Logs Capture

• Operation Type: Export or Import
• Date/Time: When the operation occurred
• User: Who performed the operation
• Status: Success, partial, or failed
• Record Count: Number of users processed
• Format: File format used
• Details: Specific configuration and results

Accessing Logs

1. Navigate to Components > User Import Export > Logs
2. View the list of all operations

Log Features

Filtering

• Filter by operation type (Export/Import)
• Search by date or details
• Sort by date, type, or status

Re-Download Exports

For export operations, you can re-download the generated file:

1. Find the export operation in the logs
2. Click the Download button if the file is still available
3. Files are retained based on log retention settings

View Details

Click on any log entry to see:

• Full configuration used
• Field selections
• Filter criteria
• Any errors or warnings
• Processing statistics

Clearing Old Logs

1. Click Clear Old Logs button
2. Select how many days of logs to keep
3. Confirm deletion
4. Old logs and associated export files are removed

Log Retention

Configure log retention in component options:

• Set number of days to keep logs
• Export files are deleted when logs are cleared
• Set to 0 to keep logs indefinitely

Security Considerations

• Export files contain sensitive user data
• Set appropriate log retention periods
• Regularly clear old logs for security
• Restrict log access to authorized administrators only

Component Options

Access component configuration via the Options button in the toolbar.

Export Settings

• Default Export Format: CSV, Excel, JSON, XML, or SQL
• CSV Delimiter: Comma, semicolon, tab, or pipe
• Password Handling:
  • Exclude: Don't include passwords (recommended)
  • Include Hash: Include the password hash
  • Placeholder: Use a placeholder text

Import Settings

• Default Password Action:
  • Generate: Create secure random passwords
  • Import: Use passwords from file
  • Reset Required: Force password reset
• Default User Group: Group for users without specified group
• Batch Size: Number of users processed per batch

Log Settings

• Log Retention Days: How long to keep operation logs
• Auto-cleanup: Automatically remove old logs

Permissions

Configure access permissions for different user groups:

Recommended Configuration

• Set password handling to Exclude for security
• Set log retention to 30-90 days
• Configure batch size based on server resources (100-500)
• Restrict import permissions to Super Users or trusted admins

Common Use Cases

Site Migration

Moving users from one Joomla site to another:

1. Export users from source site to CSV/JSON
2. Transfer file to new site
3. Import users using "Add New Only" mode
4. Users receive password reset emails

Bulk User Registration

Adding multiple users from HR or external system:

1. Prepare user list in CSV format
2. Map required fields (username, email, name)
3. Set default user group
4. Import with "Generate Password" option
5. Notify users of their new accounts

User Data Backup

Regular backup of user data:

1. Create template with all fields selected
2. Run export template periodically
3. Store export files securely
4. Delete old logs after backup confirmation

Marketing Email Lists

Export users for email marketing:

1. Select only name and email fields
2. Filter by active users only
3. Export to CSV
4. Import to email marketing platform

User Synchronization

Sync users with external CRM or database:

1. Export users to JSON/XML format
2. Process in external system
3. Import updates using "Update Existing" mode
4. New users added, existing updated

User Reports

Generate reports for management:

1. Filter by specific user groups
2. Export to Excel for professional formatting
3. Include registration dates for analysis
4. Save template for monthly reports

Database Migration

Moving to different database system:

1. Export to SQL format
2. Get INSERT statements ready
3. Modify for target database if needed
4. Execute SQL on new system

User Cleanup

Identify and manage inactive users:

1. Export all users with last visit date
2. Analyze in spreadsheet
3. Identify users inactive for X months
4. Take appropriate action (notify, block, delete)

Frequently Asked Questions

What Joomla versions are supported?

• User Import Export is compatible with Joomla 5.x and 6.x.

Can I export user passwords?

• Passwords are stored as hashes in Joomla. You can export the hash, exclude passwords, or use a placeholder. Plain text passwords cannot be exported.

What happens if I import a user that already exists?

• Depends on import mode: "Add New Only" skips existing users, "Update Existing" updates them, "Add and Update" does both.

How do I handle passwords during import?

• You can import plain text passwords (will be hashed), generate random passwords, or require password reset on first login.

Why can't I export to Excel?

• Excel export requires the PhpSpreadsheet library. Install it via Composer: composer require phpoffice/phpspreadsheet

Can I import users into specific groups?

• Yes, include a "groups" column in your import file with group names separated by commas, or set a default user group in options.

How do I import profile data?

• Use columns prefixed with "profile_" (e.g., profile_phone, profile_city, profile_address) to map to user profile fields.

What if my import fails partway through?

• Check the operation logs for details. Successfully imported users remain in the system. Fix issues and re-import with "Update Existing" mode.

Can I schedule automatic exports?

• Templates can be combined with Joomla's Task Scheduler for automated exports in future versions.

How long are export files kept?

• Export files are retained based on log retention settings. When logs are cleared, associated files are also deleted.

Is user data secure during export?

• Export files are stored in a protected folder. Always download and store exported data securely, as it may contain sensitive information.

Can I export custom fields?

• Yes, all custom fields created for com_users are automatically detected and available for export.

Common Issues and Solutions

Export Issues

Export button not working

• Check browser console for JavaScript errors
• Ensure you have export permission
• Clear Joomla cache and try again
• Check PHP error logs for server-side issues

Excel export not available

• PhpSpreadsheet library is required
• Install via Composer: composer require phpoffice/phpspreadsheet
• Use CSV format as alternative

Export file is empty

• Check filter settings - they may be too restrictive
• Ensure at least one field is selected
• Verify users exist in the selected groups

Import Issues

File upload fails

• Check PHP upload_max_filesize setting
• Verify file format is supported (CSV, XLSX, JSON, XML)
• Ensure file is not corrupted

Field mapping not working

• Ensure column headers are in the first row
• Check for special characters in headers
• Use standard field names for auto-detection

Validation errors

• Username must be unique and 3-150 characters
• Email must be valid and unique
• Required fields cannot be empty

Import partially fails

• Check logs for specific error details
• Identify problematic rows in source file
• Fix issues and re-import remaining users

General Issues

Component options error

• Ensure config.xml exists in component folder
• Clear Joomla cache
• Verify file permissions

Preview modal not opening

• Check for JavaScript conflicts
• Ensure Bootstrap is loading
• Try clearing browser cache

Timeout during large operations

• Reduce batch size in options
• Increase PHP max_execution_time
• Process in smaller batches

Getting Help

If issues persist:

• Check Joomla error logs
• Review browser console for JavaScript errors
• Contact support with detailed error information
• Include Joomla and PHP versions in support requests