Personal tools
Namespaces

Variants
Actions

Domain Orders Extended 2.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Domain Lookup Module)
(Integration Code)
Line 351: Line 351:
 
==Integration Code==
 
==Integration Code==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Integration Code' '' tab contains integration code allowing your client to access bulk domain order form from location defined in '' 'Path To External Form' ''.<br />
+
|style="padding: 10px 0px 15px 15px;"|'' 'Integration Code' '' tab contains integration code allowing your client to access bulk domain order form at the location defined in the '' 'Path To External Form' ''.<br />
 
As you can see on the following screen, you can choose from wide variety of domain order forms.
 
As you can see on the following screen, you can choose from wide variety of domain order forms.
 
|}
 
|}

Revision as of 10:42, 19 August 2014

Contents

About Domain Orders Extended For WHMCS

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconveniences.

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

Module lets your clients to perform multiple lookup and checkout for domains in a single request in entirely new domain order form in your own WHMCS client area.

  • Features:
✔ Grouping Domains Into Categories
Possibility To Make Bulk Changes On Multiple Domains:
✔ Create
✔ Set Pricing
✔ Update Domain Prices - Fixed Or Percentage
✔ Delete Categories, Prices And Domains
✔ Change Categories
✔ Possibility To Add Your Own Lookup Submodules
Configurable Domain Lookup Submodules:
✔ Predefined OpenSRS Submodule
✔ Predefined Submodule Based On Default PHP Functions
✔ Predefined TLD Sets To Import
✔ Domains Filtering
Completely New Domain Order Form In The Client Area:
✔ Multiple Lookup For Domains In One Request
✔ Multiple Checkout Of Domains In One Request
  • Additionally:
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

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.

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

Files in your WHMCS directory should look like this.

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

File is located at 'modules/addons/TLDsForm/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

DOE3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.'

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

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

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

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

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

DOE6.png
7. You have just successfully installed Domain Orders Extended For WHMCS!

You can access your module at 'Addons' 'Domain Orders Extended' .

DOE7.png
8. The last step concerns confirming usage of default WHMCS lookup module.

Go to the 'Settings' tab and press 'Update Settings' button.

DOE7 1.png

Configuration and Management

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

It will also reduce the time required to do any actions on domains owing to the bulk ctions.
Additionally, you can group TLDs into categories and decide which TLD is assigned to which registrar.

Add Category

Let's start from creating a category, go to your addon → 'Domain Categories' .

Afterwards, enter category name into the 'Categories Names' field and press 'Create Categories' button.
Note: You can create multiple quantity of categories at once. To do so, simply fill in one category per line into 'Categories Names' .

DOE8.png

New TLD

In order to add TLD, go to your addon → 'Bulk Actions' .

Afterwards, press 'Add TLD To List' button and type your TLD (both 'com' and '.com' forms are acceptable).
Note: You can create multiple quantity of TLDs at once by repeating this step.

DOE9.png
Now select previously created category, unmark 'Toggle Autoupdate Mode' and enter pricing for chosen TLDs.

To disable pricing term, mark 'Toggle 0 and -1 Price Ignoring' checkbox and type '0' for Register or '-1' for Transfer and Renew.
On the following screen you can see 3 TLDs with only 2 payment terms enabled for Register, Transfer and Renew.
Note 1: Autoupdate mode will automatically fill in fields, on the right side of field you are currently filling in, with incremented values.
Note 2: While 'Toggle 0 and -1 Price Ignoring' is enabled, you need to make change in TLD's yearly price to apply other price changes for selected TLD.

DOE10.png
Last step is assigning registrar to TLDs, select 'Basic' category (it contain all previously created TLDs) and press 'Bulk Registrar Change' .
DOE10 1.png
Afterwards, select a desired registrar and press 'Update Registrars' button.
DOE11.png

TLDs Configuration

