🖥️Creating a System Schema using the UI
Last updated
Last updated
To create a new System Schema, click on the New button at the top right corner.
After clicking on the New button, you will be asked to enter Schema details such as Schema Name, Policy Dropdown, Entity : VC/MRV/NONE, Schema Description and any other required fields.
In addition to the basic Schema details we also have an option to add Field and Condition to each field.
We can also add Property dropdown field to each field in Schema. these properties are defined by IWA and are in standardized format.
We can select respective property for that specific field by searching by entering starting alphabet:
We can also customize the Field keys and Field Title by clicking on Advanced Tab.
There are different types of Schema Types:
None
Verifiable Credential
Encrypted Verifiable Credential
Note: Important points to be noted when "Encrypted Verifiable Credential" type is selected:
Fields in schema can be marked as private (only when schema has Encrypted Verifiable Credential type) as shown below.
Encrypted Verifiable Credential will be published in IPFS with AES GCM encryption.
If VP contains Encrypted Verifiable Credential, fields marked as private will be automatically removed.
There are different types of Field Types:
Number
Integer
String
Boolean
Date
Time
DateTime
Duration
URL
Image
Account
Units of Measure
Prefix
Postfix
Enum
URI
GeoJSON
Help Text
Each of the above field types can be marked as either Marked or optional by checking the Required Field checkbox.
Now, we also have an ability to configure auto calculate expression when configuring the schema field as shown below:
Note: Important points to be noted when "Account" type is selected:
Account field type need to be referred in ‘tokenConfirmationBlock’ and ‘tokenActionBlock’. They can be present both in the parent and child documents.
If there are multiple fields of the ‘Account’ with the same name, then the value from the most immediate scope, i.e. from the current (‘child’) document is used.
Note: Important points to be noted when "Enum" type is selected:
Enum values can be added by editing or by importing it from link or from file.
If we are importing files by URL. The response should be ({"enum": ["Option1", "Option2", "Option3"]}) or has same format such as importing file (Options separated by new line symbol).
Example of URL which has correct format: https://ipfs.io/ipfs/bafkreihgbx6fsqup4psfbzjcf57zjdbfwisbjbsqzvwlg4hgx5s5xyqwzm
3. If we put more than five options, it will be automatically loaded to IPFS.
Note: Important points to be noted when "GeoJSON" type is selected:
Click on map and place the marker’s, polygons, lines.
Polygons and lines can be placed by double clicking on map.
Right Click on the map will remove temporary points for polygons and lines
View type can also be changed by pasting the GeoJSON.
Note: Important points to be noted when "String" type is selected:
Pattern input field is added in the advanced mode configuration.
Detailed information for patterns is available on https://json-schema.org/understanding-json-schema/reference/regular_expressions.html.
Once the above details are added, click on the Create button.
Once the System Schema is created, we have options for activating, deleting, editing and viewing JSON documents.