Resellerclub Tools Documentation

Upload and Configure the Addon

1. Upload the complete folders "includes", "modules" and "widgets" from the unzipped local folder \free_resellerclubmods_x.x.x\ into the folder where you have installed your WHMCS. For example, if you have installed WHMCS in /public_html/ folder, then upload the three mentioned folders into /public_html/. If you have installed WHMCS in a subfolder such as /whmcs, then upload the three folders into /public_html/whmcs/

   Do not upload the folder "widgets" into the modules folder!!! The folders "includes", "modules" and "widgets" must be uploaded into the folder where you have installed your WHMCS.

   Do not upload files individually into locations not indicated by these instructions.

   


2. Log into your WHMCS Admin Area


3. Goto Setup » Addon Modules. Click the "Green" Activate Button and then click the "Configure" Button:

   

4. This will show the configuration options for the Addon. Click the image to enlarge. Click to scroll down to the "BASIC Setup and Configuration for your 1# Live Reseller Account"

   

    

   BASIC Setup and Configuration for your 1# Live Reseller Account

    

   Complete only the following mandatory steps to setup the FREE Tool Suite for the first time.

   1. License Key: Enter your Free Licence key. You can fetch the key from our client area products details page or from the email you have received.
   
   

   Funds Widget Setup

   2. Funds Balance Widget: Tick to show the widget for your Resellerclub & LogicBoxes funds balance on the Admin Homepage. Note: You also need to activate the Admin Widget in WHMCS » Setup » Staff Management » Administrator Roles: "Widgets". Visit the TAB "Admin Widget" for further details.
   
   

   Reseller Accounts Setup

   1# Live or Demo Account

   3. Reseller API: The API URL is always https://httpapi.com. Do not add a trailing slash and do not change the URL!
   
   
   4. Display Name: Set any Display Name you wish. This helps to identify the active Account for the tools
   
   
   5. Select your Registrar: Select your Domain Provider from the dropdown menu. resellerclub, netearthone, stargate (resell.biz), etc.
   
   
   6. Reseller ID: Set your Reseller ID. This is a numeric value. How to find your Reseller ID is described in TAB "Before you Start!"
   
   
   7. Reseller API Key: Set your Reseller API Key. How to find your Reseller ID is described in TAB "Before you Start!"
   
   
   8. Reseller Selling Currencies: Select your Reseller Selling Currency! If the Currency is missing, then you need to add the Currency in your WHMCS. For eg. you will need to do this if your Selling Currency in your Reseller Account is USD but in WHMCS Default is set to EUR!
      
      Example: The default currency in your Reseller Account is INR, but in WHMCS the default currency is USD: In this case, select "INR" and activate currency conversion (see below, point 10)
   
   
   9. Default Multiplicator: Let the multiplicator dropdown on it's default value "1" if your currency is not calculated in 10's, 100's or 1000's. Example: If your default currency is COP, then change this to "1000".
   
   
   10. Activate Currency conversion: Tick the checkbox only if your WHMCS default currency does not match the default currency in your reseller account (see above, point 8)! For example, activate this option if the default selling currency in your reseller account is INR but the default currency in WHMCS is USD. This option converts INR into USD using the conversion rate you have setup in WHMCS.
   
   

   Miscellaneous

   11. WHMCS Admin User: Some of the tools make use of the local API. You can select any of the Admin accounts present in your WHMCS but we always recommend to use an Administrator Account with only API Access permissions
   
   
   12. Whois Lookup Secret: By default and only as an example set to "FB7koUY1aX". You must change this to another value or you will not be able to use the "Whois Servers Setup" Tool! Set an alphanumeric key [0-9 a-z A-Z] with length of 10 to protect unauthorized use of whois lookups by others
   
   
   13. Access Control: Under Access Control select Full Administrator.
   
   
   14. Finally click the button "Save Changes"

    

   Check your FREE Tools Suite Setup

    

   The FREE Tools are now setup and configured with the necessary basic settings. Make some small checks to see if everything is correct:

   1. Access the FREE Tools Suite Homepage from the WHMCS Top menu "Addons" » "RC & LB Tools v2"
   
   
   2. If you have everything correctly configured and your IP's (whmcs domain and primary hosting server ip) have been correctly whitelisted in your reseller account, then you should see something like the following image:

      

      Note: If you have an error or warning message, proceed with the given instructions to fix the issue and once corrected, reload the reseller account settings by selecting again the reseller account from the "Change to:" dropdown list

    

   Additional Configuration Settings

    

   Once you have the FREE Tools correctly setup and running with the basic configuration, proceed to configure further the FREE Tools and customize the behavior and settings for all the tools to fit your needs. The following shows a short description of all available config options. To learn more about the tools, visit the TAB "How it works".

   Funds Widget Setup

   • Use Currency Symbol: Tick to show the currency symbol (€) instead the currency code (EUR)
   
   
   • Font Color, Size, Family: You can change the colors and font style for the admin home page funds balance widget. Can be leaved blank for default style.
   
   

   Reseller Accounts Setup

   
   
   • 1# Live or Demo Account
   
   
   • Disable Fundsbalance on Widget: Tick to Disable Fundsbalance Output on the widget
   
   
   • Default Nameservers: You can specify here upto 5 Default Nameservers, comma separated, to be used for domain register and transfer for the selected Registrar. Leave empty to use the WHMCS Default Nameserver settings. Example: ns1.domain.com,ns2.domain.com,ns3.domain.com,ns4.domain.com
   
   
   • Disable Transfer Cron Check: You can setup a Cronjob in your Hosting account to automate the Transfer Check and disable it here temporarily
   
   
   • Disable Auto Customer Signup: If you do not want register your Customers automatically in your reseller account when they register in WHMCS, then click the check box.
   
   
   • Use WHMCS Password with Signup: Tick to use the WHMCS customer password instead of a randomly generated password with the "Auto Customer Signup"
   
   
   • Disable Auto Customer Modify: You should not disable this unless you have a good reason for. If you do not want apply in the reseller account the changes made on the customer profile in WHMCS, then click the check box
   
   
   • Apply WHMCS Password if changed: Tick to sync the password in the reseller customer account when the password in WHMCS got changed
   
   
   • Disable Auto Customer Delete: If you do not want delete the customer in the reseller account when it has been deleted in WHMCS, then click the check box
   
   
   • Disable Funds Threshold Check: Tick to Disable the hook for funds threshold mail alert. If disabled, no mail will be send to the admin
   
   
   • Overwrite Reseller Funds Threshold: You can overwrite the Threshold value from your reseller account settings. Leave blank to use your reseller settings
   
   
   • Disable Domain TLD Price Sync: You can setup a Cronjob in your Hosting account to automate Domain Price syncronization and disable it here temporarily
   
   
   • Disable Telescope TLD Pricing: Tick to disable Telescope Pricing for the Sync Cron on this account. When disabled, only the first year selling price will be set and updated
   
   
   • Update Redemption Period and Fee: Tick to Import/Update Redemption period and fee for those TLDs who support Domain restoration. If activated, period and fees will be imported/updated each time the domain selling price sync cron runs.
   
   
   • Sync Clientgroup TLD Price Slabs: By default, only the Default Base Slab Pricing will be synced. However you can tick the checkbox to activate sync for all Domain Client group Price Slabs.
     IMPORTANT! If you activate this option, then all Client based Price Slabs will be updated with the default selling prices
   
   
   • Sync Only this TLD's: If you use more than one LogicBoxes Domain Registrar, let us say "ResellerClub" and "Netearthone", then you can specifiy here the TLD's which should be synced with your Domain Prices in WHMCS. If you use only one Reseller account and Domain Registrar for all your TLD's, then simply leave the field empty to sync all TLD's or specify a list of tlds to limit the domain price sync to certain tlds
   
   
   • Exclude these TLD's: You can set the TLD's you would like to exclude from the Price sync.
   
   

   Domain Transfer Handling

   
   
   • Broken Domain Transfers : By default the Domain status is always "Pending Transfer" even if the Domain has been deleted from your LogicBoxes Account. Set your preferred option on how to handle a non existent Domain Transfer in WHMCS. Recommended settings: "Cancelled"
   
   
   • RAA Domain Report: Tick to disable if you do not want receive the daily RAA Pending Domain Report
   
   
   • Admin Mail Transfer Check Report: Tick to disable the cron transfer check admin mail
   
   
   • Send Customer Transfer Confirmation Email: Tick the check box to activate the send mail confirmation when Transfer is completed
   
   
   • Transfer Confirmation Email Template: This customized Email Template "Domain Transfer Complete" which has been created automatically for you in Setup » Email Templates » Domain Messages. Feel free to customize it
   
   
   • Pro Active Transfer Mails: Pro Active Transfer Mails will be sent to your customers using the below email templates if a domain transfer has been stalled or failed. The notification mails will be sent each 24 hours, independently on how many times the cronjob got executed. By activating the checkbox mails will be send each time the transfer check cronjob run. To setup a cronjob click the link Automation Tools from the RC & LB Tools v2 Addon » left Sidebar Menu
   
   
   • Transfer Unlock Email Template: This customized Email Template "Domain Unlock Request" has been created automatically for you in Setup » Email Templates » Domain Messages. Feel free to customize it
   
   
   • Transfer EPP Code Email Template: This customized Email Template "Domain EPP Request" has been created automatically for you in Setup » Email Templates » Domain Messages. Feel free to customize it
   
   
   • Transfer ID Protect Email Template: This customized Email Template "Domain ID Protection Request" has been created automatically for you in Setup » Email Templates » Domain Messages. Feel free to customize it
   
   
   • Transfer Failed Email Template: This is the standard WHMCS Email Template "Domain Transfer Failed" and valid for the FREE Tools. Feel free to customize it.
   
   

   Client Area Tools!

   
   
   • WHMCS Theme Style: If your Template Theme is WHMCS Six or based on the WHMCS Six theme, then select Six, otherwise select Five. Feel free to modify the template files movedomain.tpl and suggestdomain.tpl located in /modules/addons/resellerclubmods_tools/ folder
   
   
   • Move Domain Tool : Tick to activate the Move Domain / Services Tool on the Client Area Domain Details Page
   
   
   • Move Domain Permissions: Tick to allow "Only Admin" or "Client and Admin" to move their Domain and Services to another WHMCS Customer Account
   
   
   • Domainsbot require Login: By default the Domainsbot Tool does not need Login. Tick to activate Access only for logged in Clients
   
   
   • Domainsbot tlds at once: Insert the number of TLDs to be checked. Do not set this too high. Default = 5
   
   
   • Domainsbot tlds: Set the tlds for the domainsbot tool separated by a comma
   
   
   • Register Period Dropdown: By default the Domainsbot Tool uses 1 year Register Period. Tick to activate the registration period drop down so that your clients can select the duration specifically
   
   
   • Disable force SSL: By default the Domainsbot Tool page will be loaded with https if SSL support exists for your WHMCS. Tick to disable and use only http
   
   

   Domain Promo Pricelist

   
   
   • WHMCS Template Style: Select the WHMCS Style for the domain Price List. For example, if you use the five WHMCS template style, then select "five", or if you use the six WHMCS template style or a custom theme based on the six theme, then select "six". If your theme is customized and not based on six or five, then select custom and declare your own CSS classes below.
   
   
   • Custom Theme CSS Class: Set the css class (table, tr, th, td) if you use a custom theme
   
   
   • Show Default Selling Price: Select "Yes" if the Default Selling Price should be displayed with the Promo Selling Price
   
   
   • Default Selling Price Style: Insert the CSS style code for the Default Selling Price or use the predefined css style
   
   
   • Promo Selling Price Style: Insert the CSS style code for the Promo Selling Price or use the predefined css style
   
   
   • Promo Price Style: This shows how your customized Promo Price will appear in your Domain Price List
   
   
   • Expose Pre GA Label: Tick to activate if you want to show Pre GA TLDs with a custom label
   
   
   • CSS Class for Label : Set a css class from your whmcs css file for the label
   
   
   • Text for Label: Set the text for the label
   
   
   • Title for Label: Set a title tag description for the label
   
   
   • Expose Redemption Fees: Tick to activate if you want to show Domain Redemption Fees. Redemption/Restore prices will be taken via API from your Reseller Account
   
   
   • Local Redemption Fees: Since WHMCS 7.5.0, Redemption Fees are now stored in WHMCS. If activated, Redemption/Restore prices are taken from the WHMCS Database and not from your Reseller Account
     Note: Do not activate this option if your WHMCS is not greater than or equal to WHMCS 7.5.0
   
   

   API Whois Server Setup

   
   
   • Whois Lookup Secret: Set an alphanumeric key [0-9 a-z A-Z] with an exact length of 10 to protect unauthorized use of whois lookups by others.
     Note: If you change the Secret key in some time later, then you need to re-generate the current whois lookup url for all TLDs which have been setup for domain lookup via api
   
   
   • Use Registrar for Domainlookup: If activated, domain availability lookup will use the reseller account for the registrar module defined in autoreg TLD settings, otherwise the first configured account registrar will be used.
     IMPORTANT! Do not activate this option unless you have fully understood how it works! Please check TAB "How it works" from the Installation Documentation
   
   

   Domain Promos

   
   
   • Auto Activate Promo: Tick to automatically activate Domain Promos in WHMCS for all available active Promos in your Reseller Account.
   
   
   • Auto Promo Update: Tick to Activate the Auto Promo Pricing Update with the normal Selling Price when the Promo has been come to end
   
   
   • Terminate promo before end date: Set the number of days when a promo should be terminated before the real end date. Leave empty to use the registrar end date for promos
   
   

   Domain TLD's & Prices

   
   
   • Google Currency API: Tick to activate currency conversion to display your cost prices in your currency if the buy currency does not match the selling currency in WHMCS.
     Note: Activate this only if the reseller buy currency is not setup as a currency in WHMCS
   
   
   • Update Domain Recurring Prices: If activated, recurring prices for all domains will be updated with the daily cron using the current renew selling prices from the Pricing slab for default base slab or from the corrensponding Pricing slab for client groups. All Domains with recurring amount of 0.00, considered FREE Domains are excluded
   
   
   • Disable Domain Price Currency Update: Tick to disable Currency Update Domain selling prices. With the checkbox activated only the default currency selling prices will be updated. The option applies to Domain selling price sync cron (Automation Tools), Domain Promos (Manage Domain Promos) and Auto Promo Update (Action Hook)
   
   
   • Transfer Free TLDs: Transfer-ins for TLDs .com.au, .net.au, .co.uk, .me.uk, .org.uk, .com.ru, .net.ru, .org.ru, .ru and .es are always FREE of cost for Reseller and Customers and the transfer selling price for delcared TLDs will be set to 0.00. You can extend the list, comma separated. Example: co.uk,me.uk,org.uk,com.ru
   
   

   OrderBox - Cart Integration

   
   
   • Disable AutoAuth: Tick to Disable AutoAuth Customer login and only redirect to the destinations in WHMCS
   
   
   • Various Textfields for URLs: Feel free to customize these standard settings. You may visit the installation documentation, TAB "OrderBox Integration" for further details on howto setup WHMCS AutoAuth
   
   

   Miscellaneous

   
   
   • Overwrite max. value for User Import: You can set another max. value for the Import User Tool. Default value = 100
   
   
   • Overwrite max. value for User Export: You can set another max. value for the Export User Tool. Default value = 100
   
   
   • Access Control: Choose the admin role groups to permit access to this addon module

