Product
Overview
The Product is the primary top level item on the 3D product configurator. All the items under it are providing data in various ways to the product. Parts define the elements that can be composed up to a product, Materials define what kind of surfaces parts have and Accessories define the options parts have. Structure rules define how the assembly of parts is done through definition of logic and construction logic. And optional propertysets refine the assembly behavior or help construct needed data for integration (like SKU or editable value).
The Product item itself manages both the lifecycle of the offering made visible to the planner and serves as the place where top level data is defined. The product item has Base Properties and few optional propertysets that are listed below.
Add a product item
To add Product item, open context menu on the "Products" Category
Product context menu
You can add Part, Item List, Pre Built Component, Accessory Slot, Linear Structure, Free Placement Structure, Material Slot and Editable Value to the product thorough the Product context menu.
Base property overview
Base properties for Product cover the most important product lifecycle parameters, like publishing the version to the planner and name and descriptions shown by the planner
RootProperties
Version History
When using this product library, publishing the product sets the version live for all planner instances linked to this product library. This way you can test and develop versions within the Management UI environment and only publish the versions you want to live Planner versions. In future there will be ways to manage versions and even roll-back to older versions.
Root Properties
Property Name | Type | Localized | Description |
---|---|---|---|
ThumbnailImageAssetId | PNG/JPEG Asset | N | Link to an image asset of of the product to be shown on the various panels of the Planner |
DefaultComposition | Radio Button | N | Radio-button selection of the Pre Built Components made in this product as the initial one loaded to the Planner scene, empty when no pre-built compositions have been made |
DisplayName | Text field | Y | The text to be shown on the Planner for the Product |
Description | Text Field | Y | The description text shown on the Planner under the DisplayName |
Hidden | Toggle | N | Toggle to hide the product from the Planner, typically used then as a container product for shared resources across products in the product library |
MeasureSticksEnabled | Toggle | N | Enables the measure sticks |
MeasureSticksWarningEnabled | Toggle | N | Enables a warning telling that the measures might not be precise |
ShowSummaryMeasures | Toggle | N | Shows the formatted measures for composition and parts in Summary and PDF views |
ShowPlacersForReplaces | Toggle | N | Shows the placers for replace edits |
Optional property sets
Optional Propertysets include mapping of composition items into Sales Codes for price and cart integration purposes and propertyset for localization of the categories of the planner selection groups like Materials and Accessories plus some useful additional propertysets.
SalesCodeMapping
SalesCodeMapping property set is used to define the logic to determining SKU (Stock-Keeping Unit) codes used for integrations and Summary. When integrating the 3D ecommerce configurator with eCommerce platforms, both must explicitly know the same set of SKUs in order for the configurator to be able to show proper prices and map the composition configuration to an order (Add To Cart)
Property Name | Type | Localized | Description |
---|---|---|---|
Amount | Scripting | N | The defaul number of units each item where this property is defined will be counted, typically 1, but occasionally something else based on logic |
CaseGroups | Logic Fields | N | For each logic group, a selection of case split logic rules in the rule field that define an outcome code into the code field. * denotes applies to all definition A case-split can be based on scripting logic, a child condition (eg. material slot or accessory slot selection), Multiple case groups perform an composed SKU code. Refer to Sales Code Mapping for more information |
CategoryNameLocalization
Property Name | Type | Localized | Description |
---|---|---|---|
CompositionsCategory | Text field | Y | Text shown for the Compositions (Pre Build Components) category menu on the Planner |
ModulesCategory | Text field | Y | Text shown for the Modules (parts) category menu on the Planner |
AccessoriesCategory | Text field | Y | Text shown for the Accessories category menu on the Planner |
MaterialsCategory | Text field | Y | Text shown for the Material category menu on the Planner |
Note that further submenus can be made in the categories menu. This is done by adding ItemLists under the appropriate item, for example ItemList under Material Slot. The subcategory name is defined with the CategoryName property of the ItemList in Root Properties
LibraryCategoryStructure
Library category structure allows modifying the structure of Planner menu. One can select which items are allowed to be shown in which category as well as freely arrange, add, or remove categories.
It also allows arranging items (e.g. modules, materials and accessories) within the categories, so that their order differs from the order defined by Manager tree view.
Without LibraryCategoryStructure the Manager tree view rigidly maps item placement and order based on their type and order. There are the four default categories, and items are placed under those in same order as they appear in Manager. See image below for illustration of this where Parts under linear structure are placed under modules in planner in same order as they appear in Manager's product tree view. And same goes for materials, so their order is strictly defined by item order and they are always placed under Materials in Planner's menu.
Taking library category structure into use
Add property set LibraryCategoryStructure to your Product in Manager's Products tree view
Go to library categories view by clicking on the link with text "Edit Library Structure" on the property set.
- Start doing changes like Adding categories, renaming/localizing them, adding or reordering items within categories
Left hand side of the view shows items (including Parts, Accessories, and Materials) as well as any groups created in Groups view, that are not placed to any of the categories yet. Note how each of the initial category contains item starting with "role:", this is a filter which makes sure all the items belonging to the default categories are placed into that category. So all materials are placed into materials. Root level Parts (from Products tree view) are placed under Modules. Parts under other parts (in Products tree view) are in accessories. Prebuilt compositions are under Compositions.
Grouping items with library category structure
Category structure and the related view also allows to group items under single item on the planner menu view. So say you want two modules (Parts in Products tree view) to appear as only a single selection on the planner menu
CustomProperties
Custom Property set (or sets) allow definition of logic that defines something that otherwise is not predefined in the system logic.
Property Name | Type | Localized | Description |
---|---|---|---|
Name | Text field | Y | The name of the custom property. It can be referred to in scripting from elsewhere |
Value | Scripting | N | Value or scripting logic that the property has |
ValidationRule
Validation rule property set is used to define logic that can be useful to ensuring the the item where the validation rule is will follow define rules.
Property Name | Type | Localized | Description |
---|---|---|---|
DisplayMessage | Text Field | Y | Text that is shown on the Planner when the conditions of the rule are true |
Level | Radio Button | N | Selection should the rule show error, suggestion or indicating something is missing |
Trigger | Scripting | N | The logic that defines the validation rule |
ClassificationTag
Classification tag allows the configurator to define a name in the system that can be referred to in other logic components through the scripting system
Property Name | Type | Localized | Description |
---|---|---|---|
Tag | Text field | N | A label that is associated with the item it's been configured to |