Personal tools
Namespaces

Variants
Actions

EasyDCIM Colocation For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<meta name="keywords" content="easydcim colocation for whmcs, easydcim colocation configuration, easydcim colocation management, easydcim colocation installation, easydcim col...")
 
(→‎About EasyDCIM Colocation For WHMCS)
 
(127 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="easydcim colocation for whmcs, easydcim colocation configuration, easydcim colocation management, easydcim colocation installation, easydcim colocation guide, modulesgarden easydcim colocation, easydcim colocation wiki, easydcim colocation tutorial, easydcim colocation tips, whmcs easydcim colocation module wiki, easydcim colocation common problems, about easydcim colocation for whmcs, easydcim colocation documentation, easydcim colocation faq, easydcim colocation help"></meta>
+
<meta name="keywords" content="easydcim colocation for whmcs, easydcim colocation configuration, whmcs easydcim colocation management, whmcs easydcim colocation installation, whmcs easydcim colocation common problems, about whmcs easydcim colocation, whmcs easydcim colocation documentation, whmcs easydcim colocation faq, whmcs easydcim colocation help, whmcs easydcim colocation guide, whmcs easydcim colocation wiki, whmcs easydcim colocation tutorial, whmcs easydcim colocation tips, whmcs easydcim colocation wiki, collocation whmcs, colocation whmcs, co-location whmcs, dedicated server whmcs"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Colocation For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Colocation For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/office-365 Office 365 For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/easydcim-colocation EasyDCIM Colocation For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''EasyDCIM Colocation For WHMCS''' has been designed to let you automatically provision Microsoft Office 365 plans and remotely manage their key features.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''EasyDCIM Colocation For WHMCS''' is a free module that will allow you to provide and manage your [https://www.easydcim.com EasyDCIM] colocation services from the WHMCS area.<br/>
−
With this module, you will easily supervise all subscriptions, perform switches and suspensions as well as password changes right in your WHMCS.
+
You will be enabled to, among others, determine the status of each colocation, and your clients -  turn off and on their power outlets remotely.<br/>
 +
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. <br/>
 +
<br/>
 +
If you are still using the module in version 1.x and need its documentation, you will find it under [https://www.docs.modulesgarden.com/EasyDCIM_Colocation_V1.X_For_WHMCS this page].
 
|}
 
|}
−
<!--a comment maybe? -->
+
<!-- fixed -->
 +
 
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend EasyDCIM Colocation Subscriptions
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Terminate/Suspend/Unsuspend Colocation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend Addon Services
+
|style="padding: 0px 0px 0px 30px;"|✔ Update Order Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
+
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 30px;"|✔ View Service Information
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Upgrade/Downgrade Office 365 Subscriptions
+
|style="padding: 0px 0px 0px 30px;"|✔ View Colocation Resource Usage:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Statistics
 
|}
 
