Metadata
The metadata is used to describe a component and to search for it. It is important to fill the metadata to allow other users to find and understand the component. The following are the attributes that needs to be filled.
Name
The name should be a short free text to identify the component. It should be as short and descriptive as possible, like a label. Avoid introducing manufacturer or model details here and use the metadata attributes for that. I.e. “Analog Input Card 8 ports”, “Push Button with light NC”, “3 phase motor”.
Thumbnail
Thumbnails are used in the component browser to give a quick overlook. Thumbnails are created in the component editor by pressing the camera button in the 3D editor. The whole component should be visible with eventual defining features visible, such as ports, knobs or other parts of the model important to the components functionality. Also make sure that the component covers most of the image, and that it is centered.
Keywords
This attribute is used for indexing the component with the search function. Several words can be added and multiple keywords give a higher chance of being found in a search. Keep the search words consistent, relevant, and only add key features and component attributes. I.e “pushbutton, push button, light, normally open, NO”. Avoid using unnecessary keywords as this may have the component appearing in irrelevant searches, for example too generic or normative words (“component”, “fast”, “good”).
Manufacturer
This field is mandatory if it is a commercial component. Make sure to use the official manufacturer name and check if it exists before setting it. This attribute will allow narrow filtering of components.
Model
This field is mandatory if it is a commercial component. Make sure to use the official manufacturer model.
Ecl@ss
This field is recommended for all components. If not sure which is the complete classification (8 digits), it is better to set a higher level of classification (6 or less digits). This attribute will allow narrow filtering of components.
Description
This is used to document the component, explain its functionality, main features, ports and public variables. The goal of the description is to explain to the user how to use it and what to expect from it. Example:
“Analog card with 8 outputs ports and configurable output voltage. They must be connected to a PLC Rack to work.
Ports:
– x1: Electric input 24V
– x2: Electric input 0V
Variables:
– voltage_range: Output voltage range used by the card in volts”
