LiveZilla Live Chat Software
RCM - Resellerclub Mods

Howto install R.E.E.Hosting Module V3

REEHM - Resellerclub Enterprise Email Hosting 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.9 - 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 REEHM - ResellerClub Enterprise Email Hosting 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 the Enterprise and Business Email Service!

Step 3

Email Template Setup

 

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

Setup an OpenXchange Email Hosting 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 Enterprise Email Service Product setup.

IMPORTANT! Please read carefully before you start with the Product Setup!

The Enterprise and Business Email Hosting Service Setup is slightly different than for other Hosting Products. In your Reseller Account there are 4 Product PRICING Slabs from "EE1 - EE4" for Enterprise Email and "Business Email 1 - Business Email 4" for Business Email with PRICING slabs for One, Three, Six and Twelve Months. All selling/buying prices for each slabs are for Only one Email Account. Based on how many Email accounts you buy or sell using OrderBox Supersite, the prices can change.

Unfortunately you can not sell a product or configurable options based on different billing cycles and at the same time with different prices depending on a certain amount. This is not supported in WHMCS.

WHMCS only supports One Selling Price per Billing Cycle and you have to set up selling prices for only one Email account each billing cycle. With the Enterprise and/or Business Email Product purchase you are offering by default only "one Email account". Additional Email accounts are offered through "Configurable Options" during the order process or later from the Client Area.

REMBER: You need to setup only one Enterprise Email Hosting Product and only one Business Email Hosting Product. Each Product will have only one Email account by default and therefore the selling price for the Base Product is for only one Email Account. All additional Email accounts must be served with Configurable Options explained in TAB "Step 4".

 

Product Group setup

 

  1. You should create a new global product group for Enterprise Email Service 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 "Enterprise Email" and click the button "Create Group".

    Product Group setup

OpenXchange Product Setup

 

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

    MANDATORY: Product Type must be set to "Hosting Account"

    Hosting Product setup


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

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

    OpenXchange Hosting Module Settings


  3. Select the "Email Hosting Product " from the dropdown menu the module has detect in your LogicBoxes Products setup account. In this example we use the OpenXchange Product "Enterprise Email US - US Accounts".

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

  5. The "R.A.M.D.I" check box allows you to use our R.A.M.Dns Management Interface Solution if you have it installed. If not checked, the OrderBox Dns Management button for direct login will be shown instead.

  6. The "R.A.M.E.I" check box allows you to use our R.A.M.Email Management Interface Solution if you have it installed. If not checked, OrderBox Email Management button for direct login will be shown instead.

  7. The "OX Desktop" check box shows a button to open the OX Webdesktop interface for http://webmail.yourdomain.com/.

  8. 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.

  9. 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"

  10. 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.

  11. 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 Enterprise Email Product, select the "REEHM - OpenXchange Welcome Email" from the "Welcome Email Dropdownlist" and activate the option "Require Domain" . All other options as per your needs:

    Details Hosting Product setup


  12. Click now the "Upgrade" tab and tick the checkbox "Configurable Options " but do not select any of products from the Packages Upgrade menu:

    Activate Hosting Module


  13. Under the "Pricing" tab select Payment type "Recurring" and setup your selling prices for "Monthly", "Quarterly", "Semi-Annually" and "Annually". For the Biennially and Triennially 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 Hosting Product setup


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

    Hosting Product Overview

Repeat the "OpenXchange Product Setup" Steps above for the Business Email (Enterprise Email Lite) Product.

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".

When finished with the "OpenXchange Product Setup", proceed to the "Configurable Options" from STEP 4 in this document.

Step 4

Configurable Options for Additional Email Accounts

 

The next step is setting up configurable options to offer additional Email Accounts. Additional Email Accounts can be added to the Base Product during the order process or later from the Client Area using the Upgrade/Downgrade built-in feature from WHMCS. This setup is mandatory and you need to setup the configurable options even if you would not offer to sell these Addons. However, you can use the hide option to stop the selling of configurable options.

REMEMBER: The Enterprise and Business Email Services you have setup is the base product which includes only one Email Account. You need to create now a 2 Configurable option Groups to offer additional Email Accounts for the Enterprise and for the Business Email service. The Configurable options will offer the possibility to add more accounts when a customer buys the service or when the customer later need more Email accounts:

 

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

    Configurable Options Group


  2. You will see in the menu field "Assigned Products (3)" the Enterprise Email Hosting you have created in the "PRODUCT SETUP" step. Insert a "Group name (1)", for example "Enterprise Additional Email Accounts " and insert a "Description (2)", e.g. "Additonal Email Accounts (ResellerClub Enterprise Email)".

  3. Select the Enterprise Email Service you have created from the "Assigned Products" Menu.

  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 Options for Email Accounts


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

    Setup Configurable Options for Email Accounts


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

    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:

    Pricings for Email Accounts


  7. Setup your "Selling Prices (10)" according the billing cycle product setup Monthly, Quarterly, Semi-Annually and Annually. For Biennial and Triennial set the value 0.00.

  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:

    Overview Configurable Options

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

 

Configurable Options for Additional Email Accounts - Business Email (Enterprise Email LITE)

 

The steps to setup the Configurable Options for Business Email (Enterprise Email LITE) Service is exactly the same as for the Enterprise Email Configurable Options. You only need to duplicate the created Configurable Option Group. Once duplicated, adjust the names and selling prices and associate the new group to the Business Email Product.


