Workflowis a prototype collection of stepwise
Workstepprototypes corresponding to a real-world business process. Workflows provide a means of defining the relationships, rulesets and order of execution to be implemented in a baseline business process.
While the baseline protocol standard defines a
WorkflowInstance, the provisioning and management of these instances is left to the implementation provider. Provide Baseline introduces a
Workflowstaging layer that enables drafting, templating, deployment and automatic real-time generation of workflow instances. Once deployed, a
Workflowis referenced as a prototype for the spawning of
WorkflowInstanceexecutions as qualifying trigger events occur.
Workflows are useful for designing end-to-end baseline processes as they pertain to a specific use case. Composed of
Workstepobjects containing zero-knowledge proofs, a
Workflowcan be used to verifiably synchronize the entire lifecycle of any shared business process without exposing any sensitive data.
Refers to the output of a zero-knowledge prover; the result of a successfully executed
Workstep. In a baseline context, the proof resulting from a completed workflow instance provides verifiable proof that the data shared by participants in the workflow remained synchronized throughout the entire process.
Workflows are composed of individual stepwise processes called worksteps. A workstep is characterized by input, the deterministic application of a set of logic rules and data to that input, and the generation of a verifiably deterministic and verifiably correct output. Worksteps output a
proofby way of a
A workflow instance is a real-time execution of a deployed workflow. Workflow instances are spawned when conditions specified in the prime-workstep trigger are met. A
Workflowis capable of spawning n number of workflow instances. A
WorkflowInstanceis distinguishable from a
Workflowby the presence of a value in the
Statusis used to define the stages in a workflow lifecycle.
inactive; is not being referenced by any workflow instances or spawning new workflow instances.
deployment initialized. Included worksteps provisioning.
active; able to spawn a
inactive; has been replaced by a new version or removed from use
When updates are needed for a deployed
Workflow, versioning is required to avoid conflicts with previously deployed iterations and related workflow instances. A
Workflowis required to have a version in order to be deployed.
The Workflow API is intended to function within the context of an
Organizationacting as a participant in a
Within this context, it is assumed that:
Organizationscoped JWT is available for use
Organizationis a participant in a
arbitrary data pertaining to
Returns a list of
Retrieves details for a specified
Get Workflow Details
Deletes a specified
Workflow; Workflows with a status of
deprecatedcannot be deleted.
Delete a Workflow
Deploying a workflow provisions it for use amongst the participants in the associated workgroup within the defined parameters.
Once deployed, a workflow begins actively listening for workstep trigger events, spawning new workflow instance executions each time the prime-workstep is triggered. A deployed
Workflowcannot be updated and must be versioned and redeployed to introduce changes.
Deploy a Workflow
Workflowis useful for versioning and updating status. Workflows with a status of
deprecatedcannot be updated.
Update a Workflow
Returns a list of
Workstepobjects in a specified
List Worksteps in a Workflow