ImportAssist

From WHMCS Documentation

Revision as of 16:47, 21 February 2023 by David (talk | contribs) (Supported Scripts and Versions)

About this Addon Module

ImportAssist is a tool that migrates data from external systems into a WHMCS installation. In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web-based billing applications.

Addon Name Latest Release Current Version Compatible With Included in WHMCS
ImportAssist N/A N/A WHMCS 8.3 and later* No

Available on marketplace.png

* See below for additional import compatibility.

Activating ImportAssist

Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.

To do this:

  1. Download ImportAssist from the ImportAssist Marketplace listing.
  2. Unzip the ZIP file.
  3. Upload the import_assist directory to /modules/addons in your WHMCS installation.
  4. Log in to the WHMCS Admin Area.
  5. Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  6. Perform the displayed steps to complete activation.
  7. Select the admin role groups who will have access to this addon.
  8. Click Save Changes.

Using this Addon

You can access activated installations of ImportAssist by navigating to Addons > ImportAssist for WHMCS.

The system will then guide you through performing a data migration.

We recommend taking a full backup of your WHMCS database before performing any import. This will allow you to revert your changes in case of problems.

Supported Scripts and Versions

WHMCS ImportAssist supports importing data from the following applications and versions:

  • WHMCS Versions 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x, 7.8.x, 7.9.x, 7.10.x, 8.0x, v8.1.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x, 8.6.x, 8.7.x
  • Blesta Versions 2.x, 3.x, 4.1
  • ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
  • HostBill Versions 2016 and later

While performing imports from other software versions may be possible, use of these versions is unsupported.

You can import:

WHMCS 6.2 through 7.7

Addon
Client
ClientGroup
ClientNotes
ConfigOption
ConfigOptionGroup
ConfigOptionOption
Contact
Currency
CustomField
CustomFieldValue
Domain
Invoice
InvoiceItem
Pricing
Product
ProductGroup
Promotion
Server
Service
ServiceAddon
ServiceConfigOption
SupportDepartment
Ticket
TicketLog
TicketNote
TicketReply
Transaction

WHMCS 7.8 through 7.10

Addon
Client
ClientGroup
ClientNotes
ConfigOption
ConfigOptionGroup
ConfigOptionOption
Contact
Currency
CustomField
CustomFieldValue
Domain
Invoice
InvoiceItem
Pay Methods
Pricing
Product
ProductGroup
Promotion
Server
Service
ServiceAddon
ServiceConfigOption
SupportDepartment
Ticket
TicketLog
TicketNote
TicketReply
Transaction

WHMCS 8.0 and later

Addon
Client
ClientGroup
ClientNotes
ConfigOption
ConfigOptionGroup
ConfigOptionOption
Contact
Currency
CustomField
CustomFieldValue
Domain
Invoice
InvoiceItem
Pay Methods
Pricing
Product
ProductGroup
Promotion
Server
Service
ServiceAddon
ServiceConfigOption
SupportDepartment
Ticket
TicketLog
TicketNote
TicketReply
Transaction
Users

Blesta 2.x

Client
Contact
Currency
Invoice
InvoiceItem
Pricing
Product
ProductGroup
Service
SupportDepartment
Ticket
TicketReply
Transaction

Blesta 3.x, 4.1

Client
Contact
Currency
Domain
Invoice
InvoiceItem
Pricing
Product
ProductGroup
Service
SupportDepartment
Ticket
TicketNote
TicketReply
Transaction

ClientExec

Client
ClientGroup
Contact
Currency
Domain
Invoice
InvoiceItem
Pricing
Product
ProductGroup
Server
Service
SupportDepartment
Ticket
TicketReply
Transaction

HostBill

Client
Contact
Currency
Domain
Invoice
InvoiceItem
Pricing
Product
ProductGroup
Server
Service
ServiceAddon
SupportDepartment
Ticket
TicketReply
Transaction

Troubleshooting

In the unlikely event of an import failure, download a copy of the Import Log. The Import Log is available to download during and after the import process.

For help with any problems, send us the Import Log at Configuration () > System Logs or, in WHMCS 8.0 and earlier, Utilities > Logs in a Technical Support ticket describing the issue.

Unable to connect to the database

This error indicates that ImportAssist cannot establish a connection to the source database from which the data is being imported. Check the following points to resolve this error:

  • Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
  • The database host is valid relative to the WHMCS installation that is using ImportAssist. If the source database is located on the same server, try using localhost or 127.0. 0.1.
  • If the source data is remote, ensure that remote MySQL® access is permitted on the source server.
  • The MySQL service on the source server is online and remotely accessible.
  • The specified MySQL user has been assigned to the desired database and given full access to it.

Change Log

N/A