Difference between revisions of "ImportAssist"

From WHMCS Documentation

(Installation)
(Troubleshooting)
Line 187: Line 187:
 
==Troubleshooting==
 
==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. Send the import log along with a ticket describing the issue to the support team. You can contact our support team at [http://www.whmcs.com/support/ www.whmcs.com/support].
+
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. Send the import log along with a ticket describing the issue to our support team.  
 +
 
 +
===Unable to connect to the database===
 +
This error means ImportAssist cannot establish a connection to the source database whose data is being imported. The following points to check will usually resolve this error:
 +
 
 +
* Valid database connection details entered into ImportAssist and update accordingly (for example, if you recently changed the password or renamed the database itself).
 +
* Database host is valid relative to the WHMCS installation upon which ImportAssist is being used. 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 [https://docs.cpanel.net/cpanel/databases/remote-mysql/ Remote MySQL Access] is permitted on the source server
 +
* 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, as this is needed for the connection to be established.

Revision as of 12:45, 12 November 2020

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.

Download ImportAssist

Available on marketplace.png

ImportAssist is available via the WHMCS Marketplace. To download it, visit the ImportAssist Marketplace listing.

https://marketplace.whmcs.com/product/46

Installation

Once downloaded, follow the steps below to install ImportAssist.

  1. Unzip the zip folder download
  2. Upload the import_assist directory to /modules/addons
  3. Login to your WHMCS admin area
  4. Visit Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules to activate. Then, grant your admin role permission to access it post activation.

Using ImportAssist

Once installed and activated, access ImportAssist by navigating to Addons > ImportAssist for WHMCS

A wizard based process will then guide you through performing a data migration.

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

Supported Scripts & Versions

WHMCS ImportAssist supports importing data from the following applications and versions at the time of writing:

  • 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
  • Blesta Versions 2.x, 3.x, 4.x
  • 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 versions of the software outside of those listed above may be possible, please be advised it is unsupported.

What will Import

The data that can be migrated varies by software:

WHMCS 6.2 - 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+

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
Pay Methods

Blesta 2.x

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

Blesta 3.x, 4.x

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. Send the import log along with a ticket describing the issue to our support team.

Unable to connect to the database

This error means ImportAssist cannot establish a connection to the source database whose data is being imported. The following points to check will usually resolve this error:

  • Valid database connection details entered into ImportAssist and update accordingly (for example, if you recently changed the password or renamed the database itself).
  • Database host is valid relative to the WHMCS installation upon which ImportAssist is being used. 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
  • 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, as this is needed for the connection to be established.