Setup the Admin Area Homepage Widget

By default, the Widget for the FREE Tools is not displayed on the WHMCS Admin Area. Follow the instructions below to enable the Widget:

1. Make sure you have activate the option Funds Balance Widget from the Addon setup.


2. Goto Setup » Administrator Roles (whmcs v5.2 Setup » Staff Management » Administrator Roles) and select the Admin Group who should have permission to see the funds balance widget on the admin home page.


3. Under the "Widgets" Section you will see the new widget called "ResellerCub & LogicBoxes Tools v2". Tick the checkbox and "Save Changes"

Domain Price List with Promoprice Widget

In order to expose highlighted Promo Prices, you need to replace the WHMCS Domain Price List from some template files with a one-line javascript code. The new WHMCS Domain Price List will be generated with the javascript like the original price list supporting all features such as language and currency change functions.

• WHMCS 6 - Default/Five based themes
• WHMCS 6 - Six based themes
• WHMCS 6 - Custom themes
• WHMCS 7 - Standard Cart based theme
• WHMCS 7 - Modern Cart based theme
• WHMCS 7 - Custom Cart theme
• WHMCS 8 - Standard Cart based theme
• Domain Price and Domain Promo Price for an individual TLD
• Currently available Domain Promo List

<script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
							

<script language="javascript" src = "widgets/domainpricelist.php?salelistonly=1&currency={$smarty.post.currency}"></script>
							

