Difference between revisions of "ImportAssist"
From WHMCS Documentation
(→Supported Scripts and Versions) |
|||
| Line 1: | Line 1: | ||
| − | + | == About this Addon Module == | |
| − | In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web based billing 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. |
| − | == | + | <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 6.2 and later*</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td> | ||
| + | </tr> | ||
| + | </table> | ||
[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]] | [[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]] | ||
| − | + | '' * See below for additional compatibility.'' | |
| − | == | + | == Activating ImportAssist == |
| − | + | Before you can activate ImportAssist, you must download it from the WHMCS Marketplace. | |
| − | # Unzip the ZIP file | + | To do this: |
| − | # Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt>. | + | |
| + | # Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing]. | ||
| + | # Unzip the ZIP file. | ||
| + | # Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation. | ||
# Log in to the WHMCS Admin Area. | # 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'''. | # 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. | # Perform the displayed steps to complete activation. | ||
| − | # | + | # Select the admin role groups who will have access to this addon. |
| + | # Click '''Save Changes'''. | ||
| − | ==Using | + | == Using this Addon == |
You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''. | You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''. | ||
| Line 30: | Line 49: | ||
</div> | </div> | ||
| − | ==Supported Scripts and Versions== | + | == Supported Scripts and Versions == |
WHMCS ImportAssist supports importing data from the following applications and versions: | WHMCS ImportAssist supports importing data from the following applications and versions: | ||
| Line 41: | Line 60: | ||
While performing imports from other software versions may be possible, use of these versions is '''unsupported'''. | 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 === | |
<div class="row"> | <div class="row"> | ||
| Line 78: | Line 95: | ||
</div> | </div> | ||
| − | + | === WHMCS 7.8 through 7.10 === | |
<div class="row"> | <div class="row"> | ||
| Line 112: | Line 129: | ||
</div> | </div> | ||
| − | + | === WHMCS 8.0 and later === | |
<div class="row"> | <div class="row"> | ||
| Line 147: | Line 164: | ||
</div> | </div> | ||
| − | + | === Blesta 2.x === | |
| + | |||
<div class="row"> | <div class="row"> | ||
<div class="col-sm-3">Client</div> | <div class="col-sm-3">Client</div> | ||
| Line 164: | Line 182: | ||
</div> | </div> | ||
| − | + | === Blesta 3.x, 4.1 === | |
| + | |||
<div class="row"> | <div class="row"> | ||
<div class="col-sm-3">Client</div> | <div class="col-sm-3">Client</div> | ||
| Line 183: | Line 202: | ||
</div> | </div> | ||
| − | + | === ClientExec === | |
| + | |||
<div class="row"> | <div class="row"> | ||
<div class="col-sm-3">Client</div> | <div class="col-sm-3">Client</div> | ||
| Line 203: | Line 223: | ||
</div> | </div> | ||
| − | + | === HostBill === | |
| + | |||
<div class="row"> | <div class="row"> | ||
<div class="col-sm-3">Client</div> | <div class="col-sm-3">Client</div> | ||
| Line 223: | Line 244: | ||
</div> | </div> | ||
| − | ==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. | 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. | ||
| Line 229: | Line 250: | ||
For help with any problems, send us the '''Import Log''' in a Technical Support ticket describing the issue. | 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 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: | 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: | ||
| Line 238: | Line 259: | ||
* The MySQL service on the source server is online and remotely accessible. | * 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. | * The specified MySQL user has been assigned to the desired database and given full access to it. | ||
| + | |||
| + | == Change Log == | ||
| + | |||
| + | ''N/A'' | ||
Revision as of 21:34, 16 March 2022
Contents
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 6.2 and later* | No |
* See below for additional compatibility.
Activating ImportAssist
Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.
To do this:
- Download ImportAssist from the ImportAssist Marketplace listing.
- Unzip the ZIP file.
- Upload the import_assist directory to /modules/addons in your WHMCS installation.
- Log in to the WHMCS Admin Area.
- Go to Configuration () > 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 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
- 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 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