XML Schema "jpdl-4.0.xsd"

Target Namespace:

Defined Components:

5 global elements, 79 local elements, 9 complexTypes, 3 simpleTypes, 3 element groups, 2 attribute groups

Default Namespace-Qualified Form:

Local Elements: qualified; Local Attributes: unqualified

Schema Location:

C:\wsjbpm4release\jbpm4\modules\api\src\main\resources\jpdl-4.0.xsd, see XML source

Annotation

Schema for jPDL 4 process descriptions; element process is the top level element. TODO: Add activity pluggability. (add the proper any's and anyAttributes) TODO: Pull up expression. The expression element in the delegation group can be pulled up as an expression attribute in each use case of the delegationGroup TODO: Investigate if object-refs to centrally defined objects would add value over inline defined objects.

XML Source

<?xml version="1.0" encoding="UTF-8"?>

Schema for jPDL 4 process descriptions;
element process is the top level element.

TODO: Add activity pluggability. (add the proper any's and
anyAttributes)

TODO: Pull up expression. The expression element in the
delegation group can be pulled up as an expression
attribute in each use case of the delegationGroup

TODO: Investigate if object-refs to centrally defined objects would
add value over inline defined objects.

</documentation>

</annotation>

A jPDL process definition description; This
is the top level element in a jPDL process file.

</documentation>

</annotation>

</sequence>

The process name. Multiple processes can be deployed with the same name, as long as they have a different
version.

</documentation>

</annotation>

</attribute>

The key can be used to provide a short acronym that will replace the name as the basis for the generated
process definition id

</documentation>

</annotation>

</attribute>

Indicates the sequence number of this version for all processes with the same name. By specifying a version
automatic deployment can figure out if this process is already deployed or not.

</documentation>

</annotation>

</attribute>

for extensibility

</documentation>

</annotation>

</anyAttribute>

</complexType>

</element>

Start event

</documentation>

</annotation>

</sequence>

the resource name of the form in the
deployment.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

End event.

</documentation>

</annotation>

</sequence>

</restriction>

</simpleType>

</attribute>

<documentation>sets the state of the execution explicitely</documentation>

</annotation>

</attribute>

</complexType>

</element>

End cancel event.

</documentation>

</annotation>

</sequence>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

End cancel event.

</documentation>

</annotation>

</sequence>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

A wait state. When an execution arrives in this
activity, the execution will wait until an external trigger is received
with execution.signal() or execution.getActivityInstance().signal()

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

</sequence>

</complexType>

</element>

Decision gateway: selects one path out of many alternatives.
When an execution comes in, exactly one outgoing transition is taken.

</documentation>

</annotation>

The script text that will be evaluated.

</documentation>

</annotation>

</attribute>

Identification of the scripting language
to use.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

</sequence>

The script that will be evaluated and resolve to
the name of the outgoing transition.

</documentation>

</annotation>

</attribute>

Identification of the scripting language
to use for the expr attribute.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

Spawns multiple concurrent paths of
execution.

</documentation>

</annotation>

</sequence>

</complexType>

</element>

Spawns multiple concurrent paths of
execution.

</documentation>

</annotation>

</sequence>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

Evaluates a piece of text as a script

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Performs a hibernate query

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Performs a hibernate SQL query

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Sends an email

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Invokes a method on a java object.
Either the java class is instantiated with reflection, or the
java object is fetched from the environment. Then values from the
environment are injected into the fields and a method is executed.

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Uses a user defined, custom implementation of
ActivityBehaviour

</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

Creates a task in the task component.

</documentation>

</annotation>

</complexType>

</element>

</complexType>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

</sequence>

the resource name of the form in the
deployment.

</documentation>

</annotation>

</attribute>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

Waits while a sub process instance is
being executed and continues when the sub process instance ends.

</documentation>

</annotation>

<documentation>Events on which listeners can be registered.</documentation>

</annotation>

</element>

</complexType>

</element>

</complexType>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

</element>

</sequence>

Identifies the sub process by the id. This means that a specific
version of a process definition is referenced

</documentation>

</annotation>

</attribute>

Identifies the sub process by the key. This means that the latest
version of the process definition with the given key is referenced. The latest version
of the process is looked up each time the activity executes.

</documentation>

</annotation>

</attribute>

Expression that is evaluated when the sub process
instance ends. The value is then used for outcome transition mapping.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

Scope enclosing a number of activities.

</documentation>

</annotation>

<documentation>Events on which listeners can be registered.</documentation>

</annotation>

</element>

</sequence>

</complexType>

</element>

</choice>

</group>

the null value

</documentation>

</annotation>

</element>

A reference to an object in the current environment

</documentation>

</annotation>

<documentation>The name of the referred object</documentation>

</annotation>

</attribute>

</complexType>

</element>

The current environment.

</documentation>

</annotation>

</element>

A lookup from JNDI through the InitialContext

</documentation>

</annotation>

</complexType>

</element>

</annotation>

</choice>

Implementation class for this list.

</documentation>

</annotation>

</attribute>

Indicates if this collection should be synchronized
with Collections.synchronizedList(List)

</documentation>

</annotation>

</attribute>

</complexType>

</element>

</annotation>

</complexType>

</element>

</complexType>

</element>

</choice>

</complexType>

</element>

</choice>

Implementation class for this map.

</documentation>

</annotation>

</attribute>

Indicates if this collection should be synchronized
with Collections.synchronizedList(List)

</documentation>

</annotation>

</attribute>

</complexType>

</element>

A java.util.Set

</documentation>

</annotation>

</choice>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

Implementation class for this set.

</documentation>

</annotation>

</attribute>

Indicates if this collection should be synchronized
with Collections.synchronizedSet(Set)

</documentation>

</annotation>

</attribute>

</complexType>

</element>

<documentation>A java.util.Properties</documentation>

</annotation>

</complexType>

</element>

</choice>

<documentation>A file on the file system</documentation>

</annotation>

</attribute>

<documentation>A file as a resource in the classpath</documentation>

</annotation>

</attribute>

<documentation>the contents is fetched by loading a url</documentation>

</annotation>

</attribute>

optionally indicates if the content of referenced file in attributes
'file', 'resource' or 'url' is XML. The default is the
plain properties format with a space or the equals character (=) separating key and value on
each line.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

<documentation>the name of the string object</documentation>

</annotation>

</attribute>

<documentation>the actual string value</documentation>

</annotation>

</attribute>

</complexType>

</element>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

<documentation>A java.lang.Character</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

<documentation>A java.lang.Double</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

java.lang.Boolean.FALSE

</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

A java.lang.Float

</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

A java.lang.Integer

</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

a java.lang.Short

</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

java.lang.Boolean.TRUE

</documentation>

</annotation>

The name of the object. It's optional and serves
as an id to refer to this object from other object declarations. This name can
also be used lookup the object programmatically.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

</choice>

</group>

Any java object that will be created by reflection. .

There are three main ways to create an object: by constructor or by a factory
object or a static factory method.

Using the constructor

: Then the

<code>class</code>

attribute must provide the
fully qualified class name. In case another constructor then the default is
targetted, a

<code>constructor</code>

child element can be provided.
The

<code>factory</code>

attribute should not be provided for using a constructor.

Using a factory

: Then the

<code>factory</code>

attribute or one

<code>factory</code>

element must be provided along with the attribute

<code>method</code>

Using a static factory method

: Then the

<code>class</code>

and

<code>method</code>

attributes should be specified. There should be no
reference to a

<code>factory</code>

attribute of element.

Construction and initialization

: all objects (constructor and factory)
are build in two phases: construction and initialisation phase. During construction
all is done until a pointer is obtained to the object. In initialisation, operations
are applied to the object until it is ready to be used. The separation between
construction and initialisation is made to allow for bidirectional references. In
that case, at least one of both ends can not be fully initialised before it is injected
into the other end.

Operations

: after construction, various operations can be applied to objects
like e.g. direct field injection, injection through setters, method invocation,
enlist with the standard transaction, subscribe the object as a listener to an observable

Arguments

: There are two different places for arguments. The

elements for the factory method invocation should be placed as child elements under the

<code>object</code>

element. The

elements for the constructor should be
placed as child elements under the

<code>constructor</code>

element.

</documentation>

</annotation>

Contains one element that describes the factory object.

</documentation>

</annotation>

</complexType>

</element>

Specifies the arguments to use for a non-default constructor.

</documentation>

</annotation>

</choice>

</complexType>

</element>

<documentation>The factory method arguments.</documentation>

</annotation>

</element>

Injects a value into a member field of this object.
Exactly one child element must specify the value.

</documentation>

</annotation>

<documentation>The member field name</documentation>

</annotation>

</attribute>

</complexType>

</element>

Injects a value through a setter method.
Exactly one child element must specify the value.

</documentation>

</annotation>

The name of the property (without the 'set' prefix)

</documentation>

</annotation>

</attribute>

</complexType>

</element>

<documentation>Invokes a method</documentation>

</annotation>

</choice>

<documentation>the method name</documentation>

</annotation>

</attribute>

</complexType>

</element>

</choice>

<documentation>The fully qualified class name</documentation>

</annotation>

</attribute>

The class to instantiate.

</documentation>

</annotation>

</attribute>

The class to instantiate.

</documentation>

</annotation>

</attribute>

<documentation>The name of the factory object</documentation>

</annotation>

</attribute>

<documentation>The factory method name</documentation>

</annotation>

</attribute>

Indicates if the member fields and setter properties
should be automatically wired based on matching the property names and types with the
object names and types

</documentation>

</annotation>

</attribute>

</complexType>

The method arguments.
Each 'arg' element should have exactly one child element
that represents the value of the argument.

</documentation>

</annotation>

The java class name representing
the type of the method. This is optional and can be used to
indicate the appropriate method in case of method overloading.

</documentation>

</annotation>

</attribute>

</complexType>

Field injections from the environment
invocation.

</documentation>

</annotation>

</element>

<documentation>Method arguments.</documentation>

</annotation>

</element>

</sequence>

Name of the object in the environment

</documentation>

</annotation>

</attribute>

The name of the method to invoke.

</documentation>

</annotation>

</attribute>

The class to instantiate.

</documentation>

</annotation>

</attribute>

Expression that resolves to the target object
on which the method should be invoked.

</documentation>

</annotation>

</attribute>

The language in which attribute 'expr' is to be
resolved.

</documentation>

</annotation>

</attribute>

The variable name to store the return value

</documentation>

</annotation>

</attribute>

</complexType>

The content of this expression element
is the script text that will be evaluated. This is mutually
exclusive with the expression attribute.

</documentation>

</annotation>

</element>

</sequence>

The script text that will be evaluated. This
is mutually exclusive with the expression element.

</documentation>

</annotation>

</attribute>

Identification of the scripting language
to use.

</documentation>

</annotation>

</attribute>

Name of the variable in which the result
of the script evaluation will be stored

</documentation>

</annotation>

</attribute>

</complexType>

<documentation>The query text.</documentation>

</annotation>

</element>

<documentation>Query parameters.</documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

Name of the variable in which the result
of the script evaluation will be stored

</documentation>

</annotation>

</attribute>

Does this query return a unique result or a list

</documentation>

</annotation>

</attribute>

</complexType>

The id of this activity. The name should be unique
in the complete scope of the process.

</documentation>

</annotation>

</attribute>

Graphical information used by process designer tool.

</documentation>

</annotation>

</attribute>

To specify async continuations.
sync is the default.

</documentation>

</annotation>

</attribute>

</attributeGroup>

</restriction>

</simpleType>

the assignment attributes will be used in
tasks and swimlanes to specify to whom these respectively are assigned.

</documentation>

</annotation>

Expression that resolves to a userId referencing
the person to which the task or swimlane will be assigned.

</documentation>

</annotation>

</attribute>

Expression language for the assignee attribute.

</documentation>

</annotation>

</attribute>

Expression that resolves to a comma separated
list of userId's. All the referred people will be candidates for
take the task or swimlane.

</documentation>

</annotation>

</attribute>

Expression language for the
candidate-users attribute.

</documentation>

</annotation>

</attribute>

Resolves to a comma separated list of groupId's.
All the referred people will be candidates to
take the task or swimlane.

</documentation>

</annotation>

</attribute>

Expression language for the
candidate-groups attribute.

</documentation>

</annotation>

</attribute>

</attributeGroup>

<documentation>A process role.</documentation>

</annotation>

</complexType>

</element>

The outgoing transitions. The first in the list
will be the default outgoing transition.

</documentation>

</annotation>

</sequence>

<documentation>Name of this outgoing transition</documentation>

</annotation>

</attribute>

Name of the destination activity of this transition.

</documentation>

</annotation>

</attribute>

Graphical information used by process designer tool.

</documentation>

</annotation>

</attribute>

</complexType>

<documentation>A transition from one activity to another.</documentation>

</annotation>

</element>

A list of event listeners that will
be notified when the event is fired

</documentation>

</annotation>

</group>

</sequence>

The event identification. start, end, take or
any other custom event.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

The name of the sub process variable.

</documentation>

</annotation>

</attribute>

An expression for which the resulting
value will be used as value.

</documentation>

</annotation>

</attribute>

Language of the expression.

</documentation>

</annotation>

</attribute>

Name of the process variable
in the super process execution..

</documentation>

</annotation>

</attribute>

</complexType>

A list of event listeners that will
be notified when the timer fires

</documentation>

</annotation>

</group>

</sequence>

Timer duedate expression that defines the duedate of this
timer relative to the creation time of the timer. E.g. '2 hours' or '4 business days'

</documentation>

</annotation>

</attribute>

Timer duedate expression that defines repeated scheduling
relative to the last timer fire event. E.g. '2 hours' or '4 business days'

</documentation>

</annotation>

</attribute>

Absolute time in format

(see SimpleDateFormat). The format for the absolute time can be customized in the
jbpm configuration.

</documentation>

</annotation>

</attribute>

</complexType>

</element>

</choice>

</group>

<documentation>URL reference to the attachment</documentation>

</annotation>

</attribute>

<documentation>Name of the attachment resource on the classpath</documentation>

</annotation>

</attribute>

<documentation>File reference to the attachment</documentation>

</annotation>

</attribute>

</complexType>

</element>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

list of email address separated by ',' (comma) ';' (semicolon) '|' or whitespace

</documentation>

</annotation>

</attribute>

list of user ids that are resolved to the email address against configured identity component.
user ids should be separated by ',' (comma) ';' (semicolon) '|' or whitespace

</documentation>

</annotation>

</attribute>

list of group ids that are resolved to the email address against configured identity component.
group ids should be separated by ',' (comma) ';' (semicolon) '|' or whitespace

</documentation>

</annotation>

</attribute>

</complexType>

</restriction>

</simpleType>

<documentation>Reference to the email template</documentation>

</annotation>

</simpleType>

</schema>

This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
To document local element components both globally and locally (similar to attributes).
To enable/disable reproducing of namespace prefixes.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
To use the same template to generate the incredible quality RTF documentation.
To document only selected XML schema components specified by name.
To remove this very advertisement text

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To buy a license, please follow this link: http://www.filigris.com/shop/