You are here

Home » API reference » Transaction 8

README.txt in Transaction 8 

TRANSACTION DRUPAL MODULE
=========================

CONTENTS OF THIS FILE
---------------------

 * Summary
 * Requirements
 * Installation
 * Configuration
 * Usage
 * Contact


SUMMARY
-------

This module provides generic support for transactional operations linked to
content entities. An example of transactional operation is an accounting
account, where the content entity acts as the account and each transaction is a
movement.

Different transactional flows can be created in addition to accounting, such as
tracking/logging systems, workflows, or your own by integration with rules or
programming a transactor.

The parts involved are:

 * target entity
   the content entity to which the transaction flow is linked to

 * transaction type
   that defines the transactional flow

 * transactor
   a plugin that performs the transaction logic

 * transactions
   content entities where the data of each transaction is stored


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

The module depends on the "dynamic entity reference" module to refer the target
entity in transactions. This dependency will be removed once the support is in
core, see https://www.drupal.org/project/drupal/issues/2407587 for more
information.


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

Install as usual, see https://www.drupal.org/node/1897420 for further
information. You might rebuild the cache after (un)installation.


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

Module configuration is available at Manage -> Configuration -> Workflow ->
Transaction Types (/admin/config/workflow/transaction).


USAGE
-----

The basic steps are:

 * create a transaction type, choose the target entity type and the desired
   transactor. By enable the local task link option, 'tab' will appear in
   applicable entities labeled with the transaction type name

 * go to any target entity to work with. Create your first transaction in the
   transaction tab

 * execute the transaction to perform the operation


CONTACT
-------

Current maintainers:
* Manuel Adan (manuel.adan) - https://www.drupal.org/user/516420

File

README.txt
View source 
  1. TRANSACTION DRUPAL MODULE

  2. =========================

  3. 

  4. CONTENTS OF THIS FILE

  5. ---------------------

  6. 

  7.  * Summary

  8.  * Requirements

  9.  * Installation

  10.  * Configuration

  11.  * Usage

  12.  * Contact

  13. 

  14. 

  15. SUMMARY

  16. -------

  17. 

  18. This module provides generic support for transactional operations linked to

  19. content entities. An example of transactional operation is an accounting

  20. account, where the content entity acts as the account and each transaction is a

  21. movement.

  22. 

  23. Different transactional flows can be created in addition to accounting, such as

  24. tracking/logging systems, workflows, or your own by integration with rules or

  25. programming a transactor.

  26. 

  27. The parts involved are:

  28. 

  29.  * target entity

  30.    the content entity to which the transaction flow is linked to

  31. 

  32.  * transaction type

  33.    that defines the transactional flow

  34. 

  35.  * transactor

  36.    a plugin that performs the transaction logic

  37. 

  38.  * transactions

  39.    content entities where the data of each transaction is stored

  40. 

  41. 

  42. REQUIREMENTS

  43. ------------

  44. 

  45. The module depends on the "dynamic entity reference" module to refer the target

  46. entity in transactions. This dependency will be removed once the support is in

  47. core, see https://www.drupal.org/project/drupal/issues/2407587 for more

  48. information.

  49. 

  50. 

  51. INSTALLATION

  52. ------------

  53. 

  54. Install as usual, see https://www.drupal.org/node/1897420 for further

  55. information. You might rebuild the cache after (un)installation.

  56. 

  57. 

  58. CONFIGURATION

  59. -------------

  60. 

  61. Module configuration is available at Manage -> Configuration -> Workflow ->

  62. Transaction Types (/admin/config/workflow/transaction).

  63. 

  64. 

  65. USAGE

  66. -----

  67. 

  68. The basic steps are:

  69. 

  70.  * create a transaction type, choose the target entity type and the desired

  71.    transactor. By enable the local task link option, 'tab' will appear in

  72.    applicable entities labeled with the transaction type name

  73. 

  74.  * go to any target entity to work with. Create your first transaction in the

  75.    transaction tab

  76. 

  77.  * execute the transaction to perform the operation

  78. 

  79. 

  80. CONTACT

  81. -------

  82. 

  83. Current maintainers:

  84. * Manuel Adan (manuel.adan) - https://www.drupal.org/user/516420