πŸ’»Indexer User Guide

1. Step By Step Process

Indexer provides a global search facility on the landing page, and other pages’ headers. It allows users to find information by matching string values.

For example β€˜Project Description’ will find all entities which include β€˜Project’ word or β€˜Description’ word.

To find an exact phrase you need to use double quotes, e.g. type something like β€˜β€œProject Description”’. Words can be excluded by typing β€˜-’ symbol in the request. All searched entities have metadata in Hedera messages, search looks at policy message IDs, schema names, schema message IDs, VC/VP document content/values, schema properties, schema field names, etc…

To launch the Indexer, please run the following command in the root of the folder:

docker compose -f "docker-compose-indexer.yml" up -d --build

Landing page includes following information:

  • Registries, Methodologies, Total Documents, Total Issuance. All cards are clickable. Also there is an ability to check charts with count and date.

  • Project Locations section : shows locations of projects on the world map, all points are clickable.

Indexer UI sections:

Accounts, Methodologies, Documents, Others.

Sections have specific grids for displaying data and filters:

  • Accounts:

    • Standard Registries

    • Registry Users

  • Methodologies:

    • Policies

    • Tools

    • Modules

    • Schemas

    • Tokens

    • Roles

  • Documents:

    • DIDs

    • VCs

    • VPs

  • Others:

    • NFTs

    • Topics

    • Contracts

Example of the grid displaying data is seen on the screenshot below:

Majority of the grids provide capability to search by keyword filter, which has some differences in comparison to global search. In the search failed it uses β€˜chips’, i.e. type and press ENTER to add values, to search for specified items based on an AND condition.

For example, searching for. schema by typing β€˜Project’ and β€˜Description’ will find all schemas which contain β€˜Project’ and β€˜Description’ strings.

Each grid includes special details page:

  • Standard Registry details page have following tabs:

    • Overview - a common information.

    • Activity - activity of SR (VCs, VPs, Policies, Roles, Tools, Modules, Tokens, Users). All activity cards are clickable and it will navigate the user to the appropriate grid with correctly applied filters.

  • Raw Data - raw message data.

  • Policy details page have the following tabs:

    • Overview - general information with link to Standard Registry.

  • Activity - activity in policy (VCs, VPs, Roles, Creating schemas). All activity cards are clickable and it will navigate you to the appropriate table with necessary filters.

  • Raw Data - raw message data.

Tool details has the following tabs:

  • Overview - a common information.

  • Content- content of Tool (Using in policies, Tool Schemas). All content cards are clickable and it will navigate you to the appropriate table with necessary filters.

  • Raw Data - raw message data.

Module details has the following tabs:

  • Overview - a common information.

  • Raw Data - raw message data.

Schema details has the following tabs:

  • Overview - a common information with link to policy.

  • Document - schema document data.

  • Tree - schema tree. All nodes here are clickable, upon clicking they open the associated schema pages.

  • Activity - schema activity (VCs, VPs)

  • Raw Data - raw message data.

Token details has the following tabs:

  • Overview - a common information with link to NFTs.

  • Raw Data - raw token data.

Role details has the following tabs:

  • Overview - a common information with link to policy.

  • Activity - role activity (VCs)

  • Raw Data - raw message data.

DID details has the following tabs:

  • Overview - a common information.

  • Document - DID Document

  • Raw Data - raw token data.

VC details has the following tabs:

  • Overview - a common information with link to policy.

  • Document - VC document data. It can be represented in two forms JSON and Document form.

  • History - document history since it was created.

  • Relationships - document relationships with links to policy, roles, schemas, standard registry, other documents.

  • Raw Data - raw message data.

VP details includes following tabs:

  • Overview - a common information with link to policy.

  • Document - VP document data.

  • History - document history since it was created.

  • Relationships - document relationships with links to policy, roles, schemas, standard registry, other documents.

  • Raw Data - raw message data.

NFT details includes following tabs:

  • Overview - a common information.

  • History - NFT transactions history since it was minted

  • Raw Data - raw NFT data.

Topic details includes following tabs:

  • Overview - a common information with link to parent topic Id.

  • Content - topic content with all entity types such as VCs, VPs, Schema, Policies, Tools, Modules, DIDs, Contracts, etc…

  • Raw Data - raw topic data.

Synchronization of all entity data starts one time per hour, but it can be changed by changing environment variables.

2. Demo Video

Youtube

Last updated