1. Edit the template files bulkdomaintransfer.tpl, bulkdomainchecker.tpl and domainchecker.tpl


2. Locate the following html code:

   
   <table class="table table-striped table-framed">
     <thead>
       <tr>
         <th class="textcenter">{$LANG.domaintld}</th>
         <th class="textcenter">{$LANG.domainminyears}</th>
         <th class="textcenter">{$LANG.domainsregister}</th>
         <th class="textcenter">{$LANG.domainstransfer}</th>
         <th class="textcenter">{$LANG.domainsrenew}</th>
       </tr>
     </thead>
     <tbody>
   {foreach from=$tldpricelist item=tldpricelist}
       <tr>
         <td>{$tldpricelist.tld}</td>
         <td class="textcenter">{$tldpricelist.period}</td>
         <td class="textcenter">{if $tldpricelist.register}{$tldpricelist.register}{else}{$LANG.domainregnotavailable}{/if}</td>
         <td class="textcenter">{if $tldpricelist.transfer}{$tldpricelist.transfer}{else}{$LANG.domainregnotavailable}{/if}</td>
         <td class="textcenter">{if $tldpricelist.renew}{$tldpricelist.renew}{else}{$LANG.domainregnotavailable}{/if}</td>
       </tr>
   {/foreach}
     </tbody>
   </table>
   							



