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...")
 
(→‎About Domain Orders Extended For WHMCS)
 
(104 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="domain orders extended for whmcs, domain orders extended configuration, whmcs domain orders extended management, whmcs domain orders extended installation, whmcs domain orders extended common problems, about whmcs domain orders extended, whmcs domain orders extended documentation, whmcs domain orders extended faq, whmcs domain orders extended help, whmcs domain orders extended guide, whmcs domain orders extended wiki, whmcs domain orders extended tutorial, whmcs domain orders extended tips, whmcs domain orders extended wiki"></meta>
 
<meta name="keywords" content="domain orders extended for whmcs, domain orders extended configuration, whmcs domain orders extended management, whmcs domain orders extended installation, whmcs domain orders extended common problems, about whmcs domain orders extended, whmcs domain orders extended documentation, whmcs domain orders extended faq, whmcs domain orders extended help, whmcs domain orders extended guide, whmcs domain orders extended wiki, whmcs domain orders extended tutorial, whmcs domain orders extended tips, whmcs domain orders extended wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domain Orders Extended For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domain Orders Extended For WHMCS Module."></meta>
 +
 
=About [https://www.modulesgarden.com/products/whmcs/domain-orders-extended Domain Orders Extended For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/domain-orders-extended Domain Orders Extended For WHMCS]=
 
{|
 
{|
 
|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 7 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 12:
 
*'''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 Four External Domain Search Types
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Fast Cron Domain Lookup
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Simultaneous Domain Searches In Multiple Spinners
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Search For Various Domain Names In Bulk - "Lagom" And "List View" Search Types
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Perform Bulk Actions:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Add All Domains To Cart
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transfer All Domains
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Register All Domains
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Bulk Search Order Form
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Domain Name Suggestions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Domain Spinners (Name Suggestions) - Based On eNom And OpenSRS
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Domain Labels
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Lookup For Domains In One Request - Supports eNom And OpenSRS
+
|style="padding: 0px 0px 0px 30px;"|✔ Display TLDs Basing On Defined Prioritization And Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Checkout Of Domains In One Request
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Dynamic Prices Of Premium Domains Based On Registrar Values And WHMCS Price Markups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Ajax Search - One By One
+
|style="padding: 0px 0px 0px 30px;"|✔ Display TLD Prices To Client Groups Based On Set Pricing Slabs
 
|}
 
|}
 
{|
 
{|
−
|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 58:
 
|}
 
|}
 
{|
 
{|
−
|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 For Default And Custom Slab Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Categories And Registrars
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Domain Grace And Redemption Periods Pricing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Lookup Submodules
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Domain Labels
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Lookup Submodule - eNom, OpenSRS Or Default
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Domain Addons And EPP Code
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Search Form - Multiple Domains, Single Domain Or Category Search
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Promoted TLDs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Prefixes And Suffixes Of Suggested Domains
+
|style="padding: 0px 0px 0px 45px;"|✔ Delete TLDs From Categories
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Import TLD Sets From Predefined List
+
|style="padding: 0px 0px 0px 30px;"|✔ Quickly Preview TLD's Pricing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ TLDs Filtering
+
|style="padding: 0px 0px 0px 30px;"|✔ Import TLD Sets To Categories From Predefined List
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Migration Tool
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Lookup Submodules:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ gTLDs & ccTLDs Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Default Or Custom WHMCS Provider
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ IDN Support
+
|style="padding: 0px 0px 0px 45px;"|✔ CPS-Datensysteme GmbH
 
|}
 
|}
 
{|
 
{|
−
|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 45px;"|✔ Enom
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 45px;"|✔ HEXONET
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 45px;"|✔ OpenSRS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 45px;"|✔ NetEarthOne
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 45px;"|✔ ResellerCamp
 
|}
 
|}
−
 
−
=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;"|✔ ResellerClub
−
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 45px;"|✔ Add Your Own Lookup Submodules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Set TLDs Searched By Default
 
|}
 
|}
 
{|
 
{|
−
|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 0px 30px;"|✔ Toggle Premium Domains
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Search Of Domain Suggestions
 
|}
 
|}
 
{|
 
{|
−
|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 45px;"|✔ Define Returned Suggestions Limit
−
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;"|✔ Toggle Search Results Pagination - "Lagom" And "List View" Search Types
 
|}
 
|}
 
{|
 
{|
−
|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 45px;"|✔ Define Number Of Records To Show
−
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;"|✔ Select Default Label For Premium Domains
 
|}
 
|}
 
{|
 
{|
−
|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 0px 30px;"|✔ Add Customized TLD Labels:
−
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'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE4.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Label Title
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Adjust Label Priority
−
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 0px 45px;"|✔ Apply To Premium Domains Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Text And Background Color
−
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 20px 25px;"|[[File:DOE6.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Domain Search Type:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Domain Orders Extended For WHMCS!'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ List View
−
You can access your module in '' 'Addons' '' → '' 'Domain Orders Extended'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE7.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ General Category View
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. The last step concerns confirming the usage of default WHMCS lookup module.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Multi Category View
−
Go to '' 'Settings' '' tab and press '' 'Update Settings' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_7_1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Lagom - List View
 
|}
 
|}
−
 
−
=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 0px 45px;"|✔ Lagom - General Category View
−
It will also reduce the time required to do any actions on the domains due to implemented bulk actions feature.<br />
+
−
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 0px 45px;"|✔ Lagom - Multi Category View
−
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 0px 30px;"|✔ Configure Cron Domain Lookup:
 
|}
 
|}
−
==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 0px 45px;"|✔ Define Number Of Simultaneous Processes
−
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 0px 45px;"|✔ Define Number Of Search Records Per Process
 
|}
 
|}
 
{|
 
{|
−
|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 0px 30px;"|✔ Import TLDs From CSV File
−
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: 0px 0px 0px 30px;"|✔ Export TLDs To CSV File
 
|}
 
|}
 
{|
 
{|
−
|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 0px 30px;"|✔ Toggle Debug Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE10_1.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, select a desired registrar and press '' 'Update Registrars' '' button.
+
|style="padding: 10px 0px 0px 30px;"|✔ Requires Server With PHP "PCNTL FORK" Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE11.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ gTLDs & ccTLDs Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ IDN Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Drag & Drop Component Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Fully Integrated With Lagom WHMCS Client Theme
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/domain-orders-extended#open-source-version Open Source Version]
 
|}
 
|}
  
−
==TLDs Configuration==
+
=Installation=
 
{|
 
{|
−
|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 15px 15px;"|'''This tutorial will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/domain-orders-extended Domain Orders Extended For WHMCS.]''' <br />
−
To switch between Register/Renew/Transfer pricing, select one from the marked dropdown menu and press '' 'Filter Results'. ''<br />
+
We will guide you step by step through the whole installation and configuration process. <br/><br/>
−
To display/hide TLDs assigned to a category, press the category name as shown on the following screen.
+
'' '''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 20px 25px;"|[[File:DOE13.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:DOE3_1.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.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE14.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
 +
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!--  If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
−
==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:PHP72_74.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: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
 +
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:PHP56_74.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.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE16.png]]
+
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/domain-orders-extended#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
−
===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 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
−
Disable '' 'Toggle Autoupdate Mode' '' if you are not going to set up all of the payment terms.<br />
+
The content of the package to upload should look like this.  
−
Afterwards, fill out fields and press '' 'Save Pricing'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|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 15px 15px;"|'''4. When you install Domain Orders Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
You can also reassign category of selected TLDs, simply type its name into '' 'Assign To Category' '' auto-complete box.<br />
+
You can find it in '' 'modules/addons/DomainOrdersExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
−
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]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_3.png]]
 
