Personal tools
Namespaces

Variants
Actions

Domain Orders Extended For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<meta name="keywords" content="domain orders extended for whmcs, domain orders extended configuration, whmcs domain orders extended management, whmcs domain orders extended in...")
 
Line 4: Line 4:
 
{|
 
{|
 
|style="padding: 10px 0px 5px 0px;"|'''Domain Orders Extended For WHMCS''' allows you to group domains into categories and perform bulk actions on multiple domains.<br />
 
|style="padding: 10px 0px 5px 0px;"|'''Domain Orders Extended For WHMCS''' allows you to group domains into categories and perform bulk actions on multiple domains.<br />
−
The module lets your clients perform multiple lookup and checkout for domain names in a single request, in the entirely new domain order form in the WHMCS client area.<br />
+
You will be free to import predefined sets of TLDs, apply easily adjustable domain labels,  plus regulate the priority and order of TLDs.<br />
−
Worth mentioning feature is a domain spinner based on eNom and OpenSRS that will automatically suggest your clients domain names which may interest them.<br />
+
The module lets your clients perform multiple lookup and checkout for domain names in a single request, browse suggestions powered by three built-in domain spinners.<br />
 
In addition, the module supports gTLDs and ccTLDs allowing your customers to conveniently order their favorite domain names without leaving your website.
 
In addition, the module supports gTLDs and ccTLDs allowing your customers to conveniently order their favorite domain names without leaving your website.
 
|}
 
|}
Line 11: Line 11:
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Three Custom Domain Order Forms - Support For gTLDs And ccTLDs
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Three External Domain Search Forms
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Bulk Search Order Form
+
|style="padding: 0px 0px 0px 30px;"|✔ Fast Cron Domain Lookup
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Domain Spinners (Name Suggestions) - Based On eNom And OpenSRS
+
|style="padding: 0px 0px 0px 30px;"|✔ Simultaneous Domain Searches In Multiple Spinners
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Lookup For Domains In One Request - Supports eNom And OpenSRS
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Domain Name Suggestions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Checkout Of Domains In One Request
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Domain Labels
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Ajax Search - One By One
+
|style="padding: 0px 0px 0px 30px;"|✔ Display TLDs Basing On Defined Prioritization And Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ External Forms - Three Types Of Lookup
+
|style="padding: 0px 0px 10px 30px;"|✔ Multiple Checkout Of Domains In One Request
 
|}
 
|}
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
Line 36: Line 36:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Make Bulk Changes On Multiple TLDs:
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Promoted Categories And TLDs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Create
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Order Of Categories, Subcategories And TLDs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Set Pricing
+
|style="padding: 0px 0px 0px 30px;"|✔ Perform Bulk Changes On Multiple TLDs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Domain Prices - Fixed Or Percentage
+
|style="padding: 0px 0px 0px 45px;"|✔ Change TLD Categories And Registrars
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Delete Categories, Prices And TLDs
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Domain Pricing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Categories And Registrars
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Domain Labels
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Lookup Submodules
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Promoted TLDs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Lookup Submodule - eNom, OpenSRS Or Default
+
|style="padding: 0px 0px 0px 45px;"|✔ Delete TLDs From Categories
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Search Form - Multiple Domains, Single Domain Or Category Search
+
|style="padding: 0px 0px 0px 30px;"|✔ Import TLD Sets To Categories From Predefined List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Prefixes And Suffixes Of Suggested Domains
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Lookup Submodules:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Import TLD Sets From Predefined List
+
|style="padding: 0px 0px 0px 45px;"|✔ Default Or Custom WHMCS Provider
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ TLDs Filtering
+
|style="padding: 0px 0px 0px 45px;"|✔ OpenSRS
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Migration Tool
+
|style="padding: 0px 0px 0px 45px;"|✔ eNom
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ gTLDs & ccTLDs Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Add Your Own Lookup Submodules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ IDN Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Set TLDs Searched By Default
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Domains Reseller For WHMCS</u> - Efficient Domains Reselling With Your Own API [http://www.modulesgarden.com/products/whmcs/domains_reseller/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Search Of Domain Suggestions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Customized TLD Labels
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Search Form:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 45px;"|✔ List View
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 45px;"|✔ General Category View
 
|}
 
|}
−
 
−
=Installation=
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install Domain Orders Extended For WHMCS.''' <br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Multi Category View
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Cron Domain Lookup:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Simultaneous Processes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 10px 45px;"|✔ Define Number Of Search Records Per Process
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ gTLDs & ccTLDs Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ IDN Support
−
The content of PHP version files should look like this.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:sdfse.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Domain Orders Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7
−
File is located in '' 'modules/addons/TLDsForm/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
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'. ''
+
 
|}
 
|}
 +
 +
=Installation=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE4.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install Domain Orders Extended For WHMCS.''' <br />
 +
We will guide you step by step through the whole installation and configuration process. <br/><br/>
 +
'' '''Note:''' If you are still using any of the module's previous versions '''prior to v3.x''', [https://www.docs.modulesgarden.com/Domain_Orders_Extended_2.X_For_WHMCS follow these instructions].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
−
Afterwards, find '' 'Domain Orders Extended' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the downloaded file into the main WHMCS directory.'''<br />
−
To do so, click on '' 'Configure' '' button, select administrator groups which should have access to this addon and press '' 'Save Changes'. ''
+
The content of the package should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_2.png]]
 
|}
 
|}
 +
<!--
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Domain Orders Extended For WHMCS!'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2.png]]
−
You can access your module in '' 'Addons' '' → '' 'Domain Orders Extended'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE7.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
 +
The content of PHP version files should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. The last step concerns confirming the usage of default WHMCS lookup module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_2.png]]
−
Go to '' 'Settings' '' tab and press '' 'Update Settings' '' button.
+
|}-->
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Domain Orders Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
You can find it in '' 'modules/addons/DomainOrdersExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_7_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_3.png]]
 
|}
 
|}
−
 
−
=Configuration and Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Domain Orders Extended will help you with the management of your domains and their pricing.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
−
It will also reduce the time required to do any actions on the domains due to implemented bulk actions feature.<br />
+
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'. ''
−
Additionally, you can group TLDs into categories and decide which TLD is assigned to which registrar.
+
 
|}
 
|}
−
==Add Category==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's start from creating a category, go to your addon → '' 'Domain Categories'. ''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_4.png]]
−
Afterwards, enter category name into '' 'Categories Names' '' field and press '' 'Create Categories' '' button.<br />
+
−
''Note: You can create a multiple quantity of categories at once. To do so, simply fill in one category per line in '' 'Categories Names' '' field.''
+
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_8.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system. '''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 +
Afterwards, find '' 'Domain Orders Extended' '' and press '' 'Activate' '' button.
 
|}
 
|}
−
==New TLD==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In order to add a new TLD, go to your addon → '' 'Bulk Actions'. ''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_5.png]]
−
Afterwards, press '' 'Add TLD To List' '' button and type your TLD '''(both '' 'com' '' and '' '.com' '' forms are acceptable)'''.<br />
+
−
''Note: You can create a multiple quantity of TLDs at once by repeating this step.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_9.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
 +
To do so, click on '' 'Configure' '' button, select administrator groups which should have access to this addon and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, select a previously created category, unmark '' 'Toggle Autoupdate Mode' '' and enter pricing for the chosen TLDs.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_6.png]]
−
To disable pricing term, mark '' 'Toggle 0 and -1 Price Ignoring' '' checkbox and type '' '0' '' for Register or '' '-1' ''for Transfer and Renew.<br />
+
−
On the following screen you can see 2 TLDs with only 2 payment terms enabled for Register, Transfer and Renew.<br />
+
−
''Note 1: Autoupdate mode will automatically fill in the fields, on the right side of field you are currently filling in, with incremented values.''<br />
+
−
''Note 2: While '' 'Toggle 0 and -1 Price Ignoring' '' is enabled, you need to make changes in TLD's yearly price to apply other price changes for selected TLD.''<br/>
+
−
''Note 3: Disable single currency for selected term by unchecking box next to it.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_10.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, set up the  '' 'storage' '' folder as writable.'''<br />
 +
