Specifications are used to add custom typed information to presentations as parts or catalogues. Specifications may be used to display this custom information or to add search tags on information.
Specification types
Specifications are typed, and the typing is defined in the specification type repository. A specification type has a
- Name – will display as a label on specifications
- Type – May be according to the table below
- Unit – E.g used for meters, dimensions, pcs
- Code – used to control specific functions
- Sequence number – may be used for sorting
- Category – may be used to group specifications
- Mode – controls how specifications of this type will be shown, searched etc.
Allowed modes on specifications are described in a separate article here.
Types
| Type | Usage | Comment |
|---|---|---|
| Text | A string which has translations | |
| String | Short strings that are not translated | Max size is around 600 characters |
| Integer | A number | |
| Decimal | ||
| Bool | ||
| Datetime | ||
| Enumerable | A defined value set where many options can be used | Introduced in version 5.0 |
| EnumerableSingle | A defined value set where one option can be used | Introduced in version 5.0 |
| NamedString | Typically used for a code with a spelled out description | Introduced in version 5.0 |
| HtmlText | A text in which simple html tags as list elements can be used | Introduced in version 5.1 |
| HtmlString | A string in which simple html tags as list elements can be used | Introduced in version 5.1 |
| Presentation | A presentation reference | Introduced in version 5.1 |
| Image | An image reference | Introduced in version 5.1 |
Specifications
Specifications can be added to all presentations as parts and catalogues, and allowed values will depend on the specification type. Specifications may be reused between different presentations.
Specifications which are highlighted will display at top and cannot be collapsed. Specifications which are visible will instead be displayed under the Specifications header.
The category of the specification will define which group the specification belongs to and each group will become a header in the web viewer. Sorting of specifications within each group is defined in profile.config. Formatting of how labels and text are drawn is defined in the css.
Example
Specifications may have a header and be placed at the top.
This can be achieved by adding a Category, and making the specifications highlighted.
Related articles