Initial Setup

License key (Field): Enter the license key for your module. You will have received this in one of the emails when you purchased your product. If you are unable to locate this key in your records, you can find it by logging into your client area and then clicking on the menu item 'Services' and then on 'My Services' in the dropdown menu.

License email (Field): Enter the email address to which you want to receive any communications regarding the license for this module. Should there be a problem with your license for any reason, it is this address that will receive the notification emails.

License debug (Checkbox): Checking this checkbox will display licensing information at the top of the module pages.

License notification emails (Radio): Choose the type of emails regarding your license you wish to receive. 'Critical' is only those relating to license expiry or suspension. 'All' includes information emails relating to 'Remote Check'.

eNom username (Field): Enter the username for your eNom account. This is required when contacting eNom via the API to obtain TLD and pricing data.

eNom password (Field): Enter the password for your eNom account. This is required when contacting eNom via the API to obtain TLD and pricing data.

Run auto updates at (Dropdown): Select the time at which you want the downloads and updates to start. We recommend setting this 2 hours before the WHMCS Daily Cron time so all pricing updates are complete before WHMCS tasks are run.
We suggest you ensure that this time is either more than 2 hours before, or some time after, the cPanel/WHM update Cron (upcp) time as upcp may interrupt the download of eNom wholesale prices.
NOTE! Once the module has been triggered at the time set here another run will not be possible on the same day, or on the following day within 2hrs. of the last run time, unless 'Force updates at next Cron' checkbox below is checked.
We also recommend setting up a Cron job to update the currency exchange rates 5 minutes before the module runs. For example, if the time of day above is set to 5:00AM then the Cron settings would be: 55 4 * * * php -q /path/to/cron.php do --CurrencyUpdateExchangeRates, where /path/to/ is replaced by the path to your cron.php file. This will ensure the latest exchange rate is used for local pricing calculations.

Force updates at next Cron (Checkbox): Force the module to run when the WHMCS Cron job runs next.
NOTE! Checking this checkbox will cause the module to start downloading from eNom again even if it is already running.

Download eNom TLDs (Dropdown): Select the frequency at which you want to download all available eNom TLDs. If the frequency is not 'Daily', all eNom TLDs available to your account will be downloaded on the day selected in 'Download eNom TLDs on' once the time since the previous download equals or exceeds the frequency selected.
NOTE! If the eNom TLDs available to your account have not previously been downloaded, all TLDs will be downloaded when the WHMCS Cron runs irrespective of this setting.
Requires 'eNom pricing auto update' to be set to operate when the WHMCS Cron runs.

Download eNom TLDs on (Dropdown): If frequency is not 'Daily', you can select the day on which to download all available eNom TLDs.
Requires 'eNom pricing auto update' to be set to operate when the WHMCS Cron runs.

Add eNom TLDs to pricing (Radio): Choose how you want to add all TLDs downloaded from eNom to your pricing.
Auto: Automatically adds all TLDs for your defualt currency & base price slab on download.
Manual: Downloads all TLDs and lets you choose which to add from the list on the eNom TLDs tab.
Requires 'eNom pricing auto update' to be set to operate when the WHMCS Cron runs.

Domain pricing auto update (Checkbox): Check this checkbox if you want to module to automatically update your domain pricing, based on the latest eNom wholesale pricing, when the WHMCS Cron runs.
Requires the 'eNom pricing auto update' checkbox to be checked.

Update existing (Checkbox): Check this checbox if you want the module to update domain renewal pricing for existing clients.
Requires the 'Domain pricing auto update' checkbox to be checked.

Update only eNom domains (Checkbox): Check this checkbox to limit auto update functions to only those domains with Auto Registration set to eNom.

Exclude from auto update (Field): Enter a comma separated list of any TLDs you want to exclude from the automated pricing update functions.

Auto update only these (Field): Enter a comma separated list of TLDs to which you wish to limit the auto pricing update functions.
NOTE! If there are entries in this field then only those TLDs will be updated and no others.

