PolicyRolesBlock

This block allows the user to select a role or a group.

Properties

Block PropertyDefinitionExample InputStatus

type

A block which determines a role for the user.

PolicyRolesBlock (Can't be changed).

tag

Unique name for the logic block.

choose_role.

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.

roles

Available roles from which the user can choose.

Select the appropriate roles from the dropdown.

Available Roles

list of roles for selected user

Checked or unchecked.

Β·Available Groups

list of groups for selected user

Checked or unchecked.

Note: β€˜Available Groups’ option takes priority and thus, when set, causes the system to ignore β€˜Available Roles’.

Note: Setting the Permissions property to β€˜No Role’ limits the visibility of this block to those users which have not yet selected a role or a group.

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

UI Properties

UI PropertyDefinition

Title

Provide the a title for the role selector.

Description

Provide a description on the role selection.

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

API Parameters

GET /policies/{policyId}/blocks/{uuid}

Path Parameters

NameTypeDescription

policyId*

String

PolicyID

uuid*

String

Block UUID

 {
  "roles": [],
  "groups": [
    "VVBs",
    "Project_Proponent"
  ],
  "groupMap": {
    "VVBs": {
      "groupAccessType": "Private",
      "groupRelationshipType": "Multiple"
    },
    "Project_Proponent": {
      "groupAccessType": "Private",
      "groupRelationshipType": "Single"
    }
  },
  "isMultipleGroups": true,
  "uiMetaData": {
    "title": "Roles",
    "description": "Choose Roles"
  }
}

POST /policies/{policyId}/blocks/{uuid}

Path Parameters

NameTypeDescription

policyId*

String

Policy ID

uuid*

String

Block UUID

Request Body

NameTypeDescription

role*

String

invitation

String

Invite Code

Group

String

Group Name

Last updated