📂Available Schema Types

Introduction

In the realm of digital environmental assets and carbon offset tokens, data is king. The essence of creating verifiable and trustworthy digital assets lies in the quality and structure of the underlying data. This is where the concept of "Schema Types" comes into play. Schemas serve as the backbone of data organization, ensuring that every piece of information adheres to a predefined format, thereby maintaining consistency, accuracy, and reliability.

Purpose of Schema Types

Schema Types are not just about data organization; they are about setting a standard for data integrity and trustworthiness. By defining clear structures and formats for data entry, storage, and retrieval, schemas facilitate:

1. Standardization and Uniformity: Ensuring all data across various projects and methodologies conforms to a consistent structure, enabling seamless integration and comparison.

2. Flexibility and Customization: Catering to diverse needs by allowing modifications to fit specific project requirements without compromising data integrity.

3. Efficient Data Management: Streamlining the process of data handling, from input to analysis, ensuring that data-driven decisions are based on accurate and reliable information.

Role in Digital Environmental Assets

The utilization of Schema Types is pivotal for the lifecycle of digital environmental assets. From the initial stages of data collection to the final phases of token creation and verification, schemas ensure that each step is backed by solid, verifiable data. This approach not only enhances the credibility of the digital assets but also boosts confidence among stakeholders in the carbon market ecosystem.

Schema Type	Definition	Example Input
String	A string is a data type used in programming, such as an integer and floating point unit, but is used to represent text rather than numbers.	I ate 3 hamburgers.
Number	A whole number is an integer that is 0 or greater.	0, 1, 2, 3, or 4.
Integer	An integer is a whole number (not a fraction) that can be positive, negative, or zero.	10, 0, -25, 5148.
Boolean	Boolean, or boolean logic, is a subset of algebra used for creating true/false statements.	True or False.
Date	Specifies a calendar date.	2023-01-01
Time	Specifies a time.	12:00 AM.
DateTime	Specifies a calendar date and a time.	2022-03-25T12:10:33.916Z
Duration	Specifies a calendar date range calendar.	P1D (1 day), P2W (2 weeks), P3M (3 months), P4Y (4 years), P1Y1D (1 year + 1 day)
URL	Specifies a website.	https://github.com/hashgraph/guardian.
Email	Specifies a email address.	[email protected].
Image	Specifies IPFS URL of an uploaded image.	https://ipfs.io/ipfs/bafkreiebnkjylfsdds5oicxpk5vdink5tduwbxed5552xcmeyrbzpewfuu
Account	Specifies Hedera Account name	Custom Account
Prefix	Specifies adding Units in front of quantity	Rs
Postfix	Specifies adding Units after the quantity	Litres, Kgs,$
Enum	Specifies values to be added	Option 1, Option 2
Help Text	Define some help text and set some text parameters like bold, text size, text color	Text Field
GeoJSON	Define to add polygons, lines on map	Alza_....
URI	Example link to ipfs files	${schema}://{auth}/….
SentinelHub	Define Geographic rastery imagery coordinates	Height, Width, From and To Date.

Each of the above field types can be marked as either Marked or optional by checking the Required Field checkbox.

Note: Important points to be noted when "Account" type is selected:

1. Account field type need to be referred in ‘tokenConfirmationBlock’ and ‘tokenActionBlock’. They can be present both in the parent and child documents.

2. 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:

1. Enum values can be added by editing or by importing it from link or from file.

2. 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:

1. Click on map and place the marker’s, polygons, lines.

2. Polygons and lines can be placed by double clicking on map.

3. Right Click on the map will remove temporary points for polygons and lines

4. View type can also be changed by pasting the GeoJSON.

5. We can upload .kml, .json files to add locations. More details on this can be found in this doc.

Note: Important points to be noted when "String" type is selected:

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

For all fields of type string with different formats (e.g., url, uri, file), an IPFS validator has been added.

• If the value looks like an IPFS link or must be an IPFS link (depending on the format’s internal validation), the field will validate against this requirement.

• The validation is applied only for published policies. For draft policies, validation is disabled.

For geoJSON fields :

• A new property availableOptions has been added.

• On the UI, a dropdown list is displayed to select which geoJSON types are available.

• If certain types are selected, then when creating a document, the geoJSON field will only allow choosing those specific types.

• Validation has also been added for the geoJSON field to ensure that values comply with the rules of the selected geoJSON type.