Browsing schema

Edit online

The Schema browser is an interface for visualizing, exploring, and interacting with object types and their related fields to facilitate efficient schema navigation and query development.

About this task

Schema browser

An interface focused for visualizing, exploring, and interacting with object types and their related fields that facilitate efficient schema navigation and query development. The schema browser for Envizi Supply Chain Intelligence object types is designed to provide a comprehensive understanding of the object types that are defined in the Envizi Supply Chain Intelligence schema.

It offers the following features:
  • Object type visualization. The browser offers a visual representation of all object types that are defined in the schema in a structured and organized manner. Each object type is displayed with its associated fields so that you can grasp the schema's structure at a glance.
  • Field exploration. You can interactively explore the fields that belong to each object type by accessing detailed information such as field names, types, descriptions. You can understand the purpose and usage of individual fields within the schema.
Data dictionary

A resource that provides detailed information about the structure, content, and usage of data elements within a system or data set. When you work with GraphQL schemas, a data dictionary serves as a comprehensive reference for users, which offers insights into the types, fields, descriptions, and relationships that are defined within the schema along with any custom attributes that defined for the tenant. Converting a GraphQL schema into the CSV format allows for accessibility and analysis of this information. You can also download the data dictionary.

The CSV data dictionary that is derived from a GraphQL schema typically includes the following columns:
Table 1. Data dictionary
Column name Description
Data object The object type to which the field belongs
Field name The name of the field within the object type.
Data type The data type or object type of the field's value
Display name (en_US) Formatted field name.
Samples Sample data that can be used for testing purposes.
Description A description or documentation of the field's purpose and usage.
Alternative wording Custom description that can help users easily identify the use of the field.
Category The category for which the object type might be used
Business scenarios Custom description for the category.
Used as identifier (default csv schema) Fields that are required for CSV file format in the default schema to generate the global identifier.

Procedure

  1. From the side navigation menu, click Data management.
  2. To view the schema, in the Learn section, click view.
  3. Search for the fields that you are looking for.
    Search results appear in the result section. Hover over the information icon to see the description of the field.

You can also download the complete schema as a CSV file instead of browsing through the interface.

  1. Optional: To download the data dictionary, click Download data dictionary.
    Choose whether to include custom attributes in the data dictionary. If you select the checkbox, it includes all the custom attributes that you created.