Product Groups - Revision history

SarahK: Redirected page to Products and Services#Product Groups

2022-02-07T20:28:56Z

Redirected page to Products and Services#Product Groups

SarahK: /* Product Group Information */

2021-09-13T17:46:35Z

‎Product Group Information

SarahK: /* Product Group Information */

2020-08-27T17:38:58Z

‎Product Group Information

SarahK at 12:29, 4 August 2020

2020-08-04T12:29:11Z

SarahK at 20:52, 1 June 2020

2020-06-01T20:52:39Z

Matt at 14:18, 5 September 2015

2015-09-05T14:18:48Z

Matt at 11:38, 5 September 2015

2015-09-05T11:38:18Z

Matt: Created page with "Refine admin area product group configuration UI - Improve UI now there are more options - Improve consistency of field formatting (bootstrap) - Provide additional carific..."

2015-09-05T11:38:00Z

Created page with "Refine admin area product group configuration UI - Improve UI now there are more options - Improve consistency of field formatting (bootstrap) - Provide additional carific..."

New page

Refine admin area product group configuration UI

- Improve UI now there are more options
- Improve consistency of field formatting (bootstrap)
- Provide additional carification to "Use Default" order template setting

Admin UI refinement of product group order form template selections to make clearer how they work, and what “Use Default” means.

Create documentation on updates Product Group configuration options

Document the new functionality available to product groups, including the ability to define a headline, tagline, group feature highlights and featured products/bundles.

Also include information on how System Order Template, Product Group Order Template and Session Order Template parameters work together, what takes precedence, and recommended configurtions.

Create documentation for Health & Updates page

To explain the purpose of the Health & Updates page, the various different sections on it, and provide a high level overview of the checks it performs.

Product Groups

Products are organised into groups. Each group can contain an unlimited number of both products and product bundles.

A common use for product groups is grouping similar or related products together. This can allow them to be displayed side by side for comparison depending upon the order form template you select.

For each product group you can define the following:

* '''Name''' - The name displayed for the group to both admin users and customers ''(Required)''
* '''Headline''' - A headline used by newer order form templates ''(Optional)''
* '''Tagline''' - A tagline used by newer order form templates ''(Optional)''
* '''Features''' - A list of features which apply to all products within the product group. Used by some newer order form templates.
* '''Available Payment Gateways''' - Allows you to customise which of your active payment gateways are permitted for use with orders and invoices containing products from this group.
* '''Order Form Template''' - Allows you to define which order form template should be used for the product group and product configuration steps of the order process for products contained within this group.
* '''Hidden''' - Hides the product group from display in the client side Shopping Cart product group list ''(Please Note: can still be accessed directly using the Group ID)''
* '''Direct Cart Link''' - A direct link to the shopping cart that will pre-select the current product group.

==Creating a Product Group==

To create a product group, navigate to '''Setup > Products/Services''' and click on the '''Create a New Group''' button.

Fill out the fields as desired. Once complete, click the '''Save Changes''' button to complete the process.

===Headline/Tagline===

Specifying a headline and/or tagline will be used by newer order form templates.

In older order form templates, the product group name is used for the display title.

===Features===

Adding product group features allows some newer order form templates to display features that relate to all the products within the group.

<div class="docs-alert-info">'''Note:''' When creating a new product group, you must save it for the first time and then edit it again before you can add features</div>

You can add, remove and re-order features.

To add a feature, enter the display text for it and hit enter or click the Add New button.

The feature will be added to the bottom of the list. You can re-order features by clicking and dragging the crosshair icon located to the left of the feature label.

To delete a feature, click the X icon located to the right of the features. To edit a feature, you will need to delete and re-create it.

===Available Payment Gateways===

By default, all active payment gateways are available to all orders and invoices created by WHMCS.

You can however restrict the use of certain gateways on a per product group basis.

Any gateways with a check beside their name will be displayed as possible choices for orders containing products within a given group. To prevent a gateway from being used with products from a product group, uncheck the checkbox next to the name.

<div class="docs-alert-warning">'''Warning:''' If an order or invoice contains multiple products from multiple different product groups, only payment gateways that the two product groups share in common will be displayed. For this reason it is important to avoid creating a situation where product groups do not share at least one payment gateway in common as that would result in no payment gateways being available for payment.</div>

===Order Form Template===

The order form template to be used for the product group product selection page and the product configuration steps of the order process can be customised on a per product group basis.

To do this, simply select the '''"Use Specific Template"''' option in the product group configuration and then a list of available order form templates will be displayed to choose from.

The template you select will be used for displaying of products when the product group is selected from the list of available product categories within the shopping cart, and for the product configuration steps of any products/bundles contained within the group.

