[jboss-jira] [JBoss JIRA] Created: (JBPM-979) Documentation enhancement for sub-process (fix error; add binding attribute)

[Arjan van Bentem (JIRA)]

Documentation enhancement for sub-process (fix error; add binding attribute)
----------------------------------------------------------------------------

                 Key: JBPM-979
                 URL: http://jira.jboss.com/jira/browse/JBPM-979
             Project: JBoss jBPM
          Issue Type: Feature Request
          Components: Documentation
    Affects Versions: jBPM jPDL 3.2
         Environment: All
            Reporter: Arjan van Bentem
         Assigned To: Tom Baeyens



http://jira.jboss.org/jira/browse/JBPM-733 added the attribute "binding" to element "sub-process".

This attribute is not yet documented, and at some points the documentation seems to be wrong (hence: priority major).

PLEASE VERIFY THAT MY PROPOSED CHANGES ARE CORRECT... See implementation at http://fisheye.labs.jboss.com/browse/JBPM/jbpm.3/jpdl/jar/src/main/java/org/jbpm/graph/node/ProcessState.java?r=1.3#l93
http://fisheye.labs.jboss.com/browse/JBPM/jbpm.3/jpdl/jar/src/main/java/org/jbpm/graph/node/DbSubProcessResolver.java?r=1.1#l12

http://fisheye.labs.jboss.com/browse/JBPM/jbpm.3/jpdl/userguide/en/modules/modelling.xml?r=1.3#l520
or http://docs.jboss.com/jbpm/v3.2/userguide/html/processmodelling.html#processcomposition

    Process Modelling
    9.8. Process composition

Change

    When execution arrives in the 'first interview', a new execution (=process instance) for
    the latest version of the 'interview' process is created.

into something like:

    When execution arrives in the 'first interview', a new execution (=process instance) of 
    the 'interview' process is created. As no explicit version is specified, the latest version
    of the sub process as known when deploying the 'hire' process is used. To make jBPM
    instantiate a specific version the optional <literal>version</literal> attribute can be
    specified. To postpone binding the specified or latest version until actually creating the
    sub process, the optional <literal>binding</literal> attribute should be set to
    <literal>late</literal>.


http://fisheye.labs.jboss.com/browse/JBPM/jbpm.3/jpdl/userguide/en/modules/jpdl.xml?r=1.3#l1638
or http://docs.jboss.com/jbpm/v3.2/userguide/html/jpdl.html#subprocess.element

    jBPM Process Definition Language (JPDL)
    18.4.28. sub-process

Change

    <row>
        <entry>version</entry>
        ...
        <entry>the version of the sub process. If no version is 
        specified, the latest version of the given process will be
        taken.</entry>
    </row>

into

        <entry>the version of the sub process. If no version is 
        specified, the latest version of the given process as known
        while deploying the parent 
        <link linkend="processstate.element">process-state</link>
        will be taken.</entry>

And add something like:

    <row>
        <entry>binding</entry>
        <entry>attribute</entry>
        <entry>optional</entry>
        <entry>indicates if the version of the sub process should be determined
        when deploying the parent <link linkend="processstate.element">process-state</link>
        (default behavior), or when actually invoking the sub process 
        (<literal>binding="late"</literal>). When both <literal>version</literal> and
        <literal>binding="late"</literal> are given then jBPM will use the version as
        requested, but will not yet try to find the sub process when the parent 
        process-state is deployed.
        </entry>
    </row>

Note: http://jira.jboss.com/jira/browse/JBPM-910 reports that the XML schema needs updating as well. 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira