Difference between revisions of "Reseller Central"

From WHMCS Documentation

m
(Optional Location Choice Menu)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The Reseller Central module allows you to add and manage Reseller Central servers in WHMCS.
 +
 +
Reseller Central is [http://www.hostnine.com HostNine's] server control panel that interfaces with cPanel & WHM and Plesk to create a more user-friendly front end to control your clients.
 
{{Provisioning_Module
 
{{Provisioning_Module
 
| terminate = No}}
 
| terminate = No}}
== What is Reseller Central ==
+
== Adding a Reseller Central Server ==
Reseller Central is a Server Control panel that interfaces with WHM AND Plesk to create a more user friendly front end to control your clients.
+
 
Reseller Central is created, written and maintained by HostNine (http://www.hostnine.com)
+
To set up a Reseller Central server in WHMCS:
 +
 +
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
 +
# Click '''Add New Server'''.
 +
# Select ''Reseller Central'' from the menu.
 +
# Enter the hostname or IP address.
 +
# Enter the username and password or access hash.
 +
# Click '''Continue'''.
 +
# Enter the desired additional server details.
 +
# Click '''Save Changes'''.
 +
# If this is the only Reseller Central server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
 +
 
 +
=== Creating an Reseller Central Product === 
 
   
 
   
This step by step guide explains how to setup your WHMCS to work with the Reseller Central system offered by HostNineThere are two things you need to do, the first is to configure a server and then the next is to configure your packages.
+
You can create a product that provisions accounts on your Reseller Central server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.   
 +
 
 +
==== Required Custom Fields ====
 +
 
 +
When you do this, you must also configure an '''IP Address''' custom field to use in email templates with the <tt>{$service_custom_field_ipaddress}</tt> merge field.
  
== Configuring the Reseller Central Server ==
+
==== Optional Location Choice Menu ====
  
#All server modules require a server, so begin by going to '''Setup > Products/Services > Servers'''
+
<div class="docs-alert-info">
#Next, click on the Add New Server link
+
You can only offer this option for Linux hosting products.
#On the screen that is presented, next you need to enter the details about the server.  There are only 2 fields required for the Reseller Central system and they are the server name and type, however you can enter your username and password if you wish to enter your Reseller Central username and password.  In the type dropdown, make sure you select ResellerCentral.
+
</div>
  
== Configuring your Reseller Central Packages ==
+
To allow your customer to choose their hosting location:
  
#Go to '''Setup > Products/Services > Products/Services'''
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
#Click on the Create New Product link at the top of the page (you will need to have at least one group setup first)
+
# Edit the desired hosting product.
#On the following page, enter the new name for your Package and choose the group you want to assign it to
+
# Choose the '''Custom Fields''' tab.
#After clicking the submit button, you will then see all the options for this new package - from here you need to configure the description shown on the order form, pricing and any other details
+
# For '''Field Name''', enter <tt>Website Location</tt>. You must enter this value exactly.
#Once you have selected the options you want for this package, you are ready to go to the Modules Settings tab to configure the module settings
+
# For '''Field Type''', select ''Drop Down''.
#From the Server Type dropdown, choose "Resellercentral"
+
# For '''Field Options''', enter a comma-separated list of the options to offer. For example:<br><tt>Berkshire (UK),California (USA),Chicago (USA),Georgia (USA),New York (USA),Singapore (ASIA),Texas (USA),Washington DC (USA)</tt>
#The required fields for the module will then be displayed which include your API Key which you get from your Reseller Central panel, the Package Name as setup in the Reseller Central panel and the location you want the account to be setup in
+
# Check '''Show on Order Form'''.
#You should also choose at this point whether to setup a Windows or Linux hosting Account. ''(Windows hosting is only available in Texas)''
+
# Click '''Save Changes'''.
#You must complete all the fields and then click Save to save the changes to the product
 
#Finally, you need to create a custom field on the product to store the IP assigned by Reseller Central for each account - to do this go to the Custom Fields tab and add a custom field named "IP Address" - you can then use this in the email templates with the merge field {$service_custom_field_ipaddress}
 
#That's it! You have now completed the configuration of your Reseller Central Package.
 
  
== Offering Clients a Location Choice Dropdown (Optional) ==
+
=== WHMCS Connect ===
* *'''Linux Hosting Only'''*
 
  
As you will be aware, when creating an account you can choose the location you want the account to be hosted in.  With WHMCS, you can take that further and allow your client to choose where their hosting account is hosted. To do this, follow the steps below:
+
This module does not support [[WHMCS Connect]].
  
#Click the edit icon next to an existing Reseller Central package which you have created
+
==Troubleshooting==
#Next, click on the Custom Fields tab at the top of the page
 
#Now, in the Field Name box, enter "Website Location" - this is what is used to identify what the field defines so it must be entered exactly as shown
 
#In the field type dropdown, choose "Drop Down"
 
#Now in the Field Options box, enter a comma separate list of the options you want to offer - below are all the options which you can copy and paste if you want to offer your clients all of them:<br><br>Berkshire (UK),California (USA),Chicago (USA),Georgia (USA),New York (USA),Singapore (ASIA),Texas (USA),Washington DC (USA)
 
#Next tick the Show on Order Form checkbox
 
#Finally, click Save Changes and that's it (it really is that easy!) - now this field will show during the order process and the value your customer selects will override the default setting on the Server Settings tab.
 
  
== Common Error Messages ==
 
 
===No Matching Location Found===
 
===No Matching Location Found===
 +
 
This error message is saying that the location selection in Module Settings for this package is no longer offered by Reseller Central. You will need to choose a different option in the product configuration page and check that your location list is accurate and up to date.
 
This error message is saying that the location selection in Module Settings for this package is no longer offered by Reseller Central. You will need to choose a different option in the product configuration page and check that your location list is accurate and up to date.
  
 
{{modules}}
 
{{modules}}

Latest revision as of 15:40, 3 May 2022

About this Module

The Reseller Central module allows you to add and manage Reseller Central servers in WHMCS.

Reseller Central is HostNine's server control panel that interfaces with cPanel & WHM and Plesk to create a more user-friendly front end to control your clients.

Supported Features

Create Suspend Unsuspend Terminate
Yes Yes Yes No
Change Package Change Password Usage Updates Client Area Link
No No No No


Adding a Reseller Central Server

To set up a Reseller Central server in WHMCS:

  1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
  2. Click Add New Server.
  3. Select Reseller Central from the menu.
  4. Enter the hostname or IP address.
  5. Enter the username and password or access hash.
  6. Click Continue.
  7. Enter the desired additional server details.
  8. Click Save Changes.
  9. If this is the only Reseller Central server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating an Reseller Central Product

You can create a product that provisions accounts on your Reseller Central server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

Required Custom Fields

When you do this, you must also configure an IP Address custom field to use in email templates with the {$service_custom_field_ipaddress} merge field.

Optional Location Choice Menu

You can only offer this option for Linux hosting products.

To allow your customer to choose their hosting location:

  1. Go to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.
  2. Edit the desired hosting product.
  3. Choose the Custom Fields tab.
  4. For Field Name, enter Website Location. You must enter this value exactly.
  5. For Field Type, select Drop Down.
  6. For Field Options, enter a comma-separated list of the options to offer. For example:
    Berkshire (UK),California (USA),Chicago (USA),Georgia (USA),New York (USA),Singapore (ASIA),Texas (USA),Washington DC (USA)
  7. Check Show on Order Form.
  8. Click Save Changes.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

No Matching Location Found

This error message is saying that the location selection in Module Settings for this package is no longer offered by Reseller Central. You will need to choose a different option in the product configuration page and check that your location list is accurate and up to date.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible