Provisioning Module Developer Docs - Revision history

Matt: Replaced content with "This page has moved to https://developers.whmcs.com/provisioning-modules/"

2017-01-28T17:55:26Z

Replaced content with "This page has moved to https://developers.whmcs.com/provisioning-modules/"

Show changes

Matt: /* Module Parameters */

2016-10-28T15:29:09Z

‎Module Parameters

John: /* App Store */

2016-03-22T11:15:26Z

‎App Store

Cole: /* Module Parameters */

2015-12-22T16:37:54Z

‎Module Parameters

Cole: /* Supported Functions */

2015-12-22T16:24:03Z

‎Supported Functions

Cole: /* Product Configuration Options */

2015-12-22T16:10:50Z

‎Product Configuration Options

Cole: /* Naming Conventions */

2015-12-22T16:09:46Z

‎Naming Conventions

Cole: /* Product Configuration Options */

2015-12-22T14:30:08Z

‎Product Configuration Options

Andrew: /* Module Parameters */

2015-12-21T14:19:32Z

‎Module Parameters

Andrew: /* Module Parameters */

2015-12-21T14:18:47Z

‎Module Parameters

@@ Line 110: / Line 110: @@
 ==Module Parameters==
-The module parameters are the data/values passed into each function when called. Every module function receives the same parameters. These parameters provide information about the specific product/service the module command runs for. The parameters also contains the settings from the product itself.
+The module parameters are the data/values passed into each function when called. Every provisioning module function receives the same parameters. These parameters provide information about the specific product/service the module command runs for. The parameters also contains the settings from the product itself.
 <table width="100%" cellspacing="1" bgcolor="#cccccc">

@@ Line 508: / Line 508: @@
 *'''$replacevars''' - This accepts an array of strings to replace. So, for example, the module might want to pass the username and password for the API into this function. The function replaces the data with *'s wherever they appear in the request or response strings for extra security.
