Creating custom Part Properties
Overview
Part properties contain a part’s characteristics such as material, dimensions, etc. Currently, the PLM knows the following standard properties:
Name (standard.name)
Description (standard.description)
Attachments (standard.attachments)
All other properties in AMPI are freely configurable and can be created and adjusted as needed. After creating properties they still need to be added to a form the be used.
Properties are defined in the admin panel at
Home › B3_Ampi › Properties
Types of properties
The PLM offers the following types of properties to store information about parts
Boolean
Property that can have exactly one value which is TRUE or FALSE. Displayed as Yes and No in the UI.
Integer
Property that can have exactly one value which is a full number, e.g. 0, 1, 2, -5, 324, -32434.
Float
Property that can have exactly one value which is a floating-point number, e.g. 28, 0.3453, -4234.343213, 0, 3.14
Currency
Property that can have exactly one value which is a currency amount, e.g. 0.95 $, 140.00 €.
Which currency symbol is displayed can be configured through Ampi currency in the admin panel under
Home › B3_Organization › Organizations › <ORGANIZATION> › General Settings & Features
Changing the currency symbol only changes the displayed symbol. It does not trigger a currency conversion. General Settings & Features c
String
Property that can have exactly one value which is text input. Can be displayed in the UI as single line input or multi-line input.
String properties are Markdown-enabled. This means that text entered with markdown syntax will be rendered properly formatted when displayed on the part detail view. For examples of available markdown syntax go to vue-markdown .
Choice
Offers the user a selection of pre-defined choice values. The possible values are defined together with the property. The user can select only one value in the UI.
Multiple-Choice
Offers the user a selection of pre-defined choice values. The possible values are defined together with the property. The user can select more than one value in the UI.
Size
This is a special property type to enter size including the basic geometric form. Within one property we can store one of the following options (depending on the user’s choice)
sphere → diameter
cylinder → diameter, height
cuboid → x, y, z
It is possible to display this property in the UI as a slider with approximate sizes or by entering exact dimensions.
Files
This is a special property that allows the upload of attachments or taking pictures with the camera. Since it is a property, the file upload can be added anywhere in a form.
Configuration
Each property has the following configuration options
Name
The display name of the property in the UI. Can be multi-language.
Description
Additional description for the property. Displayed under the help icon when creating or editing a part. Can be multi-language
Type
The type of property. See list above
Variable namespace
Ability to distinguish different namespaces for variables. For new properties, it is recommended to use “custom”.
Note
DO NOT USE VARIABLE NAMESPACE “standard”!
Changing a property to variable namespace “standard” makes this property READ ONLY. The property then cannot be changed or deleted anymore.
Variable name
The name by which this property can be accessed in blackboxes, scores, and the CSV import. Must be unique in combination with the variable namespace.
Adding choices
For Choice and Multiple-Choice properties, we must also add individual choices that will be displayed to the user.
After saving a new choice property we can add individual choices. Each choice has the following configuration options
Name
The display name of the choice in the UI. Can be multi-language.
Description
Additional description of the choice. Currently not displayed in the UI.
Sort priority
Defines the relative order of items in the UI. E.g. an item with Sort priority = 100 is displayed before an item with sort priority = 110.
Slug
Unique identifier of a choice that is used in blackboxes and scores and to assign choices in the CSV import.