Your Enterprise Email and Business Email (Enterprise Email Lite) Hosting setup with Configurable Options is now completely done and you can start selling the services. 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 OpenXchange Hosting Management Dashboard. It will be displayed based on the style settings and automatically if not deactivated in the Product Setup tab "Module Settings".

Enterprise Email Hosting 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.E.E.Hosting 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} = The Product Domain ID (string)
  • {$mailbutton} = Prestyled form button for Mail.pw or R.A.M.Email Interface (string)
  • {$dnsbutton} = Prestyled form button for Orderbox DNS or R.A.M.Dns Interface (string)
  • {$webmailbutton} = Prestyled form button for accesing the OX Desktop interface for the domain (string)
  • {$rc_status} = The status of the Single Domain Hosting or Webservice: Active, Suspended, etc. (string)
  • {$rc_mailnum} = Total Number of mail accounts including the default mail account (string)
  • {$rc_mailspace} = Allocated mailspace per mailaccount (string)
  • {$rc_filespace} = Allocated filespace per account (string)
  • {$created_accs} = Created mail accounts (string)
  • {$created_fwds} = Created mail forwarders (string)
  • {$uncreated_accs} = Mail accounts available (string)
  • {$buy_more} = Direct link to buy more accounts (string)
  • {$dns_servers} = Partially or fully branded required DNS Servers (array)
  • {$a_records} = All A Records for external DNS Setup (array)
  • {$mx_records} = All MX Records for external DNS Setup (array)
  • {$txt_records} = All TXT Records for external DNS Setup (array)
  • {$cname_records} = All CNAME Records for external DNS Setup (array)
  • {$oxtype} = Identifies if Business (Enterprise Email LITE) or Enteprise Email (string)
  • {$no_addon_links} = If Addon links are set to be exposed or not. Empty if enabled and "on" if disabled (string)
  • {$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)
  • {$module} = Identifies the name of the module: rcmodeehosting (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/rcmodeehosting/ folder

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

Complete Code Example

 

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

<div align="center">
	<h2>{$LANG.rceeh_managementtitle}</h2>
	{if $rc_status eq "Active"}
		<table>
			<tr>
				<td><h4>{$LANG.rceeh_statustitle}</h4></td>
				<td>
					<span style="color:{if $active_color}{$active_color}{else}#006600{/if};">{$rc_status}</span>
				</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_controlpanelstitle}</strong></td>
				<td>
					<div style="float:left;padding:2px;">{$mailbutton}</div>
					<div style="float:left;padding:2px;">{$dnsbutton}</div>
					<div style="float:left;padding:2px;">{$webmailbutton}</div>
				</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_mailpoptitle}</strong></td>
				<td>pop.{$domain}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_mailimaptitle}</strong></td>
				<td>imap.{$domain}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_mailsmtptitle}</strong></td>
				 <td>smtp.{$domain}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_mailspacetitle}</strong></td>
				<td>{$rc_mailspace} {$LANG.rceeh_gigabytetitle}</td>
			</tr>
			{if $oxtype neq "Enterprise Email LITE"}
				<tr>
					<td><strong>{$LANG.rceeh_filespacetitle}</strong></td>
					<td>{$rc_filespace} {$LANG.rceeh_gigabytetitle}</td>
				</tr>
			{/if}
			<tr>
				<td><strong>{$LANG.rceeh_mailaccountstitle}</strong></td>
				<td>{$rc_mailnum}{if $no_addon_links neq "on"} {$buy_more}{/if}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_createdaccstitle}</strong></td>
				<td>{$created_accs}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_createdfwdstitle}</strong></td>
				<td>{$created_fwds}</td>
			</tr>
			<tr>
				<td><strong>{$LANG.rceeh_mailacclefttitle}</strong></td>
				<td>{$uncreated_accs}</td>
			</tr>
			<tr>
				<td colspan="2"><strong>{$LANG.rceeh_nsservertitle}</strong></td>
			</tr>
			<tr>
				<td colspan="2">
					<strong>{$LANG.rceeh_nsrecommended}</strong><br />
					{foreach key=num item=ns from=$dns_servers}
						{$ns}<br />
					{/foreach}
				</td>
			</tr>
			<tr>
				<td colspan="2"><strong>{$LANG.rceeh_nsexternal}</strong><br />
					{foreach key=num item=arecs from=$a_records}
						<div>{$arecs.0} - {$arecs.1} - {$arecs.2} - {$arecs.3}</div>
					{/foreach}
					{foreach key=num item=mxrec from=$mx_records}
						<div>{$mxrec.0} - {$mxrec.1} - {$mxrec.2} - {$mxrec.3}</div>
					{/foreach}
					{foreach key=num item=txtrec from=$txt_records}
						<div>{$txtrec.0} - {$txtrec.1} - {$txtrec.2} - {$txtrec.3}</div>
					{/foreach}
					{foreach key=num item=cnamerec from=$cname_records}
						<div>{$cnamerec.0} - {$cnamerec.1} - {$cnamerec.2} - {$cnamerec.3}</div>
					{/foreach}
				</td>
			</tr>
	   </table>
	{else}
		<table>
			<tr>
				<td><h4 style="width:30%">{$LANG.rceeh_statustitle}</h4></td>
				<td>
					<span style="color:{if $inactive_color}{$inactive_color}{else}#FC7202{/if};">{$LANG.rceeh_hostingpreparing}</span>
				</td>
			</tr>
		</table>
	{/if}
</div>

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: