LiveZilla Live Chat Software
RCM - Resellerclub Mods

Howto install R.C.C.Provisioning Module V3

RCCPM - ResellerClub Comodo Cert Provisioning Module
Release Date
Latest Version
20.10.2016
3.12.0

 

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

Document Version: 1.4 - 31-05-2016

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.0 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 RCCPM - ResellerClub Comodo 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 Comodo Certificate Product!

Step 3

Email Template Setup

 

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

Setup a Comodo 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 Comodo Positive Certificate Plan:

Product Group setup

 

  1. You can create a new global product group for all your Comodo Certificate Plans if you do not have any yet created or use any existing Group you may have created in your WHMCS. Goto Setup » Products/Services and click "Create a New Group". Set a Product Group Name, for example "Comodo SSL Certifcates" and click the button "Create Group".

    Product Group setup

Comodo Product Setup

 

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

    Comodo Product setup


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

    Module Settings Comodo 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":

    Comodo Module Settings


  3. Select the "Comodo Plan" from the dropdown menu the module has detect in your LogicBoxes Products account. In this example we use the Comodo plan "Positive SSL|300"

  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 their Certificates, 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 easly your own Dashboard design to fit your custom theme.
    • Dashboard Style default for WHMCS template style "default"
    • Dashboard Style five for WHMCS template style "five"
    • Dashboard Style six for WHMCS template style "six"
    • 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 Certificate Plan, select the "RCCPM - Comodo Welcome Email" from the "Welcome Email Dropdownlist". All other options as per your needs:

    NOTE: Leave the option "Require Domain" unchecked. You need to setup a customfield in the next step.

    Details Comodo Product setup


  9. Click now the "Custom Fields" tab to create the required "Common Name (CN)" field as per the image below:

    Custom field Comodo Product setup


    NOTE: For Wildcard Certificate do not use an example with "www". Only request the domain name, eg. "Enter only the domain to secure. Example: domain.com"


  10. Click now the "Pricing" tab, select Payment type "Recurring" and setup your selling prices. Available billing cycles are Annually, Biennially, and Triennially. 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 Comodo Product setup


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

    Comodo Product Overview

Repeat the "Comodo Product Setup" Steps above for all other Comodo 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 Comodo Certificates. Optionally, you may have a look at the tab's "TEMPLATE" and "EXPERT" to learn more about styling and customizing your own Dashboard.

Template

Dashboard Setup

 

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

Comdo Certificate Management 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.

Expert

Customizing Dashboard

 

The R.C.C.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.

Smarty variables:

  • {$rcm_serviceid} = Service ID (integer)
  • {$rcm_apisuccess} = API Success message (string)
  • {$rcm_apierror} = API Error message (string)
  • {$rcm_csrrecover} = The stored CSR file (string)
  • {$rcm_daystowait} = Number of days to wait till renewstart (integer)
  • {$rcm_renewstart} = Formatted date for renewstart as per the whmcs format settings (date)
  • {$rcm_isenroll} = If Certificate pending enrollment, value 1 (integer)
  • {$rcm_isrenew} = If Certificate pending renew enrollment, value 1 (integer)
  • {$rcm_ispending} = If Certificate pending verification / issue, value 1 (integer)
  • {$rcm_status} = service status, InActive, Suspended, Active (string)
  • {$rcm_enrollerror} = If Enrollment Error, value 1 (integer)
  • {$rcm_changeemailerror} = If Change Verify Email Error, value 1 (integer)
  • {$rcm_reissueerror} = If Reissue Error, value 1 (integer)
  • {$rcm_servicestatus} = Service Status Message (string)
  • {$rcm_defaultemails} = Dropdownlist with formatted default emails (string)
  • {$rcm_certificatecode} = Issued Certificate Code (string)
  • {$rcm_currentdate} = Current date in WHMCS default format "Y-m-d" (date)
  • {$rcm_expiredate} = Formatted certificate expiredate as per whmcs format settings (date)
  • {$rcm_renewdate} = Formatted certificate renewdate as per whmcs format settings (date)
  • {$rcm_realnextduedate} = Real certificate expiredate in WHMCS default format "Y-m-d" (date)

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/rcmodcomodo/ folder

  3. Goto to the Products Setup TAB "Module Settings" and deactivate the Built-in Dashboard

Complete Code Example

 

