Events
Last updated
Last updated
There is a new tab called ‘Events’ for every block in the GUI where events can be configured. The events allow Policy creators to transfer control/execution on exit from the current block to an arbitrary block and thus build non-linear workflows.
| 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. |
Note: The event is shown in both source and target blocks tabs regardless of where it was added initially.
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 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
Error Event : Which is called and passed the input data when error occur.
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
RestoreEvent - Which receive input vc document to restore data.
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.
Note:
The link starts with “RunEvent” of the main Mint Block and ends with “AdditionalMintEvent” of the secondary Mint Block
“Default Event” of the main Mint Block must be switched off if linked Mint Blocks follow each other
Allows to change the user-context of the execution
For example: in the situation where the Standard Registry confirms the form data from the user and the Policy author would like to come back to the execution of the StepBlock as the original user the ‘Document Owner’ should be configured here instead of the ‘Event Initiator’.
Event Initiator - Actor which triggered the event.
Document Owner- Actor is changed to the owner of the document.
Document Issuer - Actor is changed to the user who signed (confirmed) the document.
