marklogic-community / marklogicworkflow Goto Github PK

Equivalent of xdmp:node-append-child

Use alerts to start a process (via creating a process instance XML document)

Must support multiple alerts creating a single type of process, and passing on the initiating attachment.

alert-action-process.xqy - create a process doc once an alert is fired
lib-alerts.xqy - basic alert creation
lib-search-subscribe.xqy - saving a search and creating/removing alerts
/v1/resources/processsubscription.xqy - create, update and delete an alert configuration
workflow-import.xqy - Support for Alert configuration within a diagram (multiple alerts, single process)
Eclipse Workflow extension - Alert custom message type potentially required - cts:query support, external XSD import (cts:query et al)

Attach a document given a URI to a process attachment.

Update or complete a process step. E.g. complete a human step
Complete with JSON and XML and TXT (for testing scripts - process id)
See documentation/RESTAPI.md

Create a process subscription (alert to fire a new process instance. Also creates a CPF domain as required)
Complete with JSON and XML.
See documentation/MODELLING.md

Fetch the current status and data for a process instance
Complete with JSON and XML.
See documentation/RESTAPI.md

Implement the importer

Foreach loop across data elements, attachments -> place each in to instance field

Fetch the named processsubscription (or all of the current user's subscriptions?)
Complete with JSON and XML.
See documentation/MODELLING.md

Must support multiple alert configurations linked to the same Workflow Domain (start event)

Implement as:-

• Actual Process (with start event with domain message configuration) as a sub model
• Other models within file show start event (with alert message configuration) pass signal to sub process (the actual process model)

Just in idea. Actual implementation may need to vary depending upon BPMN2 standard conventions/rules.

As per BPMN2 spec

Implement via semantic inferencing?

From BPMN2 spec PDF page 163:-
"A Business Rule Task provides a mechanism for the Process to provide input to a Business Rules Engine and to get the output of calculations that the Business Rules Engine might provide. The InputOutputSpecification of the Task (see page 211) will allow the Process to send data to and receive data from the Business Rules Engine."

Get the process tasks waiting for a user in a named role (and visible to this user, who also has that role)
Complete with JSON and XML.
See documentation/RESTAPI.md

Support multiple parallel timers
Used timed task server task, with escalation query. E.g. if still have a timer element with specified name, re-route to different CPF step
Start Timer task (duration or specified date time, specify escalation step)
Cancel timer task
task action

UI: Ridiculously basic HTML for rendering step and choosing action (for ease of testing)

Must be able to be fully documented so as to act as an example for other developers.

Set permissions on a document referenced by an attachment

PUT processmodel with enable=true does not create a CPF domain. Works on a POST though.

Once event handling implemented, and sub processes, should be able to easily implement sending a message (fire and forget) and receiving a message (async messaging).

User Task (Basic HTML step processor)
Task (subclasses only for MarkLogic actions, not generic support)
Send task (SOAP)
Send task (REST)
Loop characteristic (on individual activities)
Exclusive gateway
Error event (route to specific CPF task as per BPMN2 spec)

Diagrams limited to Process model only
Steps limited to those supported by current version of ML Workflow
Custom MarkLogic specific steps supported for this version

Escalation event (non timer escalation)
Error event (custom or generic)
Custom event (any event)

Treat events as being CPF states that immediately start 1 or more parallel sub processes. (multiple event listeners)

Message and Signal events both out of scope

Fetch all processes, or all instances of the named process or process-version. (visible to the current user only?)
Complete with JSON and XML.
See documentation/RESTAPI.md

As per BPMN2 standard

process invokes another separate process (as opposed to sub process contained within same process model document)

as per bpmn2 spec

Specify pipeline or domain to invoke
Take single attachment as parameter - this will be the document the pipeline/domain is invoked on
Set the document's properties such that CPF kicks off the domain

• BPMN2 specification test process models modified and tested to MarkLogic executable standard
  • Advanced
  • Collapsed sub process
  • Correlation example seller
  • email voting 2
  • expanded subprocess
  • laneset
  • pool
  • Process
  • Procurement Processes with Error Handling - Stencil Trosotech 2 pages
  • Travel Booking
  • triso - Hardware Retailer v2
  • Triso - Order process for pizza v4
  • Extended
  • Call activity
  • Nobel prize process

Don't forget to test them all!

As per BPMN2 standards
BPMN2: complex gateway -> E.g. 3 of 5 incoming routes required in order to activate gateway

to/from other parts of BPMN2 processes

Save a search document and add as an attachment (or store inline in the process document - TBD)

Detach a named attachment from a process. Could be a single attachment, entire array, or specific instance within an array.

Complex. May be sync, async, or fire and forget
As per BPMN2 standards
service task -> invoke service and process response

Export CPF pipelines (domain) to BPMN2 model and test reintegration of any alterations.

Needs to be 100% round trippable.

Perform a search in MarkLogic and store result references in an Attachment array in the process document

See other tasks developed/updated since

Instantiate a process.
Complete with JSON and XML and TXT (for testing scripts - process id)

Fetch the named queue's workload (those items visible to this user - whether locked or not)
Complete with JSON and XML.
See documentation/RESTAPI.md

Implement as a 'sub process document' under /workflow/processes/sub
Create requisite pipeline, add to overarching domain (same as root process)
Fork Task
(hidden - CPF only, not BPMN2) Check rendezvous task - update subprocess completion state element in parent process, thus kicking rendezvous task on to next step (condition set to if all elements are true, proceed)
Rendezvous (awaiting) Task
Implement just 'all routes' to start with
Parent process flow uses subprocesses element with specific UUID (in case in future we allow parallel of parallel of subprocesses), and sub element for each fork created.

And test

Allow a process flow to initiate and return from a sub process flow.
Be aware of escalation timers, and parallel execution use cases too alongside this feature

• DEFERRED BPMN2 specification test process models modified and tested to MarkLogic executable standard
  • Basic
  • Incident Management Level 1
  • Incident Management Account Manager Only
  • Incident Management Process Engine only

Don't forget to test them!

To allow MarkLogic XQuery developers to create a new MarkLogic Workflow based project by issuing a Gradle-ml command. Rob Rudin.

• Enterprise features
  • Set security as relevant to the process document at each step in the process - irrelevant, sorted by amps and internal role
    • Especially around assignment - N/A
  • Allow a set security permissions on documents feature - postponed until MarkLogic specific steps in later sprints
  • Ensure installation creates relevant roles and permission sets
  • Creation of roles - (Requires mlnodetools enhancement)
  • creation of privileges - (Requires mlnodetools enhancement)
  • creation of amps - (Requires mlnodetools enhancement)
  • settings of modules db document security - DONE (mlnodetools enhancement)
  • setting of rest extension security - RFE logged
  • Ensure rest services honour the 'locked by' guarantee - not relevant, handled by internal privileges

Task for node-replace on a document (attachment)

Also update importer

As per BPMN2 standards

In the code, but needs testing.

• TEST support for roles (processroleinbox.xqy) on user tasks (For BD)

Made an initial start, but needs significant debugging and testing. Also need to support all CPF state, status, condition, and action configuration within BPMN2 model.

Requires Java expertise. Knowledge of Eclipse SWT and EMF also useful.

Activity: Set process variable activity with multiple from and to (simple XPath evaluation)

• See if there is an equivalent BPMN2 method - may just be a variable assignment on each step instead
• Create import step for this BPMN2 method
• Create CPF action to represent this

Fetch the current user's (or specified user's?) process inbox
Complete with JSON and XML.
See documentation/RESTAPI.md

Specifically: Support for (/some/path/one,/some/path/two)[1] style evaluation within conditions (exclusive gateway)

See wfu:evaluate() and data/examples/bpmn2/011_gateways_test.bpmn