InterfaceActionBlock

Properties

Block PropertyDefinitionExample InputStatus

type

A block to create custom actions.

InterfaceActionBlock (Can't be changed).

tag

Unique name for the logic block.

download_config_btn.

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 dependancies 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.

type

Specific the type of action workflow action block.

Current options are: SELECTOR (select an action) and DOWNLOAD (download files)

UI Properties

UI PropertyDefinitionStatus

Title

Provides the title.

Field

Provides the field name. Action workflow type needs to be SELECTOR.

Option Name

Provides the name of the option. Action workflow type needs to be SELECTOR.

Option Value

Provides the value of the option. Action workflow type needs to be SELECTOR.

Bind Block

Specify which block to pass control to. Action workflow type needs to be SELECTOR.

Deprecated

UI Class

Button style. Action workflow type needs to be SELECTOR.

Button Content

Provide the content for the button. Action workflow type needs to be DOWNLOAD.

Schema

Pre-configured schemas relevant for download to be selected from the drop down of available schemas in your Guardian instance. Only needed in the reference implementation of the Guardian because of the IoT Simulator that is generating MRV data. Action workflow type needs to be DOWNLOAD.

Target URL

Set the target URL where the file should be stored. Only needed in the reference implementation of the Guardian because of the IoT Simulator that is generating MRV data. Action workflow type needs to be DOWNLOAD.

User

Action workflow type needs to be SELECTOR. It determines who will get update actions (Dependencies property in other blocks) and which user will be used in next Blocks. It can be "Current" or "Owner". "Current" - user under which the action is performed. "Owner" - document owner.

Option Tag

Name of the dynamic events

Events

Property NameName in JSONProperty ValueValue in JSONDescription

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 .

API Parameters

GET blockType:

Path Parameters

NameTypeDescription

id*

String

Block ID

blockType*

String

Block Type

type*

String

Action type (dropdown / selector / download)

uiMetaData*

String

{}

POST blockType:

Path Parameters

NameTypeDescription

document*

VC

VC document

Last updated