Profit margin (Field): Enter the profit margin (percentage markup) you want to apply to the price calculation. This markup is performed prior to any price rounding and/or price fraction adjustment.

Price fraction (Field): Enter the value you want to set as the price fraction, the part of the price after the decimal point. This is applied to the pricing after all other calculations.

Price Rounding (Radio): Rounding of the calculated price before the addition of the price fraction.
Auto: Rounds n.5 & above up, n.49 recurring & below down.
Up: Rounds up to the next integer.
Down: Rounds down to the next integer.

Minimum price (Field): Here, if required, you can enter the minimum price any domain will be priced at. This minimum price will override any automatic price calculation falling below this value.

Multi-year discounts (Field): If you wish to offer discounts on multi-year registrations and/or renewals, you can set these here as comma separated pairs. The format for the pairs is the number of years and the discount percentage value separated by a colon ':' e.g. 2:3.5,3:5,4:5,5:7,6:7,7:7,8:10,9:10,10:15 etc. Any years where you do not want to offer a discount can simply be left out, it is not necessary to specify a zero discount.

eNom Low Balance Limit (Field): Entering a value here will cause the colour of the available balance amount and label in the 'eNom Account Balance' widget on the WHMCS home page to change from green to red if the available balance in your eNom account drops to or below this value. You can refill your eNom account balance directly via the 'eNom Account Balance' widget on the WHMCS home page without leaving WHMCS.

Grace Period (Field): Enter the values you want to appear in the Grace Period batch update dropdown as comma separated values e.g. 0,5,7,10,14,21,30,45 etc. The example values will be used as default values. Please change as required.

Grace Period Fee (Field): Enter the values you want to appear in the Grace Period Fee batch update dropdown as comma separated values e.g. 0,5,10,15,20,25,30 etc. The example values will be used as default values. Please change as required.

Redemption Grace Period (Field): Enter the values you want to appear in the Redemption Grace Period batch update dropdown as comma separated values e.g. 10,20,30,45,90 etc. The example values will be used as default values. Please change as required.

Redemption Grace Period Fee (Field): Enter the values you want to appear in the Redemption Grace Period Fee batch update dropdown as comma separated values e.g. 250,300,500 etc. The example values will be used as default values. Please change as required.

Default rows per page (Dropdown): These dropdowns allow you to set your preferred number of rows per page defaults for the 'View All Pricing', 'View Existing Client Pricing', 'View Promo Pricing' and 'View eNom Pricing' pages. The name of the page affected is indicated to the right of the dropdown.

Enable debug mode (Checkbox): Checking this checkbox enables the module to output debugging reports to the WHMCS Module Log. In order to capture the data it is also necessary to turn on debug logging in the WHMCS Module Log. This is achieved by going to Utilities->Logs->Module Log and clicking the 'Enable Debug Logging' button. Once debugging is complete, please remember to click the 'Disable Debug Logging' button in Utilities->Logs->Module Log and uncheck this checkbox.

eNom Balance/Refill Widget (Checkbox): Checking this checkbox activates the widget and displays it on the WHMCS Home page. Unchecking this checkbox deactivates the widget and hides it from display.


  • Initial Setup, Configuration
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

What needs to be in place before I start?

These requirements are in addition to the WHMCS default system requirements.A valid active eNom...

Import TLDs

From version 1.4.0, the importing of all the TLDs available to your eNom account is automated and...

Adding TLDs To Your Pricing and Setting/Updating Domain Addons, Grace/Redemption Periods and Autoreg Settings

The list of TLDs on the eNom TLDs tab are those that have already been downloaded. The TLDs...

Forcing Updates At Next Cron

If you want to force the module to download TLDs and/or wholesale prices before the next...

Installation

Unzip the downloaded .zip file into a directory of your choice on your PC.Using a method of your...

Powered by WHMCompleteSolution