|}
−
*'''Supported Services:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Office 365 Education/Education E5
+
|style="padding: 0px 0px 0px 45px;"|✔ Power Usage Statistics And Graph
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Office 365 Business/Business Essentials/Business Premium
+
|style="padding: 0px 0px 0px 45px;"|✔ Aggregate Traffic Graph
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Office 365 ProPlus/Enterprise E1/E3/E5/K1
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Default Colocation Options:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Standalone Services:
+
|style="padding: 0px 0px 0px 45px;"|✔ Model
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Exchange Online
+
|style="padding: 0px 0px 0px 45px;"|✔ Location
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ SharePoint Online
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Automation Settings:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ OneDrive For Business
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Automatic Order Acceptance
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Skype For Business Online
+
|style="padding: 0px 0px 0px 45px;"|✔ Block Automatic Suspension/Unsuspension/Termination By WHMCS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Office Applications
+
|style="padding: 0px 0px 0px 45px;"|✔ Control Service Access Level
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Project Portfolio Management
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Client Area Features:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Yammer
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Service Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Business Intelligence Service
+
|style="padding: 0px 0px 0px 60px;"|✔ Label
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Online Diagram Software
+
|style="padding: 0px 0px 0px 60px;"|✔ Model
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Information Rights Management
+
|style="padding: 0px 0px 0px 60px;"|✔ Location
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Requires Microsoft Partner Network
+
|style="padding: 0px 0px 0px 60px;"|✔ Labeled Rack With Position
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Requires Microsoft Cloud Solution Provider - Tier 1
+
|style="padding: 0px 0px 0px 60px;"|✔ IP Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 60px;"|✔ Custom Metadata
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 45px;"|✔ Allow Server Management:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 60px;"|✔ Traffic Statistics
 
|}
 
|}
−
 
−
=Installation=
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and authenticate Office 365 For WHMCS.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Power Usage Statistics
−
We will guide you step by step through the whole installation and configuration process.<br />
+
−
''Note: This module configuration requires a [http://partner.microsoft.com/ Microsoft Partner Network] account.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 60px;"|✔ Power Outlets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC1.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Devices List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 0px 45px;"|✔ Allow Server Actions:
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC2.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Log Into Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Traffic Statistics:
−
The content of PHP version files should look like this.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_2.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Aggregate Traffic Graph
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Office 365 For WHMCS for the first time you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Hide Bandwidth Usage Table
−
File is located in '' 'modules/servers/office365/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC3.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Hide Network Ports Table
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Power Usage
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC4.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Enable Power Usage Graph
 
|}
 
|}
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. To begin, you must add a new server.'''<br />
+
|style="padding: 0px 0px 0px 60px;"|✔ Hide Power Usage Table
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC8.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Devices List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Enter your server name. Choose '' 'Office365' '' from the dropdown menu. Enter your Microsoft Partner username, password, API URL, Native APP ID, Domain And Microsoft ID. Then press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 0px 60px;"|✔ Enable Devices Power Control
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC9.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Actions And Email Notifications
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In order to create full ''' 'API URL' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Account Settings' '' → '' '[https://partnercenter.microsoft.com/en-us/pcv/accountsettings/organizationprofile Organization profile]' '' and copy '' 'Default domain' '' from the section marked on the screen below:
+
|style="padding: 0px 0px 10px 30px;"|✔ Generate Default Configurable Options
 
|}
 
|}
 +
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC9_01.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ View Colocation Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To find your ''' 'Native APP ID' ''' and ''' 'Domain' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Account Settings' '' → '' '[http://partnercenter.microsoft.com/en-us/pcv/apiintegration/appmanagement App Management]' '' and copy '' 'App ID' '' and '' 'Domain' '' from the '' 'Native App' '' section:
+
|style="padding: 0px 0px 0px 45px;"|✔ Model
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC9_1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Label
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|To obtain ''' 'Microsoft ID' ''' go to '' 'Microsoft Partner Center' '' panel → '' 'Dashboard' '' → '' '[http://partnercenter.microsoft.com/en-us/pcv/customers/list Customers]' '' and see more details of the account you want to be used to sell subscriptions:
+
|style="padding: 0px 0px 0px 45px;"|✔ Location
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC9_2.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Labeled Rack With Position
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Once your server has been configured correctly, you will see the following screen.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses
−
Create a new group for your server.  Press '' 'Create New Group' '' to follow.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC10.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Custom Metadata
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Enter a name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'.'' '''
+
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC11.png]]
+
|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 45px;"|✔ As Power Usage Graph
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable/Restart Power Outlets
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Power On/Shutdown/Reboot Colocation Devices
 
|}
 
|}
  
−
==Configuration of Product==
+
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 0px 30px;"|✔ Colocation Model
−
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply move to the 12th step.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC12.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ Colocation Location
 
|}
 
|}
 +
*'''Advanced Billing Integration:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Fill in a product group name and press '' 'Save Changes'. '' '''
+
|style="padding: 10px 0px 0px 30px;"|✔ Bill For Current Power Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC13.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Bill For In/Out/Total Bandwidth Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. When you have a product group added, you can create your product and assign it to Office 365 module.
+
|style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of In/Out/Total Bandwidth Overages
 
