Difference between revisions of "Glossary"

From WHMCS Documentation

m (Typo fix)
m (→‎Glossary of Terms)
Line 1: Line 1:
 
==Glossary of Terms==
 
==Glossary of Terms==
−
This section will attempt to clarify what is meant by terms used in WHMCS and the documentation.<br />
+
This section will attempt to clarify the terms in WHMCS and the documentation.<br />
  
 
===3D Secure===
 
===3D Secure===
−
3D Secure is an extra step in the payment process, known to consumers as Verified by Visa of Mastercard Securecode, whereby they are directed to their bank to enter a password to verify the payment. If a payment gateway does not support this option, clients will never be prompted to provide their 3D Secure password.
+
 
 +
3D Secure is an extra step in the payment process, which consumers know as Verified by Visa of Mastercard Securecode. This directs consumers to their bank to enter a password to verify the payment. If a payment gateway does not support this option, the system will never prompt clients to provide their 3D Secure password.
  
 
===Array===
 
===Array===
 +
 
An array is a special variable which can hold many values under a single name, and you can access the values by referring to an index number.
 
An array is a special variable which can hold many values under a single name, and you can access the values by referring to an index number.
  
 
===API===
 
===API===
−
An acronym of Application Programming Interface, specifies how two pieces of software communicate. For example WHMCS uses the eNom API to community domain registration requests to eNom. The WHMCS software has its own API that in turn allows other pieces of software to perform actions in WHMCS remotely.
+
 
 +
An acronym of Application Programming Interface. This specifies how two pieces of software communicate. For example, WHMCS uses the eNom API to communicate domain registration requests to eNom. The WHMCS software has its own API that, in turn, allows other pieces of software to perform actions in WHMCS remotely.
  
 
===Boolean===
 
===Boolean===
 +
 
A Boolean data type is a data type with only two possible values: true or false.
 
A Boolean data type is a data type with only two possible values: true or false.
  
 
===Billing Cycle===
 
===Billing Cycle===
−
The frequency with which a service will generate invoices, such as monthly, semi-annually and annually.
+
 
 +
The frequency with which a service will generate invoices (for example, monthly, semi-annually and annually).
  
 
===Bug===
 
===Bug===
 +
 