This folder should be available at '' 'your_whmcs/modules/addons/DomainOrdersExtended/' ''. If not, create one manually.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The last step is assigning registrar to TLDs, select '' 'Basic' '' category (it contains all the previously created TLDs) and press '' 'Bulk Registrar Change'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_6_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE10_1.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Domain Orders Extended For WHMCS!'''<br />
 +
You can access your module in '' 'Addons' '' → '' 'Domain Orders Extended'. ''
 
|}
 
|}
 +
<!--
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, select a desired registrar and press '' 'Update Registrars' '' button.
+
|style="padding: 0px 0px 15px 15px;"|'''9. The last step concerns confirming the usage of default WHMCS lookup module.'''<br />
 +
Go to '' 'Settings' '' tab and press '' 'Update Settings' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_7_1.png]]
 
|}
 
|}
 +
-->
  
−
==TLDs Configuration==
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'TLDs Configuration' '' tab you can view all the information related to your TLDs, like their categories, assigned registrars and prices.<br />
+
|style="padding: 10px 0px 30px 15px;"|Domain Orders Extended will help you with the management of your domains and their pricing.<br />
−
To switch between Register/Renew/Transfer pricing, select one from the marked dropdown menu and press '' 'Filter Results'. ''<br />
+
It will also reduce the time required for performing actions on domains due to the implemented bulk actions feature.<br />
−
To display/hide TLDs assigned to a category, press the category name as shown on the following screen.
+
Additionally, you can group TLDs into categories and select TLDs assigned to a given registrar.
 
|}
 
|}
 +
==TLDs Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE13.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'TLDs Configuration' '' tab you can view all the information related to your domains, such as: categories, assigned registrars, prices and labels.<br />
 +
By default, the '' 'Unassigned' '' category is created where not yet assigned TLDs are stored.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Another useful feature enables you to make quick changes, like altering assigned registrar, category or pricing in a specific term.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_7.png]]
−
To make such adjustments, simply press value you desire to change and fill in a new value.<br />
+
−
Registrar and category values are saved automatically, whereas price changes must be confirmed as shown on the following screen.  
+
 
|}
 
|}
 +
===Add Category===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE14.png]]
+
|style="padding: 10px 0px 15px 15px;"|Let's start with creating a category, go to your addon → '' 'TLDs Configuration'. ''<br />
 +
Click on '' 'Add TLDs Group' '' button, enter the category name into the '' 'Title' '' field. <br/>
 +
You can also decide whether this category is to be promoted on the top domain search list, regardless of the specified order.<br/>
 +
'' '''Note''' that a category can also be created as a subcategory of another category. Click [https://www.docs.modulesgarden.com/images/e/eb/DOE3_2_8_1.png here] to see an exemplary result.''<br/>
 +
Press the '' 'Add Category' '' button when ready.
 
|}
 
|}
−
==Bulk Actions==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to order actions on multiple TLDs simultaneously. There are three methods to do it.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_8.png]]
−
The '''first''' way: go to '' 'TLDs Configuration' '' tab and mark checkboxes next to TLDs you want to order action on.<br />
+
−
Afterwards, press the button bounded to a certain action. For example, to change category of all selected TLDs press '' 'Bulk Category Change'. ''<br />
+
−
The '''second''' method: go to the '' 'Category' '' tab and press '' 'Bulk Actions For Domains'. ''<br />
+
−
Last but not least method, number '''three''': go to '' 'Bulk Actions' '' tab and manually add TLDs to '' 'Domains List'. ''<br />
+
−
Below we will guide you through the available bulk actions. <br />
+
−
''Note: On the following screen you can see the first method.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE15.png]]
+
|style="padding: 10px 0px 20px 15px;"|You can also edit or delete a created category at any time by clicking on the corresponding button in the upper right corner.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As soon as you are move to bulk actions, you can switch between them via entering different tabs marked on the following screen.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_8_2.png]]
−
''Note: You can also add new TLDs or already existing ones to the bulk action you are currently performing.''<br />
+
−
''Simply, press '' 'Add TLD' '' button under TLD list and type TLD you wish to add.''
+
 
|}
 
|}
 +
 +
===Assign TLDs===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE16.png]]
+
|style="padding: 10px 0px 15px 15px;"|In order to add new TLDs to a category, press the '' 'Assign TLDs' '' button.<br />
 +
You can assign multiple TLDs at once and decide whether the searched domains should be promoted at the top within this category, regardless of the order of the remaining, not promoted TLDs.<br />
 +
Afterwards, press the '' 'Assign TLDs' '' button.<br />
 +
'' '''Note:''' The given TLD can be assigned to only one category at a time.''
 
|}
 
|}
−
===Pricing===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In bulk '' 'Set Pricing' '' action you can set a new pricing or copy the pricing assigned to any of the existing TLDs.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_9.png]]
−
Disable '' 'Toggle Autoupdate Mode' '' if you are not going to set up all of the payment terms.<br />
+
−
Afterwards, fill out fields and press '' 'Save Pricing'. ''
+
 
|}
 
|}
 +
 +
===Edit TLD Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_17.png]]
+
|style="padding: 10px 0px 15px 15px;"|Click the '' 'Edit TLD Configuration' button to access the settings of the selected TLD. <br/>
 +
Here you can change the category to which a given TLD belongs, set the domain registrar, assign [https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Labels labels] or decide whether to promote searched domains on top of the category.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you desire to copy the pricing from other TLD, choose it from '' 'Copy Pricing From' '' dropdown menu. The pricing will be automatically updated.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_10.png]]
−
You can also reassign category of selected TLDs, simply type its name into '' 'Assign To Category' '' auto-complete box.<br />
+
−
Confirm changes through pressing '' 'Save Changes' '' at the bottom of the page.<br />
+
−
''Note: If category you entered does not exist, it will be automatically created.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_18.png]]
+
 
|}
 
|}
  
−
===Pricing Change===
+
===Edit TLD Pricing===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If, for some reason, you need to change the payment for TLDs by fixed or percentage value, then our module will make it available to you.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the '' Edit TLD Pricing '' tab, you can set a domain pricing for each of registration periods in each available currency.<br />
−
In '' 'Price Change' '' you can change pricing of selected TLDs by fixed or percentage amount specified by you.<br />
+
−
Start by selecting change types from '' 'Increase/Decrease'' ' and '' 'Percentage/Fixed' '' dropdown menus.<br />
+
−
Afterwards, type the value to change by and press '' 'Submit Changes'. ''<br />
+
−
Setup shown on the following screen will remove 10% value of prices from every field of chosen TLDs.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_17.png]]
 
|}
 
|}
−
===Delete Pricing===
+
 
−
{|
+
===Bulk Actions===
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Delete Pricing' '' tab, you can remove the pricing from selected TLDs.<br />
+
−
To do so, simply press '' 'Yes, Proceed' '' button.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE20.png]]
+
−
|}
+
−
===Change Category===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|To assign selected TLDs to one category, go to '' 'Change Category' '' tab.<br />
+
−
Afterwards, type a category name into '' 'New Category' '' auto-complete box.<br />
+
−
If category you entered does not exist, it will be automatically created during the process.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE21.png]]
+
−
|}
+
−
===Registrar Change===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Bulk actions tab allows you to change registrar.<br />
+
−
Proceed to '' 'Registrar Change' '' tab, select desired registrar and press '' 'Update Registrars'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE21_1.png]]
+
−
|}
+
−
===Duplicate TLDs===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Here you can create duplicate of TLDs and copy them to chosen category.<br />
+
−
''Note: Any changes made to pricing or registrar of original TLD take effect on duplicate and vice versa.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE21_2.png]]
+
−
|}
+
−
===Delete Domain===
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can also remove chosen TLDs.<br />
+
|style="padding: 10px 0px 15px 15px;"|Our module allows you to perform actions simultaneously on multiple TLDs. <br />
−
To do so, move to '' 'Delete Domain' '' tab and press '' 'Yes, Proceed'. ''
+
You can mass edit TLDs configuration, pricing or delete TLDs from the assigned categories.<br />
 +
Simply select multiple extensions on which you want to perform actions and choose the corresponding button from the displayed menu.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_15.png]]
 
|}
 
|}
  
−
==Domain Categories==
+
===Order Of Categories And TLDs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Domain Categories' '' you can add new categories and manage existing ones.<br />
+
|style="padding: 10px 0px 15px 15px;"|Using drag & drop allows you to change the order of the categories, subcategories and TLDs. <br/>
−
You can also order bulk actions for the TLDs assigned to a specified category by pressing '' 'Bulk Actions For Domains'. ''
+
This enables you to decide on the order in which categories and TLDs appear in the [https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Client_Area domain search list].<br/>
 +
'' '''Note''' that promoted categories and TLDs are always on top regardless of the specified order.<br/><br/>
 +
To change the order, simply grab the chosen item and drag it to the desired location.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Additionally, you can view TLDs assigned to categories.<br />
+
|style="padding: 10px 0px 20px 15px;"|After dragging, the new order is automatically saved.
−
Simply, hover over the fields in '' 'Domains' '' column as shown on the following screen.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Here you can also change the positioning of categories. To change the order they are displayed simply drag a category and drop it in the required place.
+
|style="padding: 10px 0px 30px 15px;"|
−
|}
+
Depending on the selected [https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Module_Settings domain search type], the order of TLDs display in search results will be set in the following sequence (from the most important to least):
−
{|
+
#Promoted categories
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_24_1.png]]
+
#Categories order on list
 +
#Promoted TLDs
 +
#TLDs with labes
 +
#TLDs order on category list
 
|}
 
|}
  
−
==Predefined TLDs==
+
==Predefined TLD Sets==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|You can install predefined sets of TLDs. Proceed to '' 'Predefined TLD Sets' '' tab. <br />
 
|style="padding: 10px 0px 15px 15px;"|You can install predefined sets of TLDs. Proceed to '' 'Predefined TLD Sets' '' tab. <br />
−
As you can see, TLDs are sorted into three tabs. Each tab contains TLDs sorted into categories, each category can have its own subcategories.<br />
+
As you can see, TLDs are sorted into categories. Some of them can have their own subcategories.<br />
−
Mark checkbox as shown on the following screen to mark all TLDs that belong to a selected category and press '' 'Install Extensions'.''
+
Choosing a parent category will also show all the TLDs belonging to their subcategories.<br />
 +
Click the '' 'select all' '' checkbox or mark the single TLD that belong to a selected category and press '' 'Add TLDs' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|TLDs installation from selected subcategories is also possible, press category name to extend it and show all of its subcategories.<br />
+
|style="padding: 0px 0px 15px 15px;"|Now you can create a new category from the set with the same name or add the selected TLDs to one of the previously created categories or subcategories in the '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#TLDs_Configuration TLDs Configuration]' ''.<br/>
−
Afterwards, mark checkboxes next to the desired TLDs and press '' 'Install Extensions'. ''<br />
+
Press '' 'Add TLDs' '' when ready.
−
''Note: This way you can install multiple TLDs from different categories, the only limitation are tabs. You can install TLDs from one tab at once.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_26.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_26.png]]
 
|}
 
|}
  
 
==Settings==
 
==Settings==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In '' 'Settings' '' tab you are able to define behavior of the module as well as configure external lookup module.
+
|style="padding: 10px 0px 30px 15px;"|In '' 'Settings' '' tab you are able to define behavior of the module domain search, suggestions as well as configure the lookup cron.
 
|}
 
|}
 
===Module Settings===
 
===Module Settings===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Here you can set up behavior of the Domain Orders Extended For WHMCS module.<br />
+
|style="padding: 10px 0px 15px 15px;"|Here you can set up domain searching and suggestions' behavior in the client area. These options are:<br /><br />
−
Depending on the domain search type:
+
* '''Replace Standard Registrar With Module Order Form''' - if enabled, the default domain lookup page in the client area will be replaced with the module's customized one. <br/>Otherwise, the standard WHMCS lookup page will be used and you will have to access the module lookup using an external URL.<br/><br/>
−
|}
+
* '''TLDs Searched By Default''' - select the TLDs you want to be searched by default when the client enters the domain without specifying the search results.<br/>If left empty, all supported TLDs will be searched at once.<br/><br/>
 +
* '''Domain Search Type''' - select one of three available domain search views in the client area:
 +
**'''List View''' - all searched domains will be displayed in a single list, regardless of their categorization
 +
**'''General Category View''' - the display of the searched domains will be allocated between the main categories, without specifying the subcategories
 +
**'''Multi Category View''' - all searched domains will be split into the main categories and their subcategories
 +
'' '''Note:''' Check the '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Client_Area Client Area]' section to see the visual differences between the domain search types.''  <br/><br/>
 +
*'''Suggested Search''' - select the provider you want to use in order to search for domain suggestions:
 +
**'''Disabled''' - choose if you do not want to display domain suggestions
 +
**'''WHMCS Lookup Provider''' - the default WHMCS provider will be used or any other that has been configured in the WHMCS '' '[https://docs.whmcs.com/Domain_Suggestions Domain Pricing]' '' settings as a lookup provider
 +
**'''eNom Lookup''' - use only if configured in the '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Submodules Submodules]' '' settings
 +
**'''OpenSRS Lookup''' - use only if configured in the '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Submodules Submodules]' '' settings
 +
'' '''Note:''' for your convenience, suggested domains available for registration will be shown in the search results, despite the provider that might also suggest the already taken domains.''
 +
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Single Domain Search'''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_27.png]]
−
1. Replace Standard Registrar With Module Order Form - if marked, a standard registration form will be replaced with Domain Orders Extended form.<br/>
+
−
1.1. Provide path to the external form that shall be used.<br/>
+
−
2. Enable Auto Expanded Categories In TLD Configuration - categories will be expanded automatically in the addon →'' 'TLDs Configuration'. ''<br/>
+
−
3. Enable Auto Expanded SubCategories In TLD Configuration - subcategories will be expanded automatically in the addon →'' 'TLDs Configuration'.'' <br/>
+
−
4. Save Searched Domain Details<br/>
+
−
5. Sort TLDs Vertically In Client Area
+
 