|}
 
|}
 +
{|
 +
|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 />
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_4.png]]
 +
|}
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''6. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder should be available at '' 'your_whmcs/modules/addons/DomainOrdersExtended/' ''. If not, create one manually.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_6_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''7. 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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''8. 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 20px 25px;"|[[File:DOE3_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''9. 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 15px 15px;"|'''10. 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:DOE3_2_7_1.png]]
 +
|}
 +
-->
  
−
===Pricing Change===
+
=Configuration and Management=
 
{|
 
{|
−
|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 30px 15px;"|Domain Orders Extended will help you with the management of your domains and their pricing.<br />
−
In '' 'Price Change' '' you can change pricing of selected TLDs by fixed or percentage amount specified by you.<br />
+
It will also reduce the time required for performing actions on domains due to the implemented bulk actions feature.<br />
−
Start by selecting change types from '' 'Increase/Decrease'' ' and '' 'Percentage/Fixed' '' dropdown menus.<br />
+
Additionally, you can group TLDs into categories and select TLDs assigned to a given registrar.
−
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.
+
 
|}
 
|}
 +
==TLDs Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE19.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.
 
|}
 
|}
−
===Delete Pricing===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Delete Pricing' '' tab, you can remove the pricing from selected TLDs.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_7.png]]
−
To do so, simply press '' 'Yes, Proceed' '' button.
+
 
|}
 
|}
 +
===Add Category===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE20.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.
 
|}
 
|}
−
===Change Category===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To assign selected TLDs to one category, go to '' 'Change Category' '' tab.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_8.png]]
−
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]]
+
|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.
 
|}
 
|}
−
===Registrar Change===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Bulk actions tab allows you to change registrar.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_8_2.png]]
−
Proceed to '' 'Registrar Change' '' tab, select desired registrar and press '' 'Update Registrars'. ''
+
 
|}
 
|}
 +
 +
===Assign TLDs===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE21_1.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.''
 
|}
 
|}
−
===Duplicate TLDs===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Here you can create duplicate of TLDs and copy them to chosen category.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_9.png]]
−
''Note: Any changes made to pricing or registrar of original TLD take effect on duplicate and vice versa.''
+
 
|}
 
|}
 +
 +
===Edit TLD Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE21_2.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.
 
|}
 
|}
−
===Delete Domain===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can also remove chosen TLDs.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_10.png]]
−
To do so, move to '' 'Delete Domain' '' tab and press '' 'Yes, Proceed'. ''
+
 
|}
 
|}
 +
 +
===Edit TLD Pricing===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE22.png]]
+
|style="padding: 10px 0px 15px 15px;"|In the '' Edit TLD Pricing '' tab, you can set the domain pricing for each of registration periods in each available currency per every active domain pricing slab.<br />
 +
 
 +
In addition, if you put:
 +
* ''' -1 ''' (minus one) value in the chosen field, then it will be treated as '''disabled'''. E.g. provide '''-1''' for transfer pricing to completely '''disable''' the possibility of domain transfers with that TLD. <br/>'' '''Important:''' If you provide '''-1''' value for registration pricing, then the whole TLD will be treated as '''disabled''', including transfer and renewal pricing.''
 +
* ''' 0 ''' (zero) value in the chosen field, then it will be treated as '''free'''. E.g. provide '''0''' for registration pricing if you want to offer the selected TLD for '''free''', but with paid transfers and renewals.
 +
* any value '''above 0''' (zero) will be of course treated as '''paid'''.
 +
 
 +
Please also note that the prices may be applied to any active custom domain pricing slab.<br/> Still, you need to manually activate the slabs directly in WHMCS and set the pricing for every TLD firstly, these are applied according to the settings of the [https://docs.whmcs.com/Client_Groups client groups].<br/>
 +
 
 +
In addition, in case of using the WHMCS '''[https://docs.whmcs.com/Premium_Domains Premium Domains]''' feature, the price of a domain will be fetched directly from the registrar API and adjusted according to the WHMCS price markups.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_17.png]]
 
|}
 
|}
  
−
==Domain Categories==
+
===Edit Grace and Redemption Periods Pricing===
 
{|
 
{|
−
|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;"|This option allows to set up and edit the Domain Grace and Redemption Periods fees and duration. <br/> If you have already set up Grace/Redemption Periods in WHMCS, the values will be overwritten by the module.<br/>
−
You can also order bulk actions for the TLDs assigned to a specified category by pressing '' 'Bulk Actions For Domains'. ''
+
'''''Note:''' This option is available for WHMCS V7.5 and later. If you are using previous version of the system, you will not have access to this feature.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_18.png]]
 +
|}
 +
 
 +
===Bulk Actions===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Our module allows you to perform actions simultaneously on multiple TLDs. <br />
 +
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:DOE3_15.png]]
 +
|}
 +
 
 +
===Order of Categories and TLDs===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Using drag & drop allows you to change the order of the categories, subcategories and TLDs. <br/>
 +
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:''' Promoted categories (marked with stars) 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 15px 15px;"|Additionally, you can view TLDs assigned to categories.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_19.png]]
−
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: 10px 0px 20px 15px;"|After dragging, the new order is automatically saved.
 
|}
 
|}
 
{|
 
{|
−
|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: 0px 0px 20px 25px;"|[[File:DOE3_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_24_1.png]]
+
|style="padding: 10px 0px 30px 15px;"|
 +
Depending on the selected [[#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
 +
#Categories order on the list
 +
#Promoted TLDs
 +
#TLDs with labels
 +
#TLDs order on the categories 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 '' '[[#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 />
−
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.
 +
 
 +
* '''Enable Premium Domains''' - decide whether to enable or disable the [https://docs.whmcs.com/Domain_Pricing#Premium_Domains premium domains] purchases.
 +
 
 +
* '''Enable Bulk Search''' - enable the option to search domains in bulks with all the available search types.
 +
 
 +
* '''Enable Results Pagination''' - Select to enable pagination of search results. Keep in mind that this option is available for '' '[[#Lagom_View|Lagom]]' '' and '' '[[#List View|List View]]' '' search types only.
 +
** '''Number Of Records To Show''' - Define a maximum number of records to show in a single results load. View further records by pressing '' 'Show More Results' '' button.
 +
 
 +
* '''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.
 +
 
 +
* '''Domain Search Type''' - select one of four 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
 +
**'''Lagom''' - searched domains will be displayed in a single list in an alphabetical order <br/>
 +
'' '''Note:''' Check the '[[#Client Area|Client Area]]' section to see the visual differences between the domain search types.''
 +
 
 +
*'''Suggestions Lookup''' - select the provider you want to use in order to search for domain suggestions, remember they must have been previously configured in the '' '[[#Submodules|Submodules]]' '' settings
 +
**'''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'''
 +
**'''OpenSRS'''
 +
**'''HEXONET'''
 +
**'''ResellerClub'''
 +
**'''ResellerCamp'''
 +
**'''NetEarthOne'''  '' '''Note:''' For your convenience, suggested domains available for registration will be shown in the search results, despite that the provider might also suggest the already taken domains.''<br / > '' '''Note 2:''' If in the meantime any of the providers has been deactivated, you will need to reset the suggested search selection and save data again.''<br/>
 +
 
 +
*'''Returned Suggestions Limit''' - Define the maximum number of records that will be displayed in the '' 'Suggestions' '' section in the client area. Set to '' '-1' '' to show all suggested domains.
 +
 
 +
*'''Default Label for Premium Domains''' - Choose a label that will be automatically added to all domains that are considered as "Premium" domains.<br/> The label will be visible both in the client area in and in the addon.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_27.png]]
 
|}
 
|}
 +
 +
===Cron Settings===
 +
{|
 +
|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 number 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.''
 +
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Single 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. 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
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_26_1.png]]
+
|style="padding: 0px 0px 30px 15px;"|To run cron processes, simply add a cron job as shown below (every 5 minutes suggested).
 +
php -q /yourWHMCS/modules/addons/DomainOrdersExtended/cron/cron.php DemonTask
 +
Do not forget to replace '' 'yourWHMCS' '' with your WHMCS root location.<br/>
 +
 
 +
'' '''Important:''' Server with PHP "PCNTL FORK" support is required.'<br />
 +
 
 +
Moreover once the cron process has been launched, you cannot change the number of running processes on the fly. <br >
 +