In the 'TLDs Configuration' tab you can view all information related to your TLDs, like their categories, assigned registrars and prices.

To switch between Register/Renew/Transfer pricing, select it from marked dropdown menu and press 'Filter Results' .
To display/hide TLDs assigned to category, press category name as shown on the following screen.

DOE13.png
Another useful feature enables you to make quick changes, like changing assigned registrar, category or pricing at specific term.

To make such change, simply press value you desire to change and enter changes.
Value for the registrar and the category will be saved automatically, while at the price change you have to confirm changes as shown on the following screen.

DOE14.png

Bulk Actions

Our module allows you to order actions on multiple TLDs simultaneously. There are three methods to do it.

For first one, go to the 'TLDs Configuration' tab and mark checkboxes next to TLDs you want to order action for.
Afterwards, press button bounded to certain action. For example, to change category of all selected TLDs press 'Bulk Category Change' .
For second one, go to the 'Category' tab and press 'Bulk Actions For Domains' .
And last but not least, third method which consists of going to 'Bulk Actions' tab and manually adding TLDs to 'Domains List' .
Below we will guide you through available bulk actions.
Note: On the following screen you can see the first method.

DOE15.png
As soon as you are moved to bulk actions, you can switch between them via entering different subtabs marked on the following screen.

Note: You can also add new TLDs or already existing ones to bulk action you are currently performing.
Simply, press 'Add TLD' button under TLD list and type TLD you wish to add.

DOE16.png

Pricing

In the bulk 'Set Pricing' action you can set a new pricing or copy pricing assigned to any of existing TLDs.

Disable 'Toggle Autoupdate Mode' if you are not going to set up all payment terms.
Afterwards, fill fields and press 'Save Pricing' .

DOE17.png
If you desire to copy pricing from older TLD, choose it from 'Copy Pricing From' dropdown menu. Pricing will be automatically updated.

You can also reassign category for selected TLDs, simply type its name into 'Assign To Category' auto-complete box.
Confirm changes through pressing 'Save Changes' at the bottom of the screen.
Note: If category you entered does not exist, it will be automatically created.

DOE18.png

Pricing Change

If for some reason you will need to change the payment for TLDs by fixed or percentage value, then our module makes it available to you.

At the 'Price Change' you can change pricing for selected TLDs by fixed or percentage value specified by you.
Start by selecting change way from an 'Increase/Decrease ' dropdown menu and the change type from 'Percentage/Fixed' dropdown menu.
Afterwards, type value to change by and press 'Submit Changes' .
Setup shown on the following screen will remove 10% value of prices from every fields of chosen TLDs.

DOE19.png

Delete Pricing

In the 'Delete Pricing' subtab, you can remove pricing from selected TLDs.

To do so, simply press 'Yes, Proceed' button.

DOE20.png

Change Category

To assign selected TLDs to one category, go to 'Change Category' subtab.

Afterwards, type category name into 'New Category' auto-complete box.
If category you entered does not exist, it will be automatically created during process.

DOE21.png

Registrar Change

Bulk actions allows you to change registrar.

Proceed to 'Registrar Change' subtab, select desired registrar and press 'Update Registrars' .

DOE21 1.png

Delete Domain

You can also remove chosen TLDs.

To do so, move to 'Delete Domain' subtab and press 'Yes, Proceed' .

DOE22.png

Domain Categories

In the 'Domain Categories' you can add a new categories and manage existing ones.

You can also order bulk actions for TLDs assigned to specified category by pressing 'Bulk Actions For Domains' .

DOE23.png
Additionally, you can view TLDs assigned to categories.

Simply, move mouse cursor over fields in 'Domains' column as shown on the following screen.

DOE24.png

Predefined TLDs

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

As you can see, TLDs are sorted into three subtabs. Each tab contains TLDs sorted into categories, each category can have its own subcategories.
Mark checkbox as shown on the following screen to mark all TLD it selected category and press 'Install Extensions' .

