Difference between revisions of "ImportAssist"

From WHMCS Documentation

(→‎Additionally Imported Data)
 
(43 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
ImportAssist is a tool that migrates data from external systems into a WHMCS installation.
+
== About this Addon Module ==
  
−
In addition to supporting importing of data from another WHMCS installation, ImportAssist can also import data from a number of other web based applications.
+
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==
+
<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
 +
<tr>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
 +
</tr>
 +
<tr>
 +
<td style="border:1px #AAA solid;padding:0.2em;">ImportAssist</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.3 and later*</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
 +
</tr>
 +
</table>
  
−
https://www.whmcs.com/images/available_on_marketplace.png
+
[[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.
+
'' * See below for additional import compatibility.''
  
−
https://marketplace.whmcs.com/product/46
+
== Activating ImportAssist ==
  
−
==Installation==
+
Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.
  
−
Once you've downloaded the latest version of ImportAssist from the WHMCS Marketplace, follow the steps below to install.
+
To do this:
  
−
# Unzip the zip folder download
+
# Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
−
# Upload the ''import_assist'' directory to ''/modules/addons''
+
# Unzip the ZIP file.
−
# Login to your WHMCS admin area
+
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation.
−
# Visit Setup > Addon Modules to activate (remember also to grant your admin role permission to access it post activation)
+
# Log in to the WHMCS Admin Area.
 +
# 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.
 +
# Select the admin role groups who will have access to this addon.
 +
# Click '''Save Changes'''. 
  
−
==Using ImportAssist==
+
== Using this Addon ==
  
−
Once installed and activated, ImportAssist can be accessed 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 the process of performing a data migration.
+
The system will then guide you through performing a data migration.
  
−
<div class="docs-alert-warning">We always recommend taking a full backup of your WHMCS database prior to attempting an import in-case of a need to rollback.</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 at the time of writing:
+
WHMCS ImportAssist supports importing data from the following applications and versions:
  
−
* WHMCS Version 6.2 and later
+
* 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 Version y.y
+
* Blesta Versions 2.x, 3.x, 4.1, 5.x
−
* ClientExec Version x.x
+
* ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
−
* HostBill Version z.z
+
* HostBill Versions 2016 and later
  
 +
While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.
  
−
===What will Import===
+
You can import:
−
For all of the above, the following core data will be migrated:
+
 
 +
=== WHMCS 6.2 through 7.7 ===
  
 
<div class="row">
 
<div class="row">
−
<div class="col-sm-3">Currencies</div>
+
<div class="col-sm-3">Addon</div>
−
<div class="col-sm-3">Clients</div>
+
<div class="col-sm-3">Client</div>
−
<div class="col-sm-3">Contacts</div>
+
<div class="col-sm-3">ClientGroup</div>
−
<div class="col-sm-3">Product Groups</div>
+
<div class="col-sm-3">ClientNotes</div>
−
<div class="col-sm-3">Products</div>
+
<div class="col-sm-3">ConfigOption</div>
 +
<div class="col-sm-3">ConfigOptionGroup</div>
 +
<div class="col-sm-3">ConfigOptionOption</div>
 +
<div class="col-sm-3">Contact</div>
 +
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">CustomField</div>
 +
<div class="col-sm-3">CustomFieldValue</div>
 +
<div class="col-sm-3">Domain</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 
<div class="col-sm-3">Pricing</div>
 
<div class="col-sm-3">Pricing</div>
−
<div class="col-sm-3">Support Departments</div>
+
<div class="col-sm-3">Product</div>
−
<div class="col-sm-3">Services</div>
+
<div class="col-sm-3">ProductGroup</div>
−
<div class="col-sm-3">Invoices</div>
+
<div class="col-sm-3">Promotion</div>
−
<div class="col-sm-3">Invoice Items</div>
+
<div class="col-sm-3">Server</div>
−
<div class="col-sm-3">Transactions</div>
+
<div class="col-sm-3">Service</div>
−
<div class="col-sm-3">Tickets</div>
+
<div class="col-sm-3">ServiceAddon</div>
−
<div class="col-sm-3">Ticket Replies</div>
+
<div class="col-sm-3">ServiceConfigOption</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketLog</div>
 +
<div class="col-sm-3">TicketNote</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 
</div>
 
</div>
  
 +
=== WHMCS 7.8 through 7.10 ===
  
−
====Additionally Imported Data====
+
<div class="row">
−
In addition to the core data, some systems will also import further data.
+
<div class="col-sm-3">Addon</div>
−
====='''WHMCS'''=====
+
<div class="col-sm-3">Client</div>
 +
<div class="col-sm-3">ClientGroup</div>
 +
<div class="col-sm-3">ClientNotes</div>
 +
<div class="col-sm-3">ConfigOption</div>
 +
<div class="col-sm-3">ConfigOptionGroup</div>
 +
<div class="col-sm-3">ConfigOptionOption</div>
 +
<div class="col-sm-3">Contact</div>
 +
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">CustomField</div>
 +
<div class="col-sm-3">CustomFieldValue</div>
 +
<div class="col-sm-3">Domain</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 +
<div class="col-sm-3">Pay Methods</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Promotion</div>
 +
<div class="col-sm-3">Server</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">ServiceAddon</div>
 +
<div class="col-sm-3">ServiceConfigOption</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketLog</div>
 +
<div class="col-sm-3">TicketNote</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 +
</div>
 +
 
 +
=== WHMCS 8.0 and later ===
  
 
<div class="row">
 
<div class="row">
−
<div class="col-sm-3">Client Groups</div>
+
<div class="col-sm-3">Addon</div>
−
<div class="col-sm-3">Client Notes</div>
+
<div class="col-sm-3">Client</div>
−
<div class="col-sm-3">Servers</div>
+
<div class="col-sm-3">ClientGroup</div>
−
<div class="col-sm-3">Config Option Groups</div>
+
<div class="col-sm-3">ClientNotes</div>
−
<div class="col-sm-3">Config Options</div>
+
<div class="col-sm-3">ConfigOption</div>
−
<div class="col-sm-3">Config Options Options</div>
+
<div class="col-sm-3">ConfigOptionGroup</div>
−
<div class="col-sm-3">Addons</div>
+
<div class="col-sm-3">ConfigOptionOption</div>
−
<div class="col-sm-3">Promotions</div>
+
<div class="col-sm-3">Contact</div>
−
<div class="col-sm-3">Domains</div>
+
<div class="col-sm-3">Currency</div>
−
<div class="col-sm-3">Service Addons</div>
+
<div class="col-sm-3">CustomField</div>
−
<div class="col-sm-3">Service Config Options</div>
+
<div class="col-sm-3">CustomFieldValue</div>
−
<div class="col-sm-3">Ticket Notes</div>
+
<div class="col-sm-3">Domain</div>
−
<div class="col-sm-3">Ticket Logs</div>
+
<div class="col-sm-3">Invoice</div>
−
<div class="col-sm-3">Custom Fields</div>
+
<div class="col-sm-3">InvoiceItem</div>
−
<div class="col-sm-3">Custom Field Values</div>
+
<div class="col-sm-3">Pay Methods</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Promotion</div>
 +
<div class="col-sm-3">Server</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">ServiceAddon</div>
 +
<div class="col-sm-3">ServiceConfigOption</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketLog</div>
 +
<div class="col-sm-3">TicketNote</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 +
<div class="col-sm-3">Users</div>
 
</div>
 
</div>
  
 +
=== Blesta 2.x ===
  
−
====='''ClientExec'''=====
 
 
<div class="row">
 
<div class="row">
−
<div class="col-sm-3">Servers</div>
+
<div class="col-sm-3">Client</div>
−
<div class="col-sm-3">Client Groups</div>
+
<div class="col-sm-3">Contact</div>
−
<div class="col-sm-3">Domains</div>
+
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 
</div>
 
</div>
  
−
====='''HostBill'''=====
+
=== Blesta 3.x, 4.1, 5.x ===
 +
 
 
<div class="row">
 
<div class="row">
−
<div class="col-sm-3">Domains</div>
+
<div class="col-sm-3">Client</div>
 +
<div class="col-sm-3">Contact</div>
 +
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">Domain</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketNote</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 +
</div>
 +
 
 +
=== ClientExec ===
 +
 
 +
<div class="row">
 +
<div class="col-sm-3">Client</div>
 +
<div class="col-sm-3">ClientGroup</div>
 +
<div class="col-sm-3">Contact</div>
 +
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">Domain</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Server</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 
</div>
 
</div>
  
−
==Troubleshooting==
+
=== HostBill ===
 +
 
 +
<div class="row">
 +
<div class="col-sm-3">Client</div>
 +
<div class="col-sm-3">Contact</div>
 +
<div class="col-sm-3">Currency</div>
 +
<div class="col-sm-3">Domain</div>
 +
<div class="col-sm-3">Invoice</div>
 +
<div class="col-sm-3">InvoiceItem</div>
 +
<div class="col-sm-3">Pricing</div>
 +
<div class="col-sm-3">Product</div>
 +
<div class="col-sm-3">ProductGroup</div>
 +
<div class="col-sm-3">Server</div>
 +
<div class="col-sm-3">Service</div>
 +
<div class="col-sm-3">ServiceAddon</div>
 +
<div class="col-sm-3">SupportDepartment</div>
 +
<div class="col-sm-3">Ticket</div>
 +
<div class="col-sm-3">TicketReply</div>
 +
<div class="col-sm-3">Transaction</div>
 +
</div>
 +
 
 +
== 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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[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 <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
 +
* 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.
 +
 
 +
===Import does not complete (remains processing indefinitely)===
 +
 
 +
This usually indicates that the connection to the database is terminated. Work with your server administrator or hosting provider to check and increase the MySQL <tt>wait_timeout</tt> setting, then attempt the importation again.
 +
 
 +
===Non-Latin Characters not imported correctly===
 +
 
 +
ImportAssist explicitly sets the database charset to <tt>utf8</tt> and the table collations to <tt>utf8_unicode_ci</tt> during the import process. This means that both the source and destination databases must use UTF-8.
 +
 
 +
Work with your database administrator to convert the existing data to the collations used by WHMCS.
 +
 
 +
===Can I import data from a newer version into an older version?===
 +
 
 +
It is not possible to import data from a newer version of WHMCS into an older version.
 +
You can import data from an installation on the same version or from an older version of WHMCS into a newer version.
 +
 
 +
== Change Log ==
  
−
In the unlikely event of an import failing, download a copy of the Import Log file which is made available to you during and after the import process has completed and send this along with a ticket describing the issue to our support team via www.whmcs.com/support
+
See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

Latest revision as of 21:50, 12 February 2024

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, 5.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.

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, 5.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.

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.

Import does not complete (remains processing indefinitely)

This usually indicates that the connection to the database is terminated. Work with your server administrator or hosting provider to check and increase the MySQL wait_timeout setting, then attempt the importation again.

Non-Latin Characters not imported correctly

ImportAssist explicitly sets the database charset to utf8 and the table collations to utf8_unicode_ci during the import process. This means that both the source and destination databases must use UTF-8.

Work with your database administrator to convert the existing data to the collations used by WHMCS.

Can I import data from a newer version into an older version?

It is not possible to import data from a newer version of WHMCS into an older version. You can import data from an installation on the same version or from an older version of WHMCS into a newer version.

Change Log

See the ImportAssist Marketplace listing.

Retrieved from "http://3.17.75.209/index.php?title=ImportAssist&oldid=34414"