Personal tools
Namespaces

Variants
Actions

EasyDCIM Colocation For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About EasyDCIM Colocation V2 For WHMCS)
Line 32: Line 32:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Traffic Statistics Graph
+
|style="padding: 0px 0px 0px 45px;"|✔ Power Usage Statistics And Graph
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Power Usage Graph
+
|style="padding: 0px 0px 0px 45px;"|✔ Aggregate Traffic Graph
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate Default Configurable Options
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Default Colocation Options:
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Colocation:
+
 
|}
 
|}
 
{|
 
{|
Line 50: Line 47:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Automatic Order Acceptance And Colocation Matching
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Automation Settings:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Access Level
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Automatic Order Acceptance
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Actions And Email Notifications
+
|style="padding: 0px 0px 0px 45px;"|✔ Block Automatic Suspension/Unsuspension/Termination By WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Control Service Access Level
 
|}
 
|}
 
{|
 
{|
Line 62: Line 62:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Display Base Features:
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Service Information:
 
|}
 
|}
 
{|
 
{|
Line 77: Line 77:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Allow Colocation Actions:
+
|style="padding: 0px 0px 0px 60px;"|✔ General Hosting Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Auto Login Link
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Graphs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Traffic Statistics
+
|style="padding: 0px 0px 0px 60px;"|✔ Aggregate Traffic
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Display Other Features:
+
|style="padding: 0px 0px 0px 60px;"|✔ Power Usage
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Allow Server Actions:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Log Into Panel
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Allow Server Management:
 
|}
 
|}
 
{|
 
{|
Line 95: Line 104:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 60px;"|✔ Power Outlets
+
|style="padding: 0px 0px 0px 60px;"|✔ Power Outlets
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Actions And Email Notifications
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Generate Default Configurable Options
 
|}
 
|}
  
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Colocation Model/Location/Label
+
|style="padding: 10px 0px 0px 30px;"|✔ View Colocation Information:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Model
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Label
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Location
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses
 
|}
 
|}
 
{|
 
{|
Line 106: Line 133:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Traffic Statistics Graph
+
|style="padding: 0px 0px 0px 30px;"|✔ View Traffic Statistics:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Usage
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Aggregate Traffic Graph
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Network Ports
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Power Usage Statistics:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ In Given Intervals
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Power Usage Graphs
+
|style="padding: 0px 0px 0px 45px;"|✔ As Power Usage Graph
 
|}
 
|}
 
{|
 
{|
Line 127: Line 169:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Bill For Current Bandwidth Usage
+
|style="padding: 0px 0px 0px 30px;"|✔ Bill For In/Out/Total Bandwidth Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of Bandwidth Overages
+
|style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of In/Out/Total Bandwidth Overages
 
|}
 
|}
  
Line 155: Line 197:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.4.3 and Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.9.4 and Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.3 Up To PHP 8.1
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.4 Up To PHP 8.1
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates "Six" And "Twenty-One"
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.3 And Later
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.4 And Later
 
|}
 
|}
  

Revision as of 13:48, 8 February 2023

Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.

Contents

About EasyDCIM Colocation V2 For WHMCS

EasyDCIM Colocation V2 For WHMCS is a free module that will allow you to provide and manage your EasyDCIM colocation services from the WHMCS area.

You will be enabled to, among others, determine the status of each colocation, and your clients - turn off and on their power outlets remotely.
At the same time you and your clients will both be empowered to display statistics on traffic and power usage as well as log in to the EasyDCIM panel with a single click.

If you are still using the module in version 1.x and need its documentation, you will find it under this page.

  • Admin Area Features:
✔ Create/Terminate/Suspend/Unsuspend Colocation
✔ Update Order Information
✔ One Click Login To User Control Panel
✔ View Colocation Resource Usage:
✔ Bandwidth Statistics
✔ Power Usage Statistics And Graph
✔ Aggregate Traffic Graph
✔ Configure Default Colocation Options:
✔ Model
✔ Location
✔ Configure Automation Settings:
✔ Toggle Automatic Order Acceptance
✔ Block Automatic Suspension/Unsuspension/Termination By WHMCS
✔ Control Service Access Level
✔ Define Client Area Features:
✔ Toggle Service Information:
✔ Label
✔ Model
✔ Location
✔ IP Address
✔ General Hosting Information
✔ Toggle Graphs:
✔ Aggregate Traffic
✔ Power Usage
✔ Allow Server Actions:
✔ Log Into Panel
✔ Allow Server Management:
✔ Traffic Statistics
✔ Power Usage Statistics
✔ Power Outlets
✔ Control Service Actions And Email Notifications
✔ Generate Default Configurable Options
  • Client Area Features:
✔ View Colocation Information:
✔ Model
✔ Label
✔ Location
✔ IP Addresses
✔ One Click Login To User Control Panel
✔ View Traffic Statistics:
✔ Bandwidth Usage
✔ Aggregate Traffic Graph
✔ Network Ports
✔ View Power Usage Statistics:
✔ In Given Intervals
✔ As Power Usage Graph
✔ Enable/Disable/Restart Power Outlets
  • Configurable Options:
✔ Colocation Model
✔ Colocation Location
  • Advanced Billing Integration:
✔ Bill For Current Power Usage
✔ Bill For In/Out/Total Bandwidth Usage
✔ Apply 95th Percentile Billing Of In/Out/Total Bandwidth Overages
  • Supported PDU Manufacturers:
✔ APC
✔ CyberPower
✔ Enlogic
✔ Raritan
  • General Info:
✔ Integrated With Advanced Billing For WHMCS v3.2.2 And Later - Actual Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports EasyDCIM v1.9.4 and Later
✔ Supports PHP 7.4 Up To PHP 8.1
✔ Supports WHMCS Templates "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.4 And Later
  • Exclusive Promo Code From ModulesGarden:
✔ Save 20% For 3 Months On The EasyDCIM Control Panel With Coupon: WHMCS20%_ED

Installation and Configuration

This tutorial will show you how to successfully install and configure EasyDCIM Colocation For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download the module.
EC1.png
2. Extract the downloaded file into the main WHMCS directory.

The content of the package should look like this.

EC2.png

Configuration of Server

3. Now, we will show you how to configure a new product.

Go to 'Setup' → 'Products/Services' → 'Servers' and press the 'Add New Server' button.

EC2 3.png
4. Next, choose 'EasyDCIMColocation' from the 'Type' dropdown menu.

Fill in your server name, address, username and password (API Key). Then check the connection with the EasyDCIM V2 server and press 'Save Changes'.
Note: The password can be found in your EasyDCIM administrator user profile listed as 'API Key'.

EC2 4.png
5. The next step is creating a server group. To do so, click on 'Create Server Group'.
EC2 5.png
6. Enter the name, click on your previously created server, press 'Add' and 'Save Changes' afterwards.
EC2 6.png

Configuration of Product

7. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

EC2 8.png
8. Enter the product group name and press 'Save Changes'.
EC2 9.png
9. Once you have a product group, you can assign your product to it.

To create a product, click on 'Create a New Product'.

EC2 10.png
10. Next, choose your product group, enter your product name and then press 'Continue'.
EC2 11.png
12. Now, move to the 'Module Settings' section. Keep in mind that the module configuration is only partly obligatory.
The server will be assigned based on the provided configuration, and will therefore match only those options that have been specified.

Default Options:

  • Configurable Options - generate if you want to use configurable options instead of 'Location' and 'Model' in the 'Module Settings' tab of a product.
  • Location (required) - the desired server location
  • Model (required) - the EasyDCIM server model

Product Configuration

  • Auto Accept - automatically run the server matching process after order placement. Use only if you have configured your EasyDCIM to automatically accept services.
    If you use cron synchronization, you can leave this option unchecked.
  • Service Access Level - configure the access level to control the features available to your clients. These levels and features are defined in your EasyDCIM at 'Clients' → 'Services' → 'Access Level' tab.

Service Actions

  • Choose service actions to send certain email notifications to selected administrators instead of performing provisioning actions immediately.
    Leave the fields unchecked to perform the default WHMCS module commands.
  • Choose administrators who will receive the specified service notifications.

Client Area Features

  • Define 'Base Features:'
    • Label
    • Model
    • Location
    • IP Addresses
  • Define 'Colocation Actions:'
    • Auto Login Link
    • Traffic Statistics
  • Traffic Statistics - display statistics on traffic in the client area.
  • Power Usage Statistics - display statistics on power usage in the client area.
  • Power Outlets - display power outlets in the client area and allow client to manage them.
EC2 14.png
13. You can also generate the default configurable options to allow your customers place orders tailored exactly to their needs.

To do that, go to 'Setup' → 'Products/Services' → 'Configurable Options'.
Note: Any configurable option will overwrite its counterpart from the 'Module Settings' tab of a product.

EC2 15.png
EC2 13.png
14. Additionally, you can set up a percentile billing for additional traffic.

Note: This option is possible only if you do not have Advanced Billing Form WHMCS module installed. If you need a bit more advanced billing integration, please go here for more information.
Go to the 'Other' tab and enable 'Overages Billing' . First, define the standard overages bandwidth billing and then set the following percentile values:

  • Soft Limit - bandwidth usage in Mbps above which the customer will be additionally charged for the used transfer
  • Cost - price per Mbps unit above the 'Soft Limit' value

