RCM - Resellerclub Mods

Howto install R.C.G.Provisioning Module V3

RCGPM - ResellerClub Codeguard Provisioning Module
Release Date
Latest Version

EOL (Deprecated)

We strongly recommend to update to the new v4 Module Series: CodeGuard Provisioning Module v4

Would you like to have it installed by us? - Order installation service for this module here

Document Version: 1.4 - 05-07-2017

Step 1

Resellerclub Mods Management Core Console (Addon)


All our products requires the Resellerclub Mods Management Core Console Addon. Download the Addon from the product license details page TAB "Download" and install first this Addon.

If already installed, make sure you run version v1.4.7 or greater.

Visit the install instructions for the ResellerClub Mods Management Core Console Addon if you havent the Addon installed/updated. Once installed/updated and configured your reseller credentials as well as the product license, go ahead with the Module Installation in STEP 2.

Step 2

Upload files and folders


Download RCGPM - ResellerClub CodeGuard Provisioning Module from the product license details page TAB "Download". Unzip the file with your prefered decompresion software. Please read carefully all the steps in this document. You should not skip any steps provided.

The following instruction explains where you have to upload folder and files:

  1. Server Module
    Upload the folder "modules" into your whmcsroot/ folder

You are now ready for setup your first CodeGuard Product!

Step 3

Email Template Setup


A standard default welcome email named as "RCGPM - CodeGuard Welcome Email" will be automatically installed in Setup » Email Templates once you configure your first CodeGuard Product.

Setup a CodeGuard Product in WHMCS


The following instruction explains how you have to setup a product in WHMCS. Most of users are yet familiar with this step. However, we strongly recommend to follow each of the steps provided below to assure correct setup. All steps are examples and based on the CodeGuard Plan Basic:

Product Group setup


  1. You should create a new global product group for all your CodeGuard Plans if you do not have any yet created. Goto Setup » Products/Services and click "Create a New Group". Set a Product Group Name, for example "CodeGuard" and click the button "Create Group".

    Product Group setup

CodeGuard Product Setup


  1. Goto Setup » Products/Services, click "Create a New Product", select product type "Other Product /Service" and select the group you just created in the above step. Name the product, for example "Basic Plan" and then click "Continue".

    CodeGuard Product setup

  2. You are now on the "Edit Product" page. Clic the TAB "Module Settings" and select the Module Name called "Rcmodcodeguard". This will load the module configuration:

    Module Settings CodeGuard Product setup

    Before anything else, select first the LogicBoxes Registrar you have previously configured in the Resellerclub Mods Console Addon (TAB Step 1) and then click the button "Save Changes".

    Select LogicBoxes Registrar

    Now you should see that the module has found "your reseller account credentials" and the API connection has been established successfully. If the API connection has been successfully established, then proceed with the configuration steps below to setup the module for this product, otherwise check your Reseller Account settings in Addons » "ResellerClub Mods Console":

    CodeGuard Module Settings

  3. Select the "CodeGuard Plan" from the dropdown menu the module has detect in your LogicBoxes Products account. In this example we use the CodeGuard plan "Basic|299"

  4. Set if you like, other colors for the messages or just leave blank to use the standard values.

  5. The Dashboard check box allows "deactivating" the Management Dashboard in the Client Area. If you do not want allow Customers to manage the Service, then you can activate the checkbox and the Dashboard will not be displayed.

  6. Dashboard Style: Accordingly to your WHMCS design, you can select the apropiate built-in Dashboard design. If you use a custom theme and any of the provided built-in style does not match your theme, then you may have a look at TAB "EXPERT" to learn how you can create easely your own Dashboard design to fit your custom theme.
    • Dashboard Style default for WHMCS template style "default"
    • Dashboard Style classic for WHMCS template style "classic"
    • Dashboard Style portal for WHMCS template style "portal"

  7. Select "Automatically setup the product as soon as the first payment is received". This adds an Order immediately into your LogicBoxes account when a customer pays the invoice and if you have sufficient funds available. This is the recommended setup for full automated provisioning and renewals.

  8. Click now the "Details" tab from where you can see the Product Type, Product Group and the Product Name. Create a product description for the CodeGuard Plan, select the "RCGPM - CodeGuard Welcome Email" from the "Welcome Email Dropdownlist". All other options as per your needs:

    NOTE: The option "Require Domain" is not mandatory. You can set up the product without this option but then you need to create a customfield to require the domain name for the CodeGuard Product. Choose between "Require Domain" or "Custom field":

    Details CodeGuard Product setup

    If you opt do not use the "Require Domain" options, then you need to create a Custom field as shown below. Feel free to use any Field Name of your choice:

    Details CodeGuard Product setup

  9. Under the "Pricing" tab select Payment type "Recurring" and setup the selling prices. Available billing cycles are Semi-Annually, Annually, and Biennially. For all other slabs set the value to -1.00 which means "not available and not supported" or simply untick the check boxes.

    NOTE: Make sure you have activated all the pricing/billing slabs for the product in your reseller account!

    TIP! You only need to set the selling prices for the default currency. All other currencies can be updated automatically using the whmcs built-in function "Update Product Prices" from Setup » Payment » Currencies:

    Pricing CodeGuard Product setup

  10. Finally click the "Save Changes" and "Back to Product List" button from where you will see the created product:

    CodeGuard Product Overview