|}
 
|}
 +
 +
*'''Supported PDU Manufacturers:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC14.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ APC
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Afterward, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ CyberPower
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC15.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Enlogic
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'Office365' '' and the previously created server group from the dropdown menu and press'' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 10px 30px;"|✔ Raritan
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|[[File:EC16.png]]
+
|style="padding: 10px 0px 0px 30px;"| ✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing#features Advanced Billing For WHMCS] - Actual Server Resource Usage Billing
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.9.6 And Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 
|}
 
|}
  
−
=Configuration and Management=
+
*'''Exclusive Promo Code From ModulesGarden:'''
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|Configuration and management of Office 365 For WHMCS is very intuitive. Read the below sections to see how easy it is.
+
|style="padding: 10px 0px 30px 30px;"|✔ '''Save 20%''' For '''3 Months''' On The EasyDCIM Control Panel With Coupon: '''WHMCS20%_ED'''
 
|}
 
|}
−
==Basic Configuration==
+
 
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's start the module configuration by choosing '' 'Office365' from '' 'Module Name' and previously created 'Server Group' ''.
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/easydcim-colocation EasyDCIM Colocation For WHMCS.]'''<br/>
 +
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:EC16.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|  
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_1.png]]
−
Now, choose '' 'Country'. '' that you will offer your Office 365 services from.<br />
+
−
Also, select the available '' 'Company Domain' ' and choose one of desired Office 365 plans. You may also assign additional services to the main plan as addons, they will be described in further parts.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC17.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''2.  Extract the downloaded file into the main WHMCS directory.'''<br />
 +
The content of the package should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Then, go to the '' 'Custom Fields' '' tab and add two new ''text box'' fields: ''' userid|User ID ''' and ''' orderid|Order ID ''' as shown on the following screen.
+
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC18.png]]
+
|style="padding: 0px 0px 30px 15px; color: #ff0000;"|If you are about to update your '''EasyDCIM Colocation''' module from '''v1 to v2'''? Remember to '''strictly follow the update instructions''' described at the bottom of this '''[[#Update_Instructions|documentation]]'''!
 
|}
 
|}
  
−
==Additional Services==
+
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 10px 0px 15px 15px;"|'''3. Now, we will show you how to configure a new product.'''<br/>
−
In order to offer additional services for a product plan you need to create a new addon first. <br/>
+
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press the '' 'Add New Server' '' button.
−
In your WHMCS system press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and select '' 'Add New Addon' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Enter a name for the addon, choose the addon to be visible in order and configure the rest of the desired options.
+
|style="padding: 0px 0px 15px 15px;"|'''4. Next, choose '' 'EasyDCIMColocation' '' from the '' 'Type' '' dropdown menu.<br/>
 +
Fill in your server name, address, username and password (API Key). Then check the connection with the EasyDCIM V2 server and press '' 'Save Changes'.''<br/>
 +
'' '''Note:''' The password can be found in your EasyDCIM administrator user profile listed as '[https://www.docs.modulesgarden.com/images/9/99/E_API_Key.png API Key]'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Go to the '' 'Applicable Products' '' tab and select the product that you want to offer this addon for. Then press '' 'Save Changes' ''.
+
|style="padding: 0px 0px 20px 15px;"|'''5. The next step is creating a server group. To do so, click on '' 'Create Server Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Go back to your product and connect the created addon with one of the available additional services in the '' 'Module Settings' '' tab.
+
|style="padding: 0px 0px 20px 15px;"|'''6. Enter the name, click on your previously created server, press '' 'Add' '' and '' 'Save Changes' '' afterwards.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC25.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_6.png]]
 
|}
 
|}
 +
 +
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'' 'Save Changes' ''. Remember that you can add more addons for other services.
+
|style="padding: 10px 0px 15px 15px;"|'''7. In order to create and configure a product, go to '' 'Setup' → 'Products/Services' → 'Products/Services'.'''''<br/>
 +
Click on '' 'Create a New Group'.''
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''8. Enter the product group name and press '' 'Save Changes'.'''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''9. Once you have a product group, you can assign your product to it.'''<br/>
 +
To create a product, click on '' 'Create a New Product'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''10. Next, choose your product group, enter your product name and then press '' 'Continue'.'''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''12. Now, move to the '' 'Module Settings' '' section. Keep in mind that the module configuration is only partly obligatory'''.<br/> The server will be assigned based on the provided configuration, and will therefore match only those options that have been specified.
  
−
==Order==
+
'''Default Options:'''
 +
*Location (required) - the desired server location
 +
*Colocation Model (required) - the EasyDCIM server model
 +
'''''Note:''' generate configurable options if you want to overwrite the '' 'Location' '' and '' 'Model' '' in the '' 'Default Options' ''
 +
 
 +
'''Automation Settings'''
 +
* Auto Accept Order - automatically run the server matching process after order placement. Use only if you have configured your EasyDCIM to automatically accept services.<br/>If you use cron synchronization, you can leave this option unchecked.
 +
* Block Automatic Suspension by WHMCS
 +
* Block Automatic Unsuspension by WHMCS
 +
* Block Automatic Termination by WHMCS
 +
* 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' '' → '' '[[Media:ED_Easy_1.png|Access Level]]' ''  tab.<br/>
 +
 
 +
'''Client Area Features'''-  define the features and information that will be available for customers in the client area<br/>
 +
*'''Service Information'''
 +
**Label
 +
**Model
 +
**Location
 +
**Labeled Rack With Position
 +
**IP Addresses
 +
**Custom Metadata
 +
 
 +
*'''Management'''
 +
**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 the client to manage them.
 +
**Devices List - display a list of devices along with their IP and location.
 +
 
 +
*'''Server Actions:'''
 +
**Auto Login Link
 +
 
 +
*'''Traffic Statistics'''
 +
**Aggregate Traffic Graph - display statistics on traffic in the client area.
 +
**Hide Bandwidth Usage Table
 +
**Hide Network Ports Table
 +
 
 +
*'''Power Usage Statistics Tables'''
 +
**Power Usage Graph - display statistics on power usage in the client area.
 +
**Hide Power Usage Table
 +
 
 +
*'''Devices List'''
 +
**Devices Power Control - allow users to restart, shut down and power on the devices on the '' 'Devices List' '' in their client area<br/>
 +
 
 +
'''Email Notifications'''<br/>
 +
*Choose service actions to send certain email notifications to selected administrators instead of performing provisioning actions immediately. <br />Leave the fields unchecked to perform the default WHMCS module commands.
 +
*Choose administrators who will receive the specified service notifications.
 +
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Once the product configuration is complete, clients will be able to order the selected subscription and addons.
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC20_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''13. You can also generate the default configurable options to allow your customers place orders tailored exactly to their needs.<br/>
 +
To do that, go to '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/>
 +
'' '''Note:''' Any configurable option will overwrite its counterpart from the 'Module Settings' tab of a product.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''14. Additionally, you can set up a percentile billing for additional traffic.'''<br />
 +
'' '''Note:''' This option is possible only if you do '''not''' have [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing Form WHMCS] module installed. If you need a bit more advanced billing integration, please go [[#Advanced Billing Integration|here]] for more information. <br/>
 +
Go to the '' 'Other' '' tab and enable '' 'Overages Billing' ''. First, define the standard [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing 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''). <br />
 +
'' '''Note:''' The percentile billing requires the standard billing of bandwidth  overages to be enabled. It will be also calculated during the execution of the [https://docs.whmcs.com/Crons#System_Cron WHMCS system cron].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_12.png]]
 
|}
 
|}
  
−
==Client Area==
+
==Custom Fields==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 10px 0px 15px 15px;"|'''Once the configuration of the module settings has been completed, the following custom fields will be created automatically.''' <br />'' '''Note:''' These fields will not be visible to your clients by default.''
−
Currently, the module does not support any additional features in the client area.<br />
+
*OrderID - the number used to link the product with EasyDCIM order number
−
The customer can order additional services to their subscription, change their password to the [http://www.office.com Office 365] panel, upgrade a subscription plan or request a service cancelation.
+
*ServerID - the number used to link the product with EasyDCIM server ID
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_7.png]]
 
|}
 
|}
  
 +
=Management=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you all functionalities of EasyDCIM Colocation For WHMCS.'''<br/>
 +
Our module allows you to offer and manage EasyDCIM colocation service right in your WHMCS system.
 +
|}
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Let's check your new product in the admin area product page. After a successful creation it should look like on the screen below.
+
|style="padding: 10px 0px 15px 15px;"|
 +
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.<br/>
 +
* '' 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 the server
 +
** By clicking on '' 'Update Order Information' '' you can also check the synchronization status of a service (works like a synchronization cron)
 +
* Quickly view the service information including data on the server: model, label, location, rack & position, IP address
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC19.1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The '' 'Username' '' and '' 'Password' '' are used to sign up to [http://www.office.com Office 365] user panel.
+
|style="padding: 0px 0px 15px 15px;"|Below these functions you can also view traffic and power usage statistics and even specify the time intervals.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:EC26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|Lastly, you can also see the custom fields with currently assigned '' 'Order ID' '' and '' 'Server ID' '' from the EasyDCIM panel.<br/>
−
The '' 'User ID' '', '' 'Order ID' '' and '' 'Subscription ID' '' are custom fields used to connect the product to the created subscription in your [http://partnercenter.microsoft.com Microsoft Partner Center].<br />
+
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).<br/>You can also force synchronization by clicking on the '' 'Update Order Information' '' module command, or enter ID manually and save the settings.
−
If one customer buys more than one subscription then the common '' 'User ID' '' will be used for connection.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC27.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_18.png]]
 
|}
 
|}
−
====Suspend/Terminate====
+
 
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 10px 0px 20px 15px;"|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.
−
Due to API limitations, ordered subscriptions can only be suspended or unsuspended. For this reason, the '' 'Terminate' '' command will work in the same way as the 'Suspend' one.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC30.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|They can view the graphs with traffic statistics and even define time intervals.<br />
−
In case of product suspension, all addons that belong to the product will also be suspended.<br />
+
'' '''Note:''' Available graphs and time intervals depend on the product registration date.
−
If the product is unsuspended, its addons will remain suspended.<br />
+
−
Information about product suspension will be shown in the '' 'Admin Notes' '' field.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_20.png]]
 
|}
 
|}
−
 
−
====Change Password====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|
+
|style="padding: 0px 0px 20px 15px;"|The same goes for power usage statistics.
−
'Change Password' will change the password for all services assigned to the user. To change it for a new one you need to:
+
−
* Provide a new password → Press '' 'Save Changes' '' → Press '' 'Change Password' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC34.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Note that the password must also meet the following requirements:
+
|style="padding: 0px 0px 20px 15px;"|Additionally, your clients can see the current state of all power outlets with the possibility to turn them on, off or restart.
−
*At least 8 characters in length
+
|}
−
*At least 1 uppercase character
+
{|
−
*At least 1 special character
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_22.png]]
−
*At least 1 numeric character
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_22_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Information regarding devices can be found on the '' 'Devices List,' '' this includes their name, IP and location. <br />
 +
If the '' 'Devices Power Control' '' option is enabled, the users will find remote control buttons next to each device, allowing them to restart, shut down, and power on the device. <br />
 +
If you want to find specific devices, you can use the search bar located above the list, or make use of the sorting function of the list.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_22_1.png]]
 
|}
 
|}
  
−
====Addons====
+
=Advanced Billing Integration=
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Information about addons will depend on their status and will be shown in the '' 'Admin Notes' '' field. By default, the '' 'Subscription ID''' service should be provided.
+
|style="padding: 10px 0px 20px 15px;"|EasyDCIM Colocation For WHMCS supports integration with the [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] module.<br/>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.<br/>
 +
 
 +
