InterfaceStepBlock

Properties

Block Property
Definition
Example Input
Status

type

Similar to the InterfaceContainerBlock, 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.

dependencies

Establish workflow dependancies that need to be completed prior.

Select the appropriate block from the dropdown.

Deprecated

cyclic

Go back one step to enable the creation of the previous object.

Checked or unchecked.

RefreshEvents are used to refreshing the UI, instead of "dependencies" property.

UI Properties

UI Property
Definition

Type BLANK

Does not contain any frame, will render all child elements one after the other.

Type TABS

A container which has a tab for each of the child element. It will render the first child element as type "blank".

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 .

API Parameters

GET blockType:

Path Parameters

Name
Type
Description

id*

String

BlockID

blockType*

String

Block Type

blocks*

array

Contained blocks array

uiMetaData*

String

{}

index*

number

Current Step

Last updated