Personal tools
Namespaces

Variants
Actions

Domain Allocator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Integration Code)
(Management)
Line 130: Line 130:
 
=Management=
 
=Management=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you the possibilities of Domain Allocator For WHMCS.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you the possibilities of Domain Allocator For WHMCS.'''<br/>
 
Our module allows you to ....
 
Our module allows you to ....
 +
|}
  
==Dashboard==
+
==Admin Area==
 +
===Dashboard===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|At the '' 'Settings' '' tab you can set up the module's behavior. Configure gateway settings and default redirection rules.
+
|style="padding: 10px 0px 15px 15px;"|Here you can see the detailed list of parked domains for each client.<br/>At this point it is possible to manage them.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 25px;"|[[File:DAlloc_9.png]]
 
|style="padding: 0px 0px 15px 25px;"|[[File:DAlloc_9.png]]
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Settings' '' select whether you want to allow only the two module gateways: '' 'Credit Card Per Country / State' '' and '' 'Redirect Per Country / State'. ''
 
Select '' 'Module Gateway Only' '' option -  then,  only the two above mentioned module gateways will be shown as payment options in the client area.<br />
 
'' 'Apply Switching Rules' '' - if selected, only gateways allowed by the defined switching rules are allowed in client area as payment methods.
 
|}
 
{|
 
|style="padding: 0px 0px 10px 25px;"|[[File:DAlloc_9_1.png]]
 
|}
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Still, you have to set up '' 'Default Redirection Rules', '' no matter which option is selected in '' 'Gateway Settings'. ''<br/>
 
Choose:
 
*'' 'Default CC Gateway' '' - it will be used with '' 'Credit Card Per Country / State' '' module gateway.
 
*'' 'Default Redirection Gateway' '' - it will be used with '' 'Redirect Per Country / State' '' module gateway.<br/>
 
Do not forget to save the changes when ready!
 
 
|}
 
|}
 
{|
 
{|
Line 159: Line 146:
 
|}
 
|}
  
==Products Configuration==
+
===Products Configuration===
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' tab you will find the list of your products. Here you can enable or disable automatic domain assignment for each of them.<br/>
 
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' tab you will find the list of your products. Here you can enable or disable automatic domain assignment for each of them.<br/>
Line 167: Line 154:
 
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_10.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_10.png]]
 
|}
 
|}
 +
 
===Integration Code===
 
===Integration Code===
 
{|
 
{|
Line 198: Line 186:
 
|}
 
|}
  
<!--
+
==Client Area==
===Modify Switching Rules===
+
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|In order to modify switching rules, expand the desired payment gateway configuration by pressing it.
+
|style="padding: 10px 0px 15px 15px;"|Your customers can perform various actions on their domains from the client area.<br/>Read the description below to see exactly what can be done.  
 
|}
 
|}
 +
===Manage Assignment===
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
+
|style="padding: 10px 0px 20px 15px;"|In the client area proceed to '' 'Domains' → My Domains' ''. Here clients can view basic information related to domains and perform several actions on them.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Configuration on the following screen allows this gateway to be used from United Kingdom and two states of the US - California and Texas.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
Both the country and the state in each configuration are modifiable.<br />
+
Select a desired option and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_13.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|To move a rule to a different gateway, press '' 'Change Gateway', '' select the desired gateway and press '' 'Save Configuration'. ''
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Manage Assignment' '' to assign domain to Web Hosting Account. Select preferred options from the dropdown menu and click '' 'Submit' '' button.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_14_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_14.png]]
 
|}
 
|}
-->
 
  
===Payment Gateways On The Order Form===
+
===Register Domain===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Payment Gateway Allocator For WHMCS affects only client area. Let's take a look how the addon affects the payments process.
+
|style="padding: 10px 0px 15px 15px;"|It is also possible to register a completely new domain. Go to '' 'Domains' 'Register a New Domain' '' and type in a name to check its availability.<br/>If so, add it to cart and click 'Checkout'.
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Case One:'''<br/>
+
'' 'Credit Card Per Country / State' '' and '' 'Redirect Per Country / State' '' payment methods have been activated.
+
 
|}
 
|}
 
{|
 
{|
Line 234: Line 215:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|In '' 'Setting' ''  section option '' 'Module Gateway Only' '' has been selected together with two default gateways for '' 'Credit Card' '' and '' 'Redirection' '' payments.
+
|style="padding: 0px 0px 15px 15px;"|Details will be visible now. '' 'Manage Assignment' '' to assign domain to already existing Web Hosting Account is one of the choices. Just select preferred options from the dropdown menu and click '' 'Submit' '' button.
 
|}
 
|}
 
