πŸ’»Tools using UI

1. Step By Step Process

1. Managing Tools

Tools page (in the Policies section) provides facilities to manage Tools and create new ones.

1.1 Importing Tools

Tools can be imported by clicking on "Import" button in Tools page as shown below:

Important note on differences between imports of Tools vs. Modules and Policies.

When importing Tools via message IDs:

  1. Tool is non-editable when it is already published.

  2. A single Tool can only be imported once, if it is already been imported then no additional import can take place.

  3. Tools are imported as global entities for the Guardian instance, i.e. they are visible to all policy authors.

  4. When Tools are imported as files (using file import) they behave in the same way as Policies and Modules.

1.2 Creating Tools

Tools can be created from scratch by clicking on "Create New" button in Tools page:

1.3 Exporting Tools

Tools can be exported as files and if a Tool has been already published then its corresponding Hedera messageID can be retrieved.

1.4 Deleting Tools

Tools that have not been published can only be deleted.

1.5 Editing Tools

Tools that have not been published can only be edited.

2. Schemas

Tools can contain schemas, which are embedded in it. All the schemas related to tools can be seen in Schemas page with type : Tool Schemas.

Note: Schemas from Tools can be used not only inside Tools, but also in the context of the Policy into which the Tool that contains the schema was added.

3. How to Use Tools

3.1 Structure

Tools β€˜insides’ are isolated from the Policy the Tool is added to. Policy components use Variables and Input\Output Events which constitute the interface for passing and retrieving data to/from the Tool.

Note: Basic interoperation principles are similar to that of Modules and Policies

3.1.1 General Internal Structure

Tools are structurally similar to Policies, most of the capabilities available for creation of Policies are supported by Tools

3.1.2 Variables

Variables are used as an external interface of Tools. They allow the usage of names for structural elements of Tools, i.e. schemas, topics, roles, tokens, for setting their values inside the Policy where the Tool is used.

Creating variables:

Variables can be created/edited by using the right side tab name "Variables" in policy configurator as shown below:

3.1.3 Input/Output Events

Similarly, Input/Output Events variables are external interfaces for events. It allows you to determine which events this Tool will accept and which events will be generated.

Input Events – It provides a facility for entry into the Tool. Correspondingly, in the Policy (outside of the Tool) it is an ingress point of events. Whereas, inside the Tool this is the point where the events get generated.

Output Events – It provides the facility for exiting the Tools. Correspondingly, in the Policy (outside of the Tool) this is the point where events get generated. Whereas, inside the Tool this is an ingress point for events destined for the β€˜outside’.

3.2 Using Under Policies

Tools can be added to the Policy similarly to Module and/or Blocks.

2. Demo Video

Youtube

Last updated