Schema tab

The Schema tab shows the object schema. This tab has two secondary tabs: Formatted View and Raw View.

Formatted View

The formatted view shows a list of schema properties and elements defined for the object.

A data grid is used to display important details for each property. The data that is shown in the grid is derived from the keyword values provided in the schema.

Paging is available for flat JSON and DSV objects. Use the paging control below the data grid to navigate through the complete list of properties.

Property
The name of the property. For BODs, it is the name of the element or attribute.
Indicators
This column is displayed if the schema is registered with additional metadata properties. This column contains an identifier path, variation path, timestamp path, or delete indicator. Icons are used to represent each of the properties in the file.
This column does not apply to BOD objects.
This table describes the different indicators:
Indicator Name Icon Description
Identifier Path nt_ico_identifier_path Indicates that the property is used as an identifier for the object. Multiple properties can be defined to make up the unique identifier.
Variation Path nt_ico_variation Indicates that the property is used to determine the variation for the object.
Timestamp Path nt_ico_timestamp Indicates that the property is used to determine the last update or create time for the object.
Delete Indicator nt_ico_delete_indicator Indicates that the property is used as the delete indicator for the object.
For more information on the additional metadata properties file, see "Defining additional object metadata properties" in the Infor ION Development Guide.
Title
Shows the title for each property, if defined in the schema. If none of the properties in the schema contain a title, this column is hidden by default.
This column does not apply to BOD objects.
Description
Describes the property in the schema. If none of the properties in the schema contain a description, this column is hidden by default.
Data type
The data type of the property.
Position
This column shows the order in which the properties in the data object should be displayed to the user.
By default, the properties on this page are listed in ascending order according to this value. Any properties that do not have a position defined in the schema are listed after those that do. If none of the properties in the schema contain this value, the column is hidden from the page.
This column does not apply to BOD objects.
Required
Indicates that the property must be included in the payload. This column is hidden for DSV objects.
Repeatable
Visible for BOD objects only. Indicates that the element can occur more than once in the data object.
Length
This column is used for string properties only. It specifies the maximum length that the value in the payload can be. If there is no maximum length defined for the property, “Not Provided” is shown in the cell.
Digits Before Decimal
This column is used for number properties only. It specifies the maximum number of digits that is allowed before the decimal for the payload value. If there is no maximum value provided for the property, “Not Provided” is displayed in the cell.
Digits After Decimal
This column is used for number properties only. It specifies the maximum number of digits that are allowed after the decimal for the payload value. If this is not defined for the property, “Not Provided” is displayed in the cell.
Negatives Allowed
This column is used for number properties only. A check box is used to indicate whether negative values are allowed for the property in the payload. If the minimum value that is provided in the schema includes negative numbers, or the minimum is not provided, the check box is selected.
Date Time Format
This column is used for date, time, and datetime properties only. For properties that use a standard format, “Standard” is displayed in this column. When a custom format is used, the exact format as defined in the schema is displayed. For BODs, all date, time, and datetime properties are considered “Standard.”
Note: For JSON and DSV objects, if you pause on “Standard”, a tooltip with the expected format is displayed.

To view a property as defined in the schema, a right panel has been added to the page. This panel is collapsed by default. To expand it, click the icon that is located at the top of the panel. After you have selected a row, the panel shows the selected row’s property definition in its raw format.

For BODs, some elements and attributes have a type that references a simpleType definition elsewhere in the schema. To view the raw schema definition of that simpleType, click the value of the "type" attribute in the right panel. To navigate back to the originally selected element or attribute's raw schema definition, use the breadcrumb above the viewer.

Raw View

The raw view shows the full object schema in its raw format. To search the schema on this tab, click anywhere inside the main area of the Raw View tab and press Ctrl + F. A search bar, where you can specify the text you want to find in the schema, is displayed.

For BOD schemas that include other XSD files, the Raw View tab is a drop-down menu. A list of all included schema files, and the main file itself, are displayed in the drop-down. You can also click the name of an included schema as an alternative way to navigate to a different schema's raw view.