Skip to content

Commit

Permalink
GITBOOK-263: Added demo videos
Browse files Browse the repository at this point in the history
  • Loading branch information
prernaadev01 authored and gitbook-bot committed Dec 9, 2024
1 parent d6b6234 commit a529185
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 79 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 💻 Project Comparison using UI

1. [Step By Step Process](project-comparison-using-ui.md#id-1.-step-by-step-process)
2. Demo Video
2. [Demo Video](project-comparison-using-ui.md#id-2.-demo-video)

## 1. Step By Step Process

Expand Down Expand Up @@ -55,4 +55,4 @@ Document comparison includes examination of the VP documents generated by both p

## 2. Demo Video

Coming Soon
[Youtube](https://www.youtube.com/live/WpV2lvNBWMo?si=T4cqx1YfsM6eumpn)
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ icon: sidebar-flip

# Schema Predefined Values using UI

1. [Step By Step Process](schema-predefined-values-using-ui.md#id-1.-step-by-step-process)
2. [Demo Video](schema-predefined-values-using-ui.md#id-2.-demo-video)

## 1. Step By Step Process

## 1. Schema Predefined Values

Predefined schema values allow users to set up values for each field in schema (number, string, GeoJSON, or other nested schema) and use them in policy while displaying request blocks. There are 3 types of predefined values:
Expand Down Expand Up @@ -49,3 +54,7 @@ Predefined values can also be used in more complex cases such as multiple fields
![](<../../../.gitbook/assets/6 (21).png>)

![](<../../../.gitbook/assets/7 (21).png>)

## 2. Demo Video

[Youtube](https://youtu.be/wFRk9uHRXss?si=2Gx2FNq6Tk9PnkIR\&t=104)
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ icon: computer

# Defining Schema Rules using UI

1. [Step By Step Process](defining-schema-rules-using-ui.md#id-1.-step-by-step-process)
2. [Demo Video](defining-schema-rules-using-ui.md#id-2.-demo-video)

## 1. Step By Step Process

## **Schema rules**

Schema rules have been created to enable authorised policy users to offer assistance to other users (and/or themselves) with data input and/or data evaluation. Schema rules define acceptable values and their ranges for schema fields (and correspondingly input fields in Guardian forms). They are activated in the UI whenever the form is viewed by users, and re-evaluated every time any of the values on the form is changed. Rules can contain mathematical formulas and logical if-then-else flow, and source data from any field in the current schema as well as any other schemas/documents that are present in the corresponding policy. When rules are evaluated they produce a binary ‘pass/fail’ output, which is displayed in the UI as green and amber field highlights correspondingly.
Expand Down Expand Up @@ -56,7 +61,7 @@ Clicking on a schema box opens the side menu which lists all the fields availabl
![](../../../../.gitbook/assets/7.png)

\
_Note: sub-schemas do not produce corresponding document, when such sub-schema is selected in the schema view the right hand panel shows the fields from the parent schema of which this sub-schema is a part._
&#xNAN;_&#x4E;ote: sub-schemas do not produce corresponding document, when such sub-schema is selected in the schema view the right hand panel shows the fields from the parent schema of which this sub-schema is a part._

**1.3.2.3 Properties**

Expand Down Expand Up @@ -174,79 +179,6 @@ Schema rules can be exported to and imported from files.

When importing the rules they effectively become the rules of the importing Guardian instance with no dependency or relations to the instances that originally produced and exported the rules.

1. **API**

Post _/api/v1/schema-rules/_

Permissions: SCHEMAS\_RULE\_CREATE

Creation of the new schema rule

Get _/api/v1/schema-rules/_

Permissions: SCHEMAS\_RULE\_READ

Retrieve the schema rules.

Get _/api/v1/schema-rules/:ruleId_

Permissions: SCHEMAS\_RULE\_READ

Retrieve the configuration of the rule by its ID

Put _/api/v1/schema-rules/:ruleId_

Permissions: SCHEMAS\_RULE\_CREATE

Update the configuration of the rule with the corresponding ID

Delete _/api/v1/schema-rules/:ruleId_

Permissions: SCHEMAS\_RULE\_CREATE

Delete the rule by its ID

Put _/api/v1/schema-rules/:ruleId/activate_

Permissions: SCHEMAS\_RULE\_CREATE

Activate the rule with the specified ID

\
Put _/api/v1/schema-rules/:ruleId/inactivate_

Permissions: SCHEMAS\_RULE\_CREATE

Deactivate the rule with the specified ID\


Get _/api/v1/schema-rules/:ruleId/relationships_

Permissions: SCHEMAS\_RULE\_READ

List all the schemas and policy relevant to the rule with the specified ID

Post _/api/v1/schema-rules/data_

Permissions: SCHEMAS\_RULE\_EXECUTE

Retrieve all the data needed for evaluating the rules

Post _/api/v1/schema-rules/:policyId/import/file_

Permissions: SCHEMAS\_RULE\_CREATE

Create a new rule from the file

\
Post _/api/v1/schema-rules/import/file/preview_

Permissions: SCHEMAS\_RULE\_CREATE

Load the file and return its preview

Get _/api/v1/policy-statistics/:ruleId/export/file_

Permissions: SCHEMAS\_RULE\_READ
## 2. Demo Video

Export the selected rule (by ID) into the file
[Youtube](https://youtu.be/RQYxEh_cmSU?si=MJUlII3Tl4KTXfd0\&t=91)
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ icon: chart-line-up

# Bottom Up Data Traceability using UI

1. [Step By Step Process](bottom-up-data-traceability-using-ui.md#id-1.-step-by-step-process)
2. [Demo Video](bottom-up-data-traceability-using-ui.md#id-2.-demo-video)

## 1. Step By Step Process

## Statistics Terminology

* Statistics **Definition** – a template which specifies schema/document fields, rules and formulas for creation of the Statistics.
Expand Down Expand Up @@ -143,7 +148,7 @@ To enable the use of **Definitions** for creating **Assessments** of real data,

#### **3.1 Creation**

Published **Definitions** can be used for creating an **Assessment** by pressing the **Create** button for the corresponding Statistics **Definition** which launches the **Assessment** wizard**.**
Published **Definitions** can be used for creating an **Assessment** by pressing the **Create** button for the corresponding Statistics **Definition** which launches the **Assessment** wizar&#x64;**.**

![](<../../../.gitbook/assets/16 (13).png>)

Expand Down Expand Up @@ -240,3 +245,7 @@ Example Hedera message on the publication of a new Statistics **Assessment**
"uri": "ipfs://bafkreigrylqfyzqifhloklsftmcw7obtqidx64vhti4hfmbnpbrnathuty"
}
```

## 2. Demo Video

[Youtube](https://youtu.be/tYLsr4rxw58?si=XNRvpap7aosnwuhh\&t=107)

0 comments on commit a529185

Please sign in to comment.