reportBlock & reportItemBlock
reportBlock
1. Properties
Block Property | Definition | Example Input | Status |
---|---|---|---|
type | Type of workflow logic | reportBlock(Can't be changed). | |
tag | Unique name for the logic block. | report. | |
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. |
2. Impacts Section
We have added new Impacts Section to display Primary/Secondary Impacts token details in Trustchain:
In the case when multiple linked mint blocks are used then the system displays all linked VPs as shown below:
2.1 Data Format:
Ingress Document has following sections:
Document Type | Description |
---|---|
vpDocument | VP document found based on its hash |
vcDocument | VC document found based on its hash |
impacts (new) | array of Impacts (VCs) if exist |
mintDocument | VC document describing the mint |
policyDocument | VC document describing the policy |
policyCreatorDocument | VC document describing the Standard Registry |
documents | collection of VC documents retrieved from the reportItemBlock |
additionalDocuments | array of VPs linked with the selected document |
3. Token Transfer Section
Token transfer, which shows how much tokens is already transferred (will display only when transfer is needed)
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.
API Parameters
GET
/policies/{policyId}/blocks/{uuid}
Path Parameters
Name | Type | Description |
---|---|---|
policyId* | String | Policy ID |
uuid* | String | Block UUID |
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.
Last updated