3. Replace the html code with the following javascript code:
   

   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>



4. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select "default" from the option "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active template folder.

1. Edit the template files bulkdomainchecker.tpl and domainchecker.tpl


2. Replace the div block in domainchecker.tpl from line 55 to 140 and in bulkdomainchecker.tpl from line 63 to 148 with the following new div block:

   
   <div id="pricingTable"{if $performingLookup} class="hidden"{/if}>
       <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true">
           <div class="panel panel-default">
               <div class="panel-heading" role="tab" id="heading{$tldCategory->id}">
                   <h4 class="panel-title">
                       <a data-toggle="collapse" data-parent="#accordion" href="#collapseAll" aria-expanded="false" aria-controls="collapseAll" class="domain-tld-pricing-category">
                           {$LANG.alltldpricing}
                       </a>
                   </h4>
               </div>
               <div id="collapseAll" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingAll">
                   <div class="panel-body">
                       <div class="row">
                           <div class="col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2 table-responsive domain-tld-pricing-table-responsive">
                               <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
                           </div>
                       </div>
                   </div>
               </div>
           </div>
       </div>
   </div>
   							



3. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select "six" from the option "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active template folder.

1. Edit the template files bulkdomaintransfer.tpl, bulkdomainchecker.tpl and domainchecker.tpl


2. Locate the html code which most probably looks similar to one of the above html code examples


3. Replace the html code with the following javascript code:
   

   
   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
   							




4. The Domain list table comes with 4 standard css class tags:

   • class="tbl_dompricing" for the <table> tag
   • class="th_dompricing" for <th> tags
   • class="tr_dompricing" for <tr> tags
   • class="td_dompricing" for <td> tags
   
   To style your custom domain table, edit your custom template css file and add these classes with your own CSS code or set the appropriate css class names in the Addon Configuration, section "Domain Promo Pricelist"


5. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select "custom" from the option "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active template folder

1. Edit the template file domainregister.tpl


2. Replace the html code between <div class="domain-pricing"> ... </div> from line 155 to 248 with the following javascript code:

   
   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
   							



3. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select your "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active orderform template folder.

1. Edit the template file adddomain.tpl


2. On line 97 add the following javascript code:

   
   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
   							



3. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select your "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active orderform template folder.

1. Locate the corresponding template file your theme uses to expose the domain search form


2. Add the following javascript code:

   
   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
   							



3. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select your "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active orderform template folder.

1. Edit the template file domainregister.tpl


2. Replace the html code between <div class="domain-pricing"> ... </div> from line 187 to 290 with the following javascript code:

   
   <script language="javascript" src = "widgets/domainpricelist.php?currency={$smarty.post.currency}"></script>
   							



3. Goto the FREE Tools Addon configuration in Setup » Addon Modules » RC & LB Tools v2, scroll down to the section "Domain Promo Pricelist" and select your "WHMCS Template Style". Save the configuration and finally upload the modified template files back into your active orderform template folder.

Since RC & LB Tools v2.9.1 it is now possible to call the widget for an individual TLD from any location to display the selling or promo price if apply. The following URL examples shows how to use the widget:

Standard URL

Passing only the TLD will show the price for domain register with regperiod 1 year, default currency and without currency format:

<script language="javascript" src = "widgets/domainpricelist.php?details=price&tld=.com"></script>
							

Standard URL with a specific regperiod

Passing additionally the regperiod:

<script language="javascript" src = "widgets/domainpricelist.php?details=price&tld=.com&regperiod=1"></script>
							

Standard URL with a specific currency id

Passing additionally another currency than the default currency:

<script language="javascript" src = "widgets/domainpricelist.php?details=price&tld=.com&regperiod=1&currency=2"></script>
							

Standard URL with formatted price

Passing additionally the format for the selling price:

<script language="javascript" src = "widgets/domainpricelist.php?details=price&tld=.com&regperiod=1&currency=2&format=1"></script>
							

Standard URL with type (register, transfer and renew)

Passing additionally the domain type:

<script language="javascript" src = "widgets/domainpricelist.php?details=price&tld=.com&regperiod=1&currency=2&format=1&type=transfer"></script>
							

Since RC & LB Tools v2.9.4 it is now possible to call the widget to expose a list of currently available domain promos in WHMCS. The following URL's are examples to show how to use the domain price widget to expose domain promos:

Standard URL

Passing no additional variables will show a list of promos with the default end date, default currency, without the currency format and without the promo title:

<script language="javascript" src = "widgets/domainpricelist.php?details=promos"></script>
							

Standard URL with promo enddate and time

Passing additionally the date variable will show the endate and time:

<script language="javascript" src = "widgets/domainpricelist.php?details=promos&date=1"></script>
							

Standard URL with currency format

Passing additionally the format variable to show the prices with currency format :

<script language="javascript" src = "widgets/domainpricelist.php?details=promos&date=1&format=1"></script>
							

Standard URL with another currency

Passing additionally the currency id to force pricing displayed in another currency:

<script language="javascript" src = "widgets/domainpricelist.php?details=promos&date=1&format=1&currency=2"></script>
							

Standard URL with promo title

Passing additionally the promotitle variable:

<script language="javascript" src = "widgets/domainpricelist.php?details=promos&date=1&format=1&currency=2&promotitle=1"></script>
							

Standard URL with display limit

Passing additionally the limit variable to display only a certain number of promos :

<script language="javascript" src = "widgets/domainpricelist.php?details=promos&date=1&format=1&currency=2&promotitle=1&limit=3"></script>
							

Howto Style the Output

The following css classes are declared and you can use them in your css file to style the output to your liking

• css class name: div_dompromo (div container for the promo output)
• css class name: h3_dompromo (h3 tag for Promo title)
• css class name: tbl_dompromo (table tag for the Promo table)
• css class name: th_dompromo (th tag for the column titles)
• css class name: td_dompromo (td tag for the Promo details)

Domainsbot (Domain Suggestion) Tool

The default URL to access the Domain Suggestion Tool is https://url-to-your-whmcs/index.php?m=resellerclubmods_tools&action=suggestdomain. This is the way WHMCS loads Client Area Addon module pages (see https://docs.whmcs.com/Addon_Modules#Client_Area_Output).

Implementing the Domain Suggestion Tool

You can Insert the link in any of your whmcs templates to offer the Domainsbot Tool to your customers or website visitors:

<a href = "index.php?m=resellerclubmods_tools&action=suggestdomain">Suggest Domain</a>
							

To offer the link outside from your whmcs, use the full URL to your whmcs:
Note: Use https:// if you have whmcs configured with the SSL System URL