Repeat the "CodeGuard Product Setup" Steps above for all other CodeGuard Plans you would like to sell.

TIP! Use the "Duplicate Product" option and simply adjust the duplicated product details, selling prices and select the appropriate product plan from the dropdownlist "Hosting Plan".

Your Product Setup is completely done and you can start selling CodeGuard Services. Optionally, you may have a look at the tab's "TEMPLATE" and "EXPERT" to learn more about styling and customizing your own Dashboard.


Dashboard Setup


There is no special setup needed for implementing the CodeGuard Management Dashboard. It will be displayed based on the style settings and automatically if not deactivated in the Product Setup tab "Module Settings".

CodeGuard Dashboard

If the Dashboard is not displayed on the client area details page for the product even if you haven't deactivated the same, then you have to check if the smarty variable {$moduleclientarea} is present in your customized clientareaproductdetails.tpl template file:

  1. Open the "clientareaproductdetails.tpl" from your active template folder.

  2. Check if you have the following code in your clientareaproductdetails.tpl:

    For WHMCS classic and portal template:

    <div align="center">{$moduleclientarea}</div>

    For WHMCS default based templates:

    {if $moduleclientarea}<div class="moduleoutput">{$moduleclientarea|replace:'modulebutton':'btn'}</div>{/if}

    if the above code is not present, then you need to insert it just above the statement "{if $username}"

  3. Upload your modfied files back into your whmcs active template folder.


Customizing Dashboard


The R.C.G.Provisioning Module allows you to offer your own and fully customized Management Dashboard. The following smarty variables are available to build your own dashboard for your customized template design.

The following smarty variables are available:

  • {$domainid} = Domain ID (string)
  • {$rc_status} = The status of the CodeGuard service: Active, Suspended, etc. (string)
  • {$rc_codeguardbutton} = Prestyled form button for CodeGuard Panel access (string)
  • {$module} = Identifies the name of the module: rcmodcodeguard
  • {$active_color} = Font Color for status message "Active" as HEX value (string)
  • {$suspend_color} = Font Color for status message "Suspended" as HEX value (string)
  • {$inactive_color} = Font Color for status message "InActive and Pending " as HEX value (string)

Howto Style your own Dashboard


  1. Create an empty file with your html editor or any text file editor such as notepad and add your customized html code. A valid Complete Code Example is available below.

  2. Save the file as clientarea.tpl and upload it into the /whmcsroot/modules/servers/rcmodcodeguard/ folder

Complete Code Example


 * RCM CodeGuard Management Dashboard Template
 * @package		Resellerclub Mods (gIF)
 * @author		Resellerclub Mods contact[at]resellerclub-mods.com
 * @copyright	Copyright (c) resellerclub-mods.com 2011-2017
 * @license		http://www.resellerclub-mods.com/en/terms-of-service/eula.html
 * @link		http://www.resellerclub-mods.com/
 * @version		v3.12.1

<div align="center">
	{if $rc_status eq "Active"}
					<span style="color:{if $active_color}{$active_color}{else}#006600{/if};">{$rc_status}</span>
					<div style="float:left;padding:2px;">{$rc_codeguardbutton}</div>
				<td><h4 style="width:30%">{$LANG.rccgp_statustitle}</h4></td>
					<span style="color:{if $inactive_color}{$inactive_color}{else}#FC7202{/if};">{$LANG.rccgp_servicepreparing}</span>

Latest Tweets

More Tweets from resmods

Latest News

We are ready for the next round ...

... and very proud to announce the immediate availability of all our modules for WHMCS 7.5.0 - RC 1 and backwards compatible till WHMCS 6.0.0!

About Us

Who we are, what we do and everything else about Resellerclub Mods, a gIF Business Project: