Joanna: /* About EasyDCIM Colocation For WHMCS */

2023-09-19T14:12:48Z

‎About EasyDCIM Colocation For WHMCS

Karolina: Created page with "
2023-02-07T10:53:39Z

Created page with "<meta name="keywords" content="easydcim colocation for whmcs, easydcim colocation configuration, whmcs easydcim colocation management, whmcs easydcim colocation installation, ..."

New page
<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>

=About [https://www.modulesgarden.com/products/whmcs/easydcim-colocation EasyDCIM Colocation For WHMCS]=
{|
|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. 
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.
|}


'''Admin Area Features:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Create/Terminate/Suspend/Unsuspend Colocation
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Update Order Information
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Colocation Resource Usage:
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Statistics
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Traffic Statistics Graph
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Power Usage Graph
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Generate Default Configurable Options
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Colocation:
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Model
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Location
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Automatic Order Acceptance And Colocation Matching
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Access Level
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Control Service Actions And Email Notifications
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Client Area Features:
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Display Base Features:
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Label
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Model
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Location
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ IP Address
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Allow Colocation Actions:
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Auto Login Link
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Traffic Statistics
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Display Other Features:
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Traffic Statistics
|}
{|
|style="padding: 0px 0px 0px 60px;"|✔ Power Usage Statistics
|}
{|
|style="padding: 0px 0px 10px 60px;"|✔ Power Outlets
|}

'''Client Area Features:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ View Colocation Model/Location/Label
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Traffic Statistics Graph
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Power Usage Graphs
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable/Restart Power Outlets
|}

'''Configurable Options:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Colocation Model
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Colocation Location
|}
'''Advanced Billing Integration:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Bill For Current Power Usage
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Bill For Current Bandwidth Usage
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of Bandwidth Overages
|}

'''Supported PDU Manufacturers:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ APC
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ CyberPower
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Enlogic
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Raritan
|}

'''General Info:'''
{|
|style="padding: 10px 0px 0px 30px;"| ✔ Integrated With Advanced Billing For WHMCS v3.2.2 And Later - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing#features (read more)]
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.4.3 and Later
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.1 Up To PHP 7.4
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V7.9 And Later
|}

'''Exclusive Promo Code From ModulesGarden:'''
{|
|style="padding: 10px 0px 30px 30px;"|✔ '''Save 20%''' For '''3 Months''' On The EasyDCIM Control Panel With Coupon: '''WHMCS20%_ED'''
|}

=Installation and Configuration=
{|
|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.]''' 
We will guide you step by step through the whole installation and configuration process.
|}
==Installation==
{|
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the downloaded file into the main WHMCS directory.''' 
The content of the package should look like this.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC2.png]]
|}

==Configuration of Server==
{|
|style="padding: 10px 0px 15px 15px;"|'''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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC3.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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 server and press '' 'Save Changes'.'' 
'' '''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:EC4.png]]
|}
{|
|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:EC5.png]]
|}
{|
|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 30px 25px;"|[[File:EC6.png]]
|}

==Configuration of Product==
{|
|style="padding: 10px 0px 15px 15px;"|'''7. In order to create and configure a product, go to '' 'Setup' → 'Products/Services' → 'Products/Services'.''''' 
Click on '' 'Create a New Group'.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC8.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''8. Enter the product group name and press '' 'Save Changes'.'''''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC9.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''9. Once you have a product group, you can assign your product to it.''' 
To create a product, click on '' 'Create a New Product'.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC10.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:EC11.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''12. Now, go to the '' 'Module Settings' '' section, choose both '' 'EasyDCIM Colocation' '' and your previously created server group from dropdown menus. 
Do not forget to click '' 'Save Changes'.'''''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC12.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''11. Before configuring the product, set up the EasyDCIM Colocation cron job.
After order placement the client's services are usually not activated immediately in EasyDCIM (it depends on your EasyDCIM configuration). 
In such situations the synchronization cron is used to assign a matching colocation as soon as the service is available. 
We suggest to run cron every 5 minutes.
php -q yourWHMCS/modules/servers/EasyDCIMColocation/cron/Cron.php
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC13.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''12. 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' '' → '' '[[Media:ED_Easy_1.png|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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC14.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. 
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.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC15.png]]
|}

==Custom Fields==
{|
|style="padding: 10px 0px 15px 15px;"|'''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
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC7.png]]
|}

=Management=
{|
|style="padding: 10px 0px 30px 15px;"|'''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==
{|
|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. 
'' The 'Log In To Panel' '' button allows you to immediately log in to your client's EasyDCIM control panel.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC16.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|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).
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC17.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Below these functions you can also view traffic and power usage statistics and even specify the time intervals.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC18.png]]
|}
{|
|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. 
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.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC25.png]]
|}

==Client Area==
{|
|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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC19.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|They can also view graph with traffic statistics and even define time intervals. 
'' '''Note:''' Available graphs and time intervals depend on the product registration date.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC20.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|The same goes for power usage statistics.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC21.png]]
|}
{|
|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.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC22.png]]
|}

=Advanced Billing Integration=
{|
|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. This allows you to charge your customers for total bandwidth, power usage and 95th percentile 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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:EC23.png]]
|}

{|
|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 20px 25px;"|[[File:EC24.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|The summary details will be displayed in a similar form also in the product view in admin area.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:EC26.png]]
|}

=Tips=
{|
|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. 
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 [http://www.docs.easydcim.com/provisioning/flow EasyDCIM documentation page].
|}

=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]'''.
|}

=Common Problems=
{|
|style="padding: 10px 0px 30px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
|}

@@ Line 164: / Line 164: @@
 *'''Exclusive Promo Code From ModulesGarden:'''
 {|
-|style="padding: 10px 0px 30px 30px;"|✔ '''Save 20%''' For '''3 Months''' On The EasyDCIM Control Panel With Coupon: '''WHMCS20%_ED'''
+|style="padding: 10px 0px 30px 30px;"|✔ '''Save 25%''' For '''3 Months''' On The EasyDCIM Control Panel With Coupon: '''WHMCS25%_ED'''
 |}

EasyDCIM Colocation V1.X For WHMCS - Revision history

Joanna: /* About EasyDCIM Colocation For WHMCS */