Comment on page

sendToGuardianBlock

1. Properties

Block Property
Definition
Example Input
Status
type
A type of the block which can save a new or updated document.
sendToGuardianBlock (Can't be changed).
tag
Unique name for the logic block.
save_new_approved_document.
permissions
Which entity has rights to interact at this part of the workflow.
Standard Registry.
defaultActive
Shows whether this block is active at this time and whether it needs to be shown.
Checked or unchecked.
entityType
Gives the document a label in the DB. Needed for filtering.
Installer.
forceNewDocument
Need to fill this out.
Checked or Unchecked.
Removed
stop Propagation
End processing here, don't pass control to the next block.
Checked or Unchecked.
options
List of attributes, which is added to the VC when it is being persistent. Can be used for more flexible filtration.
"name": "status"
"value": "Minted",
dataSource
Where to send Data
Database / Hedera / Hedera Topic / Auto
documentType
Type of Document
VC / DID / VP
topic
Topic to send a document if 'dataSource' = 'Hedera'
topic
topicOwner
if ‘Hedera Topic’ is selected for the ‘Source Type’ a new optional property ‘Topic Owner’ appears which shows which field determines the User, who will own the topic of the document. This is because in ‘Hedera Topic’ only the template of Topic is selected, not the the topic itself.
Current User - user whose credentials were used to make the current post request
Document Owner - creator of the document (has default value)
Document Issuer - user which was the last to sign the document
Memo
if 'Data Source' is Hedera topic, this field is enabled. This is used to customize the Memo field name
example memo ${document.id}
skipSaveState
Allows to skip save document state to prevent display the state in history. This property is visible only when block has Data Source : “Database” or “Auto”.
Checked or Unchecked
Note:
Force New Document’ option has been removed as its usage resulted in the duplicate documents (with the same hashes) polluting the storage and causing confusion in the links (when building trust chain). For the cases when a new document needs to be created on the basis of the old one please use ’reassigningBlock’ which would create new proof and as result new document with the equivalent content but with a new hash.

2. Auto Property:

This option applied in most cases. When Auto is selected the system applies the following logic:
1. If the hash of the new document (being saved) is different from the hash of the document then it is based on the message is sent to Hedera into the Policy Instance Topic.
2. If the database contains another document with the same hash it gets refreshed, otherwise a new document is created in the database.
RefreshEvents are used to refreshing the UI, instead of "dependencies" property.

Events

Property Name
Name in JSON
Property Value
Value in JSON
Description
Event Type
-
Input Event
Output Event
-
Type of the event - determines whether this is ingress or egress event for the current block.
Source
"source"
Block tag(string)
"block_tag"
The block which initiates the event.
Target
"target"
Block tag(string)
"block_tag"
The block which receives the event.
Output Event
"output"
Event name(string)
"event_name"
Action or issue that caused the event.
Input Event
"input"
Event name(string)
"event_name"
Action which will be triggered by the event.
Event Actor
"actor"
Event Initiator
Document Owner
Document Issuer
""
"owner"
"issuer"
Allows to transfer control of the block (execution context) to another user. Empty field leaves control at the Event Initiator.
Disabled
"disabled"
True/False
true/false
Allows to disable the event without deleting it.
To know more information about events, please look at Events.