<div class="docs-alert-info">Please note however that if the ''?carttpl=xxx'' URL parameter is used to specify an order form template to be used, then that value will take precendence over the product group setting.</div>

← Older revision		Revision as of 20:28, 7 February 2022
Line 1:		Line 1:
−	WHMCS organizes products into groups. Each group can contain an unlimited number of both products and product bundles. Product groups list similar or related products together, allowing them to display side-by-side for comparison in some order form templates.	+	#REDIRECT [[Products_and_Services#Product_Groups]]
−
−	~~==Product Group Information==~~
−
−	<div class="docs-alert-info"><span class="title">Available in</span><br /> We added this in WHMCS 8.0 and added linking to individual [[Products and Services\|product and service pages]] in WHMCS 8.3.</div>
−
−	~~For each product group, you can define the following information:~~
−
−	* '''Product Group Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
−	* '''URL''' — A friendly form of the product group's URL. This value must contain at least one letter. Use this to customize product group links '''(optional)'''.
−	* '''Product Group Headline''' — A headline for newer order form templates '''(optional)'''.
−	* '''Product Group Tagline''' — A tagline for newer order form templates '''(optional)'''.
−	* '''Group Features''' — A list of features that apply to all products within the product group. Some newer order form templates use this.
−	* '''Order Form Template''' — Allows you to define which order form template to use for the product group and product configuration steps of the order process for products within this group.
−	* '''Available Payment Gateways''' — Allows you to customize which active payment gateways you can use with orders and invoices containing products from this group.
−	* '''Hidden''' — Hides the product group from display in the client side '''Shopping Cart''' product group list. Note that this is still accessible using the group ID.
−	* '''Direct Cart Link''' — A direct link to the shopping cart, which will preselect the current product group.
−
−	~~==Creating a Product Group==~~
−
−	To create a product group, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services\|Products/Services]]''' ('''Setup > Products/Services''' prior to WHMCS 8.0) and click '''Create a New Group'''.
−
−	~~Fill out the fields, and then click '''Save Changes''' to complete the process.~~
−
−	~~===Headline/Tagline===~~
−
−	~~New order form templates use specified headlines or taglines.~~
−
−	~~Older order form templates use the product group name as the display title.~~
−
−	~~===Features===~~
−
−	~~Adding product group features allows some newer order form templates to display features that relate to all the products within the group.~~
−
−	~~<div class="docs-alert-warning">~~
−	~~<span class="title">Note</span><br />~~
−	~~When creating a new product group, you must save it for the first time and then edit it again before you can add features.~~
−	~~</div>~~
−
−	~~You can add, remove and reorder features.~~
−
−	~~To add a feature, enter the display text for it and press enter or click '''Add New'''.~~
−
−	~~The system will add the feature to the bottom of the list. You can reorder features by clicking and dragging the crosshair icon to the left of the feature label.~~
−
−	~~To delete a feature, click the X icon to the right of the features. To edit a feature, you will need to delete and recreate it.~~
−
−	~~===Available Payment Gateways===~~
−
−	~~By default, all active payment gateways are available to all orders and invoices that you create within WHMCS.~~
−
−	~~You can, however, restrict the use of certain gateways on a per-product-group basis.~~
−
−	Any gateways with a check beside their name will display as possible choices for orders containing products within a given group. To prevent a gateway's use with products from a product group, uncheck the checkbox next to the name.
−
−	~~<div class="docs-alert-warning">~~
−	~~<span class="title">Warning</span><br />~~
−	If an order or invoice contains multiple products from multiple different product groups, only payment gateways that the two product groups share in common will display. For this reason, it's important that product groups share '''at least''' one payment gateway in common. If a client orders items from two groups that don't have a gateway in common, it would result in no payment gateways being available for payment.
−	~~</div>~~
−
−	~~===Order Form Template===~~
−
−	~~You can customize the order form template for the product group product selection page and the product configuration steps of the order process on a per-product-group basis.~~
−
−	~~To do this, select the '''Use Specific Template''' option in the product group configuration. A list of available order form templates will display.~~
−
−	The system will use the template you select to display products when the product group is selected from the list of available product categories in the shopping cart, and for the product configuration steps of any products or bundles in the group.
−
−	~~<div class="docs-alert-warning">~~
−	~~<span class="title">Note</span><br />~~
−	~~If the <tt>?carttpl=xxx</tt> URL parameter specifies an order form template to use, then that value will take precendence over the product group setting.~~
−	~~</div>~~
−
−	~~===Featured Product===~~
−
−	~~Some newer order forms also support the concept of featured products to promote more prominently than other products within a group.~~
−
−	~~To set a product as the featured item for a group, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings >~~ [[Products_and_Services~~\|Products/Services~~]]~~''' ('''Setup > Products/Services''' prior to WHMCS 8.0). Select the desired product and check '''Featured''' on the '''Details''' tab of the product configuration. Then, click '''Save'''.~~
−
−	~~We recommend selecting only one featured product per group.~~

@@ Line 2: / Line 2: @@
 ==Product Group Information==
 For each product group, you can define the following information:
 * '''Product Group Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
-* '''URL''' — A friendly form of the product group's URL. This value must contain at least one letter. Use this to customize product group links '''(optional)'''. <div class="docs-alert-info"><span class="title">Available in</span><br /> We added this in WHMCS 8.0.</div>
+* '''URL''' — A friendly form of the product group's URL. This value must contain at least one letter. Use this to customize product group links '''(optional)'''.
 * '''Product Group Headline''' — A headline for newer order form templates '''(optional)'''.
 * '''Product Group Tagline''' — A tagline for newer order form templates '''(optional)'''.

@@ Line 2: / Line 2: @@
 ==Product Group Information==
-−
 For each product group, you can define the following information:
-−
 * '''Product Group Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
-* '''URL''' — A friendly form of the product group's URL. Use this to customize product group links '''(optional)'''. <div class="docs-alert-info"><span class="title">Available in</span><br /> We added this in WHMCS 8.0.</div>
+* '''URL''' — A friendly form of the product group's URL. This value must contain at least one letter. Use this to customize product group links '''(optional)'''. <div class="docs-alert-info"><span class="title">Available in</span><br /> We added this in WHMCS 8.0.</div>
 * '''Product Group Headline''' — A headline for newer order form templates '''(optional)'''.
 * '''Product Group Tagline''' — A tagline for newer order form templates '''(optional)'''.

@@ Line 1: / Line 1: @@
-Products are organized into groups.  Each group can contain an unlimited number of both products and product bundles.
+WHMCS organizes products into groups. Each group can contain an unlimited number of both products and product bundles. Product groups list similar or related products together, allowing them to display side-by-side for comparison in some order form templates.
-A common use for product groups is grouping similar or related products together. This can allow them to display side-by-side for comparison, depending on the order form template you select.
+==Product Group Information==
 For each product group, you can define the following information:
-* '''Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
+* '''Product Group Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
-* '''Headline''' — A headline for newer order form templates '''(optional)'''.
+* '''URL''' — A friendly form of the product group's URL. Use this to customize product group links '''(optional)'''. <div class="docs-alert-info"><span class="title">Available in</span><br /> We added this in WHMCS 8.0.</div>
-* '''Tagline''' — A tagline for newer order form templates '''(optional)'''.
+* '''Product Group Headline''' — A headline for newer order form templates '''(optional)'''.
-* '''Features''' — A list of features that apply to all products within the product group. Some newer order form templates use this.
+* '''Product Group Tagline''' — A tagline for newer order form templates '''(optional)'''.
 * '''Available Payment Gateways''' — Allows you to customize which active payment gateways you can use with orders and invoices containing products from this group.
 * '''Hidden''' — Hides the product group from display in the client side '''Shopping Cart''' product group list. Note that this is still accessible using the group ID.
 * '''Direct Cart Link''' — A direct link to the shopping cart, which will preselect the current product group.
@@ Line 16: / Line 17: @@
 ==Creating a Product Group==
-To create a product group, navigate to '''[[Products_and_Services|Setup > Products/Services]]''' and click '''Create a New Group'''.
+To create a product group, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' ('''Setup > Products/Services''' prior to WHMCS 8.0) and click '''Create a New Group'''.
 Fill out the fields, and then click '''Save Changes''' to complete the process.
@@ Line 39: / Line 40: @@
 To add a feature, enter the display text for it and press enter or click '''Add New'''.
-The system will add the feature to the bottom of the list.  You can reorder features by clicking and dragging the crosshair icon to the left of the feature label.
+The system will add the feature to the bottom of the list. You can reorder features by clicking and dragging the crosshair icon to the left of the feature label.
 To delete a feature, click the X icon to the right of the features. To edit a feature, you will need to delete and recreate it.
@@ Line 49: / Line 50: @@
 You can, however, restrict the use of certain gateways on a per-product-group basis.
-Any gateways with a check beside their name will display as possible choices for orders containing products within a given group.  To prevent a gateway's use with products from a product group, uncheck the checkbox next to the name.
+Any gateways with a check beside their name will display as possible choices for orders containing products within a given group. To prevent a gateway's use with products from a product group, uncheck the checkbox next to the name.
 <div class="docs-alert-warning">
@@ Line 73: / Line 74: @@
 Some newer order forms also support the concept of featured products to promote more prominently than other products within a group.
-To set a product as the featured item for a group, navigate to '''[[Products_and_Services|Setup > Products/Services]]''', select the desired product, and check the '''Featured''' checkbox on the '''Details''' tab of the product configuration. Then, click '''Save'''.
+To set a product as the featured item for a group, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' ('''Setup > Products/Services''' prior to WHMCS 8.0). Select the desired product and check '''Featured''' on the '''Details''' tab of the product configuration. Then, click '''Save'''.
 We recommend selecting only one featured product per group.

← Older revision		Revision as of 14:18, 5 September 2015
Line 59:		Line 59:

	<div class="docs-alert-info">Please note however that if the ''?carttpl=xxx'' URL parameter is used to specify an order form template to be used, then that value will take precendence over the product group setting.</div>		<div class="docs-alert-info">Please note however that if the ''?carttpl=xxx'' URL parameter is used to specify an order form template to be used, then that value will take precendence over the product group setting.</div>
		+
		+	===Featured Product===
		+
		+	Some newer order forms also support the concept of featured products which will be promoted more prominently than other products within a group.
		+
		+	To set a product as the featured item for a group, navigate to Setup > Products/Services, select the desired product, and check the '''Featured''' checkbox on the '''Details''' tab of the product configuration and then Save.
		+
		+	We recommend selecting only 1 featured product per group.

@@ Line 1: / Line 1: @@
-Products are organised into groups.  Each group can contain an unlimited number of both products and product bundles.
+Products are organized into groups.  Each group can contain an unlimited number of both products and product bundles.
-A common use for product groups is grouping similar or related products together. This can allow them to be displayed side by side for comparison depending upon the order form template you select.
+A common use for product groups is grouping similar or related products together. This can allow them to display side-by-side for comparison, depending on the order form template you select.
-For each product group you can define the following:
+For each product group, you can define the following information:
-* '''Name''' - The name displayed for the group to both admin users and customers ''(Required)''
+* '''Name''' — The name that the system displays for the group to both admin users and customers '''(required)'''.
-* '''Headline''' - A headline used by newer order form templates ''(Optional)''
+* '''Headline''' — A headline for newer order form templates '''(optional)'''.
-* '''Tagline''' - A tagline used by newer order form templates ''(Optional)''
+* '''Tagline''' — A tagline for newer order form templates '''(optional)'''.
-* '''Features''' - A list of features which apply to all products within the product group. Used by some newer order form templates.
+* '''Features''' — A list of features that apply to all products within the product group. Some newer order form templates use this.
-* '''Available Payment Gateways''' - Allows you to customise which of your active payment gateways are permitted for use with orders and invoices containing products from this group.
+* '''Available Payment Gateways''' — Allows you to customize which active payment gateways you can use with orders and invoices containing products from this group.
-* '''Order Form Template''' - Allows you to define which order form template should be used for the product group and product configuration steps of the order process for products contained within this group.
+* '''Order Form Template''' — Allows you to define which order form template to use for the product group and product configuration steps of the order process for products within this group.
-* '''Hidden''' - Hides the product group from display in the client side Shopping Cart product group list ''(Please Note: can still be accessed directly using the Group ID)''
+* '''Hidden''' — Hides the product group from display in the client side '''Shopping Cart''' product group list. Note that this is still accessible using the group ID.
-* '''Direct Cart Link''' - A direct link to the shopping cart that will pre-select the current product group.
+* '''Direct Cart Link''' — A direct link to the shopping cart, which will preselect the current product group.
 ==Creating a Product Group==
-To create a product group, navigate to '''Setup > Products/Services''' and click on the '''Create a New Group''' button.
+To create a product group, navigate to '''[[Products_and_Services|Setup > Products/Services]]''' and click '''Create a New Group'''.
-Fill out the fields as desired.  Once complete, click the '''Save Changes''' button to complete the process.
+Fill out the fields, and then click '''Save Changes''' to complete the process.
 ===Headline/Tagline===
-Specifying a headline and/or tagline will be used by newer order form templates.
+New order form templates use specified headlines or taglines.
-In older order form templates, the product group name is used for the display title.
+Older order form templates use the product group name as the display title.
 ===Features===
@@ Line 30: / Line 30: @@
 Adding product group features allows some newer order form templates to display features that relate to all the products within the group.
-<div class="docs-alert-info">'''Note:''' When creating a new product group, you must save it for the first time and then edit it again before you can add features</div>
+<div class="docs-alert-warning">
-You can add, remove and re-order features.
+You can add, remove and reorder features.
-To add a feature, enter the display text for it and hit enter or click the Add New button.
+To add a feature, enter the display text for it and press enter or click '''Add New'''.
-The feature will be added to the bottom of the list.  You can re-order features by clicking and dragging the crosshair icon located to the left of the feature label.
+The system will add the feature to the bottom of the list.  You can reorder features by clicking and dragging the crosshair icon to the left of the feature label.
-To delete a feature, click the X icon located to the right of the features. To edit a feature, you will need to delete and re-create it.
+To delete a feature, click the X icon to the right of the features. To edit a feature, you will need to delete and recreate it.
 ===Available Payment Gateways===
-By default, all active payment gateways are available to all orders and invoices created by WHMCS.
+By default, all active payment gateways are available to all orders and invoices that you create within WHMCS.
-You can however restrict the use of certain gateways on a per product group basis.
+You can, however, restrict the use of certain gateways on a per-product-group basis.
-Any gateways with a check beside their name will be displayed as possible choices for orders containing products within a given group.  To prevent a gateway from being used with products from a product group, uncheck the checkbox next to the name.
+Any gateways with a check beside their name will display as possible choices for orders containing products within a given group.  To prevent a gateway's use with products from a product group, uncheck the checkbox next to the name.
-<div class="docs-alert-warning">'''Warning:''' If an order or invoice contains multiple products from multiple different product groups, only payment gateways that the two product groups share in common will be displayed. For this reason it is important to avoid creating a situation where product groups do not share at least one payment gateway in common as that would result in no payment gateways being available for payment.</div>
+<div class="docs-alert-warning">
 ===Order Form Template===
-The order form template to be used for the product group product selection page and the product configuration steps of the order process can be customised on a per product group basis.
+You can customize the order form template for the product group product selection page and the product configuration steps of the order process on a per-product-group basis.
-To do this, simply select the '''"Use Specific Template"''' option in the product group configuration and then a list of available order form templates will be displayed to choose from.
+To do this, select the '''Use Specific Template''' option in the product group configuration. A list of available order form templates will display.
-The template you select will be used for displaying of products when the product group is selected from the list of available product categories within the shopping cart, and for the product configuration steps of any products/bundles contained within the group.
+The system will use the template you select to display products when the product group is selected from the list of available product categories in the shopping cart, and for the product configuration steps of any products or bundles in the group.
-<div class="docs-alert-info">Please note however that if the ''?carttpl=xxx'' URL parameter is used to specify an order form template to be used, then that value will take precendence over the product group setting.</div>
+<div class="docs-alert-warning">
 ===Featured Product===
-Some newer order forms also support the concept of featured products which will be promoted more prominently than other products within a group.
+Some newer order forms also support the concept of featured products to promote more prominently than other products within a group.
-To set a product as the featured item for a group, navigate to Setup > Products/Services, select the desired product, and check the '''Featured''' checkbox on the '''Details''' tab of the product configuration and then Save.
+To set a product as the featured item for a group, navigate to '''[[Products_and_Services|Setup > Products/Services]]''', select the desired product, and check the '''Featured''' checkbox on the '''Details''' tab of the product configuration. Then, click '''Save'''.
-We recommend selecting only 1 featured product per group.
+We recommend selecting only one featured product per group.

← Older revision		Revision as of 11:38, 5 September 2015
Line 1:		Line 1:
−	~~Refine admin area product group configuration UI~~
−
−	~~- Improve UI now there are more options~~
−	~~- Improve consistency of field formatting (bootstrap)~~
−	~~- Provide additional carification to "Use Default" order template setting~~
−
−	~~Admin UI refinement of product group order form template selections to make clearer how they work, and what “Use Default” means.~~
−
−
−
−
−	~~Create documentation on updates Product Group configuration options~~
−
−	~~Document the new functionality available to product groups, including the ability to define a headline, tagline, group feature highlights and featured products/bundles.~~
−
−	~~Also include information on how System Order Template, Product Group Order Template and Session Order Template parameters work together, what takes precedence, and recommended configurtions.~~
−
−
−
−	~~Create documentation for Health & Updates page~~
−
−	~~To explain the purpose of the Health & Updates page, the various different sections on it, and provide a high level overview of the checks it performs.~~
−
−
−
−
−
−
−
−
−	~~Product Groups~~
−
	Products are organised into groups. Each group can contain an unlimited number of both products and product bundles.		Products are organised into groups. Each group can contain an unlimited number of both products and product bundles.