๐Ÿ’ปTagging using UI

1. Step By Step Process

Tags

Document objects which can be attached to Schemas, Policies, Modules, Tokens, DID, VC and VP Documents by any credentialed entity at any time.

1. Structure

1.1 Object

  • uuid โ€“ unique tag identificator, tags with the same uuid are considered to be the same

  • name โ€“ label visible to the user and the criteria upon which tags are grouped

  • description โ€“ optional text field to provide additional information about tags

  • owner โ€“ DID of the user who created the tag

  • entity โ€“ type of the document to which this tag is attached (Schema, Policy, Token, Module, PolicyDocument)

  • target โ€“ link to the document to which the tag is attached (Hedera message ID)

  • localTarget โ€“ ID of the document in the local Guardian database

  • status โ€“ tag status (Draft, Published, History)

  • operation โ€“ current tag action (Create, Delete)

  • topicId โ€“ topic ID where the tag information will be published.

  • messageId โ€“ ID of the message in the topic where the tag is published.

  • policyId โ€“ Policy ID when the tag is linked to the document inside a policy (optional)

  • uri โ€“ uri of the additional document linked to the tag (optional)

  • document โ€“ additional document linked to the tag (optional)

1.2 Message

{
"id": "b8d249e8-ce63-4835-98fc-7ba7dab1df71",
"type": "Tag",
"action": "publish-tag",
"lang": "en-US",
"uuid": "ee95a359-41a4-45f6-bbf9-21559e252a52",
"name": "Label",
"description": "description",
"owner": "did:hedera:testnet:8AvszwobPqq5kHmWWq52cFg3i8wZo9oy8xSY1mBZsfD7_0.0.3916401",
"target": "1680189251.272591003",
"operation": "Create",
"entity": "Schema",
"cid": "bafkreifdxsx5bos2k3vbbupawwf7vbuhwhdscm6qvd2uiozo4aarxsv3g4",
"uri": "ipfs://bafkreifdxsx5bos2k3vbbupawwf7vbuhwhdscm6qvd2uiozo4aarxsv3g4"
}

2. Managing Tags

2.1 Create

Tags can be created by clicking on "Create Tag" button.

Tag can be created with label and the description as shown below:

An additional document can be added/linked with the tag using Add Document button and then selecting a suitable document schema

2.2 Remove

Users (DIDs) who created a tag are able to remove it later.

2.3 View

For documents displayed in the grid only the first (alphabetically) tag is shown.

Users can click on the tag icon to show the detailed information about all tag assigned to the document.

Tags are grounded by labels. When a label is selected then a detailed information about all tags with this label is displayed below.

2.4 History

Tags which have been imported with the Policy or Schema are marked as History. These tags are not directly relevant to the new objects and are displayed for the convenience of the user (policy author). These historic tags are neither synchronized nor published when the new objects are published.

2.5 Tag updates (synchronization)

Any credentialed entity can create/remove a tag on any object at any point of time independently from the Guardian instance where this tagable object (document etc) has been created. This presents a challenge for displaying the up-to-date state of 3rd party tags associated with the object, since continuous search and import/updates of such tags can affect UI responsiveness and general UX. Guardian users can refresh (or โ€˜pullโ€™) 3rd party tags and update their display in their local Guardian instance by clicking on the corresponding icon (highlighted on the screenshot below).

2. Demo Video

Youtube

Last updated