"name": "status"
"value": "Minted",
| | `documentType` | Type of Document | VC/VP/DID | | `topic` | Specifies Topic Name | topic | | `actor` | Specifies a person, who will be next Owner | Owner/Policy Owner | | `issuer` | Specifies a person, who will be Signer | owner / Policy Owner | | `onlyOwnDocuments` | Specifies whether a block applies to only those documents owned by the role specified in `permissions` | `true` or `false` | | `ViewHistory` | Specifies documents in the Grid with status timeline | `true` or `false` | | `on errors` | Specifies if the error has occurred in the Block | Retry/Go to step/Go to tag | | `onlyAssignDocuments` | Specifies which VC should be assigned to the user | `true` or `false` | # Policy Creation Policy creation in Hedera Guardian is the foundation for digitizing sustainability standards. It transforms rules into automated, transparent workflows, ensuring trust, compliance, and scalability in environmental asset management. **Importance of Policy Creation** 1. **Standardization of Methodologies** * Digitizes environmental standards into consistent, enforceable rules. * Ensures all participants follow the same verified process. 2. **Transparency & Trust** * Anchors policy actions (VCs, approvals, tokens) to Hedera. * Creates an immutable, auditable trail of activities. 3. **Automation of Workflows** * Replaces manual verification with automated checks and triggers. * Reduces errors, costs, and administrative overhead. 4. **Interoperability** * Policies use W3C-compliant VCs and schemas, enabling global compatibility across registries, standards bodies, and marketplaces. 5. **Flexibility & Governance** * Supports versioning for methodology updates. * Allows controlled deprecation of outdated policies. 6. **Scalability** * Enables large-scale deployment of sustainability projects (thousands of projects under a single policy template). 7. **Regulatory Compliance** * Encodes the requirements of standards bodies into enforceable workflows. * Provides verifiable proof of compliance for audits and reporting. # Policy Configurator The Policy Configurator is the visual editing environment in which a Standard Registry builds and maintains a policy – the executable definition of a methodology, made up of blocks, roles, schemas, tokens, and the events that connect them. ## The Problem It Solves A Guardian policy is ultimately a single large JSON configuration. Written by hand, that configuration is unforgiving: block tags must be unique, events must reference blocks that exist, every form block must point at a valid schema, and every mint block at a valid token. A misspelled tag or an orphaned event is not visible until the policy is run, and by then the failure surfaces as a broken workflow rather than an obvious typo. The Configurator removes that class of error from the authoring process. It presents the policy as a navigable tree instead of nested braces, offers only the property values that are valid in context, and validates the whole configuration on demand – so structural mistakes are caught while editing rather than during a project's first submission. It also solves a collaboration problem. Methodology experts, not developers, own the rules being digitized. A visual editor lets them read, review, and adjust a policy without reading JSON, while still producing exactly the same artifact a developer would. ## How It Works The Configurator is opened from a policy in **Draft** status and edits that draft in place. Nothing is published to Hedera while editing; the draft is a working copy that can be revised freely until it is dry-run or published. **A policy is a tree of blocks.** Every policy starts from a single container block and nests other blocks inside it. Each block has a type that determines what it does – rendering a form, requesting a signature, minting a token, calling an external service – and a set of properties that configure that behavior. The Configurator shows this hierarchy in the tree panel on the left; selecting a block loads its properties into the panel on the right. **Blocks are addressed by tag.** Each block carries a tag that is unique within the policy. Tags are how blocks refer to each other: an event that moves a document from one step to the next names its source and target by tag, not by position in the tree. This is why moving a block within the tree does not break the workflow, and why renaming a tag does. **Events connect blocks into a workflow.** The tree describes containment; events describe flow. An event fires when something happens in one block – a document is approved, a form is submitted, a timer elapses – and triggers an action in another. Together, the tree and the event graph are what turn a set of blocks into a working process. **The same policy has three representations.** The Configurator can display the policy as a **tree**, as **JSON**, or as **YAML**, and switching between them converts the current state rather than opening a different document. The tree is the primary editing surface; the text views exist for bulk edits, diffing, and copying configuration between policies. An edit made in any view is an edit to the same underlying configuration. **Reusable parts come from modules and tools.** Alongside blocks, the Configurator exposes modules and tools – self-contained fragments of policy logic that can be dropped into a policy and edited as a unit. Tools are published and versioned independently, so a policy can adopt a shared, already-validated piece of logic instead of duplicating it. **Validation is explicit.** The Configurator can validate the entire configuration and report problems against the specific blocks that caused them. A policy that fails validation can still be saved as a draft; it cannot be meaningfully run. **Editing ends at dry run or publish.** A dry run executes the policy in an isolated environment with virtual users and no Hedera transactions, so the workflow can be exercised before it becomes permanent. Publishing releases a numbered version of the policy to the public domain, at which point the configuration is frozen – further changes require a new version. ## Key Distinctions **Policy Configurator vs. Policy Wizard.** The Wizard asks a series of questions and generates a policy configuration from the answers. It is a starting point that produces a conventional structure quickly, and its output is an ordinary draft policy. The Configurator is where that draft – or any other policy – is refined, extended, and maintained. The Wizard creates; the Configurator edits. **Policy Configurator vs. the Policy APIs.** The APIs read and write the same policy configuration programmatically, and are the right tool for automation, CI pipelines, and migrations. The Configurator is the interactive equivalent, aimed at authoring and review rather than repeatable scripted changes. **Configuring a policy vs. running one.** The Configurator defines what a policy will do. Executing it – registering users, submitting documents, minting tokens – happens in the policy's own interface once it is dry-run or published, and is not part of the Configurator. ## Related * [Creating a Policy through Policy Configurator](/guardian/tutorials/creating-a-policy-through-policy-configurator) – step-by-step construction of a policy in the editor * [Getting Started with the Policy Workflows](/guardian/tutorials/creating-a-policy-through-policy-configurator/getting-started-with-the-policy-workflows) – the first blocks of a working policy * [Available Policy Workflow Blocks](/guardian/workspace/policies/policy-creation/introduction) – the specification for every block type and its properties # Available Policy Workflow Blocks Starting with the [Wikipedia definition](https://en.wikipedia.org/wiki/Workflow_engine), a Policy Workflow Engine (PWE) is a software application that manages business processes based on business rules and business data which are defined within the context of a specific policy. A PWE, therefore, manages and monitors the state of required policy actions and the required information flow in a policy grouped into a policy workflow, and determines which are the next policy actions based on the state of a policy workflow. The policy actions may be anything from saving an application form in a document management system to sending a reminder e-mail to users or escalating overdue items to management. Policy Workflow Blocks enable different business logic to exist within the Guardian’s PWE. ### Available Policy Workflows Blocks| Block | Definition | Documentation Link |
|---|---|---|
| InterfaceContainerBlock | A block which contains and organizes other blocks. | InterfaceContainerBlock |
| PolicyRolesBlock | A block which determines a role for the user. | PolicyRolesBlock |
| InterfaceStepBlock | Similar to the InterfaceContainerBlock, with the difference that it can only render a single child element. | InterfaceStepBlock |
| requestVCDocumentBlock | A type of the block which creates a form from the schema, and sends the document to the server. | requestVCDocumentBlock |
| sendToGuardianBlock | A type of the block which can save a new or updated document. | sendToGuardianBlock |
| reassigningBlock | A type of block which re-signs the document and change the user to document owner. | reassigningBlock |
| InformationBlock | A block type which can display a notification or a progress bar. | InformationBlock |
| InterfaceDocumentsSourceBlock | A block type which outputs information from the DB as grid. | InterfaceDocumentsSourceBlock |
| paginationAddon | A block type which adds pagination to the InterfaceDocumentSourceBlock if added | paginationAddon |
| DocumentsSourceAddOn | A type of block for searching VC as grid | DocumentsSourceAddOn |
| filtersAddOn | A child block for 'DocumentsSourceAddon'. Contains additional dynamic filters | filtersAddOn |
| InterfaceActionBlock | A block to create custom actions. | InterfaceActionBlock |
| externalDataBlock | Receives data from the external source and passes them over the the next block. | externalDataBlock |
| retirementDocumentBlock | Receives the VC from the previous block and retires based on the rule(s). | retirementDocumentBlock |
| calculateContainerBlock & calculateMathAddonBlock | The blocks to calculate. calculateContainerBlock: Receives VC from the previous block. Passes the new VC to the next block. calculateMathOnBlock: Child block for 'calculateContainerBlock'. Contains descriptions of variables and formulas. | calculateContainerBlock & calculateMathAddonBlock |
| reportBlock | The block container for TrustChain. | reportBlock & reportItemBlock |
| reportItemBlock | The block for setting up the elements of the TrustChain. | reportBlock & reportItemBlock |
| Switch Block | This block transfers execution to one or more blocks depending on the parameters | switchBlock |
| timerBlock | timer object which triggers the event | TimerBlock |
| aggregateDocumentBlock | block responsible for aggregation of the documents | aggregateDocumentBlock |
| revocationBlock | This Block finds related messages in policy topics, and revokes those messages and sends it to Hedera topic, but it doesn’t save documents in DB | revocationBlock |
| setRelationshipsBlock | Contains DocumentSourceAddOn Block and set relationships for input document. | setRelationshipBlock |
| buttonBlock | Block responsible for creating buttons | buttonBlock |
| documentValidatorBlock | Block to validate documents, including linked documents | documentValidatorBlock |
| tokenActionBlock | Block is responsible to automation actions related to tokens | tokenActionBlock |
| tokenConfirmationBlock | Block enables the owner of the private key for the account to manually perform operations with the token | tokenConfirmationBlock |
| mintDocumentBlock | Block is responsible for adding configurations on calculating the amount of tokens to be minted. | mintDocumentBlock |
| groupManagerBlock | Block allows to manage group membership, add and remove users from the group. | groupManagerBlock |
| multiSignBlock | This block provides a way to specify multiple signators for a single VC document, and then create a VP based on it. | multiSignBlock |
| customLogicBlock | This block is used to perform Logic | customLogicBlock |
| splitBlock | This block allows to accumulate VC documents and produce new VCs in fixed chunks | splitBlock |
| wipeDocumentBlock | This block is used to wipe the Token | wipeDocumentBlock |
| CreateTokenBlock | This block is used to create Token template | CreateTokenBlock |
| impactAddon | This is an addon to create token impacts | impactAddon |
| Http Request Block | This block is used to retrieve outside data | HttpRequestBlock |
| historyAddon | This block turn on history on interfaceDocumentsSourceBlock. | historyAddon |
| selectiveAttributes Block | This block will filter attributes (option field) in documents returned by documentsSourceAddon. | selectiveAttributesBlock |
| tagsManagerBlock | This block is responsible for managing tags in policies. | tagsManagerBlock |
| externalTopicBlock | This block allows to configure the link to Hedera topics established by other policy instances for monitoring of ‘document published’ messages and ingestion of the targeted VC documents. | externalTopicBlock |
| messagesReportBlock | This block allows to create report based on the inter-referenced messages. | messagesReportBlock |
| notificationBlock | This block is used to generate notifications | notificationBlock |
| extractDataBlock | This block extractDataBlock provides means to extract a data set which corresponds to any of these embedded schemas (at any depth level) | extractDataBlock |
| button block Addon | This block is used to display interactive buttons | buttonBlockAddon |
| Dropdown Block Addon | The block is to display an interactive dropdown menu | dropdownBlockAddon |
| RequestVC Document Block Addon | This block is to display an interactive button in the interfaceDocumentsSourceBlock. | requestVcDocumentBlockAddon |
| Data Transformation Addon | This block is to produce a transformed result based on the data from the source and filters blocks | Data Transformation Addon |
| IntegrationButtonBlock | This block enable interaction with third-party data providers | IntegrationButton |
| Global Events Reader Block | This block subscribes to global topics and routes incoming events into policy branches | |
| Global Events Writer Block | This block publishes document references to one or more global Hedera topics | |
| mathBlock | This block defines calculations on document data in mathematical notation | MathBlock |
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](/guardian/workspace/policies/policy-creation/introduction/events) ### API Parameters `GET` `/policies/{policyID}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyID\* | String | Policy ID | | uuid\* | String | block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "uiMetaData": { "type": "blank" }, "id": "27c9f288-c4b4-4690-b3b9-9843cc90129f", "blockType": "interfaceContainerBlock", } ``` {% endtab %} {% endtabs %} # PolicyRolesBlock This block allows the user to select a role or a group. ### Properties | Block Property | Definition | Example Input | Status | | ----------------- | --------------------------------------------------------------------------------- | ----------------------------------------------- | ------ | | type | A block which determines a role for the user. | **PolicyRolesBlock** (Can't be changed). | | | tag | Unique name for the logic block. | choose\_role. | | | permissions | Which entity has rights to interact at this part of the workflow. | Installer. | | | defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | | | roles | Available roles from which the user can choose. | Select the appropriate roles from the dropdown. | | | Available Roles | list of roles for selected user | Checked or unchecked. | | | ·Available Groups | list of groups for selected user | Checked or unchecked. | | {% hint style="info" %} **Note: ‘*****Available Groups*****’** option takes priority and thus, when set, causes the system to ignore **‘*****Available Roles*****’**. {% endhint %} {% hint style="info" %} **Note:** Setting the Permissions property to ‘**No Role’** limits the visibility of this block to those users which have not yet selected a role or a group. {% endhint %} {% hint style="info" %} RefreshEvents are used to refreshing the UI, instead of "dependencies" property. {% endhint %} ### UI Properties | UI Property | Definition | | ----------- | -------------------------------------------- | | Title | Provide the a title for the role selector. | | Description | Provide a description on the role selection. | ### 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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | PolicyID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "roles": [], "groups": [ "VVBs", "Project_Proponent" ], "groupMap": { "VVBs": { "groupAccessType": "Private", "groupRelationshipType": "Multiple" }, "Project_Proponent": { "groupAccessType": "Private", "groupRelationshipType": "Single" } }, "isMultipleGroups": true, "uiMetaData": { "title": "Roles", "description": "Choose Roles" } } ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | #### Request Body | Name | Type | Description | | -------------------------------------- | ------ | ----------- | | role\* | String | | | invitation | String | Invite Code | | Group | String | Group Name | # InterfaceStepBlock ### Properties | Block Property | Definition | Example Input | Status | | -------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ------ | | type | Similar to the **InterfaceContainer**Block, with the difference that it can only render a single child element. | **InterfaceStepBlock** (Can't be changed). | | | tag | Unique name for the logic block. | CSD01 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. | | | cyclic | Go back one step to enable the creation of the previous object. | Checked or unchecked. | | {% hint style="info" %} RefreshEvents are used to refreshing the UI, instead of "dependencies" property. {% endhint %} ### 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) | The block which initiates the event. | | | Target | "target" | Block tag(string) | The block which receives the event. | | | Output Event | "output" | Event name(string) | Action or issue that caused the event. | | | Input Event | "input" | Event name(string) | Action which will be triggered by the event. | | | Event Actor | "actor" |Event Initiator
Document Owner
Document 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 | Allows to disable the event without deleting it. | | To know more information about events, please look at [Events](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "uiMetaData": { "type": "blank" }, "index": 8, "id": "92fdc241-da15-46cb-9153-d223aeb61c5a", "blockType": "interfaceStepBlock", "blocks": [ null, null, null, null, null, null, null, null, { "uiMetaData": { "type": "tabs" }, "content": "interfaceContainerBlock", "blockType": "interfaceContainerBlock", "id": "768d5fae-a907-4566-aa87-62f6929a03c7" }, null, null, null, null, null ] } ``` {% endtab %} {% endtabs %} # requestVCDocumentBlock ### Properties | Block Property | Definition | Example Input | Status | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------ | | type | A type of the block which receives data in the format of a ‘credential subject’ part of a VC Document | **requestVCDocumentBlock** (Can't be changed). | | | tag | Unique name for the logic block. | add\_new\_installer\_request. | | | 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. | | | schema | Pre-configured schemas for the document relevant for policy action requests. Technically, it's the uuid of the schema, which will be used to build the form. | IRec-Application-Details (to be selected from the drop down of available schemas in your Guardian instance). | | | ID Type | Select the type of ID that is populated in the ID field of the Verifiable Credential document. | Current Options are: DID (creates a new DID), UUID (creates a new UUID), and Owner (which uses the DID of the current user). | | | stop propagation | End processing here, don't pass control to the next block. | Checked or Unchecked. | | {% hint style="info" %} RefreshEvents are used to refreshing the UI, instead of "dependencies" property. {% endhint %} ### UI Properties | UI Property | Definition | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Type | Style of the render of the form. It can be either a Page (the form is rendered as a page) or Dialogue (displays a button, which opens a dialogue with the form when clicked). | | Title | Provides the Page or Dialogue box a title. | | Description | Provides the Page or Dialogue box a description. | | hideWhenDiscontinued | Check if the button should be hidden when policy is discontinued | | Button Content | Text to fill inside a button. Needs the Dialogue box to be selected from the "Type." | | Dialogue Text | Provides a tile inside the Dialogue box. Needs the dialogue box to be selected from the "Type." | | Dialogue Description | Provides a description inside the Dialogue box. Needs the dialogue box to be selected from the "Type." | ### 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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | uuid\* | String | Block ID | | policyId\* | String | Policy ID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "id": "ef2a7742-68d4-407f-ada7-14cdce80e24d", "blockType": "requestVcDocumentBlock", "schema": { "userDID": null, "_id": "63da04dd9670adb07f82b090", "id": "63da04dd9670adb07f82b090", "uuid": "6235abf8-6b48-4212-9ecc-c82bdf90405e", "hash": "", "name": "I-REC Facility & Device Reg", "description": "I-REC Facility & Device Reg", "entity": "VC", "status": "DRAFT", "readonly": false, "system": false, "active": false, "version": "", "creator": "did:hedera:testnet:9jShvNUsztLFbvEK442VPfkccLYW3F2oU3e6rCHzr7FT_0.0.3075949", "owner": "did:hedera:testnet:9jShvNUsztLFbvEK442VPfkccLYW3F2oU3e6rCHzr7FT_0.0.3075949", "topicId": "0.0.3120995", "messageId": "", "documentURL": "", "contextURL": "", "iri": "#6235abf8-6b48-4212-9ecc-c82bdf90405e", "document": { "$id": "#6235abf8-6b48-4212-9ecc-c82bdf90405e", "$comment": "{ \"@id\": \"#6235abf8-6b48-4212-9ecc-c82bdf90405e\", \"term\": \"6235abf8-6b48-4212-9ecc-c82bdf90405e\" }", "title": "I-REC Facility & Device Reg", "description": "I-REC Facility & Device Reg", "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "readOnly": true }, "id": { "type": "string", "readOnly": true }, "field0": { "title": "Registrant Id", "description": "Registrant Id", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":0}" }, "policyId": { "title": "policyId", "description": "policyId", "readOnly": true, "type": "string", "$comment": "{\"term\":\"policyId\",\"@id\":\"https://www.schema.org/text\"}" }, "ref": { "title": "ref", "description": "ref", "readOnly": true, "type": "string", "$comment": "{\"term\":\"ref\",\"@id\":\"https://www.schema.org/text\"}" }, "field1": { "title": "Date", "description": "Date", "readOnly": false, "type": "string", "format": "date", "$comment": "{\"term\":\"field1\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":1}" }, "field2": { "title": "Is the Registrant also the owner of the Device? (provide evidence) ", "description": "Is the Registrant also the owner of the Device? (provide evidence) ", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field2\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":2}" }, "field3": { "title": "Registrant Details", "description": "Registrant Details", "readOnly": false, "$ref": "#dee7e78b-44b8-4bb0-8be0-3a86bde752b2", "$comment": "{\"term\":\"field3\",\"@id\":\"#dee7e78b-44b8-4bb0-8be0-3a86bde752b2\",\"orderPosition\":3}" }, "field4": { "title": "Production Device Details", "description": "Production Device Details", "readOnly": false, "$ref": "#b61a05c6-bb1a-4d7e-9299-c0932d8c0306", "$comment": "{\"term\":\"field4\",\"@id\":\"#b61a05c6-bb1a-4d7e-9299-c0932d8c0306\",\"orderPosition\":4}" }, "field5": { "title": "Energy Sources", "description": "Energy Sources", "readOnly": false, "$ref": "#899e042e-dc62-4849-95dc-b982af558e6c", "$comment": "{\"term\":\"field5\",\"@id\":\"#899e042e-dc62-4849-95dc-b982af558e6c\",\"orderPosition\":5}" } }, "required": [ "@context", "type", "policyId", "field3", "field4", "field5" ], "additionalProperties": false, "$defs": { "#dee7e78b-44b8-4bb0-8be0-3a86bde752b2": { "$id": "#dee7e78b-44b8-4bb0-8be0-3a86bde752b2", "$comment": "{ \"@id\": \"#dee7e78b-44b8-4bb0-8be0-3a86bde752b2\", \"term\": \"dee7e78b-44b8-4bb0-8be0-3a86bde752b2\" }", "title": "Contact Details", "description": "Contact Details", "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "readOnly": true }, "type": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "readOnly": true }, "id": { "type": "string", "readOnly": true }, "field0": { "title": "Organization Name", "description": "Organization Name", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":0}" }, "field1": { "title": "Address line 1", "description": "Address line 1", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field1\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":1}" }, "field2": { "title": "Address line 2", "description": "Address line 2", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field2\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":2}" }, "field3": { "title": "Address line 3", "description": "Address line 3", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field3\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":3}" }, "field4": { "title": "Postal code", "description": "Postal code", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field4\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":4}" }, "field5": { "title": "Country", "description": "Country", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field5\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":5}" }, "field6": { "title": "Contact person", "description": "Contact person", "readOnly": false, "type": "string", "$comment": "{\"term\":\"field6\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":6}" ..... ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Request Body | Name | Type | Description | | ------------------------------------------ | ------ | ------------------ | | document\* | Object | Credential Subject | | ref | String | ID of linked VC | # 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. | | | 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 Topic / Auto | | | documentType | Type of Document | VC / DID / VP | | | topic | Topic to send a document if 'dataSource' = 'Hedera Topic' | 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 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 | | {% hint style="info" %} **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. {% endhint %} ### 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. {% hint style="info" %} RefreshEvents are used to refreshing the UI, instead of "dependencies" property. {% endhint %} ### 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](/guardian/workspace/policies/policy-creation/introduction/events). # reassigningBlock ### Properties| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| type | A block type which re-signs the document and change the user to document owner. | reassigningBlock (Can't be changed). | |
| tag | Unique name for the logic block. | wait_for_approval. | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dependencies | Establish workflow dependencies that need to be completed prior. | Select the appropriate block from the dropdown. | Deprecated |
| stop Propagation | End processing here, don't pass control to the next block. | Checked or Unchecked. | |
| issuer | Person, who will be a Signer | not set - Current User owner - document Owner policyOwner - Policy Owner | |
| actor | Person, who will be next Block Owner | not set - Current User owner - document Owner issuer - document Issuer |
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](/guardian/workspace/policies/policy-creation/introduction/events). # InformationBlock ### Properties| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| type | A block type which can display a notification or a progress bar. | InformationBlock (Can't be changed). | |
| tag | Unique name for the logic block. | wait_for_approval. | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dependencies | Establish workflow dependencies that need to be completed prior. | Select the appropriate block from the dropdown. | Deprecated |
| stop Propagation | End processing here, don't pass control to the next block. | Checked or Unchecked. |
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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "uiMetaData": { "description": "The page will refresh automatically once the application is approved.", "type": "text", "title": "Submitted for Approval" } } ``` {% endtab %} {% endtabs %} # InterfaceDocumentsSourceBlock ### Properties| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| type | A block type which outputs information from the DB as grid. | InterfaceDocumentsSource Block (Can't be changed). | |
| tag | Unique name for the logic block. | sensors_grid. | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dataType | Specify the table to request the data from. | Current options are: Verifiable Credential, DID, Approve, or Hedera. |
| UI Property | Definition |
|---|---|
| Title | Type of the displayed value, possible options. Current options are: TEXT (ordinary text), BUTTON (a button), or BLOCK (a block embedded into the column). |
| Enable common sorting |
|
| Field Name | Object fields to retrieve the values from. Internal fields are separated by ".", access to array elements is via index. This is the field name. |
| Field Type | Current Options: TEXT, BUTTON, AND BLOCK. |
| Field Title | Title of the column. |
| Field Tooltip | Provide a tooltip for the field. |
| Field Cell Content | Content inside the cell. |
| Field UI Class | Arbitrary Class |
| Width | For example : 100px |
| Bind Group | If interfaceDocumentsSourceBlock has more than one documentsSourceAddon, then you can create different columns for each (names must be the same) |
| Bind Block | Specifying a "bindBlock" field would result in the display of the linked block in side the dialog.. Needs for the field type to be a BLOCK or BUTTON with the Action type as DIALOGUE. |
| Action | Needs for the field type to be a BUTTON. Specifies what action will happen when the button is clicked. Action options are currently: LINK to a URL or prompt a DIALOGUE box. |
| Dialogue Type | Currently only json type is supported. Needs for the field type to be a BUTTON and Action to be DIALOGUE. |
| Dialogue Content | Provide content for the dialogue box. Needs for the field type to be a BUTTON and Action to be DIALOGUE. |
| Dialogue Class | Dialog style. Needs for the field type to be a BUTTON and Action to be DIALOGUE. |
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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ``` { "data": [ { "_id": "63da084ddb84efbb04da4588", "dryRunId": "63da04e19670adb07f82b092", "dryRunClass": "VcDocumentCollection", "owner": "did:hedera:testnet:7Vn2KdgTZG2DZkz1x3naEJfazEACCEZGBkGLeUwrh45C_0.0.3075949", "hash": "29yk1PWG8h8euDCKFRcV9GXeXGCxhipyjaEnTaEw8wb9", "document": { "id": "urn:uuid:bd06ea41-9037-4294-b13d-f868563e30f1", "type": [ "VerifiableCredential" ], "issuer": "did:hedera:testnet:7Vn2KdgTZG2DZkz1x3naEJfazEACCEZGBkGLeUwrh45C_0.0.3075949", "issuanceDate": "2023-02-01T06:35:57.132Z", "@context": [ "https://www.w3.org/2018/credentials/v1" ], "credentialSubject": [ { "field1": { "type": "bf7109c2-6ff4-47bb-a39d-02a0f11574b0", "@context": [] }, "field2": { "type": "dee7e78b-44b8-4bb0-8be0-3a86bde752b2", "@context": [] }, "field3": { "type": "86f9436f-82fd-48ce-bce8-37a5130263b0", "@context": [] }, "policyId": "63da04e19670adb07f82b092", "@context": [ "schema#f6ab05cd-95a6-4465-8b3a-e1e87375fef9" ], "id": "did:hedera:testnet:7Vn2KdgTZG2DZkz1x3naEJfazEACCEZGBkGLeUwrh45C_0.0.3075949", "type": "f6ab05cd-95a6-4465-8b3a-e1e87375fef9" } ], "proof": { "type": "Ed25519Signature2018", "created": "2023-02-01T06:35:57Z", "verificationMethod": "did:hedera:testnet:7Vn2KdgTZG2DZkz1x3naEJfazEACCEZGBkGLeUwrh45C_0.0.3075949#did-root-key", "proofPurpose": "assertionMethod", "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..XUDlrhjJkXHgOIKVdGZETi3koGVRJM2elk70XKzRmCxVL8OyMEfhVyEz9c2z4L7I00dlH0nrZKoirtOdp0puAA" } }, "createDate": "2023-02-01T06:35:57.508Z", "updateDate": "2023-02-01T06:35:57.508Z", "created": "2023-02-01T06:35:57.508Z", "updated": "2023-02-01T06:35:57.508Z", "status": "NEW", "signature": 0, "type": "registrant", "policyId": "63da04e19670adb07f82b092", "tag": "create_application(db)", "messageId": "1675.233357483", "topicId": "0.0.1675233357271", "relationships": null, "option": { "status": "Waiting for approval" }, "comment": null, "assignedTo": null, "assignedToGroup": null, "hederaStatus": "ISSUE", "schema": "#f6ab05cd-95a6-4465-8b3a-e1e87375fef9", "accounts": { "default": "0.0.1675233350065" }, "tokens": null, "uuid": "801f790a-404c-4869-ae1b-4e5fe1146783", "entity": "NONE", "iri": "801f790a-404c-4869-ae1b-4e5fe1146783", "readonly": false, "system": false, "active": false, "codeVersion": "1.0.0", "group": "8e58d3eb-9af5-4705-a9b3- ..... ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | #### Request Body | Name | Type | Description | | -------------- | ------ | ------------------------ | | orderDirection | String | Order Direction ASC,DESC | | orderField | String | Order Field Path | ### Path Parameters for Pagination and Filtration #### With Child Blocks InterfaceDocumentsSourceBlock can accept and pass-on query parameters to the child pagination and filtration add-ons. **Pagination** | Name | Type | | ------------ | ------ | | itemsPerPage | Number | | page | Number | **Filtration** | Name | Type | Description | | ----- | ------ | ----------------------------------------- | | key | Number | ID or a tag of the filtration add-ons | | Value | String | the filtervalue for the Filtration add-on | **Example:** ``` /api/v1/policies/| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| type | A block for searching VC, for grid | DocumentsSourceAddOn Block (Can't be changed). | |
| tag | Unique name for the logic block. | approved_documents_grid_source | |
| permissions | Which entity has rights to interact at this part of the workflow. | Installer. | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| dependencies | Automatic update. The block is automatically re-rendered if any of the linked components gets updated. | Select the appropriate block from the dropdown. | |
| Data Type | Specify the table to request the data from. | Current options are: Verifiable Credential, DID, Approve, or Hedera. | |
| Schema | Filters the VC according to the selected scheme | iRec Application Details (1.0.0) PUBLISHED | |
| onlyOwnDocuments | When checked, filter out only VCs created by the user | checked or unchecked | |
| onlyAssignDocuments | When checked, it filter only VCs assigned to the user | checked or unchecked | |
| Order Field | name of the field | Source | |
| Order Direction | Ascending or Descending direction of the order | ASC/DESC |
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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "id": "448ff538-1c3b-45eb-a310-9414ae223b81", "blockType": "interfaceActionBlock", "type": "dropdown", "uiMetaData": { "options": [], "content": "VVB" }, "name": "document.credentialSubject.0.field0", "value": "group", "field": "assignedToGroup", "options": [ { "name": "1", "value": "6b3efd88-037c-4335-a4d1-02776e23973c" } ] } ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | #### Request Body | Name | Type | Description | | ------------------------------------------ | ---- | ----------- | | document\* | VC | VC Document | # externalDataBlock ### Properties | Block Property | Definition | Example Input | Status | | -------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | ------ | | type | Receives data from the external source and passes them over the the next block. | **externalDataBlock** (Can't be changed). | | | tag | Unique name for the logic block. | mrv\_source. | | | permissions | Which entity has rights to interact at this part of the workflow. | Installer. | | | defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | | | entityType | Specify the type of Entity this workflow block is for. | MRV. | | | schema | Pre-configured schemas relevant for download to be selected from the drop down of available schemas in your Guardian instance. | MRV. | | ### 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](/guardian/workspace/policies/policy-creation/introduction/events). # retirementDocumentBlock ### Properties | Block Property | Definition | Example Input | Status | | ---------------- | --------------------------------------------------------------------------------- | ---------------------------------------------- | ------ | | type | Receives the VC from the previous block and retires based on the rule(s). | **retirementDocumentBlock**(Can't be changed). | | | tag | Unique name for the logic block. | retire\_token. | | | 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. | | | stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | | ### UI Properties | UI Property | Definition | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Token | Select which token to retire. The token must exist in the Guardian instance. | | Rule | Rules under which the number of tokens is calculated. Math operations are supported, e.g. the following will result in 20 tokens: data = { amount: 2 } rule = "amount \* 10" | ### 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](/guardian/workspace/policies/policy-creation/introduction/events). # calculateContainerBlock & calculateMathAddOnBlock ## calculateContainerBlock This Block accepts source VC as input and generates output as new VC document. ### Input Parameters: #### inputSchema : source VC schema #### inputFields : array of variables which would be taken from the source VC. | Variable | Definition | Example of Input | | -------- | ---------------------------------------- | ---------------- | | name | Refer to the specified field value | field0 | | title | Title of the operation | Summary | | value | Variable to store the value of the field | E0 | ``` "inputFields": [ { "name": "field0", "title": "Summary", "value": "E0" }, ] ``` New variable "E0" would be created with a value set to one from the "field0" in the VC document. {% hint style="info" %} "title" is not a mandatory parameter. The value is set automatically as per the user convenience. {% endhint %} ### Output Parameters #### outputSchema : output VC schema #### outputFields : array of variables of output VC, which will be the field with the values from the variables. | Variable | Definition | Example of Input | | -------- | ----------------------------------------- | ---------------- | | name | Variable that refers to specified field | field0 | | title | Title of the operation | Summary | | value | Points to the value of specified variable | E1 | ``` outputFields: [ { "name": "field0", "title": "Summary", "value": "E1" } ] ``` The output variable "field0" will contain the value from the variable "E1". {% hint style="info" %} "title" is not a mandatory parameter. The value is set automatically as per the user convenience. {% endhint %} ## calculateMathAddonBlock This Block performs mathematical calculations sequentially. #### equations : array of formulas. ``` "equations": [ { "variable": "E1", "formula": "E0*10" } ] ``` When above code is executed, a new variable, "E1" will be created which would contain the value of the calculation "E0\*10". {% hint style="info" %} Note: All the expressions available in [Math.js](https://mathjs.org/docs/) are supported by calculateMathAddOnBlock. {% endhint %}| Operator | Name | Syntax | Associativity | Example | Result |
|---|---|---|---|---|---|
(, ) | Grouping | (x) | None | 2 * (3 + 4) | 14 |
[, ] | Matrix, Index | [...] | None | [[1,2],[3,4]] | [[1,2],[3,4]] |
{, } | Object | {...} | None | {a: 1, b: 2} | {a: 1, b: 2} |
, | Parameter separator | x, y | Left to right | max(2, 1, 5) | 5 |
. | Property accessor | obj.prop | Left to right | obj={a: 12}; obj.a | 12 |
; | Statement separator | x; y | Left to right | a=2; b=3; a*b | [6] |
; | Row separator | [x; y] | Left to right | [1,2;3,4] | [[1,2],[3,4]] |
| Statement separator | x \n y | Left to right | a=2 \n b=3 \n a*b | [2,3,6] | |
+ | Add | x + y | Left to right | 4 + 5 | 9 |
+ | Unary plus | +y | Right to left | +4 | 4 |
- | Subtract | x - y | Left to right | 7 - 3 | 4 |
- | Unary minus | -y | Right to left | -4 | -4 |
* | Multiply | x * y | Left to right | 2 * 3 | 6 |
.* | Element-wise multiply | x .* y | Left to right | [1,2,3] .* [1,2,3] | [1,4,9] |
/ | Divide | x / y | Left to right | 6 / 2 | 3 |
./ | Element-wise divide | x ./ y | Left to right | [9,6,4] ./ [3,2,2] | [3,3,2] |
% | Percentage | x% | None | 8% | 0.08 |
% | Addition with Percentage | x + y% | Left to right | 100 + 3% | 103 |
% | Subtraction with Percentage | x - y% | Left to right | 100 - 3% | 97 |
% mod | Modulus | x % y | Left to right | 8 % 3 | 2 |
^ | Power | x ^ y | Right to left | 2 ^ 3 | 8 |
.^ | Element-wise power | x .^ y | Right to left | [2,3] .^ [3,3] | [8,27] |
' | Transpose | y' | Left to right | [[1,2],[3,4]]' | [[1,3],[2,4]] |
! | Factorial | y! | Left to right | 5! | 120 |
& | Bitwise and | x & y | Left to right | 5 & 3 | 1 |
~ | Bitwise not | ~x | Right to left | ~2 | -3 |
| | Bitwise or | x | y | Left to right | 5 | 3 | 7 |
^| | Bitwise xor | x ^| y | Left to right | 5 ^| 2 | 7 |
<< | Left shift | x << y | Left to right | 4 << 1 | 8 |
>> | Right arithmetic shift | x >> y | Left to right | 8 >> 1 | 4 |
>>> | Right logical shift | x >>> y | Left to right | -8 >>> 1 | 2147483644 |
and | Logical and | x and y | Left to right | true and false | false |
not | Logical not | not y | Right to left | not true | false |
or | Logical or | x or y | Left to right | true or false | true |
xor | Logical xor | x xor y | Left to right | true xor true | false |
= | Assignment | x = y | Right to left | a = 5 | 5 |
? : | Conditional expression | x ? y : z | Right to left | 15 > 100 ? 1 : -1 | -1 |
: | Range | x : y | Right to left | 1:4 | [1,2,3,4] |
to, in | Unit conversion | x to y | Left to right | 2 inch to cm | 5.08 cm |
== | Equal | x == y | Left to right | 2 == 4 - 2 | true |
!= | Unequal | x != y | Left to right | 2 != 3 | true |
< | Smaller | x < y | Left to right | 2 < 3 | true |
> | Larger | x > y | Left to right | 2 > 3 | false |
<= | Smallereq | x <= y | Left to right | 4 <= 3 | false |
>= | Largereq | x >= y | Left to right | 2 + 4 >= 6 | true |
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](/guardian/workspace/policies/policy-creation/introduction/events). ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "hash": "BV4VxNEGvBjodqZ6KWCoV6r4xks4LYSGu8mjWyXLLX52", "data": { "vpDocument": { "type": "VP", "title": "Verifiable Presentation", "tag": "mint_token", "hash": "BV4VxNEGvBjodqZ6KWCoV6r4xks4LYSGu8mjWyXLLX52", "issuer": "did:hedera:testnet:7Q9aPi8rEhceMGMqviCdya9APf515YVbtiyjHrHYPh5N_0.0.3075949", "username": "Virtual User 1", "document": { "_id": "63da2203db84efbb04da45a7", "dryRunId": "63da04e19670adb07f82b092", "dryRunClass": "VpDocumentCollection", "owner": "did:hedera:testnet:7Q9aPi8rEhceMGMqviCdya9APf515YVbtiyjHrHYPh5N_0.0.3075949", "hash": "BV4VxNEGvBjodqZ6KWCoV6r4xks4LYSGu8mjWyXLLX52", "document": { "id": "urn:uuid:0bb9966d-bbce-4e7d-a943-21c7d6283adc", "type": [ "VerifiablePresentation" ], "@context": [ "https://www.w3.org/2018/credentials/v1" ], "verifiableCredential": [ { "id": "urn:uuid:7aeb978a-01bf-4ceb-be52-33997832e32d", "type": [ "VerifiableCredential" ], "issuer": "did:hedera:testnet:9jShvNUsztLFbvEK442VPfkccLYW3F2oU3e6rCHzr7FT_0.0.3075949", "issuanceDate": "2023-02-01T08:25:38.804Z", "@context": [ "https://www.w3.org/2018/credentials/v1" ], "credentialSubject": [ { "field0": "did:hedera:testnet:7Q9aPi8rEhceMGMqviCdya9APf515YVbtiyjHrHYPh5N_0.0.3075949", "field1": "did:hedera:testnet:EHXwuE486eSD4yGXr6qTNLstmb8H1B2Jn4kx3PeWZzjv_0.0.1675232535045", "field2": { "field0": "Organization Name", "type": "dee7e78b-44b8-4bb0-8be0-3a86bde752b2", "@context": [] }, "field3": { "field0": "device1", "type": "b61a05c6-bb1a-4d7e-9299-c0932d8c0306", "@context": [] }, "field6": "2023-02-01", "field7": 1, "field8": "2023-02-01", "field17": "StandardRegistry", "field18": "0.0.3075944", "policyId": "63da04e19670adb07f82b092", "ref": "did:hedera:testnet:EHXwuE486eSD4yGXr6qTNLstmb8H1B2Jn4kx3PeWZzjv_0.0.1675232535045", "@context": [ "schema#80b8a663-8dec-411f-83fd-6e4cb7170427" ], "id": "urn:uuid:bdc30a12-443f-43a1-b1ff-05fdb4d39017", "type": "80b8a663-8dec-411f-83fd-6e4cb7170427" } ], "proof": { "type": "Ed25519Signature2018", "created": "2023-02-01T08:25:38Z", "verificationMethod": "did:hedera:testnet:9jShvNUsztLFbvEK442VPfkccLYW3F2oU3e6rCHzr7FT_0.0.3075949#did-root-key", "proofPurpose": "assertionMethod", "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..hcXXdjwaicZzXlUraPIaQqEpMkt9tRYJWAEMX8j8ipXUcrh1dgTDeHxHmVfxOrpOaxqgoo2Sf2VltQi8FRjvBA" } }, { "id": "urn:uuid:c6ae4294-bd77-43ec-9389-f0c1a9bbc830", "type": [ "VerifiableCredential" ], "issuer": "did:hedera:testnet:9jShvNUsztLFbvEK442VPfkccLYW3F2oU3e6rCHzr7FT_0.0.3075949", "issuanceDate": "2023-02-01T08:25:38.920Z", "@context": [ "https://www.w3.org/2018/credentials/v1" ], "credentialSubject": [ { "date": "2023-02-01T08:25:38.917Z", "tokenId": "0.0.3120996", "amount": "1", "@context": [ "ipfs://bafkreib67gunqam5jcv6xx3ioapfzyrnvte5wvpmcq56emso5acckercae" ], "type": "MintToken" } ], "proof": { "type": "Ed25519Signature2018", "created": "2023-02-01T08:25:38Z", "verificationMethod": ..... ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | #### Request Body | Name | Type | Description | | --------------------------------------------- | ------ | ----------- | | filterValue\* | String | VP Hash | ## reportItemBlock ### Properties | Block Property | Definition | Example Input | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Title | Title of the element | Report | | Description | Description of the element | Reporting | | Visibility | Visibility of the element. False if there is a need to build a chain of elements which must not be shown | False | | Multiple | which allows store multiple documents in Report Item | True | | Filters | Array of filters for the VC for this element |"filters": \[
{
"field": "document.id", "value": "actionId", "typeValue": "variable", "type": "equal"
},
{
"typeValue": "value",
"field": "type",
"type": "equal",
"value": "report"
}
]
| | Dynamic Filters | We can set “Field Path” (in current Report Item Document\[s]), “Next Item Field Path” and “Type” (Filter Type) to filter documents in Report Items dynamically directly in trust chain. | Type | | Variables | List of common variables. It gets filled in in the process of the transition from one reportItemBlock to the next |"variables": \[
{
"value":"document.credentialSubject.0.ref",
"name": "projectId"
}
]
| A new variable projectId will be created which would be assigned the value from document.credentialSubject.0.ref. # switchBlock ### Properties | Block Property | Definition | Example Input | Status | | ------------------ | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | tag | Unique name for the logic Block. | **switchBlock** | | | 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 | | | On errors | Called if the system error occurs in the Block |- No action
- Retry
- Go to step
- Go to tag
- First True - only the ‘branch’ under the first ‘true’ condition gets executed.
- 2. All True - branches under all conditions evaluated as ‘true’ get executed.
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](/guardian/workspace/policies/policy-creation/introduction/events). # aggregateDocumentBlock ### Properties Input - a document or an array of documents which will be aggregated Output - an array of documents, after the reporting period expired or the condition is met | Block Property | Definition | Example Input | Status | | ---------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------ | | tag | Unique name for the logic block. | **aggregateDocumentBlock** | | | 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. | | | On errors | Called if the system error occurs in the Block |- No action
- Retry
- Go to step
- Go to tag
- Cumulative Dimension
- Period
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](/guardian/workspace/policies/policy-creation/introduction/events). # TimerBlock ### Properties Input - document which is needed to start the timer for different users separately. | Block Property | Definition | Example Input | Status | | ---------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | tag | Unique name for the logic block. | **timerBlock** | | | 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. | | | On errors | Called if the system error occurs in the Block |- No action
- Retry
- Go to step
- Go to tag
Yearly
Monthly
Weekly
Daily
Hourly
Custom - advanced period
configuration
If ‘Period’ = ‘Custom’
Mask - cron mask for timer (example:
Interval (number) - trigger timer on every tick
(e.g. every two days)
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](/guardian/workspace/policies/policy-creation/introduction/events). # revokeBlock This block finds related messages in policy topics, and revokes those messages and sends it to Hedera topic, but it doesn’t save documents in DB. Output of this Block is the documents array. ### Properties | Block Property | Definition | Example Input | Status | | ------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------ | | tag | Unique name for the logic block. | **revokeBlock** | | | permissions | Which entity has rights to interact at this part of the workflow. | Registrant | | | defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | | | On errors | Called if the system error occurs in the Block |- No action
- Retry
- Go to step
- Go to tag
- No action
- Retry
- Go to step
- Go to tag
- No action
- Retry
- Go to step
- Go to tag
Two types of buttons:
1. Selector : Simply button. 2. Selector - dialog : button with dialog
Field (field) – field of document.
Value (value) – field to compare.
Type (type)– type of comparison.
| | | dialogResultFieldPath | This will allow to define destination field where value from dialog will be stored. Also it will not override value of this field, it will only be replaced to array or value will be just pushed to existing array. | Field Path | | | Enable Individual Filters | As per button visibility filters instead of hiding all buttons | Checked or Unchecked | | ### API Parameters `GET` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | {% tabs %} {% tab title="200: OK Successful Operation" %} ```javascript { "id": "fa4c1642-700a-44f6-a8eb-1089e77c4d64", "blockType": "buttonBlock", "type": "selector", "uiMetaData": { "options": [ { "title": "", "name": "Add", "tooltip": "", "type": "text", "value": "Waiting for Validation", "uiClass": "btn-approve", "bindBlock": "save_added", "tag": "Option_0" } ], "content": "VVB", "buttons": [ { "tag": "Option_0", "name": "Add", "type": "selector", "filters": [], "field": "option.status", "value": "Waiting for Validation", "uiClass": "btn-approve" } ] } } ``` {% endtab %} {% endtabs %} `POST` `/policies/{policyId}/blocks/{uuid}` #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | policyId\* | String | Policy ID | | uuid\* | String | Block UUID | #### Request Body | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | document\* | Object | VC Document | # documentValidatorBlock This block is to validate documents, including linked documents. This block returns an error if at least one of the checks don’t pass. It can be placed as a ‘child’ document, or as a link in the sequence of the blocks.  ### Properties| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| tag | Unique name for the logic block. | documentValidatorBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | VVB | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error occurs in the Block |
| |
| stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | |
| DocumentType | Type of the documents to be validated. | · VC Document · VP Document · Related VC . Related VP Document | |
| Check Schema | Validates schema documents. | Schema | |
| Check Own Document | If ‘true’ validates document owners. | True / False | |
| Check Assign Document | If ‘true’ validates document owners. | True / False | |
| Conditions | Array containing conditions for validation. | Array |
| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| tag | Unique name for the logic block. | tokenActionBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | VVB | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error occurs in the Block |
| |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | |
| Token | The token which is affected by the action | iREC token | |
| Account Type | The type of the account under which the action is performed. If set to ‘Default’ the account of the currently logged in user is used (i.e. the owner of the document). If set to ‘Custom’ the account specified in the ‘accountId’ field is used. | Custom | |
| Account Id (Field) | The value from this field is used as the ID of the account under which the action is performed when ‘Account Type’ is set to ‘Custom’. | field0 | |
| Action | Action to be performed on Token |
| |
| Use Template | This needs to be enabled if we need to use token template, which is created already. | Enabled or Disabled | |
| Token Template | Which will take created tokenId from input document by template name | token_template_0 |
- No action
- Retry
- Go to step
- Go to tag
The type of the account under which the action is performed. If set to ‘Default’ the account of the currently logged in user is used (i.e. the owner of the document).
If set to ‘Custom’ the account specified in the ‘accountId’ field is used.
| Custom | | | Account Id (Field) | The value from this field is used as the ID of the account under which the action is performed when ‘Account Type’ is set to ‘Custom’. | field0 | | | Action | Action to be performed on Token |- Associate
- Dissociate
| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| tag | Unique name for the logic block. | mintDocumentBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | VVB | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error occurs in the Block |
| |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. |
| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| Round Method | The method used to round the number of tokens. | Select an option from the dropdown ('Round to nearest' is selected by default):
| |
- Custom Account Field
- Custom Account Value
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. |   {% hint style="info" %} Note: The event is shown in both source and target blocks tabs regardless of where it was added initially. {% endhint %} ### Default Events Default events correspond to the implicit default transfer of execution control from the current to the next (adjacent) block graphically represented by the block immediately below the current one. Default events can be switched off by setting ‘Disabled’ to ‘true’ on the Events tab, or ‘Stop Propagation’ to ‘true’ on the Properties tab as in the older Guardian versions.  ### Output Events Output events are events which are created by the ‘Source’ blocks. **Output Event (enum):** **All Blocks:** * RunEvent - appears upon the completion of main logic of the block. * RefreshEvent - triggered upon the changes in the state of the block.  **TimerBlock:** * TimerEvent – triggered upon each ‘tick’ of the timer **switchBlock:** * Condition 1..N - each condition expression in the switch block maps to the corresponding event created upon the evaluation of its condition into ‘true’  **InterfaceActionBlock:** * Option 1..N - each Option (button) triggers a corresponding event upon the button press action from the user  #### Calculate Block, Custom Logic Block, DocumentValidatorBlock, ExternalDataBlock, MintBlock, Reassigning Block, RequestVcDocumentBlock, RetirementBlock, RevokeBlock, SendToGuardianBlock, TokenActionBlock, TokenConfirmationBlock * Error Event : Which is called and passed the input data when error occur. ### Input Events Input Events are received and processed by the egress interface of the ‘Target’ block. **Input Event (enum):** **All Blocks:** * RunEvent - triggers the execution of the main logic of the block. * RefreshEvent - triggers the refresh of the block (in the UI it re-draws the component) **aggregateDocumentBlock:** * TimerEvent - triggers the execution of the time(period)-activated aggregation logic, and passes the aggregated data further * PopEvent - removes the document from the aggregation.  **timerBlock:** * StartTimerEvent - starts the timer for the user (to ‘tick’ for the time-activated aggregation logic) * StopTimerEvent – stops the ‘ticking’ timer for the user #### RequestVcDocumentBlock: * RestoreEvent - Which receive input vc document to restore data. #### mintDocumentBlock: * AdditionalMintEvent - allows linking of the result of one mint block with another mint block. * RetryMintEvent - It allows to retry mint action if there were some errors, issues there. Environment variable RETRY\_MINT\_INTERVAL is setting up retry mint interval (in minutes), default is 10 minutes.- No action
- Retry
- Go to step
- Go to tag
· Group Owner – only the creator of the group
· All – all members of the group
| | | Can Delete | specifies who can remove users from the group |· Group Owner – only the creator of the group
. All – all members of the group
| |- No action
- Retry
- Go to step
- Go to tag
| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| tag | Unique name for the logic block. | customLogicBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | NoRole | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error occurs in the Block |
| |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | |
| Output Schema | Sending the logic output to this particular Schema | Report Employee schema | |
| Document Signer | defines who will sign processed document. Options: 1. Policy Owner 2. First Document Owner 3. First Document Issues | Policy Owner | |
| Id Type | defines Id Type in credential subject of processed document. Options: 1. DID (new DID) 2. UUID (new UUID) 3. Owner (Owner DID) | UUID (new UUID) |
| Block Property | Definition | Example Input | Status |
|---|---|---|---|
| tag | Unique name for the logic block. | splitBlock | |
| permissions | Which entity has rights to interact at this part of the workflow. | NoRole | |
| defaultActive | Shows whether this block is active at this time and whether it needs to be shown. | Checked or unchecked. | |
| On errors | Called if the system error occurs in the Block |
| |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or unchecked. | |
| Threshold | The size of a single ‘portion’ (chunk) the original document would be split into. Note: It is always number>0 | 1000 | |
| Source field | It is the path to the field in the VC document which is the parameter used in the calculation of the ‘size’ of the VC. Note: is a field to which the ‘source field’ path points. It must be of numeric type. | source path link |
| Property Name | Description | Example | Status |
|---|---|---|---|
| Tag | Unique name for the logic block. | impactAddon_1 | |
| Permissions | Which entity has rights to interact at this part of the workflow. | Standard Registry | |
| Default Active | Shows whether this block is active at this time and whether it needs to be shown. | Checked or UnChecked | |
| Stop Propagation | End processing here, don't pass control to the next block. | Checked or UnChecked | |
| On Errors | Called if the system error occurs in the Block |
| |
| Impact Type | shows the type of the impact | Primary Impacts / Secondary Impacts | |
| Label | Title of the Impact | Test | |
| Description | Description of the impact | Impact description | |
| Amount (Formula) | Formula for calculating the impact quantitative representation based on the data from the source VC | field0 | |
| Unit | Unit of measurement of impact amounts | Kg |
No action
Retry
- No action
- Retry
- No action
- Retry
"attributes": \[
{
"attributePath": "status"
},
Note: If value is empty no attributes will be selected and field option in returned documents will be empty.
- No action
- Retry
o Get – find and extract the part of the document which corresponds to the specified schema
o Set – update the part of the document, which corresponds to the specified schema, with new data
| | | Schema | the schema which is target of the action. It is used to identify the embedded part of the data object - i.e. the field in the document which corresponds to this schema | Contact Details (1.1) | | ### 1.1 Extraction- No action
- Retry
- No action
- Retry
| Property Name | Description | Example | Status |
|---|---|---|---|
| Button Name (name) | The label (name) of the button as displayed to the user | "Approve", "Reject" | |
| UI Class (uiClass) | The UI class of the button | “btn-approve”, “btn-reject”, “btn-link” | |
| hideWhenDiscontinued | Check if the button should be hidden when policy is discontinued | Checked/Unchecked | |
| Dialog (dialog) | Determines if a dialog should be opened after the button is clicked | true, false. | |
| Dialog Options (dialogOptions) | Will be shown only if the Dialog setting is set to true. |
|
\[
{
"name": "field0",
"title": "Project Details",
"value": "field0",
"readonly": false
}
]
| |A custom JavaScript
function that transforms
the existing source data
and returns it in a
custom format
|function main(documents){
let sum = 0;
for(let i=0; i< documents.length; i++) {
sum+=
documents\[i].document.credentialSubject\[0].fiel
d0 +
d1;
documents\[i].document.credentialSubject\[0].fiel
}
return {
sum
}
}
done(main(documents));
| Property Name | Description | Example |
|---|---|---|
| Button name | The display name of the button | Integration Data |
| Enable caching | If set to true, and the data was previously saved to the database (e.g., via the "sendToGuardian" block), future requests with the same parameters will retrieve the data from the cache instead of performing a new request. | Checked/unchecked |
| Integration | Type of integration. Currently supported values:
| KANOP_IO |
| hideWhenDiscontinued | Check if the button should be hidden when policy is discontinued | Checked/Unchecked |
| Request type | The name of the specific request to execute (varies per integration). | getDatasets |
| Request params | Parameters required for the selected request. These are integration-specific. | datasets |
· Single – only a single user can be included in the group. This type is maintained for backward compatibility with historic policy versions.
· Multiple – the group can include multiple users. This is the new mode of operation.
| | Access Type |· Global – static group is created at the start. The creator of the group is the creator of the policy.
· Private – a new instance of the group is created every time a user selects group creation action. The creator of the group is the user who executed the group creation action.
|all IDs are taken into consideration when comparing blocks
(for example when this option is chosen if all Properties of tokens in two Policies being compared are the same these tokens would still be considered different since they would by definition have different UUIDs)
all IDs are taken into consideration when comparing blocks
(for example when this option is chosen if all Properties of tokens in two Policies being compared are the same these tokens would still be considered different since they would by definition have different UUIDs)
| Color | Color Blind Mode | Purpose |
|---|---|---|
| Green | Blue | blocks are equal, including their child blocks |
| Green - Amber | Blue-Orange | blocks are equal, but their child blocks are different |
| Amber | Orange | blocks are of the same type and are partially equal, there are some notable differences |
| Red | Purple | blocks are absent in the other Policy |