E.g. If 'Soft Limit = 100' and 'Cost = 0.500' and the client exceeds the bandwidth by 10 Mbps, reaching to '110 Mbps' , they will be additionally charged with $5 USD (10 x 0.500).
Note: The percentile billing requires the standard billing of bandwidth overages to be enabled. It will be also calculated during the execution of the WHMCS system cron.

EC2 12.png

Custom Fields

Once the configuration of the module settings has been completed, the following custom fields will be created automatically.
Note: These fields will not be visible to your clients by default.
  • OrderID - the number used to link the product with EasyDCIM order number
  • ServerID - the number used to link the product with EasyDCIM server ID
EC2 7.png

Management

In this section we will show you all functionalities of EasyDCIM Colocation For WHMCS.

Our module allows you to offer and manage EasyDCIM colocation service right in your WHMCS system.

Admin Area

As soon as you set up a server for a client, you can perform various actions and view server details from the WHMCS admin area.
The 'Log In To Panel' button allows you to immediately log in to your client's EasyDCIM control panel.
Our module allows you to create/suspend/unsuspend/terminate server.
By clicking on 'Update Order Information' you can also check the synchronization status of a service (works like a synchronization cron).

EC2 16.png
Below these functions you can also view traffic and power usage statistics and even specify the time intervals.
EC2 17.png
Lastly, you can also see the custom fields with currently assigned 'Order ID' and 'Server ID' from the EasyDCIM panel.

An empty 'Server ID' field means that it has not been automatically assigned by the cron yet (e. g. it may not be activated in the EasyDCIM panel yet).
You can also force synchronization by clicking on the 'Update Order Information' module command, or enter ID manually and save the settings.

EC2 18.png

Client Area

In the main view of the client area your customers can check basic details of a colocation service as well as log in to their EasyDCIM control panel with a single click.
EC2 19.png
They can view the graphs with traffic statistics and even define time intervals.

Note: Available graphs and time intervals depend on the product registration date.

EC2 20.png
The same goes for power usage statistics.
EC2 21.png
Additionally, your clients can see the current state of all power outlets with the possibility to turn them on, off or restart.
EC2 22.png
EC2 22 0.png

Advanced Billing Integration

EasyDCIM Colocation For WHMCS supports integration with the Advanced Billing For WHMCS module.
This allows you to charge your customers for total bandwidth (In, Out and Total), power usage and 95th percentile (In, Out and Total) billing for additional traffic.

Note: We suggest to run the cron only once per hour (with the interval of 3600 seconds).
This is due to the fact that while generating an invoice, only the last billed record is taken into account, so there is no need to collect data more often.

EC2 23.png
Once the relevant options are enabled, your clients will also be able to view billing for the current usage in your client area.
EC2 24.png

Tips

1. Note that placing two identical orders may result in assigning servers with slightly different parameters.

It is a natural result of how server matching in EasyDCIM works. In brief, it matches a server basing on the resources and models precised in the order, without considering other resources.
In the first place, the process aims at identifying the server matching the order 100%. When it fails, the server fulfilling the highest number of specifications will be assigned instead.
More information about server provisioning flow can be found on EasyDCIM documentation page.

Update Instructions

If you are updating your EasyDCIM Colocation For WHMCS module and wish to migrate your data to the new V2 module version, it is advised to familiarize yourself with the below instructions firstly.

Please follow the instructions step by step to avoid any unexpected errors.

Start with making a backup copy of your WHMCS files and database.
This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
1. Download the latest version of the module from our client area.
2. Upload and extract the new module files into your WHMCS root directory.
3. Move to the System Settings → Servers, create a new server and a new server group dedicated to the EasyDCIMcolocationv2 module.
4. Move to the System Settings → Products/Services, find and open the product you are going to update.
5. Open the Module Settings section of the product of you interest, find and open the product you are going to update.
6. Change the 'Module Name' from "EasyDCIMColocation" to "EasDCIMColocationv2".
Change the 'Server Group' to the created in the step 4th one.
7. Configure the module settings from scratch and save the changes.
8. Open the Custom Fields section, correct the existing custom fields names as shown below:
  • orderID|Order ID → OrderID|Order ID
  • serverID|Server ID → ServerID|Server ID
    (Differences in the upper/lower case.)
9. Generate any configurable options if need any.
10.* Regarding billing methods update:
  • Advanced Billing For WHMCS:
    If the Advanced Billing For WHMCS module is used to calculate the billing, move to this module addon and set up the product pricing again, as described here.
  • WHMCS inbuilt system is used:
    If you do not use the Advanced Billing For WHMCS module to calculate the billing, move to the System Settings → Products/Services → Other tab.
    Configure the "Percentile Usage", "Percentile Cost", "Power Usage" and "Power Usage Cost" fields from scratch.

Common Problems

1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=EasyDCIM_Colocation_For_WHMCS&oldid=61937"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
EasyDCIM Colocation For WHMCS