Transmute Verifiable Data Platform supports Workflows as defined by the Traceability Interoperability specification. Workflows provide a way to explicitly connect Verifiable Presentations, submitted at different points in time. This is useful for example for:
- Early submission of partially completed required documentation.
- Updates to previous submitted documentation.
- Providing context of the type of documentation presented.
- Coordinating data presentations across multiple parties.
A Workflow is a property of a Presentation. It is attached to a Presentation by the sender (“holder”) as an explicit indication to the receiver (“verifier”). A presentation which includes a Workflow indication is a Traceable Presentation (an extension of Verifiable Presentation).
More specifically, the Traceable Presentation’s Workflow element can indicate two aspects: its Definition and Instance:
- The Workflow Definition defines the type of workflow which the Presentation is part of.
- The Workflow Instance defines this concrete workflow which the Presentation is part of.
As an example, consider custom’s requirements for importing stainless steel from a particular country. The requirement could be submission of three particular types of documents. These procedures would be documented on
An importer of this commodity, would include
https://stainless-steel-import-procedures.country.govas the Workflow Definition when filing my importing documentation. This explicitly indicates that the documents being submitted are intended to satisfy the requirements specific to this steel import procedure.
The Traceable Presentation would also include a Workflow Instance, for example
urn:uuid:51908497-5c96-4ce5-8d69-a4cf592eff5c. Only two of the three required documents might be ready at time of submission. Now, when the third document becomes available, it can be submitted subsequently, and by again including the same Workflow Instance (
urn:uuid:51908497-5c96-4ce5-8d69-a4cf592eff5c) the importer is explicitly indicating to Customs the two individual submissions relate to the same import filing.
VDP offers rich features for managing Workflow Definitions and Instances. This makes it easy to coordinate across teams which Workflow Definitions are used for common purposes, tracking the status of in-progress Workflow Instances, and correlate Workflows with both sent and received Traceable Presentations.
Workflow Definition management is available under the Presentations main menu.
Workflow definition management
This lists your organization’s Workflow Definitions, managed with name, description and tags in order to make the intended usage of a particular Workflow Definition clear.
Click the “ + Workflow Definition” button to create a new Workflow Definition.
New workflow definition
In the Workflow Definition creation window, enter suitable name, description and tags. These are for internal use only and should be descriptive making it clear under which circumstances this Workflow Definition should be applied.
Also, enter the actual Workflow Definition, which is the identifier signaling externally which workflow definition a presentation is part of. This could well be provided by a verifier, which will be receiving presentations and require a particular identifier. The identifier must be in valid URL format.
Newly created workflow definition
To update a Workflow Definition, from the submenu, select “Edit”.
Edit a workflow definition
All internal metadata (name, description and tags) can be updated. Note that the Workflow Definition is a unique identifier and thus cannot be updated.
To delete a Workflow Definition, select it from the list and click the trash icon.
Select workflow for deletion
Confirm the deletion on the pop up.
Delete workflow definition
Making a new Traceable Presentation is where:
- Workflow Definitions are reference, and
- Workflow Instances are created or referenced.
Under “Presentations” select “New”:
New presentation with workflow instance
Ensure that “Include this Presentation as part of a Workflow” is toggled on.
From the drop down, select the appropriate Workflow Definition:
Workflow definition selection
Creating a new workflow instance
Under Workflow Instance, select “New workflow instance” and fill in details for internally managing this Workflow Instance: name, description and tags.
Note that the identifier is automatically created for new workflow instances.
Presentation with workflow definition and instance
Fill in the rest of the data required to submit a presentation (recipient, sender and credentials) and click “Send”. This will send the presentation and create the Workflow Instance.
You can now make additional presentations for the same Workflow Instance and Workflow Definition.
Referencing an existing workflow instance
This time, instead of creating a new Workflow Instance, select “ + Add to existing workflow instance”, and select the Workflow Instance from the drop down.
Fill in the rest of the Presentation similar to earlier, and click Send.
Go to “Presentations” -> “Workflow Instances” to see an list of the organization’s current Workflow Instances:
List workflow instances
Select “Edit” from the submenu to access a Workflow Instance’s details. This will show you the following four sections:
- Details Editor
- Sent Presentations
- Received Presentations
- Workflow Definitions
Editing Workflow Instances
At the top is the Workflow Instance editor:
Workflow instance editor
All internal metadata (name, description and tags) can be updated. Note that the Workflow Instance is a unique identifier and thus cannot be updated.
Workflow Instance’s Sent Presentations
Presentations referencing the same workflow instance
Sent Presentations lists the two presentations which were sent earlier.
Workflow Instance’s Received Presentations
Presentations received with workflow instance id
The same Workflow Instance can be used across multiple interacting actors, and thus be associated with sent as well as received presentations.
In this case there have been no received presentations for the Workflow Instance.
Related Workflow Definitions
Related workflow definitions
Two Traceable Presentations for the same Workflow Instance may not necessarily be part of the same Workflow Definition (although in practice they very often will be).
The Workflow Definitions list at the bottom lists all of the Workflow Definitions associated through Traceable Presentations to Workflow Definitions.
A presentation can be made directly from a Workflow Instance.
Present from workflow definition
Select “Present” from the submenu. This will take you to the Presentation screen, pre-populated with this Workflow Instance identifier.
Workflow Instances can be deleted, typically as clean up once the workflow is completed.
Delete a workflow instance
To delete a Workflow Instance, select it from the list and click the trash icon.