|}
 
|}
 +
 +
===Cron Settings===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_26_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|The default WHMCS lookup may work extremely slowly while checking a large number of domains, therefore we have introduced an additional cron solution.<br />The cron processes are responsible for searching a large quantity of domains and suggestions. <br />
−
|}
+
<br/>
 +
Here you can configure the number of simultaneously run processes and how many domains can be handled by one process at the same time.<br/>
 +
For example, you can set 5 processes to work simultaneously, and each of them can deliver up to 20 search results at once.
 +
 
 +
'' '''Note:''' The higher the number of processes and search records per process, the faster the search for domains, but also the increased usage of server resources and number of requests to the lookup provider.''<br/>''Use these options reasonably.''
 +
 
 +
 
 +
To run cron processes, simply add a cron job as shown below (each 5 minutes suggested).
 +
php -q /yourWHMCS/modules/addons/DomainOrdersExtended/cron/cron.php
 +
Do not forget to replace '' 'yourWHMCS' '' with your WHMCS root location.<br/>
 +
'' '''Important:''' It is required that ''' 'exec' ''' function is '''not''' blocked in your PHP configuration.''
 +
|}
 +
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Multiple domain Search'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_28.png]]
−
1. Replace Standard Registrar With Module Order Form - if marked, a standard registration form will be replaced with Domain Orders Extended form.<br/>
+
−
1.1. Provide path to the external form that shall be used.<br/>
+
−
2. Load Results On Lookup Page - if selected, results will be displayed on current site, no redirection will take place.<br/>
+
−
3. Enable Auto Expanded Categories In TLD Configuration - categories will be expanded automatically in the addon →'' 'TLDs Configuration'. ''<br/>
+
−
4. Enable Auto Expanded SubCategories In TLD Configuration - subcategories will be expanded automatically in the addon →'' 'TLDs Configuration'.'' <br/>
+
−
5. Save Searched Domain Details<br/>
+
−
6. Sort TLDs Vertically In Client Area
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_26_2.png]]
+
|style="padding: 0px 0px 30px 15px;"|If you would like to stop the cron processes manually, delete all content of the '' '/yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons/' '' folder or execute the command below:
−
|}
+
rm -r /yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons/*
−
{|
+
As previously, do not forget to replace '' 'yourWHMCS' '' with your WHMCS root location.
−
|style="padding: 0px 0px 15px 15px;"|'''Category Search'''<br/>
+
−
1. Suggested Prefixes - allows you to define the list of prefixes used to create suggested domains.<br/>
+
−
2. Suggested Suffixes -allows you to define the list of suffixes used to create suggested domains.<br/>
+
−
3. Replace Standard Registrar With Module Order Form - if marked, a standard registration form will be replaced with Domain Orders Extended form.<br/>
+
−
4. Enable Auto Expanded Categories In TLD Configuration - categories will be expanded automatically in the addon →'' 'TLDs Configuration'. ''<br/>
+
−
5. Enable Auto Expanded SubCategories In TLD Configuration - subcategories will be expanded automatically in the addon →'' 'TLDs Configuration'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_26_3.png]]
+
−
|}
+
  
−
===Domain Lookup Module===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The ability to order a group of domains entails a large quantity of requests.<br />
 
−
Default WHMCS lookup module may work extremely slowly while checking a large amount of domains. Therefore we integrated an additional lookup module.<br />
 
−
To use the external lookup module, select it from a '' 'Domain Lookup Module' '' dropdown menu.<br />
 
−
Next, fill in module configuration.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_27.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Additionally, you can define configuration of the domain spinner.<br />
 
−
Press '' 'Update Settings' '' to save changes.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_28.png]]
 
 
|}
 
|}
  
−
==Integration Code==
+
==Submodules==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Integration Code' '' tab contains integration code allowing your clients to access bulk domain lookup form.<br />
+
|style="padding: 10px 0px 15px 15px;"|In this section, you can configure the connection data to use an external domain lookup provider. The currently available are:
−
The form must be located in the location defined under '' 'Path To External Form' '' field in '' 'Settings' '' page.<br />
+
*'''Default Submodule'''
−
As you can see on the following screen, you can choose from a wide variety of domain order forms.<br />
+
*'''OpenSRS'''
−
Additionally, you can check here if Domain Orders Extended domain order form is currently used.
+
*'''eNom'''
 +
You can use these providers at the same time, but make sure they actually support the available TLDs. <br/>
 +
You can also exclude TLDs that shall not be presented among the results offered by a given domain spinner.<br/>
 +
In addition, you can enable the '' 'Default Submodule' '' to search for domains if you do not have the submodules configuration, or if they do not support relevant TLDs.<br/>
 +
In this case, the WHMCS lookup provider configured in the '' 'Domain Pricing' '' settings will be used.<br/><br/>
 +
'' '''Note:''' If all submodules are used and a domain search is started for TLD mutually supported by them, then the domain will be checked first by the ''OpenSRS'' submodule, <br/>next if not found it will be searched by the eNom submodule, and then, finally, by the default WHMCS lookup.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE29.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_29.png]]
−
|}
+
−
==Client Area==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Now, we are about to show you the main functionality of this module, which is placed in the client area.
+
−
|}
+
−
===Domains Lookup & Order===
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|As soon as you check '' 'Replace Standard Registrar With Module Order Form', '' your clients will see a way different domain order form under '' 'Domains' → 'Register a New Domain'. ''<br />
+
−
They can choose even domains using gTLDs and ccTLDs!<br />
+
−
'''Important:''' Custom order forms are not supported by 'Ajaxcart' order form template.<br />
+
−
<br /><br />
+
−
'''TLD Visibility'''<br />
+
−
Your clients have access only to the TLDs assigned to categories.<br />
+
−
Clients can search TLDs by categories or switch back to '' 'All Categories' '' and use quick search.
+
−
|}
+
−
====Single Domain Search====
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Basic search form of Domain Orders Extended. It allows your clients to easily check availability of a chosen domain using multiple TLDs.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_30.png]]
+
 
|}
 
|}
  
−
====Multiple Domains Search====
+
==Labels==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This search form extends Single Domain Search by the ability to lookup multiple domains using different TLDs at once.<br />
+
|style="padding: 10px 0px 15px 15px;"|Here you can create labels that can then be assigned to the selected TLDs. <br/>
−
''Note: When switching between categories, TLDs chosen in other categories are not cleared.''<br />
+
Each label may be distinguished by its own color and may receive priority. <br/>
−
''Therefore your clients can order domains with TLDs from different categories during one order.''
+
Labels will then be displayed next to the assigned TLD on the domain search and suggestions results.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|After lookup, your clients should have a view similar to the one on the following screen.<br />
+
|style="padding: 10px 0px 15px 15px;"|To start, press the '' 'Add Label' '' button to create the first one. <br/>
−
If some of the domains are unavailable, clients can go to domains www address, view its whois and transfer it.
+
Then, set a title that will appear on the label and message that appears when you move the cursor over the label. <br/>
 +
Next, set its priority which will determine the label's position next to a domain. The higher the number, the higher the priority, and thus the closer the label to a domain.<br/>
 +
'' '''Note:''' You can also prioritize different labels with the same value.''<br/>
 +
Finally, set the color of the text and the background of the label, and save changes when ready.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|For available domains, clients can decide if they want to order domains, and select registration period from a dropdown menu.<br />
+
|style="padding: 10px 0px 15px 15px;"|Once the label has been created, it will appear on the list, where you can edit or delete it. <br/>
−
If clients do not want to order some of the domains, they have to unmark checkboxes next to those domains.<br />
+
To learn how to assign the label to a particular TLD, see the '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Edit_TLD_Configuration Edit TLD Configuration] ' section.
−
Press '' 'Proceed To The Cart' '' to continue shopping.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_33.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_32.png]]
 
|}
 
|}
  
−
====Category Search====
+
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Category Search allows you to define TLD for suggestions, top grossing and suggested TLDs.
+
|style="padding: 10px 0px 20px 15px;"|Now, we are about to show you the main functionality of this module, which is located in the client area.
 
|}
 
|}
 +
===Domains Lookup===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_33_5.png]]
+
|style="padding: 0px 0px 15px 15px;"|As soon as you check '' 'Replace Standard Registrar With Module Order Form' ''  in '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Settings Settings]'' ', your clients will see a different domain order form under '' 'Domains' → 'Register a New Domain'. ''<br /><br />
 +
Your clients have access only to the TLDs assigned to categories and with the pricing set. <br />
 +
By default, only TLDs selected in the '' '[https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Module_Settings Module Settings]' '' will be searched for an entered phrase. <br/>If your customers want to get results concerning other TLDs, they can select them from the drop-down list.
 
|}
 
|}
−
===Domain Spinner===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Owing to integration with eNom and OpenSRS, our module allows you to enable domain spinner for your clients.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_30_1.png]]
−
Let's take a look at how it works, for this purpose, order single domain with 2 TLDs.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_1.png]]
+
|style="padding: 0px 0px 30px 15px;"|Below you can also see the differences in the display of the domain search depending on the previously chosen settings.
 
|}
 
|}
 +
====List View====
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see, domain spinner shows domains with similar names to the one you were looking for.<br />
+
|style="padding: 10px 0px 20px 15px;"|The list view represents all the domains searched in one common list. <br/>Your customers will not see the search results divided into previously created categories and subcategories. <br/>Nevertheless, the order of the displayed domains will still depend on the set order of categories and TLDs in the configuration but the ''promoted'' TLDs will be displayed at the top of the list. <br/>If enabled, the list also contains domain suggestions.
−
It is extremely useful when the domains you were looking for are already taken.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_30.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, make another lookup, but this time enable '' 'Enable Multiple Domain Search' '' in the module settings.<br />
+
−
Additionally, unmark '' 'Enable Transfer For Domain Spinner' '' in the lookup module settings.<br />
+
−
Fill in 2 domains, choose 2 TLDs and press '' 'Check Availability'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|As shown on the screen below, domain spinner mixed domain names you were looking for.<br />
+
−
Additionally, since '' 'Enable Transfer For Domain Spinner' '' is unmarked, domain spinner suggested only unregistered domains.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|As you can see, our inbuilt domain spinner will suggest your customers the domain names that should interest them.<br />
+
−
This will definitely come in handy and will let your clients order their favorite domains quickly and capably. Make sure that you have enabled this functionality!
+
 
|}
 
|}
  
−
===Bulk Search===
+
====General Category View====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Clients are allowed to choose what type of selection they want to use. Find '' 'Domain Search' ''dropdown and select the manner domains will be searched for you.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In this view, your clients will see a categorization of the searched domains in tabs, but without showing their subcategories. <br/>TLDs from the subcategories will be displayed in the main categories. <br/>If none of the TLDs in a given category is included in the search results, this subcategory will not be displayed in the results list. <br/>The order of the displayed results depends on the first set order of the categories, and then on the order of the TLDs within them. Promoted TLDs will be displayed at the top.
−
Choose between '' 'Bulk Search', 'Bulk Search Available' '' and '' 'Bulk Search Transfer'. '' Pressing any of the three options means being redirected to a separate form.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE33_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_33_5.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Enter domain names into a text field. Please enter one domain per line. Forms '' 'example' '' and '' 'example.com' '' are allowed.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE33_7.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|A list of available domains will appear in a moment.<br/> Depending on searching type, among results there can be domains available to transfer, only available domains or all of them.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE33_8.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|You may come back to the standard lookup at any time, simply press '' 'Domain Search' '' in dropdown menu.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE33_9.png]]
+
 
|}
 
|}
  
−
==Migration==
+
====Multi Category View====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can easily upgrade your Domain Orders Extended For WHMCS 1.0 to the latest version owing to the migration tool.<br />
+
|style="padding: 10px 0px 15px 15px;"|This view works similarly to the '' 'General Category View' '', but also includes a subcategorization of search results that customers will be able to expand from category tabs.''
−
1. First of all, deactivate the module under '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
−
2. Next, upload and extract the latest version of Domain Orders Extended archive to your WHMCS main directory.<br />
+
−
3. Remove content of '' 'templates_c' '' folder located in '' 'your_whmcs\template_c'. ''<br />
+
−
4. Activate the module and assign permission to it under '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
−
5. Proceed to '' 'Addons' '' → '' 'Domain Orders Extended' '' → '' 'Migration Tool' '' and press '' 'Migrate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_31.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|As you can see, '' 'Migration Tool' '' disappeared from the module navigation, we will not need it any more due to a successfully completed migration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE35.png]]
+
 
|}
 
|}
  
Line 578: Line 461:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. In case you are using other template than '' 'default', '' some files need to be copied from '' 'default' '' template.<br />
+
|style="padding: 0px 0px 10px 15px;"|2. The module does '''not''' support the migration from previous versions 2.X. All settings have to be defined anew.
−
These files are:
+
|}
−
*domainorder.tpl
+
{|
−
*domaintabs.tpl
+
|style="padding: 0px 0px 30px 15px;"|3. The bulk domain search is not yet implemented. It will be reimplemented in the future updates.
−
*gettemplatesfromcat.tpl
+
−
*listalldomains.tpl
+
−
*listavailabledomain.tpl
+
−
*listavailabledomains.tpl
+
−
*listspinner.tpl
+
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|2. If you encounter error:
+
−
Fatal error: main(): Failed opening required '/whmcs/modules/addons/TLDsForm/TLDsForm.php' (include_path='.:/usr/share/php:/usr/share/pear')
+
−
in '' /var/www/whmcs/admin/configaddonmods.php'' on line 0, please check if module files have a correct chmod.
+
 
|}
 
|}

Revision as of 18:55, 16 November 2017

Contents

About Domain Orders Extended For WHMCS

Domain Orders Extended For WHMCS allows you to group domains into categories and perform bulk actions on multiple domains.

You will be free to import predefined sets of TLDs, apply easily adjustable domain labels, plus regulate the priority and order of TLDs.
The module lets your clients perform multiple lookup and checkout for domain names in a single request, browse suggestions powered by three built-in domain spinners.
In addition, the module supports gTLDs and ccTLDs allowing your customers to conveniently order their favorite domain names without leaving your website.

  • Client Area Features:
✔ Supports Three External Domain Search Forms
✔ Fast Cron Domain Lookup
✔ Simultaneous Domain Searches In Multiple Spinners
✔ Display Domain Name Suggestions
✔ Display Domain Labels
✔ Display TLDs Basing On Defined Prioritization And Order
✔ Multiple Checkout Of Domains In One Request
  • Admin Area Features:
✔ Group TLDs Into Categories & Subcategories
✔ Set Promoted Categories And TLDs
✔ Set Order Of Categories, Subcategories And TLDs
✔ Perform Bulk Changes On Multiple TLDs:
✔ Change TLD Categories And Registrars
✔ Set Domain Pricing
✔ Set Domain Labels
✔ Toggle Promoted TLDs
✔ Delete TLDs From Categories
✔ Import TLD Sets To Categories From Predefined List
✔ Choose Domain Lookup Submodules:
✔ Default Or Custom WHMCS Provider
✔ OpenSRS
✔ eNom
✔ Add Your Own Lookup Submodules
✔ Set TLDs Searched By Default
✔ Toggle Search Of Domain Suggestions
✔ Add Customized TLD Labels
✔ Choose Domain Search Form:
✔ List View
✔ General Category View
✔ Multi Category View
✔ Configure Cron Domain Lookup:
✔ Define Number Of Simultaneous Processes
✔ Define Number Of Search Records Per Process
  • General Info:
✔ gTLDs & ccTLDs Support
✔ IDN Support
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7

Installation

This tutorial will show you how to successfully install Domain Orders Extended For WHMCS.

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

Note: If you are still using any of the module's previous versions prior to v3.x, follow these instructions.

1. Log in to your client area and download the module.
DOE3 1.png
2. Extract the downloaded file into the main WHMCS directory.

The content of the package should look like this.

DOE3 2 2.png
3. When you install Domain Orders Extended For WHMCS for the first time you have to rename 'license_RENAME.php' file.

You can find it in 'modules/addons/DomainOrdersExtended/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

DOE3 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'.

DOE3 4.png
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 Orders Extended' and press 'Activate' button.

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

To do so, click on 'Configure' button, select administrator groups which should have access to this addon and press 'Save Changes'.

DOE3 6.png
7. Now, set up the 'storage' folder as writable.

This folder should be available at 'your_whmcs/modules/addons/DomainOrdersExtended/' . If not, create one manually.

DOE3 6 2.png
8. You have just successfully installed Domain Orders Extended For WHMCS!

You can access your module in 'Addons' → 'Domain Orders Extended'.

Configuration and Management

Domain Orders Extended will help you with the management of your domains and their pricing.

It will also reduce the time required for performing actions on domains due to the implemented bulk actions feature.
Additionally, you can group TLDs into categories and select TLDs assigned to a given registrar.

TLDs Configuration

In 'TLDs Configuration' tab you can view all the information related to your domains, such as: categories, assigned registrars, prices and labels.

By default, the 'Unassigned' category is created where not yet assigned TLDs are stored.

DOE3 7.png

Add Category

Let's start with creating a category, go to your addon → 'TLDs Configuration'.

Click on 'Add TLDs Group' button, enter the category name into the 'Title' field.
You can also decide whether this category is to be promoted on the top domain search list, regardless of the specified order.
Note that a category can also be created as a subcategory of another category. Click here to see an exemplary result.
Press the 'Add Category' button when ready.

DOE3 2 8.png
You can also edit or delete a created category at any time by clicking on the corresponding button in the upper right corner.
DOE3 2 8 2.png

Assign TLDs

In order to add new TLDs to a category, press the 'Assign TLDs' button.

You can assign multiple TLDs at once and decide whether the searched domains should be promoted at the top within this category, regardless of the order of the remaining, not promoted TLDs.
Afterwards, press the 'Assign TLDs' button.
Note: The given TLD can be assigned to only one category at a time.

DOE3 2 9.png

Edit TLD Configuration

Click the 'Edit TLD Configuration' button to access the settings of the selected TLD.

Here you can change the category to which a given TLD belongs, set the domain registrar, assign labels or decide whether to promote searched domains on top of the category.

DOE3 2 10.png

Edit TLD Pricing

In the Edit TLD Pricing tab, you can set a domain pricing for each of registration periods in each available currency.
DOE3 2 17.png

Bulk Actions

Our module allows you to perform actions simultaneously on multiple TLDs.

You can mass edit TLDs configuration, pricing or delete TLDs from the assigned categories.
Simply select multiple extensions on which you want to perform actions and choose the corresponding button from the displayed menu.

DOE3 15.png

Order Of Categories And TLDs

Using drag & drop allows you to change the order of the categories, subcategories and TLDs.

This enables you to decide on the order in which categories and TLDs appear in the domain search list.
Note that promoted categories and TLDs are always on top regardless of the specified order.

 To change the order, simply grab the chosen item and drag it to the desired location.

DOE3 19.png
After dragging, the new order is automatically saved.
DOE3 20.png

Depending on the selected domain search type, the order of TLDs display in search results will be set in the following sequence (from the most important to least):

  1. Promoted categories
  2. Categories order on list
  3. Promoted TLDs
  4. TLDs with labes
  5. TLDs order on category list

Predefined TLD Sets

You can install predefined sets of TLDs. Proceed to 'Predefined TLD Sets' tab.

As you can see, TLDs are sorted into categories. Some of them can have their own subcategories.
Choosing a parent category will also show all the TLDs belonging to their subcategories.
Click the 'select all' checkbox or mark the single TLD that belong to a selected category and press 'Add TLDs' .

DOE3 25.png
Now you can create a new category from the set with the same name or add the selected TLDs to one of the previously created categories or subcategories in the 'TLDs Configuration' .

Press 'Add TLDs' when ready.

DOE3 26.png

Settings

In 'Settings' tab you are able to define behavior of the module domain search, suggestions as well as configure the lookup cron.

Module Settings

Here you can set up domain searching and suggestions' behavior in the client area. These options are:

  • Replace Standard Registrar With Module Order Form - if enabled, the default domain lookup page in the client area will be replaced with the module's customized one.
    Otherwise, the standard WHMCS lookup page will be used and you will have to access the module lookup using an external URL.

  • TLDs Searched By Default - select the TLDs you want to be searched by default when the client enters the domain without specifying the search results.
    If left empty, all supported TLDs will be searched at once.

  • Domain Search Type - select one of three available domain search views in the client area:
    • List View - all searched domains will be displayed in a single list, regardless of their categorization
    • General Category View - the display of the searched domains will be allocated between the main categories, without specifying the subcategories
    • Multi Category View - all searched domains will be split into the main categories and their subcategories

Note: Check the 'Client Area' section to see the visual differences between the domain search types.

  • Suggested Search - select the provider you want to use in order to search for domain suggestions:
    • Disabled - choose if you do not want to display domain suggestions
    • WHMCS Lookup Provider - the default WHMCS provider will be used or any other that has been configured in the WHMCS 'Domain Pricing' settings as a lookup provider
    • eNom Lookup - use only if configured in the 'Submodules' settings
    • OpenSRS Lookup - use only if configured in the 'Submodules' settings

Note: for your convenience, suggested domains available for registration will be shown in the search results, despite the provider that might also suggest the already taken domains.

DOE3 27.png

Cron Settings

The default WHMCS lookup may work extremely slowly while checking a large number of domains, therefore we have introduced an additional cron solution.
The cron processes are responsible for searching a large quantity of domains and suggestions.


Here you can configure the number of simultaneously run processes and how many domains can be handled by one process at the same time.
For example, you can set 5 processes to work simultaneously, and each of them can deliver up to 20 search results at once.

Note: The higher the number of processes and search records per process, the faster the search for domains, but also the increased usage of server resources and number of requests to the lookup provider.
Use these options reasonably.


To run cron processes, simply add a cron job as shown below (each 5 minutes suggested). 

php -q /yourWHMCS/modules/addons/DomainOrdersExtended/cron/cron.php

Do not forget to replace 'yourWHMCS' with your WHMCS root location.
Important: It is required that 'exec' function is not blocked in your PHP configuration.

DOE3 28.png
If you would like to stop the cron processes manually, delete all content of the '/yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons/' folder or execute the command below: 
rm -r /yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons/*

As previously, do not forget to replace 'yourWHMCS' with your WHMCS root location.

Submodules

In this section, you can configure the connection data to use an external domain lookup provider. The currently available are:
  • Default Submodule
  • OpenSRS
  • eNom

You can use these providers at the same time, but make sure they actually support the available TLDs.
You can also exclude TLDs that shall not be presented among the results offered by a given domain spinner.
In addition, you can enable the 'Default Submodule' to search for domains if you do not have the submodules configuration, or if they do not support relevant TLDs.
In this case, the WHMCS lookup provider configured in the 'Domain Pricing' settings will be used.

Note: If all submodules are used and a domain search is started for TLD mutually supported by them, then the domain will be checked first by the OpenSRS submodule,
next if not found it will be searched by the eNom submodule, and then, finally, by the default WHMCS lookup.

DOE3 29.png

Labels

Here you can create labels that can then be assigned to the selected TLDs.

Each label may be distinguished by its own color and may receive priority.
Labels will then be displayed next to the assigned TLD on the domain search and suggestions results.

DOE3 30.png
To start, press the 'Add Label' button to create the first one.

Then, set a title that will appear on the label and message that appears when you move the cursor over the label.
Next, set its priority which will determine the label's position next to a domain. The higher the number, the higher the priority, and thus the closer the label to a domain.
Note: You can also prioritize different labels with the same value.
Finally, set the color of the text and the background of the label, and save changes when ready.

DOE3 31.png
Once the label has been created, it will appear on the list, where you can edit or delete it.

To learn how to assign the label to a particular TLD, see the 'Edit TLD Configuration ' section.

DOE3 32.png

Client Area

Now, we are about to show you the main functionality of this module, which is located in the client area.

Domains Lookup

As soon as you check 'Replace Standard Registrar With Module Order Form' in 'Settings ', your clients will see a different domain order form under 'Domains' → 'Register a New Domain'.

Your clients have access only to the TLDs assigned to categories and with the pricing set.
By default, only TLDs selected in the 'Module Settings' will be searched for an entered phrase.
If your customers want to get results concerning other TLDs, they can select them from the drop-down list.

DOE3 30 1.png
Below you can also see the differences in the display of the domain search depending on the previously chosen settings.

List View

The list view represents all the domains searched in one common list.
Your customers will not see the search results divided into previously created categories and subcategories.
Nevertheless, the order of the displayed domains will still depend on the set order of categories and TLDs in the configuration but the promoted TLDs will be displayed at the top of the list.
If enabled, the list also contains domain suggestions.
DOE3 2 30.png

General Category View

In this view, your clients will see a categorization of the searched domains in tabs, but without showing their subcategories.
TLDs from the subcategories will be displayed in the main categories.
If none of the TLDs in a given category is included in the search results, this subcategory will not be displayed in the results list.
The order of the displayed results depends on the first set order of the categories, and then on the order of the TLDs within them. Promoted TLDs will be displayed at the top.
DOE3 33 5.png

Multi Category View

This view works similarly to the 'General Category View' , but also includes a subcategorization of search results that customers will be able to expand from category tabs.
DOE3 2 31.png

Tips

1. TLDs are hidden for clients as long as they are not assigned to any category.
2. The module does not support the migration from previous versions 2.X. All settings have to be defined anew.
3. The bulk domain search is not yet implemented. It will be reimplemented in the future updates.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Domain_Orders_Extended_For_WHMCS&oldid=34382"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Domain Orders Extended For WHMCS