Oryx Docs

Metadata

The Metadata section allows you to create, delete, edit, and restore metadata.

Metadata describes additional information about a product (product variant):

  • stores information about product (product variant) identifiers from external systems;
  • stores system parameters of products (product variants) that are not attributes.

Existing metadata is displayed in the workspace of the section as a list.

Description of Metadata List Fields

Field NameDescription
IDUnique identifier of the metadata in the PIM system database
CodeMetadata code
NameMetadata name
ProductsNumber of products to which the metadata applies
VariantsNumber of product variants to which the metadata applies
ActiveCurrent status of the metadata in the system, allows distinguishing between active (available for use) and inactive (temporarily disabled) items in the PIM system database
TranslationsAvailability of localizations for the name and description of the metadata, can have values: RU, EN, etc.

Creating Metadata

  1. Go to the Metadata settings section.
  2. Click the Add button.
  3. Fill out the Create Metadata form:
    1. Input field Code (optional): can be used by external systems to filter metadata by code. Not filled in by the user.
    2. Selection field Type: allows you to select the data type for the metadata value from the list (string, integer, selection, multiple selection, floating point number, boolean, money). Choose the data type for the metadata value from the provided list.
    3. Toggle Active: determines the current status of the metadata in the system. Default value is "Active". Set the desired value.
    4. Additional tab panel:
      • Default:
        • Input field Name (required): defines the name of the metadata. Enter the name of the metadata.
        • Input field Description (required): enter the description of the metadata.
      • Language tabs: determine the availability of translations for the name and description fields for the selected locale. Fill out the language tabs if necessary.
  4. To create metadata, click Save, to cancel, click Back.

Upon successful creation, the newly created metadata will be displayed in the section's list.

Editing Metadata

  1. Go to the Metadata settings section.
  2. In the section's workspace, find the desired metadata entry and click Edit.
  3. Edit the form:
    1. Input field Code (optional): can be used by external systems to filter metadata by code. Not filled in by the user.
    2. Selection field Type: allows you to select the data type for the metadata value from the list (string, integer, selection, multiple selection, floating point number, boolean, money). Edit the data type.
    3. Toggle Active: determines the current status of the metadata in the system. Default value is "Active". Edit the toggle value.
    4. Additional tab panel:
      • Default:
        • Input field Name (required): defines the name of the metadata. Edit the name of the metadata.
        • Input field Description (required): Edit the description of the metadata.
      • Language tabs: determine the availability of translations for the name and description fields for the selected locale. Edit the language tabs if necessary.
  4. To save changes, click Save, to cancel, click Back.

Upon successful editing, the updated metadata will be displayed in the section's list.

Deleting Metadata

  1. Go to the Metadata settings section.
  2. In the section's workspace, find the desired metadata entry and click Edit.
  3. Click Delete. To confirm the deletion, click Confirm, to cancel the deletion, click Cancel.

Upon successful operation, the deleted metadata will disappear from the section's list.

Restoring Metadata

  1. Go to the Metadata settings section.
  2. In the section's workspace, toggle Show Deleted.
  3. In the section's workspace, click Edit for the selected metadata entry, then click Restore.

Upon successful restoration, the restored metadata will be displayed in the section's list.

On this page