Difference between revisions of "Migration Guide"

From WHMCS Documentation

(Redirected page to Importing Data)
 
m (copied over from importing data in preparation to redirect it here)
 
Line 1: Line 1:
#REDIRECT [[Importing_Data]]
+
We understand that the majority of companies already have a billing system in place to manage their hosting clients and are worried by the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.
 +
 
 +
==ImportAssist==
 +
 
 +
[[File:import_assist_banner_2.png|link=https://marketplace.whmcs.com/product/46]]
 +
 
 +
When performing a migration from another billing system or WHMCS installation, we recommend using our ImportAssist addon that supports multiple billing systems to import from. At this time, the following are supported:
 +
 
 +
* WHMCS Version 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
 +
* Blesta Version 2.x, 3.x
 +
* ClientExec Version 5.3+
 +
* HostBill 2016 Version
 +
 
 +
For detailed information on obtaining and using ImportAssist, please refer to [[ImportAssist]].
 +
 
 +
==Server Sync Tool==
 +
 
 +
<div class="docs-alert-info">This section refers to a new feature in WHMCS 7.8. To import services from a cPanel server when using WHMCS 7.7 and older, please refer to the cPanel/WHM Import section below.</div>
 +
 
 +
In WHMCS 7.8, we've introduced a new Server Sync Tool that can compare and sync details from cPanel, Plesk and DirectAdmin servers. This is particularly useful for performing an initial import when first starting with WHMCS, but can also be used for other purposes, such as identifying and importing missing domains, syncing usernames & package info and terminating inactive domains.
 +
 
 +
Detailed information on how it works and how to use it can be found at the [[Server_Sync_Tool|Server Sync Tool page]].
 +
 
 +
==WHM/cPanel Import Script==
 +
When using WHMCS 7.7 or older, the WHM Import Tool can be accessed using the Utilities menu.  This will allow you to import all the domains from your existing cPanel/WHM servers.  Instructions for use can be found on the separate [[CPanel/WHM_Import|CPanel/WHM Import page]].
 +
 
 +
==Manual Entry==
 +
We understand that the ImportAssist addon and Server Sync Tool may not always meet your needs for adding clients and their items, for example if a client needs to be added manually and their items are not tied to a hosting account and/or domain registrar. In such circumstances, it is possible to add clients and their items manually via the admin area using the instructions below.
 +
 
 +
===Adding Clients===
 +
To manually import your clients, use the following steps for each client:
 +
 
 +
#Go to Clients > Add New Client
 +
#Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
 +
#Untick the box to send a New Account Information Message (if desired)
 +
#Click Add Client
 +
 
 +
You have now finished adding your client.  By following the steps above, your client will have not been notified that you've added them (if chosen) and you can now add the applicable items to their account as needed as described below.
 +
 
 +
===Adding Services===
 +
Once the clients have been added, you can proceed to add their services (such as hosting accounts).  You do this as follows for each client:
 +
 
 +
#On the Client Summary page, click the "Add New Order" link in the "Actions" panel.
 +
#The client will be pre-selected, so you should fill out the rest of the form - begin by choosing the payment gateway you want their future invoices to use.
 +
# Choose the applicable product/service and billing cycle for the service(s).
 +
# If the service has an associated domain name, enter it in the box provided.  If the domain name is registered with you, select the "Register" option on the domain section below and choose any addons the user has for their domain.
 +
#Untick the boxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding.
 +
#Set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS.
 +
 
 +
After doing so, you will now be shown the order details page and it will summarise the details of the order you just added.
 +
 
 +
As the final step, go into the service details and set the correct next due date.  To do this from the order details page, click on the link in the "Item" column of the items ordered - this will take you straight to the service details page.  From there, you can edit the next due payment date (and for hosting accounts, select the correct server and enter the username for the account to allow suspensions & terminations to be performed by WHMCS).
 +
 
 +
===Adding Domains===
 +
To add a domain on its own without a product, follow the steps below:
 +
 
 +
#On the Client Summary page, click the "Add New Order" link in the "Actions" panel
 +
#The client will be pre-selected, so you should fill out the rest of the form - begin by choosing the payment gateway you want their future invoices to use.
 +
#Leave the Product/Service dropdown menu set at None
 +
#Leave the Billing Cycle dropdown menu for the product section set at Monthly
 +
#Enter the domain in the Domain text field and select "Register" as the Domain Registration Option (even though you aren't intending to register it today)
 +
#Choose the number of years you want the client to be invoiced for at the time of renewal and tick any addons the user has for their domain
 +
#Untick the boxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding.
 +
#Set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS.
 +
 
 +
After doing so, you will now be shown the order details page and it will summarise the details of the order you just added.
 +
 
 +
As the final step, go to the domain's information page to enter the correct next due and expiry dates, as well as selecting the registrar that the domain is registered with (if a registrar module is present and active).  To do this from the order details page, click on the link in the "Item" column of the items ordered - this will take you straight to the domain details page.

Latest revision as of 20:11, 15 August 2019

We understand that the majority of companies already have a billing system in place to manage their hosting clients and are worried by the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.

ImportAssist

Import assist banner 2.png

When performing a migration from another billing system or WHMCS installation, we recommend using our ImportAssist addon that supports multiple billing systems to import from. At this time, the following are supported:

  • WHMCS Version 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
  • Blesta Version 2.x, 3.x
  • ClientExec Version 5.3+
  • HostBill 2016 Version

For detailed information on obtaining and using ImportAssist, please refer to ImportAssist.

Server Sync Tool

This section refers to a new feature in WHMCS 7.8. To import services from a cPanel server when using WHMCS 7.7 and older, please refer to the cPanel/WHM Import section below.

In WHMCS 7.8, we've introduced a new Server Sync Tool that can compare and sync details from cPanel, Plesk and DirectAdmin servers. This is particularly useful for performing an initial import when first starting with WHMCS, but can also be used for other purposes, such as identifying and importing missing domains, syncing usernames & package info and terminating inactive domains.

Detailed information on how it works and how to use it can be found at the Server Sync Tool page.

WHM/cPanel Import Script

When using WHMCS 7.7 or older, the WHM Import Tool can be accessed using the Utilities menu. This will allow you to import all the domains from your existing cPanel/WHM servers. Instructions for use can be found on the separate CPanel/WHM Import page.

Manual Entry

We understand that the ImportAssist addon and Server Sync Tool may not always meet your needs for adding clients and their items, for example if a client needs to be added manually and their items are not tied to a hosting account and/or domain registrar. In such circumstances, it is possible to add clients and their items manually via the admin area using the instructions below.

Adding Clients

To manually import your clients, use the following steps for each client:

  1. Go to Clients > Add New Client
  2. Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
  3. Untick the box to send a New Account Information Message (if desired)
  4. Click Add Client

You have now finished adding your client. By following the steps above, your client will have not been notified that you've added them (if chosen) and you can now add the applicable items to their account as needed as described below.

Adding Services

Once the clients have been added, you can proceed to add their services (such as hosting accounts). You do this as follows for each client:

  1. On the Client Summary page, click the "Add New Order" link in the "Actions" panel.
  2. The client will be pre-selected, so you should fill out the rest of the form - begin by choosing the payment gateway you want their future invoices to use.
  3. Choose the applicable product/service and billing cycle for the service(s).
  4. If the service has an associated domain name, enter it in the box provided. If the domain name is registered with you, select the "Register" option on the domain section below and choose any addons the user has for their domain.
  5. Untick the boxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding.
  6. Set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS.

After doing so, you will now be shown the order details page and it will summarise the details of the order you just added.

As the final step, go into the service details and set the correct next due date. To do this from the order details page, click on the link in the "Item" column of the items ordered - this will take you straight to the service details page. From there, you can edit the next due payment date (and for hosting accounts, select the correct server and enter the username for the account to allow suspensions & terminations to be performed by WHMCS).

Adding Domains

To add a domain on its own without a product, follow the steps below:

  1. On the Client Summary page, click the "Add New Order" link in the "Actions" panel
  2. The client will be pre-selected, so you should fill out the rest of the form - begin by choosing the payment gateway you want their future invoices to use.
  3. Leave the Product/Service dropdown menu set at None
  4. Leave the Billing Cycle dropdown menu for the product section set at Monthly
  5. Enter the domain in the Domain text field and select "Register" as the Domain Registration Option (even though you aren't intending to register it today)
  6. Choose the number of years you want the client to be invoiced for at the time of renewal and tick any addons the user has for their domain
  7. Untick the boxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding.
  8. Set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS.

After doing so, you will now be shown the order details page and it will summarise the details of the order you just added.

As the final step, go to the domain's information page to enter the correct next due and expiry dates, as well as selecting the registrar that the domain is registered with (if a registrar module is present and active). To do this from the order details page, click on the link in the "Item" column of the items ordered - this will take you straight to the domain details page.