To change them, stop the cron, change the number and launch it again.
 
|}
 
|}
 +
 +
===Logs Settings===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Multiple domain Search'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|In the end you may turn on the Debug Mode to have insight into any errors occurrences, you will find a list of any log entries in the log section.<br/>
−
1. Replace Standard Registrar With Module Order Form - if marked, a standard registration form will be replaced with Domain Orders Extended form.<br/>
+
'''''Note:''''' It is advised to keep it turned off on daily basis and enable only when necessary.'''
−
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 25px;"|[[File:DOE3_28_1.png]]
 
|}
 
|}
 +
 +
==Submodules==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Category Search'''<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:
−
1. Suggested Prefixes - allows you to define the list of prefixes used to create suggested domains.<br/>
+
*'''Default Submodule'''
−
2. Suggested Suffixes -allows you to define the list of suffixes used to create suggested domains.<br/>
+
*'''CPS-Datensysteme GmbH'''
−
3. Replace Standard Registrar With Module Order Form - if marked, a standard registration form will be replaced with Domain Orders Extended form.<br/>
+
*'''OpenSRS'''
−
4. Enable Auto Expanded Categories In TLD Configuration - categories will be expanded automatically in the addon →'' 'TLDs Configuration'. ''<br/>
+
*'''Enom'''
−
5. Enable Auto Expanded SubCategories In TLD Configuration - subcategories will be expanded automatically in the addon →'' 'TLDs Configuration'.''
+
*'''HEXONET'''
 +
*'''RessellerClub'''
 +
*'''ResellerCamp'''
 +
*'''NetErathOne'''
 +
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 that is supported by all of them, then the domain will be checked first by the ''OpenSRS'' submodule, <br/>then, if it has not been found or in case the first provider returns an error, it will be searched by the Enom submodule, and lastly, by the default WHMCS lookup.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_26_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_29.png]]
 
|}
 
|}
  
−
===Domain Lookup Module===
+
==Labels==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The ability to order a group of domains entails a large quantity of requests.<br />
+
|style="padding: 10px 0px 15px 15px;"|Here you can create labels that can then be assigned to the selected TLDs. <br/>
−
Default WHMCS lookup module may work extremely slowly while checking a large amount of domains. Therefore we integrated an additional lookup module.<br />
+
Each label may be distinguished by its own color and may receive priority. <br/>
−
To use the external lookup module, select it from a '' 'Domain Lookup Module' '' dropdown menu.<br />
+
Labels will then be displayed next to the assigned TLD on the domain search and suggestions results.
−
Next, fill in module configuration.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Additionally, you can define configuration of the domain spinner.<br />
+
|style="padding: 10px 0px 15px 15px;"|To start, press the '' 'Add Label' '' button to create the first one. <br/>
−
Press '' 'Update Settings' '' to save changes.
+
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 30px 25px;"|[[File:DOE2_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_31.png]]
 
|}
 
|}
 +
{|
 +
|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/>
 +
Please be aware that '' 'Premium' '' labels will be displayed with premium domains only.<br/>
  
−
==Integration Code==
+
To learn how to assign the label to a particular TLD, see the '' '[[#Edit TLD Configuration|Edit TLD Configuration]]' section.
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Integration Code' '' tab contains integration code allowing your clients to access bulk domain lookup form.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_32.png]]
−
The form must be located in the location defined under '' 'Path To External Form' '' field in '' 'Settings' '' page.<br />
+
−
As you can see on the following screen, you can choose from a wide variety of domain order forms.<br />
+
−
Additionally, you can check here if Domain Orders Extended domain order form is currently used.
+
 
|}
 
|}
 +
 +
==Import==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE29.png]]
+
|style="padding: 10px 0px 20px 15px;"|In this section you may import TLDs to your system from a file containing any configuration details of the TLDs.<br/>
 
|}
 
|}
−
==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.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_1.png]]
 
|}
 
|}
−
===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 />
+
|style="padding: 0px 0px 15px 15px;"|Start with preparing a file with a list of TLDs with ready configuration that will be transferred to the module.<br/>A default file with the TLDs set must include the exactly same heading as shown below:
−
They can choose even domains using gTLDs and ccTLDs!<br />
+
 
−
'''Important:''' Custom order forms are not supported by 'Ajaxcart' order form template.<br />
+
  tld,type,period,price,currency,slab,group,registrar,labels,promoted,dns_management,email_forward,id_protection,epp_code
−
<br /><br />
+
 
−
'''TLD Visibility'''<br />
+
Make sure there are no typos or unnecessary spaces in the headings as the file will not be uploaded and an error notification will appear.<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.
+
In order to successfully import the uploaded TLDs to the system the following data are '''required:'''  
 +
*'''TLD'''
 +
*'''Type'''
 +
*'''Period'''
 +
*'''Price'''
 +
*'''Currency'''
 +
*'''Group'''<br/>
 +
 
 +
Remaining data are optional and may be left empty in the uploaded file. <br/>
 +
 
 +
Underneath you may take a look at the optional content of a correctly filled in file:
 
|}
 
|}
−
====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 20px 25px;"|[[File:DOE3_32_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_30.png]]
+
|style="padding: 0px 0px 15px 15px;"|When you have a ready file, press the '' 'Upload File' '' button to begin.<br/>
 +
'''''Important:''' Make sure the 'importFiles' file located in '/addons/domainOrdersExtended/storage/app/' has permissions set to writable, otherwise the upload process will be blocked.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Find the file and upload it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|All TLDs will be uploaded immediately and will appear on  a clear and easy to read list .<br/> Now, select the TLDs that you want to import to your system  and press '' 'Import TLDs'. ''<br/>
 +
'''''Note:''' Keep in mind that if you select TLDs that already exist in your WHMCS their configuration will be overwritten with the new one.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|When the import task has been completed, you will see a detailed report on the results with enumerated every TLD, its status and message.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_32_6.png]]
 
|}
 
|}
  
−
====Multiple Domains Search====
+
==Export==
 
{|
 
{|
−
|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;"|This section allows to export the TLDs from your system to a ''.csv'' file.<br/>
−
''Note: When switching between categories, TLDs chosen in other categories are not cleared.''<br />
+
'''''Note:''' If the number of TLDs in your system is high, it might take a while to load the page, please wait a moment to see the list of all TLDs.''
−
''Therefore your clients can order domains with TLDs from different categories during one order.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_7.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: 0px 0px 15px 15px;"|You may export all TLDs at once to a single file, simply press the button marked on the screen.<br/>Information on the TLD type, pricing, registrars, labels and others will be included in the file.<br/>
−
If some of the domains are unavailable, clients can go to domains www address, view its whois and transfer it.
+
'''''Information:''' Set the "exportFiles" file permissions to writable to successfully use this option.<br/> You will find the file in: 'modules/addons/DomainOrdersExtended/storage/app/exportFiles' directory.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_8.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: 0px 0px 15px 15px;"|It is also possible to export selected TLDs only.<br/> You will need to manually find them on the list, mark the select boxes next to them and then press the mass action button that will appear.  
−
If clients do not want to order some of the domains, they have to unmark checkboxes next to those domains.<br />
+
−
Press '' 'Proceed To The Cart' '' to continue shopping.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_32_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Once you have confirmed the action, the file will be generated and downloaded instantly.<br/> That is how an exemplary content might look like.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_33_1.png]]
 
|}
 
|}
  
−
====Category Search====
+
==Logs==
 
{|
 
{|
−
|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;"|If there are any problems with the operation of submodules, you will find corresponding '''errors''' from the API responses in the 'Logs' section.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE2_33_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_33.png]]
 
|}
 
|}
−
===Domain Spinner===
+
 
 +
==Client Area==
 
{|
 
{|
−
|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: 10px 0px 20px 15px;"|Now, we are about to show you the main functionality of this module, which is located in the client area.
−
Let's take a look at how it works, for this purpose, order single domain with 2 TLDs.
+
 
|}
 
|}
 +
===Domains Lookup===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|As soon as you check '' 'Replace Standard Registrar With Module Order Form' ''  in '' '[[#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 '' '[[#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.
 
|}
 
|}
 
{|
 
{|
−
|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: 0px 0px 20px 25px;"|[[File:DOE3_30_1.png]]
−
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 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;"|Now, make another lookup, but this time enable '' 'Enable Multiple Domain Search' '' in the module settings.<br />
+
|style="padding: 10px 0px 15px 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 will be divided and the button to '' 'Show More Results' '' will be available, just like on the screen below. There also might be shown domain suggestions if such have been allowed by the admin.<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'. ''
+
Use the '' 'Domain Bulk Actions' '' button to:
 +
* ''Add all domains to cart'' - all "Available" domains are registered, "Taken" domains are transferred, not available domains are skipped. this action is a default one.
 +
* ''Transfer all domains'' - all domains marked as "Taken" are transferred, all the others are skipped
 +
* ''Register all domains'' - only "Available" domains are registered, all the others on the list are skipped
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE2_33_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As shown on the screen below, domain spinner mixed domain names you were looking for.<br />
+
|style="padding: 0px 0px 20px 15px;"|You may also use the option to search domains in bulk, note that this option must be previously enabled by the administrator.<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 25px;"|[[File:DOE3_2_30_1.png]]
 +
|}
 +
 
 +
====General Category View====
 +
{|
 +
|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.
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_33_5.png]]
−
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===
+
====Multi 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 20px 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.''
−
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_2_31.png]]
 
|}
 
|}
 +
====Lagom View====
 
{|
 
{|
−
|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: 10px 0px 15px 15px;"|'''Lagom - List View'''<br/>
 +
 
 +
This view type shows promoted TLDs on the very first search page.<br/>
 +
'''''Note:''' The Lagom theme allows only one label to be visible here. If you have more, only the first in line will be added.''<br/>
 +
Notice that only 10 promoted TLDs are displayed and they are in an alphabetical order.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE33_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_32.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 15px;"|That is how the search results look like, when using a single domain search type.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:DOE33_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DOE3_2_32_1.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 20px 15px;"|Underneath, a bulk domain search view with '' 'Results Pagination' '' option on and the '' "Show More Results" '' button visible:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE33_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_2_33.png]]
 
|}
 
|}
−
 
+
<!--
−
==Migration==
+
 
