EasyDCIM Colocation For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
|
|
| Line 368: |
Line 368: |
| | =Advanced Billing Integration= | | =Advanced Billing Integration= |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|The module supports integration with [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] module. This allows you to billing your customers for total bandwidth, power usage and 95th percentile billing for additional traffic. | + | |style="padding: 10px 0px 20px 15px;"|The module 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. |
| | |} | | |} |
| | {| | | {| |
| Line 374: |
Line 374: |
| | |} | | |} |
| | {| | | {| |
| − | |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 the current usage billing in their client area. | + | |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. |
| | |} | | |} |
| | {| | | {| |
Revision as of 12:11, 28 February 2018
EasyDCIM Colocation For WHMCS will allow you to xxxxxxxxxxxxxxxxxxxxx.
xxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxx.
|
| ✔ Create/Terminate/Suspend/Unsuspend Server
|
| ✔ Boot/Reboot/Shutdown Server
|
| ✔ Change Server SSH Access Details
|
| ✔ View Server Resource Usage Graphs
|
| ✔ Generate Default Configurable Options
|
| ✔ Toggle Automatic Order Acceptance And Server Matching
|
| ✔ Define Required Devices
|
| ✔ Define Required Item Models:
|
| ✔ Define Client Area Features
|
| ✔ Choose OS Templates Available For Rebuilding
|
| ✔ Choose OS Templates Available For Rebuilding
|
| ✔ Control Service Actions And Email Notifications
|
| ✔ Determine Monthly Interval Of Bandwidth Usage
|
| ✔ Define Percentile Billing Of Bandwidth Overage
|
| ✔ One Click Login To EasyDCIM:
|
| ✔ Boot/Reboot/Shutdown Server
|
| ✔ Receive Email Notification On Complete Server Creation
|
| ✔ Change Server SSH Password
|
| ✔ Access KVM Console (Dell And SuperMicro Servers)
|
| ✔ Rebuild Server OS Using OS Templates And Your Own Credentials
|
| ✔ View Server Resource Usage Graphs
|
| ✔ View Traffic Statistics
|
| ✔ One Click Login To User Control Panel
|
| ✔ Additional IP Addresses
|
| ✔ Supports PHP 5.4 Up To PHP 7
|
| ✔ Supports WHMCS Templates Five and Six
|
| ✔ Supports WHMCS V6 and V7
|
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.
|
2. Extract the downloaded file into the main WHMCS directory.
The content of the package should look like this.
|
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.
|
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 'API Key'.
|
| 5. The next step is creating a server group. To do so, click on 'Create Server Group'.
|
| 6. Enter the name, click on your previously created server, press 'Add' and 'Save Changes' afterwards.
|
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'.
|
| 8. Enter the product group name and press 'Save Changes'.
|
9. Once you have a product group, you can assign your product to it.
To create a product, click on 'Create a New Product'.
|
| 10. Next, choose your product group, enter your product name and then press 'Continue'.
|
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'.
|
| 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
|
|
| 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' → '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.
Options Visible In Client Area
- 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.
|
|
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.
|
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
|
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 servers 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).
|
| Below these functions you can also view traffic and power usage statistics and even specify the time intervals.
|
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.
|
Client Area
| In the main view of the client area your customers can check basic details of a colocation server as well as log in to their EasyDCIM control panel with a single click.
|
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.
|
| The same goes for power usage statistics.
|
| Additionally, your clients can see the current state of all power outlets with the possibility to turn them on, off or restart.
|
Advanced Billing Integration
| The module supports integration with the Advanced Billing For WHMCS module. This allows you to charge your customers for total bandwidth, power usage and 95th percentile billing for additional traffic.
|
| Once the relevant options are enabled, your clients will also be able to view billing for the current usage in your client area.
|
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
| Essential guidance through the process of updating the module is offered here.
|
Common Problems
| 1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.
|
