LiveZilla Live Chat Software
RCM - Resellerclub Mods

Howto install R.A.M.Cert Interface V3

RAMCI - Resellerclub Advanced Management Certificate Interface
Release Date
Latest Version
27.04.2015
3.9.3

 

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

Document Version: 2.5 - 27-04-2015

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.3.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 RAMCI - ResellerClub Advanced Managment CERT Interface 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

  2. Certificate Mangament Interface
    Upload the file "certmanagement.php" into your whmcsroot/ folder

  3. Certificate Mangament Templates and Images
    Upload the folder "images" into your whmcsroot/ folder
    Upload the *.tpl files into your active whmcsroot/templates/(portal, classic, default or custom ) folder.

You are now ready to setup your first Certificate Product!

Step 3

Email Template setup

 

Begin by setting up first the welcome email template thus the "welcome email" will be ready and you can select it during the next steps! To setup up a customized email template, login to your whmcs and goto "Setup" » Email Templates from where you should create a new template by clicking on "Create New Email Template Type:" Product. A standard welcome email for Certificate orders is available in the unzipped "rcmodthawte_x.x.x" folder (email_welcome_template.html).

Setup a Certificate 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 Thawte SSL 123 Certificate Product setup:

Product Group setup

 

  1. You should create a new global product group for all certificates. Goto Setup » Products/Services and click "Create a New Group". Set a Product Group Name, for example "Thawte SSL Certificates" and click the button "Create Group".

    Create Product Group

Certificate Product setup

 

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

    Create Certificate Product

  2. You are now on the "Edit"Product" page » "Details" tab where you can see the Product Type, Product Group and the Product Name. Create a product description for the certificate, select the Welcome Email you created at beginning and leave all other fields empty as shown below:

    Manage Product Details

  3. Under the "Pricing" tab select Payment type "Recurring" and setup your selling prices for "Annually" and "Biennially". Set the value "-1.00" for all other Billing cycles or simply uncheck the checkbox.

    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

    Manage Certificate Product Pricings

  4. Under the "Module Settings" tab select the Module Name called "rcmodthawte". This will load the module configuration.

    Configure RAMCI Module

    Now you need to select first the LogicBoxes registrar you like to use for this product. Select the Registrar and then click the button "Save Changes".

    Select LogicBoxes Registrar

    You should then see that the module has found "your reseller account credentials" and the API connection has been established successfully. If not, check your settings in Addons » "ResellerClub Mods Console" » R.A.M.Cert Interface. If the setup is correct, then proceed with the configuration steps below to setup the module:

    Configure RAMCI Module

  5. In "Productkey" insert the correct key value for the product you are setting up. For example, Thawte ssl123 use "fssl" as productkey.

  6. You can set the colors for the messages that are shown for module actions. Leave this fields blank to use the default values.

  7. The "Openssl path" can be leaved blank if you are on a cpanel hosting server. If the CSR checker tool throws and error, contact your hosting provider and ask for the correct path to the openssl binary. If you are not sure, just leave this field blank.

  8. The "Days before activate renew button" field is set by default to 30. You can insert any value from 1 to 30. We recommend to leave it blank to use the default value of 30. This will activate the renewal button for the certificate 30 days before the expire date.

  9. The Dashboard check box allows "deactivating" the Management Console on the clientareaproductdetails.tpl. No Dashboard will be shown if checked and $smarty variables are created for the Plan details to build your own Dashboard. For more information about customizing your own Dashboard, refer to the Expert TAB in this documentation.

  10. Dashboard Style: Accordingly to your WHMCS design, you can select the apropiate built-in Dashboard design.
    • Dashboard Style defaultv5.1 if you use whmcs v5.1 or above with template style "default"
    • Dashboard Style defaultv5 if you use whmcs v5 with template style "default"
    • Dashboard Style defaultv4 for any whmcs version with template style "classic"
    • Dashboard Style portal for any whmcs version with template style "portal"

  11. If you activate the option "Enable Auto Renew" the renewal initiated from the client area will run automatically if the renewal invoice has been paid. If deactivated, the customer can still initiate the renewal process. However, the renewal order only will be added and pending execution untill you log into your reseller account (Orderbox) and execute the pending payment order manually.

  12. Select "Automatically setup the product as soon as the first payment is received". This will add a Certificate 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.

  13. Under the "Custom fields" tab we need to setup additional informations required for a certificate order:

    Certificate Custom Field


  14. Insert in the Field Name a clear an short name, for example "Common Name (CN)".

  15. Select Field Type "TextBox"

  16. For Thawte Certs SSL 123, SSL Webserver and SuperCert SGC, insert a short and clear description, for example: "Enter the domain you wish to secure. Example: www.mydomain.com".

    Note: For Wildcard Certificate do not specify "www" nor "*."! Simply request for the domain name, eg. "Enter only the domain you wish to secure: mydomain.com"

  17. Leave the "Validation" and "Select Options" field blank

  18. Select "Required Field", "Show on Order Form" and "Show on Invoice".

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

    Certificate Product Overview