See [[#Defect]]
 
See [[#Defect]]
  
 
===Change Package===
 
===Change Package===
−
The module change package function is the process by which WHMCS sends the signal to the server/service telling it to change the client's package (ie. upgrade or downgrade). If the configurable package addon is in use for the product, this option can also be used to change the client's individual quotas in the configurable options.
+
 
 +
The module change package function is the process by which WHMCS sends the signal to the server or service to change the client's package (upgrade or downgrade). If the configurable package addon is in use for the product, this option can also change the client's individual quotas in the configurable options.
  
 
===Client Area Link===
 
===Client Area Link===
−
This module feature will display a link on the product details page in the WHMCS client area which clients can click to login to the server control panel.
+
 
 +
This module feature will display a link on the product details page in the WHMCS client area that clients can click to log in to the server control panel.
  
 
===Configurable Option===
 
===Configurable Option===
−
Allows for the customisation of products within set parameters. Typically used to allow clients to choose certain aspects of their hosting product (disk space, bandwidth). Always takes the same billing cycle as the service.
+
 
 +
Allows for the customisation of products within set parameters. Typically, you use this to allow clients to choose certain aspects of their hosting product (for example, disk space or bandwidth). This always takes the same billing cycle as the service.
  
 
===Create===
 
===Create===
−
The module creation function is the process by which WHMCS sends the signal to the server/service telling it to create the necessary account. The credentials entered under the client's Products/Services tab are often passed to the server/service within the command, at a minimum typically the username, password and domain.
+
 
 +
The module creation function is the process by which WHMCS sends the signal to the server or service to create the necessary account. The credentials under the client's Products/Services tab are often passed to the server or service within the command. Typically, this is at least the username, password and domain.
  
 
===Cron===
 
===Cron===
−
A cron is a time-based job scheduler in Unix-Based systems. WHMCS makes use of this system to trigger a number of the automated tasks, including invoice generation, overdue reminders, suspension, termination, ticket escalation rules and more.
 
  
−
Cron may also be used to refer to the specific script which should be triggered by the server's cron scheduler this is located at /crons/cron.php
+
A cron is a time-based job scheduler in Unix-Based systems. WHMCS makes use of this system to trigger a number of the automated tasks, including invoice generation, overdue reminders, suspension, termination, and ticket escalation rules.
 +
 
 +
You can also use cron jobs to refer to the specific script that the server's cron scheduler triggers. This is in the <tt>/crons/cron.php</tt> file.
  
 
===Daily Tasks===
 
===Daily Tasks===
−
Daily Tasks are specific actions which WHMCS performs only once per day. For example sending overdue reminder emails are considered a daily task because they are sent once per day, but escalation rules are run many times per day, so are not.
+
 
 +
Daily Tasks are specific actions that WHMCS performs only once per day.  
 +
 
 +
For example, you may consider sending overdue reminder emails to be a daily task because you send them once per day. However, escalation rules run many times per day, and so are not daily tasks.
  
 
===Decimal===
 
===Decimal===
−
A number with decimal amounts. Mostly with two decimal places, but in some situations can have more. xx.xx
+
 
 +
A number with decimal amounts. For example, <tt>xx.xx</tt>. Usually, this includes two decimal places, but they can also have more.
  
 
===Defect===
 
===Defect===
−
A defect in the WHMCS software occurs when the actual behaviour of a specific part or function operates otherwise in accordance with the intended design. This is distinct from the desired design of an end user. The decision as to what constitutes intended design and a defect lies with WHMCS personnel.
 
  
−
Reproducible defect reports in the stock software are welcomed at https://bugs.whmcs.com<br/>
+
A defect in the WHMCS software occurs when the actual behaviour of a specific part or function operates differently from the intended design. This is distinct from the desired design of an end user. The decision as to what constitutes intended design and a defect lies with WHMCS personnel.
−
Proposals for changes to the intended design can be submitted for consideration at https://requests.whmcs.com
+
 
 +
Reproducible defect reports in the stock software are welcome at https://bugs.whmcs.com<br/>
 +
You can submit proposals for changes to the intended design for consideration at https://requests.whmcs.com
  
 
===Email===
 
===Email===
−
An email address formatted with an @ symbol
+
 
 +
An email address, which includes an <tt>@</tt> symbol.
  
 
===First Payment Amount===
 
===First Payment Amount===
−
When Next Due Date = Registration Date, this value will be the amount the client is initially invoiced for their service. It is the sum of the product Setup Fee + Price + configurable options.
+
 
 +
When the Next Due Date is the Registration Date, this is the initial amount that the client will receive an invoice for. It is the sum of the product setup fee, price, and configurable options.
  
 
===Integer===
 
===Integer===
−
An integer is a number that is written without a fractional component. For example, 21, 4, and −2048 are integers; 9.75, 5½, and √2 are not integers. The set of integers consists of the natural numbers (1, 2, 3, ...), zero (0) and the opposites of the natural numbers (−1, −2, −3, ..., that are negative).
+
 
 +
An integer is a number that doesn't include a fractional component. For example, 21, 4, and −2048 are integers; 9.75, 5½, and √2 are not integers. The set of integers consists of positive whole numbers (1, 2, 3), zero (0), and the opposites of the positive whole numbers (−1, −2, −3).
  
 
===Json===
 
===Json===
−
Json is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs. It is used primarily to transmit data between a server and web application, as an alternative to XML.
+
 
 +
JSON is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs. It primarily transmits data between a server and web application, as an alternative to XML.
  
 
===Menu Items===
 
===Menu Items===
 +
 
[http://{{SERVERNAME}}/classes/classes/WHMCS.View.Menu.Item.html Menu Item Class]
 
[http://{{SERVERNAME}}/classes/classes/WHMCS.View.Menu.Item.html Menu Item Class]
  
 
Menu item objects are the core building block to all programmable client area menus in WHMCS. They power dynamic navigation bars, sidebars, the client area home page's panels, and other UI elements. Individual menu items contain all of the components necessary to render it on a page including display labels, links, icons, and certain HTML elements.
 
Menu item objects are the core building block to all programmable client area menus in WHMCS. They power dynamic navigation bars, sidebars, the client area home page's panels, and other UI elements. Individual menu items contain all of the components necessary to render it on a page including display labels, links, icons, and certain HTML elements.
  
−
Menu items are arranged in a tree structure. A menu item can have many child items and one parent item. The only item with no parent is the root menu item at the top of the tree. The root menu item has access to every child item in the menu tree.
+
Menu items exist in a tree structure. A menu item can have many child items and one parent item. The only item with no parent is the root menu item at the top of the tree. The root menu item has access to every child item in the menu tree.
  
 
===Module===
 
===Module===
−
A file which contains the code that communicates between WHMCS and provider's API. For example the cPanel module contains the code to communicate with the cPanel API. The eNom module contains the code to communicate with the eNom API and so on. Comes in three types; provisioning, registrar and gateway.
+
 
 +
A file that contains the code that communicates between WHMCS and a provider's API. For example, the cPanel module contains the code to communicate with the cPanel & WHM APIs, and the eNom module contains the code to communicate with the eNom API. There are three types of module: provisioning, registrar and gateway.
  
 
===Next Due Date===
 
===Next Due Date===
−
The date at which the client's next renewal payment is due. Invoices are typically generated several days in advance based upon your Automation Settings. It will automatically increment forward one billing cycle when a renewal invoice is paid.
+
 
 +
The date at which the client's next renewal payment is due. The system typically generates invoices several days in advance, according to your Automation Settings. It will automatically increment forward one billing cycle when a customer pays a renewal invoice.
  
 
===Product===
 
===Product===
−
An item that can be purchased by a client via the order form. Usually with a fixed price although they can be customised via configurable options and product addons. These are configured in the administration area under Setup > Products/Services > Products/Services.
+
 
 +
An item that a client can purchase via the order form. Usually, products have a fixed price, although you can customize them via configurable options and product addons. Configure these in the administration area under Setup > Products/Services > Products/Services.
  
 
===Product Addon===
 
===Product Addon===
−
Can be added on to a product to increase the price. Usually one-time or recurring items that you may wish to upsell to clients such as a software licence. They should be considered on/off options and can have a separate billing cycle as the service.
+
 
 +
Additions  to a product that increase the price. Usually, these are one-time or recurring items that you want to upsell to clients, such as a software licence. Treat these as on-or-off options. They can have a separate billing cycle from the service.
  
 
===Recurring Amount===
 
===Recurring Amount===
−
Provided Next Due Date =/= Registration Date, this value will be the amount the client is invoiced for the next renewal of their service. It is the sum of the product Price + configurable options.
+
 
 +
When the provided Next Due Date is not the Registration Date, this value will be the amount of the client's invoice for the next renewal of their service. It is the sum of the product price and configurable options.
  
 
===Sandbox===
 
===Sandbox===
−
The 'Sandbox' is a development system that enables you to test your checkout for functionality without being 'live' so any transactions you use to test it are not 'real'. When you are happy that everything is working properly just deselect that option.  
+
 
 +
The 'Sandbox' is a development system that enables you to test your checkout for functionality without being 'live', so any transactions you use to test it are not 'real'. When you are happy that everything is working properly, deselect the option.  
  
 
===Standard Hook===
 
===Standard Hook===
−
A standard hook is determined within WHMCS to be a hook that runs when a specific action occurs.
+
 
−
A return may be accepted, see the [https://developers.whmcs.com/hooks/ hook page] for more information, but no validation occurs on the hook return.
+
In WHMCS, a standard hook is a hook that runs when a specific action occurs. The system can accept a return, but no validation occurs for the hook return. For more information, see our [https://developers.whmcs.com/hooks/ hook page].
  
 
===Service===
 
===Service===
−
When a client orders a Product, that particular instance is referred to as a Service. The Service record can be accessed from the client's Products/Services tab and can be customised form the default price, billing cycle, addons can be added and configurable options can be changed.
+
 
 +
When a client orders a product, that particular instance of the product is a Service. You can access the Service record from the client's Products/Services tab. You can customize the default price and billing cycle, add addons, and change configurable options.
  
 
===String===
 
===String===
−
A string is generally understood as a data type and is often implemented as an array of bytes (or words) that stores a sequence of elements, typically characters, using some character encoding. A string may also denote more general arrays or other sequence (or list) data types and structures.
+
 
 +
A data type that developers often implement as an array of bytes (or words) that store a sequence of elements, typically characters, using some character encoding. A string may also denote more general arrays or other sequence (or list) data types and structures.
  
 
===Suspend===
 
===Suspend===
−
The module suspension function is the process by which WHMCS sends the signal to the server/service telling it to suspend the account on the server. Typically the client files and setting will be retained but access to their account on the server is blocked.
+
 
 +
The module suspension function is the process by which WHMCS sends the signal to the server or service to suspend the account on the server. Typically, the system retains the client files and settings but blocks access to their account.
  
 
===Telephone===
 
===Telephone===
 +
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
−
We regular expression match/validate a single digit, a space, a dot, a dash or a pair of brackets.  Instead of making sure the whole string matches a string of correct characters, we replace all correct characters with empty strings, and whatever is left behind is assumed to be wrong and will fail validation.
+
We regular expression match or validate a single digit, a space, a dot, a dash or a pair of brackets.  Instead of making sure the whole string matches a string of correct characters, we replace all correct characters with empty strings, and whatever is left behind is assumed to be wrong and will fail validation.
 
</div>
 
</div>
 +
 
A standard phone number, in local format, without any country code.
 
A standard phone number, in local format, without any country code.
 +
 
====International Telephone====
 
====International Telephone====
−
An automatically formatted number using the client country to add the country code. In the format +CC.xxxxxxxxx
+
 
 +
An automatically-formatted number, using the client country to add the country code. This uses the format <tt>+CC.xxxxxxxxx</tt>.
  
 
===Terminate===
 
===Terminate===
−
The module termination function is the process by which WHMCS sends the signal to the server/service telling it to delete the account from the server. The record of the account will remain within WHMCS.
+
 
 +
The module termination function is the process by which WHMCS sends the signal to the server or service to delete the account from the server. The record of the account will remain within WHMCS.
  
 
===Unsuspend===
 
===Unsuspend===
−
The module unsuspension function is the process by which WHMCS sends the signal to the server/service telling it to reverse the suspension process and re-activate a previous suspended account on the server.
+
 
 +
The module unsuspension function is the process by which WHMCS sends the signal to the server or service telling it to reverse the suspension process and reactivate a previous suspended account on the server.
  
 
===Usage Updates===
 
===Usage Updates===
−
If enabled in [[Automation_Settings#Update_Usage_Statistics|Automation Settings]] this module feature enabled WHMCS to obtain the disk space and bandwidth usage for individual accounts. This is displayed in the client and admin areas and can be used on conjunction with [[Disk_Space_and_Bandwidth_Overage_Billing|overage billing]].
+
 
 +
If you enable it in [[Automation_Settings#Update_Usage_Statistics|Automation Settings]], this module feature allows WHMCS to obtain the disk space and bandwidth usage for individual accounts. This is visible in the client and admin areas, and you can use it with [[Disk_Space_and_Bandwidth_Overage_Billing|overage billing]].
  
 
===Validation Hook===
 
===Validation Hook===
−
A hook that runs to perform a validation check on the data being entered. The return from this hook can stop the saving of data from occurring. See the [https://developers.whmcs.com/hooks/ hook page] for more information.
+
 
 +
A hook that runs to perform a validation check on entered data. The return from this hook can stop data from saving. For more information, see our [https://developers.whmcs.com/hooks/ hook page].

Revision as of 20:48, 28 April 2020

Glossary of Terms

This section will attempt to clarify the terms in WHMCS and the documentation.

3D Secure

3D Secure is an extra step in the payment process, which consumers know as Verified by Visa of Mastercard Securecode. This directs consumers to their bank to enter a password to verify the payment. If a payment gateway does not support this option, the system will never prompt clients to provide their 3D Secure password.

Array

An array is a special variable which can hold many values under a single name, and you can access the values by referring to an index number.

API

An acronym of Application Programming Interface. This specifies how two pieces of software communicate. For example, WHMCS uses the eNom API to communicate domain registration requests to eNom. The WHMCS software has its own API that, in turn, allows other pieces of software to perform actions in WHMCS remotely.

Boolean

A Boolean data type is a data type with only two possible values: true or false.

Billing Cycle

The frequency with which a service will generate invoices (for example, monthly, semi-annually and annually).

Bug

See #Defect

Change Package

The module change package function is the process by which WHMCS sends the signal to the server or service to change the client's package (upgrade or downgrade). If the configurable package addon is in use for the product, this option can also change the client's individual quotas in the configurable options.

Client Area Link

This module feature will display a link on the product details page in the WHMCS client area that clients can click to log in to the server control panel.

Configurable Option

Allows for the customisation of products within set parameters. Typically, you use this to allow clients to choose certain aspects of their hosting product (for example, disk space or bandwidth). This always takes the same billing cycle as the service.

Create

The module creation function is the process by which WHMCS sends the signal to the server or service to create the necessary account. The credentials under the client's Products/Services tab are often passed to the server or service within the command. Typically, this is at least the username, password and domain.

Cron

A cron is a time-based job scheduler in Unix-Based systems. WHMCS makes use of this system to trigger a number of the automated tasks, including invoice generation, overdue reminders, suspension, termination, and ticket escalation rules.

You can also use cron jobs to refer to the specific script that the server's cron scheduler triggers. This is in the /crons/cron.php file.

Daily Tasks

Daily Tasks are specific actions that WHMCS performs only once per day.

For example, you may consider sending overdue reminder emails to be a daily task because you send them once per day. However, escalation rules run many times per day, and so are not daily tasks.

Decimal

A number with decimal amounts. For example, xx.xx. Usually, this includes two decimal places, but they can also have more.

Defect

A defect in the WHMCS software occurs when the actual behaviour of a specific part or function operates differently from the intended design. This is distinct from the desired design of an end user. The decision as to what constitutes intended design and a defect lies with WHMCS personnel.

Reproducible defect reports in the stock software are welcome at https://bugs.whmcs.com
You can submit proposals for changes to the intended design for consideration at https://requests.whmcs.com

Email

An email address, which includes an @ symbol.

First Payment Amount

When the Next Due Date is the Registration Date, this is the initial amount that the client will receive an invoice for. It is the sum of the product setup fee, price, and configurable options.

Integer

An integer is a number that doesn't include a fractional component. For example, 21, 4, and −2048 are integers; 9.75, 5½, and √2 are not integers. The set of integers consists of positive whole numbers (1, 2, 3), zero (0), and the opposites of the positive whole numbers (−1, −2, −3).

Json

JSON is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs. It primarily transmits data between a server and web application, as an alternative to XML.

Menu Items

Menu Item Class

Menu item objects are the core building block to all programmable client area menus in WHMCS. They power dynamic navigation bars, sidebars, the client area home page's panels, and other UI elements. Individual menu items contain all of the components necessary to render it on a page including display labels, links, icons, and certain HTML elements.

Menu items exist in a tree structure. A menu item can have many child items and one parent item. The only item with no parent is the root menu item at the top of the tree. The root menu item has access to every child item in the menu tree.

Module

A file that contains the code that communicates between WHMCS and a provider's API. For example, the cPanel module contains the code to communicate with the cPanel & WHM APIs, and the eNom module contains the code to communicate with the eNom API. There are three types of module: provisioning, registrar and gateway.

Next Due Date

The date at which the client's next renewal payment is due. The system typically generates invoices several days in advance, according to your Automation Settings. It will automatically increment forward one billing cycle when a customer pays a renewal invoice.

Product

An item that a client can purchase via the order form. Usually, products have a fixed price, although you can customize them via configurable options and product addons. Configure these in the administration area under Setup > Products/Services > Products/Services.

Product Addon

Additions to a product that increase the price. Usually, these are one-time or recurring items that you want to upsell to clients, such as a software licence. Treat these as on-or-off options. They can have a separate billing cycle from the service.

Recurring Amount

When the provided Next Due Date is not the Registration Date, this value will be the amount of the client's invoice for the next renewal of their service. It is the sum of the product price and configurable options.

Sandbox

The 'Sandbox' is a development system that enables you to test your checkout for functionality without being 'live', so any transactions you use to test it are not 'real'. When you are happy that everything is working properly, deselect the option.

Standard Hook

In WHMCS, a standard hook is a hook that runs when a specific action occurs. The system can accept a return, but no validation occurs for the hook return. For more information, see our hook page.

Service

When a client orders a product, that particular instance of the product is a Service. You can access the Service record from the client's Products/Services tab. You can customize the default price and billing cycle, add addons, and change configurable options.

String

A data type that developers often implement as an array of bytes (or words) that store a sequence of elements, typically characters, using some character encoding. A string may also denote more general arrays or other sequence (or list) data types and structures.

Suspend

The module suspension function is the process by which WHMCS sends the signal to the server or service to suspend the account on the server. Typically, the system retains the client files and settings but blocks access to their account.

Telephone

We regular expression match or validate a single digit, a space, a dot, a dash or a pair of brackets. Instead of making sure the whole string matches a string of correct characters, we replace all correct characters with empty strings, and whatever is left behind is assumed to be wrong and will fail validation.

A standard phone number, in local format, without any country code.

International Telephone

An automatically-formatted number, using the client country to add the country code. This uses the format +CC.xxxxxxxxx.

Terminate

The module termination function is the process by which WHMCS sends the signal to the server or service to delete the account from the server. The record of the account will remain within WHMCS.

Unsuspend

The module unsuspension function is the process by which WHMCS sends the signal to the server or service telling it to reverse the suspension process and reactivate a previous suspended account on the server.

Usage Updates

If you enable it in Automation Settings, this module feature allows WHMCS to obtain the disk space and bandwidth usage for individual accounts. This is visible in the client and admin areas, and you can use it with overage billing.

Validation Hook

A hook that runs to perform a validation check on entered data. The return from this hook can stop data from saving. For more information, see our hook page.

Retrieved from "http://3.17.75.209/index.php?title=Glossary&oldid=28324"