<a href = "your-whmcs-domain/index.php?m=resellerclubmods_tools&action=suggestdomain">Suggest Domain</a>
							

Customizing the template suggestdomain.tpl

The template file located in /whmcsroot/modules/addons/resellerclubmods_tools/ is styled for WHMCS six and default/five based themes. Feel free to customize the template file to fit your needs!

Client Area Move Domain Tool

The default URL to access the Move Domain Tool is https://url-to-your-whmcs/index.php?m=resellerclubmods_tools&action=movedomain&domain=domainname&domainid=domainid. This tool works only for Admins logged in on behalf of a Customer or if permission is granted, for logged in Customers. The link must be placed into the clientareadomaindetails.tpl file.

Implementing the Move Domain Tool

By default, the move domain tool is not enabled. To offer the tool you need to activate the following options from the Addon setup:

• Move Domain Tool : Tick to activate the Move Domain / Services Tool on the Client Area Domain Details Page


• Move Domain Permissions: Tick to allow "Only Admin" or "Client and Admin" to move their Domain and Services to another WHMCS Customer Account

For Default and Five based themes

Insert the link into the clientareadomaindetails.tpl template file. You can place the link where you want. Best practice is to place the link into the "Management Tools" Menu:

1. Edit the clientareadomaindetails.tpl file and locate the html code <ul class="dropdown-menu"> ... </ul>


2. Insert the following html code between the above mentioned ul tag:

   
   <li><a href = "index.php?m=resellerclubmods_tools&action=movedomain&domain={$domain}&domainid={if $domainid}{$domainid}{else}{$id}{/if}">Move Domain</a></li>
   							

Customizing the template movedomain.tpl

The template file located in /whmcsroot/modules/addons/resellerclubmods_tools/ is styled for WHMCS six and default/five based themes. Feel free to customize the template file to fit your needs!

Order Box Shopping Cart Integration

When your Customers login to their Customer OrderBox Control Panel, there are several options available to purchase various products and services that you sell. These are in the form of buttons or links either in the menu or the pages themselves. These links and buttons need to redirect to the Shopping Cart or any custom page or site of your WHMCS.

You can customize the destination URL's in the FREE Tools Addon Configuration Section "OrderBox - Cart Integration".

In order to redirect your logged in Customers from the OrderBox Control Panel to your WHMCS, you need to setup an Integration URL. Your custom Integration URL is available in Addons » RC & LB Tools v2 » "Automation Tools" with a guide on howto setup this in your reseller account.

WHMCS AutoAuth

What is AutoAuth?

AutoAuth is a great built-in feature from WHMCS. AutoAuth stands for Automatic Authentication and is a method for you to be able to automatically log a user in from your own trusted third party code. For example you might use it if you have another software on your website which clients already log into, and once they have logged into that you don't want them to have to re-authenticate again seperately to access WHMCS.

Enabling AutoAuth

AutoAuth is disabled by default so to enable it for your WHMCS install, you will need to add the following line to your WHMCS configuration.php file to define an AutoAuth key. The value just needs to be a random sequence of letters and numbers. The following is only an Example! Do not use the example string "abcXYZ123". Create your own using only letters and numbers from the US-ASCII code such as a-z, A-Z and 0-9:

$autoauthkey = "abcXYZ123";
							

Disable AutoAuth

You can at any time disable the AutoAuth login feature from the FREE Tools Addon Configuration "OrderBox - Cart Integration". With AutoAuth disabled, logged in OrderBox customers will not be authenticated in your WHMCS and only redirected to the URL's you have setup for each action.

How it works

• Reseller Account Switcher: You can switch at any time to another reseller account from any of the Tool pages. The active account is always visible on all Tools pages. The same account switcher is available on the FREE Tools home and whenever you change the addon settings for an account you have to use it to reload the new configuration settings.


• Re-validate License: You need to re-validate your License if you have changed your domain, ip or install path as well if you have updated to a newer version


• Fundthreshold Alert (action hook): The action hook runs when a product or domain (register, transfer, renwal) has been successfully added in your reseller account. It checks your threshold level against your available reseller funds. If the funds balance is below the threshold, an alert mail will be send to the admin. An alert mail is again send if the funds balance has changed to an ever lesser value than the last recorded value.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Auto Promo Activate (action hook): The action hook runs when the daily whmcs cronjob runs (once a day). It checks if you have active promos in your reseller account to setup all promos automatically like you would do manually with the Domain Promo Management Interface.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Domain Promos.


• Auto Promo Update (action hook): The action hook runs when the daily whmcs cronjob runs (once a day). It checks if you have promo prices applied to the domain selling prices and if the promo is still valid. If the promo has ended, the selling price will be reset with the default selling price. A daily Redport will be send to the Admin if at least one promo has been activated.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Domain Promos.


• Delete Customer (action hook): The action hook runs when you delete a customer in WHMCS and deletes the customer account from your ResellerClub / LogicBoxes reseller account if not disabled from the addon setup. An entry of each action is written into the WHMCS System Activity log.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Modify Customer (action hook): The action hook automatically syncs the changes to the ResellerClub / LogicBoxes customer account when you or your customer modify the customer profile in WHMCS and if not disabled from the addon setup. An entry of each action is written into the WHMCS System Activity log.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Register Customer (action hook): The action hook runs when a new customer signup or when you manually add a new customer. It adds the customer automatically under your ResellerClub / LogicBoxes reseller account if not disabled from the addon setup. An entry of each action is written into the WHMCS System Activity log.
  
  You can disable the hook in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Use WHMCS Password with Signup (action hook): The action hook runs when a new customer signup or when you manually add a new customer. If activated, the whmcs customer password will be used for the logicboxes customer account. Please take in mind the logicboxes password rules. Should a password not meet these requirements, customer signup will fail.
  
  You can activate the option in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Apply WHMCS Password if changed (action hook): The action hook runs when you or a customer changes the customer password. If activated, the whmcs customer password will be changed for the logicboxes customer account. Please take in mind the logicboxes password rules. Should a password not meet these requirements, change password will fail.
  
  You can activate the option in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Admin Home Widget (action hook): The action hook runs when you access the main admin home page and shows your actual funds balance at ResellerClub / LogicBoxes if the funds balance widget option has been activated in the addon setup. See TAB "Admin Widget" in the installation documentation for more details


• Default Nameservers (action hook): This action hook overrides your WHMCS Default Nameserver settings when register/transfer a domain under the following circunstances:
  • You have specified a set of nameservers for the reseller account in Setup » Addon Modules » RC & LB Tools » Reseller Accounts Setup » "Default Nameservers"
  • The customer does not specifiy his own Nameservers during the purchase of a register/transfer domain
  • The override feature is completely transparent and does not visually modify the Nameserver settings in WHMCS nor in the shopping card domain configuration. You will always see the WHMCS default Nameservers or the Clients specified Nameservers
  
  The override Nameserver feature only runs when it comes to execute the register or transfer module commands for a LogicBoxes Registrar Module and you have set Nameservers in the "Default Nameservers" field in the Reseller account setup.


• RAA Domain Report (action hook): This action hook runs when the daily whmcs cronjob runs. You will receive a report with all domains pending verification once a day.
  
  You can disable the Report in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Domain Transfer Handling.


• Update Domain Recurring Prices (action hook): This action hook runs when the daily whmcs cronjob runs and will update all domain recurring prices automatically for you. The recurring price is taken from the WHMCS renewal domain price table, based on the default slab and client group slabs (if apply). Domains set to 0.00 (FREE Domains) are excluded and not updated.
  
  You can activate this option in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Domain TLD's & Prices.


• Manage Domain Promos: This tool allows you to setup your own Domain Promos for Register/Transfer/Renewal. The tool also shows all active promotions you have within your ResellerClub / LogicBoxes Reseller Account. You can update the domain selling price with the established or with your custom promo price. If the option "Auto Promo Update" has been activated, WHMCS daily cron automatically takes care to terminate the promo in WHMCS by changing the promo price back to the normal selling price based on the established promo end date.


• Domain Transfer check GUI : This tool checks if a Domain Transfer has been completed in your reseller account, sets the domain to active and send a confirmation mail to the customer if activated in the addon setup.


• Domain Transfer Check Cron: The same as for Domain Transfer check GUI tool but running as an automated cronjob. An email with the check result will be send to the admin. You can setup a cronjob for each reseller account.
  
  You can disable the Cron without the need to remove the cronjob, in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Domain Price Sync Cron: You can setup a cronjob to sync all your Domain prices in WHMCS with your selling prices from your Reseller Account! If you have set up multiple Reseller Accounts, with different LogicBoxes Registrars, then you can setup for each reseller account a cronjob to sync a specified list of TLD's. We recommend to setup a daily cronjob. To setup a cron, see WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link » Automation Tools.
  
  You can disable the Cron without the need to remove the cronjob, in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Update Redemption Period and Fee: Activate this option if you want to Import/Update Redemption period and fee for those TLDs who support Domain restoration. If activated, period and fees will be imported/updated each time the domain selling price sync cron runs.
  
  You can activate this option in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Disable Telescope Pricing: You can globally disable telescope selling pricing. If disabled, only the first year selling price will be imported/updated and all other years will be deactivated. This option applies to the Domain Price Sync cron as well as to the TLD Bulk Update feature from the "Import TLD's & Import/Update Selling Prices"
  
  You can activate this option in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: 1# Account (or the account in question).


• Move Domain / Services: This Tool moves the Domain and all associated Products from one customer to another customer in WHMCS and in your Reseller Account.


• Export WHMCS Users: This tool allows you to add an existent WHMCS client to your ResellerClub / LogicBoxes reseller account.


• Domainbots Suggest Domain Tool: This tool will help your Customers find and register good domain names. You can place the link to the domain suggest tool on any of your website pages. By default the Domainsbot Tool does not need Login. You can restrict access for registered clients.
  
  You can configure this tool in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Client Area Tools!.