Your Thawte SSL 123 product setup has been finished at this point. Repeat the "Certificate Product setup" steps above for SGC SuperCert, SSL Webserver Cert and Wildcard Cert. Once finished, proceed to the "Configurable Options for Additional Certificate Licences" from STEP 4 in this document.

Step 4

Configurable Options for Additional Certificate Licences

 

The next step is setting up configurable options to sell additional licenses for each certificate product you have created. You need to create for each certificate product a new Configurable option Group.

Note You cannot create only one global configurable option group for all certificates. Please proceed exaclty with the configuration steps below for each Certificate product:

  1. Goto Setup » Configurable Options and click "Create a new Group"

    Create Configurable Option Group


  2. You will see in the menu field "Assigned Products (3)" the SSL Certificate Products you have created in the "PRODUCT SETUP" step. Insert a "Group name (1)", for example "Thawte SSL 123 Licences" and insert a "Description (2)", e.g. "Additonal Thawte SSL 123 Licences (ResellerClub SSL)".

  3. Select the correct certificate for the additional licenses! In this exampe, we use Thawte SSL 123 Certificate.

  4. Click the "Save Changes (4)" Button and hold on until you see the "Add new Configurable Option" Button with a new empty table as shown below:

    Manage Configurable Option Group


  5. Click the button "Add New Configurable Option (5)". This opens a new window for setup the pricing and other options.

    Additional Certificate Licences


  6. Insert under "Option Name (6)" for example: Additional Licences. From the "Option Type (7)" dropdown select "Quantity". Under "Add Option (8)" insert, for example SSL Licences. Then Simply click the button "Save Changes (9)" and you will see the pricing tables below:

    Additional Certificate License Pricing


  7. Setup your "Selling Prices (10)" according the billing cycle product setup Annually and Biennially. For all other Billing cycle set the value -1.00. 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.

  8. Click the "Save Changes (11)" and then the "Close Window (12)" Button. This creates automatically a new entry in the table as shown below:

    Configurable Options for Additional Certificates

  9. Click "Save Changes (13)" and then the "Back to Groups List (14)" Button.

Your ResellerClub Thawte SSL 123 Certificate Product with Configurable Options setup is now completely done. Repeat the entire "Configurable Options for Additional Certificate Licences" steps for the other certificate products, SGC SuperCert, Webserver Cert and Wildcard Cert.

Optionally, have a look at the tab's "RENEW" for automated renew process, "TEMPLATE" and "EXPERT" to learn more about styling and customizing the Dashboard

Renew

Automated Certificate Renewal Notice

 

Thawte allows the reuse of the CSR used for the Certificate Enrollment and since version RAMCI v3.8.1, the CSR is stored automatically in the database and recovered when it comes to renew the certificate.

In order to automate further more the Certificate renewal process, a new feature has been implemented. Once the customer has paid the renewal invoice, an automated mail with renewal instructions will be send to the customer. The setup is not mandatory but recommended:

  1. Begin by setting up a renewal welcome email template. To setup up a customized email template, login to your whmcs and goto "Setup" » Email Templates from where you should create a new template by clicking on "Create New Email Template Type:" Product. A standard welcome renewal email template is available in the unzipped "rcmodthawte_x.x.x" folder (email_renewnotice_template.html).

  2. Goto the Resellerclub Mods Console Addon Setup -> Section "R.A.M.Cert Interface" and select from the dropdown menu "Notify for Renew" the previously created email template and click the "Save Changes" Button.

Template

Dashboard Setup

 

There is no special setup needed for implementing the Certificate Management Dashboard. It will be displayed automatically if not disabled previously.

Certificate Dashboard

If the Dashboard is not displayed on the client area details page for the product, 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 v5.0 - v5.3 default template:

    {if $moduleclientarea}<div>{$moduleclientarea|replace:'modulebutton':'btn'}</div>{/if}
    

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


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

CSS Style Setup

 

CSS Styling is only necessary for WHMCS classic and portal based templates.

Open the whmcs "style.css" file located in your active template folder and insert (copy/paste) at the end, the new style content from the classic_update_style.css or portal_update_style.css file. Upload your modyfied style.css back into your active whmcs template folder.

Expert

Customizing Dashboard

 

The R.A.M.Cert Interface module allows you to deactivate the built-in Dashboard. With the Dashboard deactivated, the module generate a set of smarty variables which you can use to build your own dashboard for your customized template design.

The following smarty variables are available:

  • {$certstatus} = Status of the certificate (string)
  • {$messagecolor} = Color for Status message (string)
  • {$reissuebutton} = Button for Certificate reissue (string)
  • {$renewcertbutton} = Button for renewal (string)
  • {$viewsealsbutton} = Button for thawte seals (string)
  • {$viewcertbutton} = Button for obtaining Certificates (string)
  • {$checkcertbutton} = Button for status information (string)
  • {$certenrollbutton} = Button for Cert enrollment (string)
  • {$csrcheckerbutton} = Button for CSR checker tool (string)
  • {$certcheckerbutton} = Button for Certificate Installation Checker tool (string)

