Workflow configuration

Author: noniagriconomie

reference/configuration/framework.rst

@@ -198,14 +198,14 @@ Configuration
   * :ref:`enabled <reference-workflows-enabled>`
   * :ref:`name <reference-workflows-name>`
 
-    * `audit_trail`_
-    * `initial_place`_
-    * `marking_store`_
-    * `places`_
+    * :ref:`type <reference-workflows-type>`
     * `supports`_
     * `support_strategy`_
+    * `marking_store`_
+    * `places`_
+    * `initial_place`_
     * `transitions`_
-    * :ref:`type <reference-workflows-type>`
+    * `audit_trail`_
 
 secret
 ~~~~~~
@@ -2249,15 +2249,28 @@ name
 
 Name of the workflow you want to create.
 
-audit_trail
-"""""""""""
+.. _reference-workflows-type:
 
-**type**: ``array``
+type
+""""
 
-initial_place
-"""""""""""""
+**type**: ``string`` **possible values**: ``'workflow'`` or ``'state_machine'``
 
-**type**: ``string`` **default**: ``null``
+Defines the kind of workflow that is going to be created, which can be either
+a normal workflow or a state machine. Read :doc:`this article </workflow/introduction>`
+to know their differences.
+
+supports
+""""""""
+
+**type**: ``string`` | ``array``
+
+Object(s) that is(are) supported by this workflow configuration.
+
+support_strategy
+""""""""""""""""
+
+**type**: ``string``
 
 marking_store
 """""""""""""
@@ -2276,15 +2289,16 @@ places
 
 **type**: ``array``
 
-supports
-""""""""
+All available places for this workflow configuration.
 
-**type**: ``string`` | ``array``
+initial_place
+"""""""""""""
 
-support_strategy
-""""""""""""""""
+**type**: ``string`` **default**: ``null``
 
-**type**: ``string``
+One of the ``places`` or ``null``.
+If not null and the supported object is not already initialized via the workflow,
+this place will be set.
 
 transitions
 """""""""""
@@ -2293,22 +2307,20 @@ transitions
 
 Each marking store can define any of these options:
 
-* ``from`` (**type**: ``string``)
-* ``guard`` (**type**: ``string``) a :doc:`ExpressionLanguage </components/expression_language>`
+* ``name`` (**type**: ``string``) the name of the transition
+* ``guard`` (**type**: ``string``) an :doc:`ExpressionLanguage </components/expression_language>`
   compatible expression to block the transition
-* ``name`` (**type**: ``string``)
-* ``to`` (**type**: ``string``)
+* ``from`` (**type**: ``string``) value from the ``places``
+  multiple values are allowed, for both ``workflow`` and ``statemachine``
+* ``to`` (**type**: ``string``) value from the ``places``
+  multiple values are allowed only for both ``workflow``
 
-.. _reference-workflows-type:
-
-type
-""""
+audit_trail
+"""""""""""
 
-**type**: ``string`` **possible values**: ``'workflow'`` or ``'state_machine'``
+**type**: ``bool``
 
-Defines the kind of workflow that is going to be created, which can be either
-a normal workflow or a state machine. Read :doc:`this article </workflow/introduction>`
-to know their differences.
+Whether to enable automatically the :class:`Symfony\\Component\\Workflow\\EventListener\\AuditTrailListener`.
 
 .. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
 .. _`Security Advisory Blog post`: https://symfony.com/blog/security-releases-symfony-2-0-24-2-1-12-2-2-5-and-2-3-3-released#cve-2013-4752-request-gethost-poisoning