'' '''Note:''' We suggest to run the cron '''only once per hour''' (with the interval of 3600 seconds).<br/>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.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:EC28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:EC2_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|For example, if the addon is suspended the information will also appear in this field.
+
|style="padding: 0px 0px 20px 15px;"|Once the [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS#Usage_Records relevant options] are enabled, your clients will also be able to view billing for the current usage in your client area.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:EC29.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:EC2_24.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. For more information on how the Microsoft Partner program works, see [http://partner.microsoft.com/en-us/membership/how-it-works here].'''
+
|style="padding: 10px 0px 30px 15px;"|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.<br />
 +
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.<br />
 +
More information about server provisioning flow can be found on [http://www.docs.easydcim.com/provisioning/flow EasyDCIM documentation page].
 +
|}
 +
 
 +
==How To Use Language Overrides==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.'''<br/> The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Here's how to apply language overrides:
 +
* Navigate to the ''~/langs/'' directory located within the following ''yourWHMCS/modules/servers/moduleName/langs/'' path.
 +
* Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure:
 +
  ''~/langs/overrides/english.php''.
 +
* Open the newly created override file to edit its contents.
 +
* At the beginning of the file, indicate the used code, for instance, you can use: '''<?php''' for PHP code.
 +
* Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.
 +
 
 +
For example:
 +
 
 +
'''Original ''yourWHMCS/modules/servers/moduleName/langs/english.php:'''''
 +
 
 +
  $_LANG['Search'] = 'Search';
 +
 
 +
'''Override ''yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:''''' 
 +
 
 +
  $_LANG['Search'] = 'Look for';
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.<br/>
 +
 
 +
Remember that some of the modules have more than one language file, located under ''/addons'' and ''/servers'' paths. You may create the override files for both of them.<br/> Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.<br/> Consequently, the override lang file might include only one or just a few lines.
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 15px 15px;"|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.<br/>
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
Please follow the instructions step by step to avoid any unexpected errors.
−
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
 
|}
 
|}
 +
{|
 +
|style="color: #ff0000; padding: 0px 0px 15px 15px;"|'''Start with making a backup copy of your WHMCS files and database.'''<br/> This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|1. Download the latest version of the module from our [https://www.modulesgarden.com/client-area/products client area].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. Upload and extract the new module files into your WHMCS root directory.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|3. Move to the ''System Settings → Servers'', create a new server and a new server group dedicated to the EasyDCIMcolocationv2 module.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|4. Move to the ''System Settings → Products/Services'', find and open the product you are going to update.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|5. Open the ''Module Settings'' section of the product of you interest, find and open the product you are going to update.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|6. Change the '' 'Module Name' '' from "EasyDCIMColocation" to '''"EasyDCIMColocationv2"'''.<br/> Change the '' 'Server Group' '' to the created in the step '''4th''' one.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|7. Configure the module settings from scratch and save the changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|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 <br/>''(Differences in the upper/lower case.)''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|9. Generate any configurable options if need any.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|10.* Regarding billing methods update:<br/>
 +
*Advanced Billing For WHMCS:<br/> 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 [[#Advanced_Billing_Integration|here]].
 +
*WHMCS inbuilt system is used:<br/> If you '''do not''' use the Advanced Billing For WHMCS module to calculate the billing, move to the ''System Settings → Products/Services → Other'' tab.<br/> Configure the ''"Percentile Usage", "Percentile Cost", "Power Usage"'' and ''"Power Usage Cost"'' fields from scratch.
 +
|}
 +
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, make sure that SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 13:47, 26 April 2024

Contents

[edit] About EasyDCIM Colocation For WHMCS

EasyDCIM Colocation 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 Service Information
✔ 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
✔ Labeled Rack With Position
✔ IP Addresses
✔ Custom Metadata
✔ Allow Server Management:
✔ Traffic Statistics
✔ Power Usage Statistics
✔ Power Outlets
✔ Devices List
✔ Allow Server Actions:
✔ Log Into Panel
✔ Toggle Traffic Statistics:
✔ Aggregate Traffic Graph
✔ Hide Bandwidth Usage Table
✔ Hide Network Ports Table
✔ Toggle Power Usage
✔ Enable Power Usage Graph
✔ Hide Power Usage Table
✔ Toggle Devices List
✔ Enable Devices Power Control
✔ Control Service Actions And Email Notifications
✔ Generate Default Configurable Options
  • Client Area Features:
✔ View Colocation Information:
✔ Model
✔ Label
✔ Location
✔ Labeled Rack With Position
✔ IP Addresses
✔ Custom Metadata
✔ 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
✔ Power On/Shutdown/Reboot Colocation Devices
  • 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 - Actual Server Resource Usage Billing
✔ Multi-Language Support
✔ Supports EasyDCIM v1.9.6 And Later
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
  • Exclusive Promo Code From ModulesGarden:
✔ Save 20% For 3 Months On The EasyDCIM Control Panel With Coupon: WHMCS20%_ED

[edit] 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.

[edit] Installation

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

The content of the package should look like this.

EC2 2.png
If you are about to update your EasyDCIM Colocation module from v1 to v2? Remember to strictly follow the update instructions described at the bottom of this documentation!

[edit] 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

[edit] 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:

  • Location (required) - the desired server location
  • Colocation Model (required) - the EasyDCIM server model

Note: generate configurable options if you want to overwrite the 'Location' and 'Model' in the 'Default Options'

Automation Settings

  • Auto Accept Order - 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.
  • Block Automatic Suspension by WHMCS
  • Block Automatic Unsuspension by WHMCS
  • Block Automatic Termination by WHMCS
  • 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.

Client Area Features- define the features and information that will be available for customers in the client area

  • Service Information
    • Label
    • Model
    • Location
    • Labeled Rack With Position
    • IP Addresses
    • Custom Metadata
  • Management
    • 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 the client to manage them.
    • Devices List - display a list of devices along with their IP and location.
  • Server Actions:
    • Auto Login Link
  • Traffic Statistics
    • Aggregate Traffic Graph - display statistics on traffic in the client area.
    • Hide Bandwidth Usage Table
    • Hide Network Ports Table
  • Power Usage Statistics Tables
    • Power Usage Graph - display statistics on power usage in the client area.
    • Hide Power Usage Table
  • Devices List
    • Devices Power Control - allow users to restart, shut down and power on the devices on the 'Devices List' in their client area

Email Notifications

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

[edit] 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

[edit] 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.

[edit] 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 the server
    • By clicking on 'Update Order Information' you can also check the synchronization status of a service (works like a synchronization cron)
  • Quickly view the service information including data on the server: model, label, location, rack & position, IP address
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

[edit] 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
Information regarding devices can be found on the 'Devices List,' this includes their name, IP and location.

If the 'Devices Power Control' option is enabled, the users will find remote control buttons next to each device, allowing them to restart, shut down, and power on the device.
If you want to find specific devices, you can use the search bar located above the list, or make use of the sorting function of the list.

EC2 22 1.png

[edit] 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

[edit] 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.

[edit] How To Use Language Overrides

Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.
The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.
Here's how to apply language overrides:
  • Navigate to the ~/langs/ directory located within the following yourWHMCS/modules/servers/moduleName/langs/ path.
  • Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure: 
 ~/langs/overrides/english.php.
  • Open the newly created override file to edit its contents.
  • At the beginning of the file, indicate the used code, for instance, you can use: <?php for PHP code.
  • Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.

For example:

Original yourWHMCS/modules/servers/moduleName/langs/english.php: 

 $_LANG['Search'] = 'Search';

Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php: 

 $_LANG['Search'] = 'Look for';
By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.

Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them.
Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.
Consequently, the override lang file might include only one or just a few lines.

[edit] 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 "EasyDCIMColocationv2".
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.

[edit] 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=66704"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
EasyDCIM Colocation For WHMCS