Difference between revisions of "Migration Guide"

From WHMCS Documentation

m (→‎Adding Services)
(→‎ImportAssist)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
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.
+
We understand that the majority of companies already have a billing system in place to manage their hosting clients and worry about 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.
 +
 
 +
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Migration Services:</b> Contact our team to discuss our migration services.</small></em><span class="button">Services</span></a></html>
  
 
==ImportAssist==
 
==ImportAssist==
Line 5: Line 7:
 
[[File:import_assist_banner_2.png|link=https://marketplace.whmcs.com/product/46]]
 
[[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:
+
When performing a migration from another billing system or WHMCS installation, we recommend using our ImportAssist addon, which supports importing data from multiple billing systems. At this time, this supports the following systems:
  
 
* 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
 
* 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
+
* Blesta Version 2.x, 3.x, 4.1, 5.x
 
* ClientExec Version 5.3+
 
* ClientExec Version 5.3+
 
* HostBill 2016 Version
 
* HostBill 2016 Version
  
−
For detailed information on obtaining and using ImportAssist, please refer to [[ImportAssist]].
+
For detailed information on obtaining and using ImportAssist, see [[ImportAssist]].
  
 
==Server Sync Tool==
 
==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 and later, you can compare and sync details from cPanel, Plesk and DirectAdmin servers using the '''[[Server Sync Tool]]''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.  
  
−
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.
+
This is particularly useful for performing an initial import when first starting with WHMCS, but you can also use it for other purposes, such as identifying and importing missing domains, syncing usernames and package information, 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]].
+
==cPanel & WHM Import Script==
  
−
==WHM/cPanel Import Script==
+
In WHMCS 7.7 or older, you can import all of the domains on your existing cPanel & WHM servers using the tools at '''Utilities > [[CPanel/WHM_Import|WHM Import Tool]]'''.
−
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==
 
==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.
+
 
 +
We understand that the ImportAssist addon and Server Sync Tool may not always meet your needs for adding clients and their items (for example, when you need to add a client manually and there is no associated hosting account or domain registrar for their items). In these circumstances, it is possible to add clients and their items manually via the admin area using the instructions below.
  
 
===Adding Clients===
 
===Adding Clients===
 +
 
To manually import your clients, use the following steps for each client:
 
To manually import your clients, use the following steps for each client:
  
−
#Go to Clients > Add New Client
+
#Go to '''Clients > Add New Client'''.
−
#Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
+
#Fill out the client details. You must provide, at least, the first and last names, email address, and password.
−
#Untick the box to send a New Account Information Message (if desired)
+
#Optionally, deselect the checkbox to send a '''New Account Information Message'''.
−
#Click Add Client
+
#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.
+
You have now finished adding your client. However, the system will not automatically notify your client that you added them. You can now add the applicable items to their account in the section below.
  
 
===Adding Services===
 
===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.
+
Once you have added the clients, you can proceed to add their services (such as hosting accounts).  Perform the following steps for each client:
−
#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 ''Order Confirmation'' and ''Generate 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.
+
# In the '''[[Clients:Summary Tab|Summary]]''' tab in the client profile, click '''Add New Order'''. The system will preselect the client.
 +
# Fill out the rest of the form, beginning with choosing the payment gateway you want their future invoices to use.
 +
# Choose the applicable product or service and the billing cycle.
 +
# If the service has an associated domain name, enter it in the textbox.
 +
# If you also control the domain name registration, select ''Register'' on the domain section below and choose any addons the user has for their domain.
 +
# Deselect the boxes for '''Order Confirmation''' and '''Generate Invoice'''. This will ensure that the system doesn't email the client about the order you are adding.
 +
# Select '''Active''' from the '''Order Status''' menu.
 +
# Click '''Submit'''.
  
−
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).
+
The system will display the order details page, which will summarise the details of the order you 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 to the service details page. From there, you can edit the next due payment date. For hosting accounts, select the correct server and enter the username for the account to allow WHMCS to perform suspensions and terminations.
  
 
===Adding Domains===
 
===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.
+
To add a domain without a product:
  
−
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.
+
# In the '''[[Clients:Summary Tab|Summary]]''' tab in the client profile, click the  '''Add New Order''' link in the '''Actions''' panel. The system will preselect the client.
 +
# Fill out the rest of the form, beginning with choosing the payment gateway for future invoices to use by default.
 +
# Select '''Active''' from the '''Order Status''' menu.
 +
# Deselect the checkboxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding and no invoice is raised.
 +
# Select '''Registration''' for the domain registration type. The domain fields will then be shown.
 +
# Enter the domain in the '''Domain''' field.
 +
# Choose the number of years you want to invoice the client for at the time of renewal.
 +
# Select any addons that the user has for their domain such as DNS Management.
 +
# Click '''Submit''' to add the order to WHMCS. The system will display the order details page, which will summarise the details of the order you added.
 +
# Click '''Domain''' in the '''Item''' column to check whether the next due date, expiry date, and registrar settings are correct. Make any necessary updates and then click '''Save Changes'''.

Latest revision as of 07:31, 24 May 2024

We understand that the majority of companies already have a billing system in place to manage their hosting clients and worry about 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.

Migration Services: Contact our team to discuss our migration services.Services

ImportAssist

Import assist banner 2.png

When performing a migration from another billing system or WHMCS installation, we recommend using our ImportAssist addon, which supports importing data from multiple billing systems. At this time, this supports the following systems:

  • 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, 4.1, 5.x
  • ClientExec Version 5.3+
  • HostBill 2016 Version

For detailed information on obtaining and using ImportAssist, see ImportAssist.

Server Sync Tool

In WHMCS 7.8 and later, you can compare and sync details from cPanel, Plesk and DirectAdmin servers using the Server Sync Tool at Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.

This is particularly useful for performing an initial import when first starting with WHMCS, but you can also use it for other purposes, such as identifying and importing missing domains, syncing usernames and package information, and terminating inactive domains.

cPanel & WHM Import Script

In WHMCS 7.7 or older, you can import all of the domains on your existing cPanel & WHM servers using the tools at Utilities > WHM Import Tool.

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, when you need to add a client manually and there is no associated hosting account or domain registrar for their items). In these 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 client details. You must provide, at least, the first and last names, email address, and password.
  3. Optionally, deselect the checkbox to send a New Account Information Message.
  4. Click Add Client.

You have now finished adding your client. However, the system will not automatically notify your client that you added them. You can now add the applicable items to their account in the section below.

Adding Services

Once you have added the clients, you can proceed to add their services (such as hosting accounts). Perform the following steps for each client:

  1. In the Summary tab in the client profile, click Add New Order. The system will preselect the client.
  2. Fill out the rest of the form, beginning with choosing the payment gateway you want their future invoices to use.
  3. Choose the applicable product or service and the billing cycle.
  4. If the service has an associated domain name, enter it in the textbox.
  5. If you also control the domain name registration, select Register on the domain section below and choose any addons the user has for their domain.
  6. Deselect the boxes for Order Confirmation and Generate Invoice. This will ensure that the system doesn't email the client about the order you are adding.
  7. Select Active from the Order Status menu.
  8. Click Submit.

The system will display the order details page, which will summarise the details of the order you 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 to the service details page. From there, you can edit the next due payment date. For hosting accounts, select the correct server and enter the username for the account to allow WHMCS to perform suspensions and terminations.

Adding Domains

To add a domain without a product:

  1. In the Summary tab in the client profile, click the Add New Order link in the Actions panel. The system will preselect the client.
  2. Fill out the rest of the form, beginning with choosing the payment gateway for future invoices to use by default.
  3. Select Active from the Order Status menu.
  4. Deselect the checkboxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding and no invoice is raised.
  5. Select Registration for the domain registration type. The domain fields will then be shown.
  6. Enter the domain in the Domain field.
  7. Choose the number of years you want to invoice the client for at the time of renewal.
  8. Select any addons that the user has for their domain such as DNS Management.
  9. Click Submit to add the order to WHMCS. The system will display the order details page, which will summarise the details of the order you added.
  10. Click Domain in the Item column to check whether the next due date, expiry date, and registrar settings are correct. Make any necessary updates and then click Save Changes.
Retrieved from "http://3.17.75.209/index.php?title=Migration_Guide&oldid=34577"