• Move Domain to another Client: This Tool allows Customers to move their domains from their whmcs account to another whmcs account. By default, this tool is not activated. To allow access you have to activate the tool and configure the permissions for "Admin Only" or "Admin and Clients". Additionally you may restrict further use with the WHMCS sub-accounts permission "Manage Domains".
  
  You can configure this tool in the Addon Configuration: WHMCS » Addons » RC & LB Tools v2 » Left Sidebar Menu link "Configure Addon" » Section link: Client Area Tools!.


• Domain Promo Pricelist: This Tool allows you to expose domain selling prices with active domain promo prices and Redemption Fees, styled with your own css code. For further details please see TAB "Domain Price Widget".


• Manage TLD's & Domains: These Tools allows you to manage TLD and Domain related settings such as change the autoreg settings for the TLD's, change the Registrar Module for Domains and Activate/Deactivate Domain Management Tools for Domains.


• Reseller Domain Bulk move: This tool allows you to move your Domains from one Reseller Account to another Reseller Account. You can move your domains between Reseller Accounts from the same Registrar (ResellerClub sub-reseller to sub-reseller or direct reseller, the same for Resell.biz (Stargate), Net Earth One and ResellerCamp).


• RAA Domain Management This tool allows you to see and manage at a glance all the domains you have in WHMCS pending RAA verification. You can resend the mail for each customer or for the selected customers with one click. The interface shows how many days left for verification, how many times you have re sent the verification mail and the last sent date/time.


• Option Flags for Daily Cron hook tools: WHMCS offers option flags to control the daily cron processes individually. However, action hooks controlled with the daily cron are executed each time the daily cron runs. In order to avoid RAA Report and Auto Promo Update hooks to be executed each time the daily cron runs, add the skip flag for these tools. Information and Examples are available in the FREE Tool menu "Automation Tools".


• API WHOIS Server Setup: This tools allows you to setup automatically or manually the whoisservers.php file (WHMCS v6) and whois.json file (WHMCS 7) using your reseller api url for domain availability lookups instead of using public whois servers which are almost limited, overload, restricted or simply unavailable. For taken domains, extended whoislookup will show full whois results without restrictions. Public whois servers for extended whoislookup are located in the file whoislookup.php and can be extended at any time manually.


• Use Registrar for Domainlookup: If activated, domain availability lookup will use the reseller account "registrar" and the "registrar module" defined in autoreg TLD settings. By default this option is disabled and you should not enable it unless you fully understand how it works.
  

  In order to use this option correctly, the following requirements are necessary:

  1. You have setup at least two reseller accounts for each "Registrar" in the FREE Tools configuration. For Example, if you plan to use Resellerclub and Netearthone togheter, then you need to select the corresponding "Registrar" for each account. It is possible to use two reseller accounts from the same registrar, eg. Resellerclub, but it is mandatory to select for each Reseller Account a different registrar and you need to setup the corresponding registrar module.
  2. You have setup only LogicBoxes Registrar Modules and at least two of them. For example "Resellerclub" and "NetEarthOne": Setup » Products/Services » Domain Registrars
  3. TLD Autoreg settings have been established for each TLD: Setup » Products/Services » Domain Pricing


• Import Users: This tool allows you to import multiple clients on a per 100 clients step batch (adjustable in addon setup). Optionally you can activate to import the current customer funds which then are available in the WHMCS clients profile.


• Import TLD's & Import/Update Selling Prices and Redemption Fees : This tool allows you to Setup Domain TLD's and Import / Update your domain selling prices with the selling prices from your reseller account. A second option allows you to use your cost price + a Dower value instead importing your selling prices from your reseller account.


• Import Domains This tool allows you to Import all active Domains for each Customer. TLDs, selling prices and customers must be setup first before you can start import


• Import Bulk Domains: This tool allows you to Import all active Domains based on the customer id's you pass with the form. TLDs, selling prices and customers must be setup first before you can start import

From any version prior to v2.8.2

1. Deactivate the Addon RC & LB Tools v2


2. Delete the Folder "resellerclubmods_tools" in /whmcsroot_folder/modules/addons/


3. Delete all files starting with "resellerclubmods_* in /whmcsroot/includes/hooks/


4. Install the Addon as per the setup instructions given in TAB "Setup"

From any version upwards v2.8.2 to v2.16.x

To update the FREE Tools, follow the instructions below step by step:

1. Download the latest release for your php version from our client area product details page for your FREE license, TAB "Downloads"


2. Upload the folders "includes", "modules" and "widgets" from the unzipped local folder \free_resellerclubmods_x.x.x\ into the whmcsroot/ folder.

   Important! The folder "widgets" must be uploaded into the main whmcs folder like the "modules" and "includes" folder. Do not upload the "widgets" folder into the whmcs "modules" folder!

   Do not upload files individually into locations not indicated by these instructions.

   


3. Goto the FREE Tools Addon Home: WHMCS » Addons » RC & LB Tools v2. This will trigger any needed Database updates and update the FREE Tools version number.


4. You may visit now the Addon Configuration to make further changes for the newly implemented tools and options.

The update has been finished.