{|
 
{|
Line 240: Line 221:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Consequently, client may now choose only between:
+
|style="padding: 0px 0px 15px 15px;"|Apart from that, a new account can be ordered. To do so, press '' 'Order New Hosting Account' '' button and select the hosting that suits your needs most.
*'' 'Pay With Credit Card' '' option - in our case it will be '' 'SecurePay' '' gateway.
+
*'' 'Proceed To Payment' '' option - in our case it will be '' '2CheckOut' '' gateway.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Case Two:'''<br/>
+
In another scenario, in '' 'Settings' '' section of the module '' 'Apply Switching Rules' '' option is selected.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_1.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Switches' '' section, there is a rule forcing clients from United States to pay with '' '2CheckOut' '' payment gateway.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_2.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Consequently, client Test Tester, who is from USA, has no choice, but to pay with the enforced by the admin payment gateway.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_15_3.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''Case Three:'''<br/>
+
To allow all gateways in the client area, proceed to the addon → '' 'Settings' '' page and clear the settings. <br />
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_16.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Let's check payment options in the client area once again. Now, your clients are able to pay using every active payment gateway. <br/>
+
However, when selecting '' 'Pay With Credit Card' '' or '' 'Proceed To Payment' '' option, client will be redirected to a gateway keeping any switching rules.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:DAlloc_17.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|If you wish to hide only part of the gateways, for example only those for which switching rules are set, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. ''<br />
+
Afterwards, uncheck '' 'Show On Order Form' '' checkbox next to the desired gateway and press '' 'Save Changes'. '' Repeat this step for each gateway you wish to hide from the client area.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DAlloc_15.png]]
 
|}
 
|}
  

Revision as of 18:17, 15 February 2017

Contents

About Domain Allocator For WHMCS

Domain Allocator For WHMCS allows you to integrate available domains ... .

The module supports cPanel, Direct Admin and Plesk.


Moduł dołączający domeny jako addon domains z integracją z cpanel/da/plesk.


  • Admin Area Features:
  • Client Area Features:
  • Supported Modules:
✔ DirectAdmin & DirectAdmin Extended For WHMCS
✔ cPanel & cPanel Extended For WHMCS
✔ Plesk & Plesk Extended For WHMCS
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure Domain Allocator For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to your client area and download Domain Allocator For WHMCS.
DAlloc 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

DAlloc 2.png
3. When you install Domain Allocator for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/PGPC/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

DAlloc 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'.

DAlloc 4.png

Addon Configuration

5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules'. Afterwards, find 'Domain Allocator' and press 'Activate' button.

DAlloc 5.png
6. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'.

DAlloc 6.png

|}

DAlloc 7.png
8. Afterwards, move to 'Manage Existing Gateways' to rename them. Press 'Save Changes'.

These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Domain Allocator.

DAlloc 8.png
9. You have just successfully installed Domain Allocator For WHMCS!

-->

Management

In this section we will show you the possibilities of Domain Allocator For WHMCS.

Our module allows you to ....

Admin Area

Dashboard

Here you can see the detailed list of parked domains for each client.
At this point it is possible to manage them.
DAlloc 9.png
File:DAlloc 9 2.png

Products Configuration

In 'Configuration' tab you will find the list of your products. Here you can enable or disable automatic domain assignment for each of them.

Note that not all submodules are supported thus management of your other products will not be available.

DAlloc 10.png

Integration Code

In order to allow your clients to manage assignment, follow these steps.
1. Open the file found in the below directory.
templates/orderforms/standard_card/configuredomains.tpl
2. Delete the line:
{if $domain.hosting}[{$LANG.cartdomainshashosting}]{else}<a href="cart.php" style="color:#cc0000;">[{$LANG.cartdomainsnohosting}]</a>{/if}
and add the proper code:
DAlloc 12.png
3. You can see correctly placed code below.
DAlloc 12.png
4. This is how it should be seen in the client area.
DAlloc 12.png

Client Area

Your customers can perform various actions on their domains from the client area.
Read the description below to see exactly what can be done.

Manage Assignment

In the client area proceed to 'Domains' → My Domains' . Here clients can view basic information related to domains and perform several actions on them.
DAlloc 13.png
DAlloc 13.png
Press 'Manage Assignment' to assign domain to Web Hosting Account. Select preferred options from the dropdown menu and click 'Submit' button.
DAlloc 14.png

Register Domain

It is also possible to register a completely new domain. Go to 'Domains' → 'Register a New Domain' and type in a name to check its availability.
If so, add it to cart and click 'Checkout'.
DAlloc 13.png
Details will be visible now. 'Manage Assignment' to assign domain to already existing Web Hosting Account is one of the choices. Just select preferred options from the dropdown menu and click 'Submit' button.
DAlloc 14.png
Apart from that, a new account can be ordered. To do so, press 'Order New Hosting Account' button and select the hosting that suits your needs most.
DAlloc 15.png

Tips

1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in 'Setup' → 'Payments' → 'Payment Gateways'.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Domain Allocator For WHMCS