Data
- Default Namespace
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
- abstractQueueEntry
- actorTypeEnum
- processDefinition
- processDefinitionContextMap
- processDefinitionDeploymentStatus
- processDefinitionStatus
- processDefinitionVersion
- processTemplate
- processTemplateType
- supportFile
- taskActor
- taskInfo
- taskInfoStatus
- taskRule
- transitionRule
- transitionsRule
- workflowPriorityQueueEntry
- workflowPrioritySource
- workflowTriggerMethod
Element taskRule
- Type: taskRule
Bean that used to save Task configuration in xml format.
Example XML
<?xml version="1.0" encoding="UTF-8"?><taskRule name="..." autoSelectActor="..." notifyByEmail="..." producerTask="..."> <actor type="..."> <name>...</name> </actor> <accepted>...</accepted> <rejected>...</rejected> <instructions>...</instructions></taskRule>
Element transitionsRule
- Type: transitionsRule
A TransitionsRule contains a list of TransitionRule.
Example XML
<?xml version="1.0" encoding="UTF-8"?><transitionsRule> <transitionRule defaultTransition="..." name="..."> <rule>...</rule> </transitionRule> <transitionRule defaultTransition="..." name="..."> <!--...--> </transitionRule> <!--...more "transitionRule" elements...--></transitionsRule>
Type abstractQueueEntry
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
modifiedDate (dateTime) | 0/1 | (no documentation provided) |
retryCount (int) | 0/1 | (no documentation provided) |
createdDate (dateTime) | 0/1 | (no documentation provided) |
serverName (string) | 0/1 | (no documentation provided) |
version (int) | 0/1 | (no documentation provided) |
lockHash (string) | 0/1 | (no documentation provided) |
lockDate (long) | 0/1 | (no documentation provided) |
targetServerName (string) | 0/1 | (no documentation provided) |
queuePk (int) | 0/1 | (no documentation provided) |
Type actorTypeEnum
Enum that define type of task assignee.
Possible Values
value | description |
---|---|
USER | Assign to user. |
ROLE | Assign to role. |
Type processDefinition
OwsProcessDefinition generated by hbm2java
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processDefinitionPk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
processTemplate (processTemplate) | 0/1 | (no documentation provided) |
deployable (boolean) | 1/1 | (no documentation provided) |
lastDeployedDate (dateTime) | 0/1 | (no documentation provided) |
lastModifiedDate () | 0/1 | (no documentation provided) |
processDefinitionXml (string) | 0/1 | (no documentation provided) |
gpdXml (string) | 0/1 | (no documentation provided) |
processImageBytes (base64Binary) | 0/1 | (no documentation provided) |
supportFiles (supportFile) | 0/unbounded | (no documentation provided) |
isActive (boolean) | 0/1 | (no documentation provided) |
processDefinitionVersions (processDefinitionVersion) | 0/unbounded | (no documentation provided) |
definitionStatus (processDefinitionStatus) | 0/1 | (no documentation provided) |
deploymentStatus (processDefinitionDeploymentStatus) | 0/1 | (no documentation provided) |
processDefinitionContextMap (processDefinitionContextMap) | 0/unbounded | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
prioritySource (workflowPrioritySource) | 0/1 | (no documentation provided) |
priority (int) | 0/1 | (no documentation provided) |
timeOut (int) | 0/1 | (no documentation provided) |
displayProperty (string) | 0/1 | (no documentation provided) |
priorityComputingWorkflowUuid (string) | 0/1 | (no documentation provided) |
Type processDefinitionContextMap
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
procDefContextMapPk (int) | 0/1 | (no documentation provided) |
processDefinition (processDefinition) | 0/1 | (no documentation provided) |
nodeVarValue (string) | 0/1 | (no documentation provided) |
nodeVarMapping (string) | 0/1 | (no documentation provided) |
uuid () | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
Type processDefinitionStatus
Possible Values
value | description |
---|---|
INCOMPLETE | |
COMPLETE | |
MODIFIED | |
UNDEFINED |
Type processDefinitionVersion
OwsProcessDefinitionVersions generated by hbm2java
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
jbpmProcessId (int) | 0/1 | (no documentation provided) |
processDefinition (processDefinition) | 0/1 | (no documentation provided) |
jbpmProcessVersion (int) | 0/1 | (no documentation provided) |
xmlData (string) | 0/1 | (no documentation provided) |
gpdXml (string) | 0/1 | (no documentation provided) |
processImageBytes (base64Binary) | 0/1 | (no documentation provided) |
Type processTemplate
ProcessTemplate generated by hbm2java
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processTemplatePk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
archiveBytes (base64Binary) | 0/1 | (no documentation provided) |
archiveUploadDate (dateTime) | 0/1 | (no documentation provided) |
lastModifiedDate () | 0/1 | (no documentation provided) |
isActive (boolean) | 0/1 | (no documentation provided) |
archiveName (string) | 0/1 | (no documentation provided) |
uuid () | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
type (processTemplateType) | 0/1 | Returns the type values which used for storing in database field of OWS_PROCESS_TEMPLATE. |
Type processTemplateType
Enumeration containing types of workflow template (process template).
String values are used for storing in database field of OWS_PROCESS_TEMPLATE.Possible Values
value | description |
---|---|
STANDARD | |
PRIORITY_COMPUTATION |
Type supportFile
OwsSupportFile generated by hbm2java
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
supportFilePk (int) | 1/1 | (no documentation provided) |
fileName (string) | 0/1 | (no documentation provided) |
processDefinition (processDefinition) | 0/1 | (no documentation provided) |
xmlData (string) | 0/1 | (no documentation provided) |
binaryData (base64Binary) | 0/1 | (no documentation provided) |
Type taskActor
Bean that used to save Task configuration related to assignee of this task in xml format.
Attributes
name | type | description |
---|---|---|
type | actorTypeEnum | Type of task assignee. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | Getter for name field. |
Type taskInfo
Represents TaskInfo entity mapped on OWS_TASK_INFO table in DB. Contains additional information about BPM task instance.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
taskInfoPk (int) | 0/1 | Gets primary key for current entity. |
uuid (string) | 0/1 | Gets UUID for current entity. |
assignedToRole (boolean) | 1/1 | Gets value for ASSIGNED_TO_ROLE entity field. |
producerTask (boolean) | 1/1 | Checks if current task is in producer scope. |
acceptTransitionId (long) | 0/1 | Gets transition ID for producer task completed as accepted. |
rejectTransitionId (long) | 0/1 | Gets transition ID for producer task completed as rejected. |
taskInstanceId (long) | 0/1 | Gets BPM task instance ID related to current TaskInfo instance. |
status (taskInfoStatus) | 0/1 | Gets current status for the task. Is one of TaskInfoStatus enum values. |
startedByUser (string) | 0/1 | Gets name of user started current task. |
bundlePk (int) | 0/1 | Getter for bundlePk field. |
notifyByEmail (boolean) | 1/1 | Getter for notifyByEmail field. |
instructions (string) | 0/1 | Getter for instructions field. |
Type taskInfoStatus
Contains enumerated states for BPM task instance.
Possible Values
value | description |
---|---|
ASSIGNED | |
STARTED | |
COMPLETED | |
ACCEPTED | |
REJECTED | |
TERMINATED |
Type taskRule
Bean that used to save Task configuration in xml format.
Attributes
name | type | description |
---|---|---|
name | string | Name of current task. |
autoSelectActor | boolean | the autoSelectActor |
notifyByEmail | boolean | Should we notify assignee using email. |
producerTask | boolean | Is current task Producer task. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
actor (taskActor) | 1/1 | Getter for actor field. |
accepted (string) | 0/1 | Getter for accepted field. |
rejected (string) | 0/1 | Getter for rejected field. |
instructions (string) | 0/1 | Getter for instructions field. |
Type transitionRule
A TransitionRule contains name and rule for transition of decision Node.
Attributes
name | type | description |
---|---|---|
defaultTransition | boolean | (no documentation provided) |
name | string | name value |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
rule (string) | 0/1 | Transition rule of decision node |
Type transitionsRule
A TransitionsRule contains a list of TransitionRule.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
transitionRule (transitionRule) | 0/unbounded | List of transition rules. |
Type workflowPriorityQueueEntry
- Extends: abstractQueueEntry
An entry in the administration config tree
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 0/1 | (no documentation provided) |
workflowContext (string) | 0/1 | (no documentation provided) |
priority (int) | 0/1 | (no documentation provided) |
processId (long) | 0/1 | (no documentation provided) |
suspended (boolean) | 0/1 | (no documentation provided) |
triggerMethod (workflowTriggerMethod) | 0/1 | (no documentation provided) |
triggerData (string) | 0/1 | (no documentation provided) |
status (string) | 0/1 | (no documentation provided) |
marker (string) | 0/1 | (no documentation provided) |
Type workflowPrioritySource
Enumeration containing types of sources for workflow priority.
String values are used for storing in database field of OWS_PROCESS_DEFINITION.Possible Values
value | description |
---|---|
EXPLICIT | Workflow priority value, set explicitly.E.g. from the UI. |
COMPUTED | Workflow priority is computed in another workflow.Means that there's a special computation workflow associated with current one.This separate workflow will be triggered for calculatingworkflow priority based on current execution context, which provides great flexibility. |
Type workflowTriggerMethod
Enumeration of workflow trigger methods/types.
Possible Values
value | description |
---|---|
DEFAULT_TRIGGER | |
HOTFOLDER_TRIGGER | |
HTTP_TRIGGER |