You are here

README.txt in Commerce License 8.2

Same filename and directory in other branches
  1. 7 README.txt
INTRODUCTION
------------

The Commerce License allows the creation of products that sell access to some
aspect of the site. This could be a role, publication of a node, and so on.

This access is controlled by a License entity, which is created for the user
when the product is purchased.

The nature of what a License entity grants is handled by License type plugins.
Each License entity will have one License type plugin associated with it.

A product variation that sells a License will have a configured License type
plugin field value. This acts as template to create the License when a user
purchases that product variation.


REQUIREMENTS
------------

This module requires the following modules:

 * Commerce (https://drupal.org/project/commerce)
 * Recurring Period (https://drupal.org/project/recurring_period)
 * Advanced Queue (https://drupal.org/project/advancedqueue)

This module also integrates with Commerce Recurring
(https://drupal.org/project/commerce_recurring) to provide licenses that
automatically renew with a subscription.

The following patches are required:

 * https://www.drupal.org/project/drupal/issues/2911473#comment-12676912
  Selected yet disabled individual options from checkboxes element don't persist
  through save.

The following patches are recommended:

 * https://www.drupal.org/project/commerce/issues/2930979: Don't show the
  'added to your cart' message if the item quantity is unchanged.

INSTALLATION
------------

Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules for
further information.

CONFIGURATION
-------------

To create products that grant licenses that expire:

1 Configure or create a checkout flow which does not allow anonymous checkout.
2 Configure or create an Order Type to use the checkout flow.
3 Configure or create an Order Item Type to use the Order Type, and work with
  Licenses.
4 Configure or create a Product Variation Type to use the Order Item Type, and
  provide Licenses.
5 Configure or create a Product Type that uses the Product Variation Type.
6 Create one or more products that provide licenses. In the product variation,
  configure:
  - The license type
  - The expiration.

To create products that grant licenses that renew with a subscription:

1 Configure or create a checkout flow which does not allow anonymous checkout.
2 Configure or create an Order Type to use the checkout flow.
3 Configure or create an Order Item Type to use the Order Type, and work with
  Licenses.
4 Configure or create a Product Variation Type to use the Order Item Type, and
  provide both Licenses and Subscriptions.
5 Configure or create a Product Type that uses the Product Variation Type.
6 Create one or more products that provide licenses and subscriptions. In the
  product variation, configure:
  - The license type
  - The expiration should be 'Unlimited', as the subscription controls this.
  - Set the subscription type to 'License'.
  - Select the billing schedule.

KNOWN ISSUES AND LIMITATIONS
----------------------------

This module is still incomplete, and has the following limitations:

- The admin forms to create/edit licenses are not yet complete. They should only
  be used by developers who know what they are doing. Changing values here can
  break things!

File

README.txt
View source
  1. INTRODUCTION
  2. ------------
  3. The Commerce License allows the creation of products that sell access to some
  4. aspect of the site. This could be a role, publication of a node, and so on.
  5. This access is controlled by a License entity, which is created for the user
  6. when the product is purchased.
  7. The nature of what a License entity grants is handled by License type plugins.
  8. Each License entity will have one License type plugin associated with it.
  9. A product variation that sells a License will have a configured License type
  10. plugin field value. This acts as template to create the License when a user
  11. purchases that product variation.
  12. REQUIREMENTS
  13. ------------
  14. This module requires the following modules:
  15. * Commerce (https://drupal.org/project/commerce)
  16. * Recurring Period (https://drupal.org/project/recurring_period)
  17. * Advanced Queue (https://drupal.org/project/advancedqueue)
  18. This module also integrates with Commerce Recurring
  19. (https://drupal.org/project/commerce_recurring) to provide licenses that
  20. automatically renew with a subscription.
  21. The following patches are required:
  22. * https://www.drupal.org/project/drupal/issues/2911473#comment-12676912
  23. Selected yet disabled individual options from checkboxes element don't persist
  24. through save.
  25. The following patches are recommended:
  26. * https://www.drupal.org/project/commerce/issues/2930979: Don't show the
  27. 'added to your cart' message if the item quantity is unchanged.
  28. INSTALLATION
  29. ------------
  30. Install as you would normally install a contributed Drupal module. Visit
  31. https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules for
  32. further information.
  33. CONFIGURATION
  34. -------------
  35. To create products that grant licenses that expire:
  36. 1 Configure or create a checkout flow which does not allow anonymous checkout.
  37. 2 Configure or create an Order Type to use the checkout flow.
  38. 3 Configure or create an Order Item Type to use the Order Type, and work with
  39. Licenses.
  40. 4 Configure or create a Product Variation Type to use the Order Item Type, and
  41. provide Licenses.
  42. 5 Configure or create a Product Type that uses the Product Variation Type.
  43. 6 Create one or more products that provide licenses. In the product variation,
  44. configure:
  45. - The license type
  46. - The expiration.
  47. To create products that grant licenses that renew with a subscription:
  48. 1 Configure or create a checkout flow which does not allow anonymous checkout.
  49. 2 Configure or create an Order Type to use the checkout flow.
  50. 3 Configure or create an Order Item Type to use the Order Type, and work with
  51. Licenses.
  52. 4 Configure or create a Product Variation Type to use the Order Item Type, and
  53. provide both Licenses and Subscriptions.
  54. 5 Configure or create a Product Type that uses the Product Variation Type.
  55. 6 Create one or more products that provide licenses and subscriptions. In the
  56. product variation, configure:
  57. - The license type
  58. - The expiration should be 'Unlimited', as the subscription controls this.
  59. - Set the subscription type to 'License'.
  60. - Select the billing schedule.
  61. KNOWN ISSUES AND LIMITATIONS
  62. ----------------------------
  63. This module is still incomplete, and has the following limitations:
  64. - The admin forms to create/edit licenses are not yet complete. They should only
  65. be used by developers who know what they are doing. Changing values here can
  66. break things!