Optionally generated smarty variables for complex Dashboard build:

  • {$isrenewactive} = Generates tag disabled="disabled" for button if not in renewal period, else empty (string)
  • {$certpending} = true if cert is issue pending, empty if false (string)
  • {$certcancelled} = true if cert was cancelled due wrong enrollment, empty if false (string)
  • {$certenrollpending} = true if cert is pending for enrollment, empty if false (string)
  • {$certissued} = true if cert is issued, empty if false (string)
  • {$activatedaysbefore} = shows the number of days configured before activating the renewal option (int)
  • {$product} = Product name (string)
  • {$restdays} = shows the days before expire date from min. 30 to max. -30 (int)

Style your own Dashboard

 

  1. Goto Setup » Products/Services and select the product for which you want to use your customized Dashboard. Click the tab "Module Settings" and deactivate the Dashboard

    Deactivate Dashboard


  2. Open your html editor or any text file editor such as notepad and add your customized html code. A valid Standard Code Example as well as a Complex standard Example is available below.

  3. Save the file as clientarea.tpl and upload the file into the /whmcsroot/modules/servers/rcmodthawte/ folder

Standard Code Example

 

The following example allows you to style your own Dashboard very easy. You only need to styling your dashboard. Status messages and buttons are generated automatically and you do not need any smarty / php knowledge to style your Dashboard:

<h2>{$LANG.rccert_managementtitle}</h2>
<table>
  <tr>
    <td><strong>{$LANG.rccert_statustitle}</strong></td>
    <td><p style="color:{$messagecolor};">{$certstatus}</p></td>
  </tr>
  <tr>
    <td>{$csrcheckerbutton}</td>
    <td>{$LANG.rccert_csrcheckerbuttondesc}</td>
  </tr>
  <tr>
    <td>{$certenrollbutton}</td>
    <td>{$LANG.rccert_certenrollbuttondesc}</td>
  </tr>
  <tr>
    <td>{$checkcertbutton}</td>
    <td>{$LANG.rccert_checkcertbuttondesc}</td>
  </tr>
  <tr>
    <td>{$viewcertbutton}</td>
    <td>{$LANG.rccert_viewcertbuttondesc}</td>
  </tr>
  <tr>
    <td>{$viewsealsbutton}</td>
    <td>{$LANG.rccert_viewsealsbuttondesc}</td>
  </tr>
  <tr>
    <td>{$reissuebutton}</td>
    <td>{$LANG.rccert_reissuebuttondesc}</td>
  </tr>
  <tr>
    <td>{$certcheckerbutton}</td>
    <td>{$LANG.rccert_certcheckerbuttondesc}</td>
  </tr>
  <tr>
    <td>{$renewcertbutton}</td>
    <td>{$LANG.rccert_renewcertbuttondesc}</td>
  </tr>
</table>

Complex standard Example

 

The following example is fully customizable and makes use of the optionally available smarty variables which allows you to activate or deactivate certain buttons based on if conditions you may consider better for your Dashboard implementation. You need certain knowledge for smarty / php coding.

<h2>{$LANG.rccert_managementtitle}</h2>
<table>
  <tr>
    <td><strong>{$LANG.rccert_statustitle}</strong></td>
    <td><p style="color:{$messagecolor};">{$certstatus}</p></td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=csrchecker">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input name="certype" value="{$product}" type="hidden"/>
      <input name="certkey" value="{$certkey}" type="hidden"/>
      <input {if $certissued || $certpending}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_checkcsrbotton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_csrcheckerbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=enrollcert">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input {if $certissued || $certpending}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_regbutton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_certenrollbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=checkcert">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input {if $certenrollpending}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_statusbutton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_checkcertbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=viewcert">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input {if !$certissued}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_viewcertbutton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_viewcertbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=viewseals">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input name="certype" value="{$product}" type="hidden"/>
      <input {if !$certissued}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_pickupsealbotton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_viewsealsbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=reissuecert">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input {if !$certissued}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_reissuecertbutton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_reissuebuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=certchecker">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input name="certype" value="{$product}" type="hidden"/>
      <input {if !$certissued}disabled="disabled"{/if} type="submit" value="{$LANG.rccert_checkcertbotton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_certcheckerbuttondesc}</td>
  </tr>
  <tr>
    <td>
      <form method="post" action="certmanagement.php?action=renewcert">
      <input name="domain" value="{$domain}" type="hidden"/>
      <input name="domainid" value="{$id}" type="hidden"/>
      <input {$isrenewactive} type="submit" value="{$LANG.rccert_renewbutton}"/>
      </form>
    </td>
    <td>{$LANG.rccert_renewcertbuttondesc}</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: