Difference between revisions of "ImportAssist"

From WHMCS Documentation

m (→‎Blesta 3.x, 4.x)
Line 7: Line 7:
 
[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]
 
[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]
  
−
ImportAssist is available via the WHMCS Marketplace. To download it, visit the ImportAssist Marketplace listing.
+
ImportAssist is available via the WHMCS Marketplace. To download it, visit [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
−
 
 
−
https://marketplace.whmcs.com/product/46
 
  
 
==Installation==
 
==Installation==
  
−
Once downloaded, follow the steps below to install ImportAssist.
+
To install ImportAssist, perform the following steps:
  
−
# Unzip the zip folder download
+
# Unzip the ZIP file that you downloaded.
−
# Upload the ''import_assist'' directory to ''/modules/addons''
+
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt>.
−
# Login to your WHMCS admin area
+
# Log in to the WHMCS Admin Area.
−
# Visit '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > 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.
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
 +
# Perform the displayed steps to complete activation.
 +
# Grant your admin role permission to access it post-activation.
  
 
==Using ImportAssist==
 
==Using ImportAssist==
  
−
Once installed and activated, access ImportAssist by navigating to ''Addons > ImportAssist for WHMCS''
+
You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''.
  
−
A wizard based process will then guide you through performing a data migration.
+
The system will then guide you through performing a data migration.
  
−
<div class="docs-alert-warning">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.</div>
+
<div class="docs-alert-warning">
 +
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.
 +
</div>
  
−
==Supported Scripts & Versions==
+
==Supported Scripts and Versions==
  
−
WHMCS ImportAssist supports importing data from the following applications and versions at the time of writing:
+
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
 
* 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
Line 37: Line 39:
 
* HostBill Versions 2016 and later
 
* 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.
+
While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.
  
 
==What will Import==
 
==What will Import==
−
The data that can be migrated varies by software:
+
 
 +
The data that can be migrated varies:
  
 
====WHMCS 6.2 - 7.7====
 
====WHMCS 6.2 - 7.7====
Line 222: Line 225:
 
==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 our support team.  
+
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''' in a Technical Support ticket describing the issue.
  
 
===Unable to connect to the database===
 
===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).
+
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:
−
* 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
+
* Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
−
* MySQL service on the source server is online and remotely accessible
+
* 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 <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
−
* 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.
+
* 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.
 +
* 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.

Revision as of 14:30, 15 September 2021

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.

Installation

To install ImportAssist, perform the following steps:

  1. Unzip the ZIP file that you downloaded.
  2. Upload the import_assist directory to /modules/addons.
  3. Log in to the WHMCS Admin Area.
  4. Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  5. Perform the displayed steps to complete activation.
  6. Grant your admin role permission to access it post-activation.

Using ImportAssist

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
  • 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 other software versions may be possible, use of these versions is unsupported.

What will Import

The data that can be migrated varies:

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

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 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.
Retrieved from "http://3.17.75.209/index.php?title=ImportAssist&oldid=30723"