{*
 * RCM Comodo Certificate Management Dashboard Template
 *
 * @package		Resellerclub Mods (gIF)
 * @author		Resellerclub Mods contact[at]resellerclub-mods.com
 * @copyright	Copyright (c) resellerclub-mods.com 2011-2015
 * @license		http://www.resellerclub-mods.com/en/terms-of-service/eula.html
 * @link		http://www.resellerclub-mods.com/
 * @version		v3.11.1
 *}
 
<h2>{$LANG.rcccp_managementtitle}</h2>
<table width="100%" border="0" cellpadding="10" cellspacing="0">
	<tr>
		<th width="150">{$LANG.rcccp_statustitle}:</th>
		<th><font color="{$color}">{$rcm_servicestatus}</font></th>
	</tr>
	<tr>
		<td colspan="2">
			<div style="text-align:left;">
				{*-- SUCCESS / ERROR HANDLING --*}
				{if $rcm_apierror}
					<div><p>{$rcm_apierror}</p></div>
				{/if}
				{if $rcm_apisuccess}
					<div><p>{$rcm_apisuccess}</p></div>
				{/if}
	
				{if $rcm_status neq "InActive"}
					{literal}<script language="javascript" type="text/javascript"> function showonlyone(thechosenone) { $('.newboxes').each(function(index) { if ($(this).attr("id") == thechosenone) { $(this).show(800); } else { $(this).hide(800); } }); }</script>{/literal}
					{if $rcm_ispending}
						{*-- CERTIFICATE PENDING ISSUE/VERIFICATION --*}
						{literal}<script language="javascript" type="text/javascript">function changeverifyemail(){$("#contentmodify").slideToggle();}</script>{/literal}
						<p><strong>{$LANG.rcccp_certstatustitle}</strong> <span>{$LANG.rcccp_certissuepending}</span></p>
						<input type="button" onclick="javascript:showonlyone('newboxes1');return false;" value="{$LANG.rcccp_certissuepending}" />
						<div class="newboxes" style="display:{if $rcm_changeemailerror}block{else}none{/if};" id="newboxes1">
							<p>{$LANG.rcccp_verifydescdetails}</p>
							<p><br />{$LANG.rcccp_verifydescdetails1} <span style="text-decoration:underline;cursor:pointer;" onclick="changeverifyemail();return false;">{$LANG.rcccp_verifydescdetails2}</span></p>
							<div style="display:{if $rcm_changeemailerror}block{else}none{/if};" id="contentmodify">
								<form action="clientarea.php?action=productdetails&id={$rcm_serviceid}" method="post">
								<table border="0" width="100%">
									<tr>
										<td>{$LANG.rcccp_domainregcemail}</td>
										<td><input name="custom-email" value="{smarty.post.custom-email}" size="40"/></td>
									</tr>
									<tr>
										<td>{$LANG.rcccp_usedefaultmail}</td>
										<td>{$rcm_defaultemails}</td>
									</tr>
								</table>
								<p align="center"><input name="doEmailchange" type="submit" value="{$LANG.rcccp_changeverifyemailbutton}" /></p>
								</form>
							</div>
						</div>

					{elseif $rcm_isenroll}
						{*-- CERTIFICATE PENDING ENROLLMENT --*}
						<p><strong>{$LANG.rcccp_certstatustitle}</strong> <span>{$LANG.rcccp_enrolldesc}</span></p>
						<input type="button" onclick="javascript:showonlyone('newboxes4');return false;" value="{$LANG.rcccp_regandpendingenroll}" />
						<div class="newboxes" style="display:{if $rcm_enrollerror}block{else}none{/if};;" id="newboxes4">
							<form action="clientarea.php?action=productdetails&id={$rcm_serviceid}" method="post">
							<table border="0" width="100%">
								<tr>
									<td colspan="2"><p><strong>{$LANG.rcccp_aproverequest}</strong></p></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_domainregcemail}</td>
									<td><input name="custom-email" value="{php}echo $_POST["custom-email"];{/php}" size="40"/></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_usedefaultmail}</td>
									<td>{$rcm_defaultemails}</td>
								</tr>
								<tr>
									<td colspan="2"><p><strong>{$LANG.rcccp_certwebservertitle}</strong></p></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_csrtitle}</td>
									<td><textarea style="width:100%" name="csr" cols="80" rows="20" >{$smarty.post.csr}</textarea></td>
								</tr>
							</table>
							<p align="center"><input name="doEnroll" type="submit" value="{$LANG.rcccp_buttonenroll}" /></p>
							</form>
						</div>

					{else}
						<p><strong>{$LANG.rcccp_certstatustitle}</strong> <span>{$LANG.rcccp_certificateissued}</span></p>
						<input type="button" onclick="javascript:showonlyone('newboxes2');return false;" value="{$LANG.rcccp_certificatedetailstitle}" />
						<input type="button" onclick="javascript:showonlyone('newboxes3');return false;" value="{$LANG.rcccp_reissuecertificatetitle}" />

						{if $rcm_isrenew}
							{*-- BEGIN CERTIFICATE RENEW --*}
							<input type="button" onclick="javascript:showonlyone('newboxes4');return false;" value="{$LANG.rcccp_regandpendingenrollrenew}" />
							<div class="newboxes" style="display:{if $rcm_enrollerror}block{else}none{/if};;" id="newboxes4">
								<form action="clientarea.php?action=productdetails&id={$rcm_serviceid}" method="post">
								<table border="0" width="100%">
									<tr>
										<td colspan="2"><p><strong>{$LANG.rcccp_aproverequest}</strong></p></td>
									</tr>
									<tr>
										<td>{$LANG.rcccp_domainregcemail}</td>
										<td><input name="custom-email" value="{php}echo $_POST["custom-email"];{/php}" size="40"/></td>
									</tr>
									<tr>
										<td>{$LANG.rcccp_usedefaultmail}</td>
										<td>{$rcm_defaultemails}</td>
									</tr>
									<tr>
										<td colspan="2"><p><strong>{$LANG.rcccp_certwebservertitle}</strong></p></td>
									</tr>
									<tr>
										<td>{$LANG.rcccp_csrtitle}</td>
										<td><textarea style="width:100%" name="csr" cols="80" rows="20" >{$smarty.post.csr}</textarea></td>
									</tr>
								</table>
								<p align="center"><input name="doEnroll" type="submit" value="{$LANG.rcccp_buttonrenewenroll}" /></p>
								</form>
							</div>
						{/if}

						{*-- BEGIN CERTIFICATE ISSUED --*}
						<div class="newboxes" style="display:{if $rcm_enrollerror || $rcm_reissueerror}none{else}block{/if};" id="newboxes2">
							<table border="0" width="100%">
								<tr>
									<td width="100">{$LANG.rcccp_expiredate}</td>
									<td>{$rcm_expiredate}</td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_renewstarttitle}</td>
									<td>
										{if $rcm_isrenew}
											<span>{$rcm_renewdate} - {$LANG.rcccp_renewwaitdays}</span> - {$LANG.rcccp_canrenewnow}</span>
										{else}
											<span>{$rcm_renewdate} - {$LANG.rcccp_renewwaitdays} - {$LANG.rcccp_waitforrenew} {$rcm_daystowait} {$LANG.rcccp_daysrenew}</span>
										{/if}
									</td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_certificate}</td>
									<td><textarea style="width:100%;" cols="80" rows="20" >{$rcm_certificatecode}</textarea></td>
								</tr>
							</table>
						</div>

						{*-- BEGIN CERTIFICATE REISSUE --*}
						<div class="newboxes" style="display:{if $rcm_reissueerror}block{else}none{/if};" id="newboxes3">
							<form action="clientarea.php?action=productdetails&id={$rcm_serviceid}" method="post">
							<table border="0" width="100%">
								<tr>
									<td colspan="2"><p><strong>{$LANG.rcccp_aproverequest}</strong></p></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_domainregcemail}</td>
									<td><input name="custom-email" value="{php}echo $_POST["custom-email"];{/php}" size="40"/></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_usedefaultmail}</td>
									<td>{$rcm_defaultemails}</td>
								</tr>
								<tr>
									<td colspan="2"><p><strong>{$LANG.rcccp_certwebservertitle}</strong></p></td>
								</tr>
								<tr>
									<td>{$LANG.rcccp_csrtitle}</td>
									<td><textarea style="width:100%" name="csr" cols="80" rows="20" >{$smarty.post.csr}</textarea></td>
								</tr>
							</table>
							<p align="center"><input name="doReissue" type="submit" value="{$LANG.rcccp_reissuecertificatetitle}" /></p>
							</form>
						</div>
					{/if}
				{/if}
			</div>
		</td>
	</tr>
</table>

Latest Tweets

More Tweets from resmods

Latest News

Black Friday and Important News!

Black Friday is coming and will start tonight! Don't miss it and get the best possible discount on our complete Portfolio!
Read more...

About Us

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