Difference between revisions of "Enkompass"
From WHMCS Documentation
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <div class="docs-alert-danger"> | ||
| + | <span class="title">Discontinued</span><br /> | ||
| + | Effective February 2014, the Enkompass control panel was discontinued by cPanel. As a result this module will no longer be distributed with the WHMCS software. | ||
| + | </div> | ||
| + | |||
Enkompass is cPanel's Windows Web Hosting Control Panel System. | Enkompass is cPanel's Windows Web Hosting Control Panel System. | ||
| − | For more information on Enkompass, | + | For more information on Enkompass, [http://www.cpanel.net/windows/overview.html cPanel's website]. |
==WHMCS Module Features== | ==WHMCS Module Features== | ||
| − | The WHMCS module for Enkompass supports all the usual functionality that you would expect with a web hosting control panel. This includes full automation for both shared & resellers accounts from setup, through to suspension | + | The WHMCS module for Enkompass supports all the usual functionality that you would expect with a web hosting control panel. This includes full automation for both shared & resellers accounts from setup, through to suspension and ultimately termination of cancelled accounts. |
Here's a full list of the supported functions for each product type: | Here's a full list of the supported functions for each product type: | ||
| Line 16: | Line 21: | ||
*Terminate | *Terminate | ||
*Password Changing/Resets | *Password Changing/Resets | ||
| − | |||
*Importing of Disk & Bandwidth Usage Stats (thus allowing for usage/overage based billing) | *Importing of Disk & Bandwidth Usage Stats (thus allowing for usage/overage based billing) | ||
| Line 28: | Line 32: | ||
*Password Changing/Resets | *Password Changing/Resets | ||
*Reseller Package Upgrades/Downgrades (Allows for changing of disk/bandwidth limits, number of accounts limit, and overselling restrictions - ie. changing between reseller packages) | *Reseller Package Upgrades/Downgrades (Allows for changing of disk/bandwidth limits, number of accounts limit, and overselling restrictions - ie. changing between reseller packages) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Setting up an Enkompass Product in WHMCS== | ==Setting up an Enkompass Product in WHMCS== | ||
| Line 44: | Line 40: | ||
#You need to begin by creating a Server for your Enkompass products to be assigned to in WHMCS | #You need to begin by creating a Server for your Enkompass products to be assigned to in WHMCS | ||
| − | #To do this, navigate to '''Setup > Servers''' and then click on '''Add New Server''' | + | #To do this, navigate to '''Setup > [[Servers]]''' and then click on '''Add New Server''' |
| − | # | + | #Configure your server settings. |
| − | |||
| − | |||
[[File:Enkompassremoteaccess.png]] | [[File:Enkompassremoteaccess.png]] | ||
| Line 55: | Line 49: | ||
*Once you have the server created, it's time to create your products | *Once you have the server created, it's time to create your products | ||
*Products are the "packages" you want to offer, that define the features & resources of the hosting account | *Products are the "packages" you want to offer, that define the features & resources of the hosting account | ||
| − | *For Enkompass, these should be setup in the normal way in '''Setup > Products/Services''', with a name, pricing, welcome email, etc... | + | *For Enkompass, these should be setup in the normal way in '''Setup > [[Products and Services|Products/Services]]''', with a name, pricing, welcome email, etc... |
*And then the Enkompass specific related settings are set on the Module Settings tab | *And then the Enkompass specific related settings are set on the Module Settings tab | ||
| Line 64: | Line 58: | ||
#In most cases, you should create a plan inside the Enkompass panel itself (in '''Plans > Manage Plans''') and then just enter a Plan Name into WHMCS (leaving all the other fields blank) | #In most cases, you should create a plan inside the Enkompass panel itself (in '''Plans > Manage Plans''') and then just enter a Plan Name into WHMCS (leaving all the other fields blank) | ||
| − | #But there is also the option to define custom packages - you can do that by | + | #But there is also the option to define custom packages - you can do that by checking the Custom Settings checkbox and just defining the individual limits into the fields the module settings page |
#If you're creating a reseller based product, the last 2 rows contain the settings for those, where you can define how the reseller is limited, and if overselling should be allowed | #If you're creating a reseller based product, the last 2 rows contain the settings for those, where you can define how the reseller is limited, and if overselling should be allowed | ||
#And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders | #And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders | ||
| Line 73: | Line 67: | ||
==Error Messages== | ==Error Messages== | ||
===Object moved=== | ===Object moved=== | ||
| − | This error response is the Enkompass API response for a login failure. So double check the Username and Access Hash settings in Setup > Products/Services | + | This error response is the Enkompass API response for a login failure. So double check the Username and Access Hash settings in '''Setup > [[Products and Services|Products/Services]]''' inside your WHMCS for the server in question match the Remote Access Key inside Enkompass and try generating a new one if necessary. |
Latest revision as of 18:25, 22 April 2022
Discontinued
Effective February 2014, the Enkompass control panel was discontinued by cPanel. As a result this module will no longer be distributed with the WHMCS software.
Enkompass is cPanel's Windows Web Hosting Control Panel System.
For more information on Enkompass, cPanel's website.
Contents
WHMCS Module Features
The WHMCS module for Enkompass supports all the usual functionality that you would expect with a web hosting control panel. This includes full automation for both shared & resellers accounts from setup, through to suspension and ultimately termination of cancelled accounts.
Here's a full list of the supported functions for each product type:
Shared Accounts
- Create
- Suspend
- Unsuspend
- Terminate
- Password Changing/Resets
- Importing of Disk & Bandwidth Usage Stats (thus allowing for usage/overage based billing)
Reseller Accounts
- Create
- Set Limits either by Number of Accounts and/or Disk Space/Bandwidth + Permit Overselling of Disk/Bandwidth
- Suspend
- Unsuspend
- Terminate
- Password Changing/Resets
- Reseller Package Upgrades/Downgrades (Allows for changing of disk/bandwidth limits, number of accounts limit, and overselling restrictions - ie. changing between reseller packages)
Setting up an Enkompass Product in WHMCS
If you're familiar with WHMCS and cPanel, then setting up a product for Enkompass is very similar and so you shouldn't have any problems, but below is a step by step guide for how to do it.
Setting Up The Server
- You need to begin by creating a Server for your Enkompass products to be assigned to in WHMCS
- To do this, navigate to Setup > Servers and then click on Add New Server
- Configure your server settings.
Setting Up A Product
- Once you have the server created, it's time to create your products
- Products are the "packages" you want to offer, that define the features & resources of the hosting account
- For Enkompass, these should be setup in the normal way in Setup > Products/Services, with a name, pricing, welcome email, etc...
- And then the Enkompass specific related settings are set on the Module Settings tab
- You need to begin by selecting the Module Name "Enkompass"
- Once you do that you'll be presented with the fields & options as shown below
- In most cases, you should create a plan inside the Enkompass panel itself (in Plans > Manage Plans) and then just enter a Plan Name into WHMCS (leaving all the other fields blank)
- But there is also the option to define custom packages - you can do that by checking the Custom Settings checkbox and just defining the individual limits into the fields the module settings page
- If you're creating a reseller based product, the last 2 rows contain the settings for those, where you can define how the reseller is limited, and if overselling should be allowed
- And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders
Error Messages
Object moved
This error response is the Enkompass API response for a login failure. So double check the Username and Access Hash settings in Setup > Products/Services inside your WHMCS for the server in question match the Remote Access Key inside Enkompass and try generating a new one if necessary.