What is Metadata?

Metadata are properties of items that cannot be changed by the end user which may be used within the system for:


  • Enhancing user experiences
  • Allow the properties of a product to manipulate the visuals


Add Metadata in Catalog


Open the catalog item and enter the edit mode.

Locate the Metadata Window and click "Add Metadata"

Screen Shot 2021-06-01 at 11.22.18 AM.png

Select either "String" or "Number"

Screen Shot 2021-06-01 at 11.22.28 AM.png

Naming Metadata

When naming your metadata be sure to avoid operator, precedence, and delimiter-style characters such as:
, . “ ‘ ? ; : & * ( ) - = _ + [ ] \ { } | ( ) # @ ! < >

String metadata allows for alphanumeric characters as well as special characters in the "Value" field.

Screen Shot 2021-06-01 at 11.24.10 AM.png

Number metadata only allows numeric characters in the "Value" field.

Screen Shot 2021-06-01 at 11.24.16 AM.png


At this time, all metadata is "Local."


Metadata in Rules: Conditions


In the catalog, metadata may be used for selecting which part referenced items are modified by a rule.

  • Create a new rule
  • Add a condition using a part reference attribute where the items referenced contain metadata.
  • Select "metadata" from the dropdown.
  • Click "+ parameter."
  • Type in the name of the metadata on the part reference.
  • Select an appropriate operator.
  • Type in the desired value.

Screen Shot 2021-06-03 at 2.41.52 PM.png


Metadata in Rules: Actions


This action allows metadata information to be passed from part referenced items into attribute values in a higher level configurator.

  • Create a new rule
  • Add an action of "set attribute value."
  • Select the attribute that will change values
  • Select "metadata" from the dropdown.
  • Select "item"
  • Type in the name of the metadata

Screen Shot 2021-06-03 at 2.40.56 PM.png


Metadata values are case sensitive. Be sure to check the name if your rule does not behave as expected.


Using Metadata to Modify 3D Assets


In the catalog item AND asset editor, ensure an attribute (global attributes are recommended) exists for each component to be adjusted based on metadata.

Screen Shot 2021-06-02 at 3.19.09 PM.png

In the asset editor rules tab, select a condition for the attribute with a type of "metadata" and select whether the metadata exists on the item or the asset.

Screen Shot 2021-05-25 at 9.25.06 AM.png

Click "Parameter" to list which metadata will be utilized.

Screen Shot 2021-05-25 at 9.29.51 AM.png

Click the + icon for each action and select the type of value you wish to modify.
Screen Shot 2021-06-02 at 3.17.31 PM.png
Screen Shot 2021-06-02 at 3.17.26 PM.png

Multiple values may be modified on a single rule. For example, the camera, visibility of stage props, and lighting may be modified based upon item size metadata.

Screen Shot 2021-06-02 at 3.25.49 PM.png


Share this