Skip to content

Latest commit

 

History

History
98 lines (82 loc) · 7.85 KB

buttonblock.md

File metadata and controls

98 lines (82 loc) · 7.85 KB
Raw

buttonBlock

Properties

Block Property Definition Example Input Status
tag Unique name for the logic block. buttonBlock
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 has occurs in the Block
  • No action
  • Retry
  • Go to step
  • Go to tag
stop Propagation End processing here, don't pass control to the next block. Checked or unchecked.

Button

Block Property Definition Example Input Status
Type Type of the Button

Two types of buttons:
1. Selector : Simply button. 2. Selector - dialog : button with dialog
Button Tag Tag of the button will be chosen in events tab Button_0
Dialog Title pop - up dialog title. this field gets enabled when button type is Selector-dialog Reject
Dialog Description It is the text inside dialog pop up. This field is enabled when button type is Selector - dialog Enter reject reason
Button Name Label of the button Validate
Field Field of document to change option.status
Value Value to set Validated
UI Class UI class of the button btn-approve
Filters array of addition visible filters

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

{% swagger method="get" path="" baseUrl="/policies/{policyId}/blocks/{uuid}" summary="" %} {% swagger-description %}

{% endswagger-description %}

{% swagger-parameter in="path" name="policyId" type="String" required="true" %} Policy ID {% endswagger-parameter %}

{% swagger-parameter in="path" name="uuid" type="String" required="true" %} Block UUID {% endswagger-parameter %}

{% swagger-response status="200: OK" description="Successful Operation" %}

{
  "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"
      }
    ]
  }
}

{% endswagger-response %} {% endswagger %}

{% swagger method="post" path="" baseUrl="/policies/{policyId}/blocks/{uuid}" summary="" %} {% swagger-description %}

{% endswagger-description %}

{% swagger-parameter in="path" name="policyId" type="String" required="true" %} Policy ID {% endswagger-parameter %}

{% swagger-parameter in="path" name="uuid" type="String" required="true" %} Block UUID {% endswagger-parameter %}

{% swagger-parameter in="body" name="document" type="Object" required="true" %} VC Document {% endswagger-parameter %} {% endswagger %}