DOE25.png
Installing of TLDs from selected subcategories are also possible, press category name to extend it and show all of its subcategories.

Afterwards, mark checkboxes next to desired subcategories and press 'Install Extendions' .
Note: This way you can install multiple subcategories from different categories, only limitation are subtabs. You can install TLDs from one subtab at once.

DOE26.png

Settings

In the 'Settings' tab you are able to define behaviour of the module as well as configure external lookup module.

Base Settings

Here you can set up behaviour of the Domain Orders Extended For WHMCS module.

1. If marked, standard registration form will be replaced with Domain Orders Extended form, no integration code required.
2. Place here URL to external domain registration form if you are using it.
3. Shows results directly on the lookup page - multiple domain search only.
4. Enables to search multiple domain names at once.
5. Auto expand categories at the addon → 'TLDs Configuration' .
6. Auto expand subcategories at the addon → 'TLDs Configuration' .

DOE26 1.png

Domain Lookup Module

Ability of ordering group of domains entails large quantity of requests.

Default WHMCS lookup module may work extremely slow at lookup of large amount of domains. Therefore we integrated additional lookup module.
To use external lookup module, select it from a 'Domain Lookup Module' dropdown menu.
Next, fill in module configuration.

DOE27.png
Additionally, you can define configuration of the domain spinner.

Press 'Update Settings' to save settings.

DOE28.png

Integration Code

'Integration Code' tab contains integration code allowing your client to access bulk domain order form at the location defined in the 'Path To External Form' .

As you can see on the following screen, you can choose from wide variety of domain order forms.

DOE29.png

Client Area Domains Lookup & Order

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

Using marked field, your client can define multiple domains to order.
Note: Check 'Enable Multiple Domain Search' to allow defining of multiple domain name with chosen TLDs.
Otherwise, your clients will be able to define only one domain with chosen TLDs.

DOE30.png
Your client have access only to TLDs assigned to categories.

Client can select TLDs from categories or switch back to 'All Categories' and use quick search.
As you can see on the following screen, our module supports subcategories, therefore you can sort your TLDs even more.

File:DOE30 1.png
After typing domain and selecting TLDs your client needs to press 'Check Availability' to proceed.

Important: There is disjunction relation between entered domain and selected TLDs.
For example, client type 'example' and 'mytestingdomain' domains and select '.com' and '.org' TLDs.
He will lookup 'example.com', 'example.org', 'mytestingdomain.com' and 'mytestingdomain.org'.
Note: When switching between categories, TLDs chosen at other categories are not cleared.
Therefore your client can order domains with TLDs from different categories during one order.

DOE31.png
After lookup, your client will see a screen similar to the one on the following screen.

If some of the domains are unavailable, client can go to domains www address, view its whois and transfer it.

DOE32.png
For available domains, client can decide if he wants to order domains and select registration period from a dropdown menu.

If client does not want to order some of the domains, he has to unmark checkboxes next to them.
Afterwards, customer has to press 'Proceed To The Cart' .

DOE33.png

Migration

You can easily upgrade your Domain Orders Extended For WHMCS 1.0 to latest version owing to migration tool.

1. First of all, deactivate the module at 'Setup' 'Addon Modules' .
2. Next, upload and extract Domain Orders Extended archive to your WHMCS main directory.
3. Activate the module and assign permission to it at 'Setup' 'Addon Modules' .
4. Proceed to 'Addons' 'Domain Orders Extended' 'Migration Tool' and press 'Migrate' button.

DOE34.png
As you can see, 'Migration Tool' disappeared from the module navigation, we will not need it any more due to successfully completed migration.
DOE35.png

Tips

1. TLDs are hidden for clients as long as they are not assigned to any category.

Common Problems

1. Predefined TLD set button is inactive at 'Predefined TLD Sets' despite of removing TLDs created by it.

Solution: Remove categories created earlier by using preset button.

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community