Concept: Property
Definition
In KE-chain, a property defines a characteristic of a part. As with parts, properties can be split into two categories: property models, which are located under part models and property instances, which are used under part instances. For example, a part model "table top" could have a property model called "material". If a specific part instance would be instantiated from that part model, say Glasholm table top, the "material" property also exist under the part instance.
The following applies to properties:
- A part model can contain an arbitrary number of properties
- Properties exist in different types
- Properties defined under a part model will be replicated under every part instance created based on that respective part model.
- All property models have a default value, which can be left empty or can be filled in. Any filled in default value will be translated to the values of the property instances, but the property instance value can be changed anytime afterwards. If the default value is left empty, then the property instance will be instantiated with an empty value as well.
- All property models have property validators. These are used to impose certain requirements on the property values to be filled in. Whenever such a property validator is used, the user will be notified that the property value is not respecting some of the requirements defined in the validator. The most common validator is the 'required value' validator, which notifies the user that the property value must be filled in. See below examples of how properties with such validators look inside KE-chain.
Figure 1 - A property with a numeric field validator
Figure 2 - A property with a required field validator
All properties have the following settable fields:
- Display name
- Description
- Type
- Value
- Required property value validator
The display name, description and type must be specified on the property model and the property instances created based on them will copy the fields. Any subsequent edit of the name or description must occur on the property model. The type cannot be changed after creation.
As mentioned above, the default value can be specified on the property model and the property instances will copy that value on creation. The value of each individual property instance can be changed separately and is not linked to the property model default value after creation.
The integer and decimal properties also have an unit field and a specific numeric field validator, where a minimum and maximum value can be set, as well as a stepsize. They also allow for the values to be displayed using thousand separators, which take into account the language the user is using and display the numbers accordingly (e.g. 123,456.78 for English language and 123.456,78 for Dutch).
The decimal property also has a display field, which can be used to either display the value as it is, restrict to only a certain number of decimal places, or present only a particular number of significant digits.
The single line text and multi line text also have a regex (regular expression) field, which is used to restrict the text inside to a certain pattern. The 2 format options currently are email, which, as the name implies, restricts the text to be in the standard email format, and custom, which the user can edit itself as it pleases. This custom feature is best handled by users with some minimum knowledge in regular expressions.
The link property allows the user to specify whether he wants to have the link open in the current tab or in a new one through a field called link target.
The single select list properties also have a list of items field, used to add the options that the user can select from. These options can also be displayed as either checkboxes, dropdown list or buttons.
The part reference properties need to be connected to a part model through the selected part model field. It also has a single reference validator, which restricts the property value to reference just a single part.
The attachment property allows the specification of a file extension as well as a maximum size for files that are to be uploaded to that property.
Types of properties
The following table shows the property types available. Each property type has a number of configurable options, of which some are optional and some are specific to the type of property.
The overview below shows all property types available in Property, and their specific details, if any.
| # | Property type | Additional inputs | Valid values | Invalid values | Validators | Remarks |
|---|---|---|---|---|---|---|
| 1 | Single line text | Unit Regex format | Any text < 255 char |
Or
| Required field validator Email validator Custom (regexp) validator | Max. length 255 characters. |
| 2 | Multi line text | Unit Regex format | Any long text | When regex format is set to email, any text that has not the format of an email address is invalid:
This note also applies to Single line text | Required field validator Email validator Custom (regexp) validator | Unlimited number of characters |
| 3 | Date | Autofill | 2018-02-05 | Any text not corresponding to the format. | Required field validator | Datepicker interface is available. Autofill will fill the property value on click with the current date. |
| 4 | Date / time | Autofill | 2018-02-05 15:45 | Any text not corresponding to the format. | Required field validator | Datepicker interface is available. Autofill will fill the property value on click with the current date and time. |
5 | Integer number | Unit Display thousand separators |
|
| Required field validator Numeric field validator (based on minimum value, maximum value and step size) | Unit is pure text. Unit conversion is not supported |
| 6 | Decimal number | Unit Display:
Display thousand separators |
| Any text | Required field validator Numeric field validator (based on minimum value, maximum value and step size) | Unit is pure text. Unit conversion is not supported. |
| 7 | Attachment field | File extension Maximum size | Any single file | n.a. | Required field validator File extension validator Maximum size validator | |
| 8 | Boolean | - | Yes = true No = false None selected = No value | n.a. | Required field validator | 2 checkboxes: "Yes" and "No" |
| 9 | Link (http) | Link target:
| http://www.example.com | Any text not corresponding to the format. | Required field validator | Single URL link in one property |
| 10 | Single selection | List of items Display:
| Item 1; Item 2; Item 3; | n.a. | Required field validator | Semicolon used to separate the items |
| 11 | Multiple selections | List of items Display:
| Item 1; Item 2; Item 3; | n.a. | Required field validator | Semicolon used to separate the items |
| 12 | Part references | Part model After model selection:
| Valid KE-chain part model | n.a | Required field validator Single reference validator | Dropdown list for projects available1 Dropdown list for part models available Checkboxes for columns (properties) to show Prefilter view same as in part shop dialog |
| 13 | Geographical information | Can only be filled in by using the location-picker | n.a. | n.a. | Required field validator | Location picker available |
| 14 | Weather information | Can only be filled in based on your location by pressing the Autofill | n.a. | n.a. | Required field validator | |
| 15 | Activity references | - | Any KE-chain activity in that respective project | n.a. | Required field validator Single reference validator | |
| 16 | User references | - | Any KE-chain user | n.a. | Required field validator Single reference validator | |
| 17 | Project references | - | Any KE-chain project | n.a. | Required field validator Single reference validator |
1 Each project must be enabled individually in order to use cross-scope references. File a request in the KE-chain support if you want a specific project to have this functionality.