{|
 
{|
−
|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: 0px 0px 20px 15px;"|
−
1. First of all, deactivate the module under '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
'''Lagom - General Category View'''
−
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 20px 25px;"|[[File:DOE3_5_1.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 20px 15px;"|
 +
'''Lagom - Multi Category View'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:DOE35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DOE3_5_2.png]]
 
|}
 
|}
 +
-->
  
 
=Tips=
 
=Tips=
Line 578: Line 768:
 
|}
 
|}
 
{|
 
{|
−
|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 5px 15px;"|3. In the case of certain registrars, like OpenSRS and Enom, the pricing of premium domains is returned by the API only in the USD currency.<br/>
−
*gettemplatesfromcat.tpl
+
For this reason, when using other currencies, it is required that the '' 'USD' '' currency code is still available in your WHMCS system.<br/>
−
*listalldomains.tpl
+
Thanks to that, the prices of premium domains provided in any other currency will be recalculated based on the '' 'Base Conv. Rate' '' settings from the USD value.
−
*listavailabledomain.tpl
+
|}
−
*listavailabledomains.tpl
+
{|
−
*listspinner.tpl
+
|style="padding: 0px 0px 30px 15px;"|4. If you want to translate the category or subcategory name (CA view only), simply add a new entry into the english.php file with a new name.<br/> See the below example:  <br/>
 +
<pre>$LANG['categoryLang']['CategoryName'] = "YourCategoryNewName";</pre>
 +
In your file: <br/>
 +
<pre>$_LANG['categoryLang']['General'] = "GeneralGroup";  </pre>
 +
<pre>$_LANG['categoryLang']['European Union'] = "EU";  </pre>
 +
 
 +
|}
 +
 
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/domain-orders-extended#open-source-version Open Source version] of your Domain Orders Extended For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.  
 
|}
 
|}
  
Line 594: Line 803:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|2. If you encounter error:
+
|style="padding: 0px 0px 10px 15px;"|2. If you have problems with connection with OpenSRS submodule, make sure that ports '''51000''' and '''55443'''  are open.
−
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.
+
{|
 +
|style="padding: 0px 0px 5px 15px;"|3. If you face problems with searching domains using the cron task and there is no information in logs, you might look at the cronLog file content.<br/>
 +
You will find this file at: ''yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|4. In case no logs are visible in the '' 'Logs' '' section, and the debug mode is on, then please clear the DomainOrdersExtended_Logger tables manually in your database.<br/>
 +
The problem might be caused by a too high number of log entries.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|5. If you encounter the below error with the OpenSRS submodule:
 +
oSRS Error Code #400: Could not get credentials for reseller RESELLER_NAME
 +
Please ensure you have provided the correct API details and that the '''main user''' has been used to connect with API.  
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|6. If you cannot export all the available TLDs into a file, please check the PHP, ''max_input_vars'' settings.<br/> Increase the ''max_input_vars'' limit to allow downloading a required number of records.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|7. The Domain Orders Extended For WHMCS module is partially integrated with the following modules:
 +
* [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS] module - you must be aware that branding is not fully supported yet and Domain Orders Extended works well with the '''main brand''' only.
 +
* [https://www.modulesgarden.com/products/whmcs/resellers-center Resellers Center For WHMCS] module - the module functionality is limited for '''reseller clients''' who utilize the '''Allow CNAME''' option.  
 
|}
 
|}

Latest revision as of 13:46, 26 April 2024

Contents

[edit] 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 7 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 Four External Domain Search Types
✔ Fast Cron Domain Lookup
✔ Simultaneous Domain Searches In Multiple Spinners
✔ Search For Various Domain Names In Bulk - "Lagom" And "List View" Search Types
✔ Perform Bulk Actions:
✔ Add All Domains To Cart
✔ Transfer All Domains
✔ Register All Domains
✔ Display Domain Name Suggestions
✔ Display Domain Labels
✔ Display TLDs Basing On Defined Prioritization And Order
✔ Display Dynamic Prices Of Premium Domains Based On Registrar Values And WHMCS Price Markups
✔ Display TLD Prices To Client Groups Based On Set Pricing Slabs
✔ 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 For Default And Custom Slab Groups
✔ Set Domain Grace And Redemption Periods Pricing
✔ Set Domain Labels
✔ Set Domain Addons And EPP Code
✔ Toggle Promoted TLDs
✔ Delete TLDs From Categories
✔ Quickly Preview TLD's Pricing
✔ Import TLD Sets To Categories From Predefined List
✔ Choose Domain Lookup Submodules:
✔ Default Or Custom WHMCS Provider
✔ CPS-Datensysteme GmbH
✔ Enom
✔ HEXONET
✔ OpenSRS
✔ NetEarthOne
✔ ResellerCamp
✔ ResellerClub
✔ Add Your Own Lookup Submodules
✔ Set TLDs Searched By Default
✔ Toggle Premium Domains
✔ Toggle Search Of Domain Suggestions
✔ Define Returned Suggestions Limit
✔ Toggle Search Results Pagination - "Lagom" And "List View" Search Types
✔ Define Number Of Records To Show
✔ Select Default Label For Premium Domains
✔ Add Customized TLD Labels:
✔ Set Label Title
✔ Adjust Label Priority
✔ Apply To Premium Domains Only
✔ Set Text And Background Color
✔ Choose Domain Search Type:
✔ List View
✔ General Category View
✔ Multi Category View
✔ Lagom - List View
✔ Lagom - General Category View
✔ Lagom - Multi Category View
✔ Configure Cron Domain Lookup:
✔ Define Number Of Simultaneous Processes
✔ Define Number Of Search Records Per Process
✔ Import TLDs From CSV File
✔ Export TLDs To CSV File
✔ Toggle Debug Mode
✔ View Logs
  • General Info:
✔ Requires Server With PHP "PCNTL FORK" Support
✔ gTLDs & ccTLDs Support
✔ IDN Support
✔ Drag & Drop Component Support
✔ Fully Integrated With Lagom WHMCS Client Theme
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] 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 our client area and download the module.
DOE3 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

DOE3 2 2.png
4. 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
5. 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 our client area → 'My Products'.

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

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

DOE3 6 2.png
7. 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
8. 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
9. You have just successfully installed Domain Orders Extended For WHMCS!

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

[edit] 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.

[edit] 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

[edit] 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

[edit] 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] 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] Edit TLD Pricing

In the Edit TLD Pricing tab, you can set the domain pricing for each of registration periods in each available currency per every active domain pricing slab.

In addition, if you put:

  • -1 (minus one) value in the chosen field, then it will be treated as disabled. E.g. provide -1 for transfer pricing to completely disable the possibility of domain transfers with that TLD.
    Important: If you provide -1 value for registration pricing, then the whole TLD will be treated as disabled, including transfer and renewal pricing.
  • 0 (zero) value in the chosen field, then it will be treated as free. E.g. provide 0 for registration pricing if you want to offer the selected TLD for free, but with paid transfers and renewals.
  • any value above 0 (zero) will be of course treated as paid.

Please also note that the prices may be applied to any active custom domain pricing slab.
Still, you need to manually activate the slabs directly in WHMCS and set the pricing for every TLD firstly, these are applied according to the settings of the client groups.

In addition, in case of using the WHMCS Premium Domains feature, the price of a domain will be fetched directly from the registrar API and adjusted according to the WHMCS price markups.

DOE3 2 17.png

[edit] Edit Grace and Redemption Periods Pricing

This option allows to set up and edit the Domain Grace and Redemption Periods fees and duration.
If you have already set up Grace/Redemption Periods in WHMCS, the values will be overwritten by the module.

Note: This option is available for WHMCS V7.5 and later. If you are using previous version of the system, you will not have access to this feature.

DOE3 2 18.png

[edit] 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

[edit] 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: Promoted categories (marked with stars) 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 the list
  3. Promoted TLDs
  4. TLDs with labels
  5. TLDs order on the categories list

[edit] 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

[edit] Settings

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

[edit] 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.
  • Enable Premium Domains - decide whether to enable or disable the premium domains purchases.
  • Enable Bulk Search - enable the option to search domains in bulks with all the available search types.
  • Enable Results Pagination - Select to enable pagination of search results. Keep in mind that this option is available for 'Lagom' and 'List View' search types only.
    • Number Of Records To Show - Define a maximum number of records to show in a single results load. View further records by pressing 'Show More Results' button.
  • 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 four 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
    • Lagom - searched domains will be displayed in a single list in an alphabetical order

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

  • Suggestions Lookup - select the provider you want to use in order to search for domain suggestions, remember they must have been previously configured in the 'Submodules' settings
    • 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
    • OpenSRS
    • HEXONET
    • ResellerClub
    • ResellerCamp
    • NetEarthOne Note: For your convenience, suggested domains available for registration will be shown in the search results, despite that the provider might also suggest the already taken domains.
      Note 2: If in the meantime any of the providers has been deactivated, you will need to reset the suggested search selection and save data again.
  • Returned Suggestions Limit - Define the maximum number of records that will be displayed in the 'Suggestions' section in the client area. Set to '-1' to show all suggested domains.
  • Default Label for Premium Domains - Choose a label that will be automatically added to all domains that are considered as "Premium" domains.
    The label will be visible both in the client area in and in the addon.
DOE3 27.png

[edit] 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 number 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.

DOE3 28.png
To run cron processes, simply add a cron job as shown below (every 5 minutes suggested). 
php -q /yourWHMCS/modules/addons/DomainOrdersExtended/cron/cron.php DemonTask

Do not forget to replace 'yourWHMCS' with your WHMCS root location.

Important: Server with PHP "PCNTL FORK" support is required.'

Moreover once the cron process has been launched, you cannot change the number of running processes on the fly.
To change them, stop the cron, change the number and launch it again.

[edit] Logs Settings

In the end you may turn on the Debug Mode to have insight into any errors occurrences, you will find a list of any log entries in the log section.

Note: It is advised to keep it turned off on daily basis and enable only when necessary.

DOE3 28 1.png

[edit] Submodules

In this section, you can configure the connection data to use an external domain lookup provider. The currently available are:
  • Default Submodule
  • CPS-Datensysteme GmbH
  • OpenSRS
  • Enom
  • HEXONET
  • RessellerClub
  • ResellerCamp
  • NetErathOne

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 that is supported by all of them, then the domain will be checked first by the OpenSRS submodule,
then, if it has not been found or in case the first provider returns an error, it will be searched by the Enom submodule, and lastly, by the default WHMCS lookup.

DOE3 29.png

[edit] 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.

Please be aware that 'Premium' labels will be displayed with premium domains only.

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

DOE3 32.png

[edit] Import

In this section you may import TLDs to your system from a file containing any configuration details of the TLDs.
DOE3 32 1.png
Start with preparing a file with a list of TLDs with ready configuration that will be transferred to the module.
A default file with the TLDs set must include the exactly same heading as shown below: 
 tld,type,period,price,currency,slab,group,registrar,labels,promoted,dns_management,email_forward,id_protection,epp_code

Make sure there are no typos or unnecessary spaces in the headings as the file will not be uploaded and an error notification will appear.

In order to successfully import the uploaded TLDs to the system the following data are required:

  • TLD
  • Type
  • Period
  • Price
  • Currency
  • Group

Remaining data are optional and may be left empty in the uploaded file.

Underneath you may take a look at the optional content of a correctly filled in file:

DOE3 32 2.png
When you have a ready file, press the 'Upload File' button to begin.

Important: Make sure the 'importFiles' file located in '/addons/domainOrdersExtended/storage/app/' has permissions set to writable, otherwise the upload process will be blocked.

DOE3 32 3.png
Find the file and upload it.
DOE3 32 4.png
All TLDs will be uploaded immediately and will appear on a clear and easy to read list .
Now, select the TLDs that you want to import to your system and press 'Import TLDs'.

Note: Keep in mind that if you select TLDs that already exist in your WHMCS their configuration will be overwritten with the new one.

DOE3 32 5.png
When the import task has been completed, you will see a detailed report on the results with enumerated every TLD, its status and message.
DOE3 32 6.png

[edit] Export

This section allows to export the TLDs from your system to a .csv file.

Note: If the number of TLDs in your system is high, it might take a while to load the page, please wait a moment to see the list of all TLDs.

DOE3 32 7.png
You may export all TLDs at once to a single file, simply press the button marked on the screen.
Information on the TLD type, pricing, registrars, labels and others will be included in the file.

Information: Set the "exportFiles" file permissions to writable to successfully use this option.
You will find the file in: 'modules/addons/DomainOrdersExtended/storage/app/exportFiles' directory.

DOE3 32 8.png
It is also possible to export selected TLDs only.
You will need to manually find them on the list, mark the select boxes next to them and then press the mass action button that will appear.
DOE3 32 9.png
Once you have confirmed the action, the file will be generated and downloaded instantly.
That is how an exemplary content might look like.
DOE3 33 1.png

[edit] Logs

If there are any problems with the operation of submodules, you will find corresponding errors from the API responses in the 'Logs' section.
DOE3 33.png

[edit] Client Area

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

[edit] 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.

[edit] 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 will be divided and the button to 'Show More Results' will be available, just like on the screen below. There also might be shown domain suggestions if such have been allowed by the admin.

Use the 'Domain Bulk Actions' button to:

  • Add all domains to cart - all "Available" domains are registered, "Taken" domains are transferred, not available domains are skipped. this action is a default one.
  • Transfer all domains - all domains marked as "Taken" are transferred, all the others are skipped
  • Register all domains - only "Available" domains are registered, all the others on the list are skipped
DOE3 2 30.png
You may also use the option to search domains in bulk, note that this option must be previously enabled by the administrator.
DOE3 2 30 1.png

[edit] 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

[edit] 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

[edit] Lagom View

Lagom - List View

This view type shows promoted TLDs on the very first search page.
Note: The Lagom theme allows only one label to be visible here. If you have more, only the first in line will be added.
Notice that only 10 promoted TLDs are displayed and they are in an alphabetical order.

DOE3 2 32.png
That is how the search results look like, when using a single domain search type.
DOE3 2 32 1.png
Underneath, a bulk domain search view with 'Results Pagination' option on and the "Show More Results" button visible:
DOE3 2 33.png

[edit] 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. In the case of certain registrars, like OpenSRS and Enom, the pricing of premium domains is returned by the API only in the USD currency.

For this reason, when using other currencies, it is required that the 'USD' currency code is still available in your WHMCS system.
Thanks to that, the prices of premium domains provided in any other currency will be recalculated based on the 'Base Conv. Rate' settings from the USD value.

4. If you want to translate the category or subcategory name (CA view only), simply add a new entry into the english.php file with a new name.
See the below example: 
$LANG['categoryLang']['CategoryName'] = "YourCategoryNewName";

In your file: 

$_LANG['categoryLang']['General'] = "GeneralGroup";  
$_LANG['categoryLang']['European Union'] = "EU";

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Domain Orders Extended For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you have problems with connection with OpenSRS submodule, make sure that ports 51000 and 55443 are open.
3. If you face problems with searching domains using the cron task and there is no information in logs, you might look at the cronLog file content.

You will find this file at: yourWHMCS/modules/addons/DomainOrdersExtended/storage/crons

4. In case no logs are visible in the 'Logs' section, and the debug mode is on, then please clear the DomainOrdersExtended_Logger tables manually in your database.

The problem might be caused by a too high number of log entries.

5. If you encounter the below error with the OpenSRS submodule: 
oSRS Error Code #400: Could not get credentials for reseller RESELLER_NAME

Please ensure you have provided the correct API details and that the main user has been used to connect with API.

6. If you cannot export all the available TLDs into a file, please check the PHP, max_input_vars settings.
Increase the max_input_vars limit to allow downloading a required number of records.
7. The Domain Orders Extended For WHMCS module is partially integrated with the following modules:
  • Multibrand For WHMCS module - you must be aware that branding is not fully supported yet and Domain Orders Extended works well with the main brand only.
  • Resellers Center For WHMCS module - the module functionality is limited for reseller clients who utilize the Allow CNAME option.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Domain_Orders_Extended_For_WHMCS&oldid=66702"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Domain Orders Extended For WHMCS