-==App Store==
+==WHMCS Marketplace==
-WHMCS offers an app store which accepts submission of the completed module. Displayed listed are found under the Addons tab within the administration area and online at http://www.whmcs.com/appstore . This is a great way to make WHMCS users aware of the module.
+WHMCS offers a Marketplace which accepts submission of the completed module. Displayed listed are found under the Addons tab within the administration area and online at http://marketplace.whmcs.com . This is a great way to make WHMCS users aware of the module.
-Submission of a listing requires a login for whmcs.com/members, if you do not have one please [https://www.whmcs.com/members/submitticket.php?step=2&deptid=5 Contact Us]. Once logged in, visit the app store page at the above URL and click the "Submit your Addon" link. We aim to review submissions in 1-2 weeks.
+For help using the Marketplace please refer to https://marketplace.whmcs.com/help . We aim to review submissions in 1-2 weeks.
 {{Developer_Links}}

@@ Line 121: / Line 121: @@
 <tr bgcolor="#ffffff"><td>password</td><td>Password generated for the service. (10 char generated on first creation consisting of letters & numbers, both upper & lowercase).<br />Database Field: tblhosting.password</td></tr>
 <tr bgcolor="#ffffff"><td>producttype</td><td>The product type which can be one of sharedhosting, reselleraccount,
-server or other</td></tr>
+server or other.</td></tr>
 <tr bgcolor="#ffffff"><td>moduletype</td><td>The module name (will match filename of module).</td></tr>
 <tr bgcolor="#ffffff"><td>configoptionX</td><td>with X being from 1 to 24.<br />These fields contain the module settings for the product defined in the ConfigOptions function.</td></tr>
 <tr bgcolor="#ffffff"><td>clientsdetails</td><td>Contains an array of all client details service owner. This contains things like firstname, lastname, email, address1, country, etc…</td></tr>
 <tr bgcolor="#ffffff"><td>customfields</td><td>Contains an array of all custom fields defined on the product.<br />
-The key is the custom field name - $params[‘customfields’][‘Field Name’]</td></tr>
+The key is the custom field name - $params[‘customfields’][‘Field Name’].</td></tr>
 <tr bgcolor="#ffffff"><td>configoptions</td><td>Contains an array of all the configurable options defined on the product.<br />
-Again the key being the option name in this case - $params[‘configoption’][‘Option Name Here’]</td></tr>
+Again the key being the option name in this case - $params[‘configoption’][‘Option Name Here’].</td></tr>
-<tr bgcolor="#ffffff"><td>server</td><td>true/false - Is the product assigned to a server</td></tr>
+<tr bgcolor="#ffffff"><td>server</td><td>true/false - Is the product assigned to a server.</td></tr>
-<tr bgcolor="#ffffff"><td>serverip</td><td>The IP Address of the selected server</td></tr>
+<tr bgcolor="#ffffff"><td>serverip</td><td>The IP Address of the selected server.</td></tr>
-<tr bgcolor="#ffffff"><td>serverhostname</td><td>The Hostname of the selected server</td></tr>
+<tr bgcolor="#ffffff"><td>serverhostname</td><td>The Hostname of the selected server.</td></tr>
-<tr bgcolor="#ffffff"><td>serverusername</td><td>The Username of the selected server</td></tr>
+<tr bgcolor="#ffffff"><td>serverusername</td><td>The Username of the selected server.</td></tr>
-<tr bgcolor="#ffffff"><td>serverpassword</td><td>The Password of the selected server</td></tr>
+<tr bgcolor="#ffffff"><td>serverpassword</td><td>The Password of the selected server.</td></tr>
-<tr bgcolor="#ffffff"><td>serveraccesshash</td><td>The Access Hash of the selected server</td></tr>
+<tr bgcolor="#ffffff"><td>serveraccesshash</td><td>The Access Hash of the selected server.</td></tr>
-<tr bgcolor="#ffffff"><td>serversecure</td><td>true/false - Is an SSL connection enabled in the Server Configuration</td></tr>
+<tr bgcolor="#ffffff"><td>serversecure</td><td>true/false - Is an SSL connection enabled in the Server Configuration.</td></tr>
 </table>
@@ Line 146: / Line 146: @@
 Values from any custom fields & configurable options are passed into modules as parameters. Passed as an array with the key being the name of the field or option.
-For example for a custom field called “Username”, would become $params[‘customfields’][‘Username’]. Likewise, a configurable option named “Disk Space”, would become $params[‘configoptions’][‘Disk Space’]
+For example for a custom field called “Username”, would become $params[‘customfields’][‘Username’]. Likewise, a configurable option named “Disk Space”, would become $params[‘configoptions’][‘Disk Space’].
 ==Core Module Functions==

@@ Line 102: / Line 102: @@
 *'''LoginLink''' - Used to define HTML code to link to the customers account on a server control panel. Displayed on the product management page of the admin area. The return must be HTML output or link (no forms).
 *'''ClientAreaCustomButtonArray''' - Used to define custom functions that your module supports. Customers can invoke and run these from the client area. The functions can perform actions or product page output in the client area. Example usages for this are to provide product management pages, bandwidth reporting pages, etc…
-*'''ClientAreaAllowedFunctions''' - Like the above, used to define custom functions. Customers can invoke, but are not shown as buttons by default. (i.e. custom client area output will invoke them).
+*'''ClientAreaAllowedFunctions''' - Like the above, used to define custom functions. Customers can invoke, but are not shown as buttons by default (i.e. custom client area output will invoke them).
 *'''AdminCustomButtonArray''' - Used to define custom functions in your module for admin users. This can contain more functions than the client area equivalent.
 *'''UsageUpdate''' - Used to perform a daily import of the disk and bandwidth usage from a server. The data imported is then used to display the usage stats both within the client and admin areas of WHMCS. The data is also used in disk and bandwidth overage billing calculations if enabled for a product.

@@ Line 34: / Line 34: @@
 ===Product Configuration Options===
-The required function of all provisioning modules is the ConfigOptions function. This defines the settings that are configurable on a per product basis when a product uses the module. The name of this function must be '''mymodule_ConfigOptions''' matching the name of your module.
+The required function of all provisioning modules is the ConfigOptions function. This defines the settings that are configurable on a per product basis when a product uses the module. The name of this function must be '''mymodule_ConfigOptions''', matching the name of your module.
 There is a limited number of supported field types. These are: '''Text, Password, Yes/No Checkboxes, Dropdown Menus, Radio Buttons & Text Areas'''.

@@ Line 30: / Line 30: @@
 Provisioning Modules are found in the '''/modules/servers/''' directory. The module name chosen must be unique and should be all lowercase. The name must only contain letters & numbers whilst always starting with a letter.
-Inside the module, function naming will follow a certain format. Functions have a prefix of the module filename, underscore, then the function name. For example a module "mymodule" would have the create function "mymodule_CreateAccount".
+Inside the module, function naming will follow a certain format. Functions have a prefix of the module filename, underscore, then the function name. For example, a module "mymodule" would have the create function "mymodule_CreateAccount".
 ===Product Configuration Options===

@@ Line 112: / Line 112: @@
 The module parameters are the data/values passed into each function when called. Every module function receives the same parameters. These parameters provide information about the specific product/service the module command runs for. The parameters also contains the settings from the product itself.
-<table width="100%" cellspacing="4" bgcolor="#cccccc">
+<table width="100%" cellspacing="1" bgcolor="#cccccc">
 <tr bgcolor="#efefef"><td>Var Name</td><td>Description</td></tr>
 <tr bgcolor="#ffffff"><td>serviceid</td><td>The unique ID of the service.<br />Database Field: tblhosting.id</td></tr>