Application Distribution Parameters - Closet Configurator
Each application distribution must define its own parameters, that is to say parameters are dedicated to a Distribution of the Home Application.
The parameters are written in a JSON object.
↗ Open a sample of a complete JSON object 🔗 with the whole parameters.
❗ The JSON object cannot contain any comment.
Supported settings
For... | See... |
---|---|
Language, Units and Currency | locales |
Search | aggregationParameters |
Catalog | catalogData |
Edit Panel | editPanel |
Medias | plans2d |
locales
This parameter contains the list of available locales for the Application Distribution. It must contain at least one element.
Mandatory parameter– Value type: list of local objects.
Object defining a set of regional parameters, can contain the keys / pairs below.
name
Mandatory key – Value type: string.
A combination of a mandatory and an optional element joined in a string and separated by a "-" (dash).
- MANDATORY: 2-letter code of a language, following 🔗 ISO 639-1.
- OPTIONAL: 2-letter code of a region / country, following 🔗 ISO 3166-1. Examples: "da-DK" for "Danish-Danemark" or "fr-FR" for "French-France".
unitSystem
Mandatory key – Value type: string.
Defines which unit system is used in the application. Valid values are:
- "metrics"
- "imperial"
lengthUnit
Mandatory parameter – Value type: string
Defines the base unit for length in the application. Valid values are:
- "millimeter"
- "centimeter"
- "decimeter"
- "meter"
- "inch"
- "foot"
- "yard"
lengthPrecision
Mandatory parameter – Value type: integer
The various lengths displayed in the application will be displayed with lengthPrecision decimal digits.
lengthFractionPrecision
Mandatory if "imperial" – Value type: integer
Used only when the value of unitSystem
is "imperial".
lengthFractionPrecision
is the minimal fraction of lengthUnit
.
Valid values are: "8", "16" or "32".
Example 1 – Array of three locales with metrics
{
"locales":
[
{
"name": "en-GB",
"isDefault": true,
"lengthUnit": "millimeter",
"unitSystem": "metrics",
"lengthPrecision": 0
},
{
"name": "fr-FR",
"lengthUnit": "millimeter",
"unitSystem": "metrics",
"lengthPrecision": 0
}
]
}
Example 2 – Array of two locales with imperial
{
"locales":
[
{
"name": "en-US",
"unitSystem": "imperial",
"lengthUnit": "foot",
"lengthPrecision": 0,
"lengthFractionPrecision": 16,
},
{
"name": "es-US",
"unitSystem": "imperial",
"lengthUnit": "foot",
"lengthPrecision": 0,
"lengthFractionPrecision": 16,
}
]
}
search
The search
attribute groups settings related to the search configuration.
aggregationParameters
Status | Type | Default value |
---|---|---|
Optional | array of string | [] |
These aggregation parameters are used in the product browser, replace catalog and the search bar.
For a parameter to be used as a filter, it must be set as a searchable parameter on the product(s) and defined in the API and in application distribution parameters in 3dcloud.
➡️ See the Searchable Parameters 🔗 for a further explanation of how to set the parameters.
{
"search": {
"aggregationParameters": [
"commercialDepth",
"commercialWidth"
]
},
}
sortStringFilter
Status | Type | Default value |
---|---|---|
Optional | string | "desc" |
sortStringFilter
defines the sorting order of the string type filters in the Catalog Browser. If the value of the sortStringFilter
is asc
it will be sorted in alphabetical order. And If the value is desc
, it will be sorted in reverse alphabetical order.
The default value for the key is desc
. If no value is provided for the key, by default the filter will be sorted in the reverse alphabetical order.
{
"sortStringFilter": "desc",
}
sortNumericFilter
Status | Type | Default value |
---|---|---|
Optional | string | "desc" |
sortNumericFilter
defines the sorting order of the number type filters in the Catalog Browser. If the value of the sortNumericFilter
is asc
it will be sorted in ascending order. And If the value is desc
, it will be sorted in descending order.
The default value for the key is desc
. If no value is provided for the key, by default the filter will be sorted in the descending order.
{
"sortNumericFilter": "desc"
}
catalogData
The catalogData
is used to configure the different catalog entries data displayed in the closet configurator.
design
Status | Type | Default value |
---|---|---|
Optional | array of catalog object | [] |
Each item in design
is an object which describes the information of the catalog. It contains the following attributes:
icon
Status | Type | Default value |
---|---|---|
Mandatory | string | "" |
The name of the SVG icon to use for this catalog. Supported values are listed below.
translationKey
Status | Type | Default value |
---|---|---|
Mandatory | string | "" |
The translation key suffix for the catalog entry name. The configurator builds the full translation key like follows (where {key_suffix} is replaced by the provided translationKey
)
full key = catalog_entry.design_state.{key_suffix}
closedTags
Status | Type | Default value |
---|---|---|
Mandatory | array of number | [] |
List of closed tag IDs that are searched when the user clicks on catalog button. Search results are any product that has either of these closed tags.
freeTags
Status | Type | Default value |
---|---|---|
Mandatory | array of string | [] |
List of free tag IDs that are searched when the user clicks on catalog button. Search results are any product that has either of these free tags.
productRank
Status | Type | Default value |
---|---|---|
Optional | boolean | false |
Defines if the searchScore must be used when sorting results of the search.
About the Icons
Each catalog entry is illustrated by an icon that you can choos from the predefined list below:
Picto name | Icon |
---|---|
accessories-closet | |
accessories | |
appliances | |
closet-structure | |
coverings | |
deco | |
dining | |
doors-closet | |
doors | |
flooring | |
front | |
furniture-alt | |
furniture | |
handles | |
objects | |
openings | |
worktop |
Example
"catalogData": {
"design": [
{
"icon": "closet-structure",
"freeTags": [],
"closedTags": [
275,
518
],
"productRank": true,
"translationKey": "box"
},
{
"icon": "doors",
"freeTags": [],
"closedTags": [
536
],
"productRank": true,
"translationKey": "door"
},
{
"icon": "accessories",
"freeTags": [],
"closedTags": [
539,
192,
546
],
"productRank": true,
"translationKey": "interior_accessories"
}
]
}
The above example produces the following catalog entries:
editPanel
The editPanel
attribute groups settings related to product panel configuration.
groups
Status | Type | Default value |
---|---|---|
Mandatory | array of parameters object | [] |
The groups
is used to define the groups of the parameters displayed in the product panel. It contains the following attributes:
parameters
Status | Type | Default value |
---|---|---|
Mandatory | array of string | [] |
The array contains the list of parameters which will be displayed as a group. The parameters of the product will be shown in the panel as the same order defined in the array.
translationKey
Status | Type | Default value |
---|---|---|
Mandatory | string | "" |
The translation key is used to translate the name of the group displayed as the title in the panel.
The product panel will display all the visible and editable parameters of a product selected. If a parameter is visible and editable but NOT defined in any array of
parameters
, it will be shown in the group "Other". It means that you need to have atranslationKey
asedit_panel.groups.other
for displaying any visible and editable parameters which are not belongs to any groups.
Example
"editPanel": {
"groups": [
{
"parameters": [
"width",
"depth",
"height"
],
"translationKey": "edit_panel.groups.dimensions"
},
{
"parameters": [
"leftCoverPanel",
"rightCoverPanel",
"topCoverPanel"
],
"translationKey": "edit_panel.groups.cover_panels"
},
{
"parameters": [
"autoLeftFillerOption",
"autoRightFillerOption",
"autoTopFillerOption"
],
"translationKey": "edit_panel.groups.fillers"
}
]
}
The above example produces the following product panel:
plans2d
The plans2d
attribute groups settings related to the generation of 2d plans.
version
Status | Type | Default value |
---|---|---|
Mandatory | number | – |
The 2d plans configuration version. Only version 0 is supported.
configs
Status | Type | Default value |
---|---|---|
Optional | array of config objects | [] |
The list of 2D plans configurations. Each config object will result in 1 generated plan. You can generate several 2D plans of the same view with different visible elements on each view.
Possible parameters for a configuration object are:
Name | Mandatory | Type | Possible Values | Description |
---|---|---|---|---|
typePlan | yes | string | "Top" "Face" "TopGround" "TopWall" | the type of plan to compute |
showFurniture | – | num | 0 or 1 | draws the furniture. (default value: 1) |
showFurnitureDimension | – | num | 0 or 1 | draws the furniture dimensions. (default value: 0) |
showWallDimension | – | num | 0 or 1 | draws the wall and bay dimensions. (default value: 0) |
showNumbering | – | num | 0 or 1 | draws the furniture numbers. (default value: 0) |
showFronts | – | num | 0 or 1 | draws the front and handles of the products (default value: 1) |
roomsOnly | – | num | 0 or 1 | draws a plan for each room that contains products (default value: 1) |
resol | – | num | 1 - 1000 | Resolution in PPI. (default value: 300) |
scale | – | num | 0 or 1 | Scale of the plan when printed at the current resol (20 means 1/20 scale) (default value: 20) |
imageWidth | – | num | 0 or 1 | Width of the 2D plans in pixels |
imageHeight | – | num | 0 or 1 | Height of the 2D plans in pixels |
Example
"plans2d": {
"configs": [
{
"resol": 300,
"scale": 20,
"typePlan": "Top",
"roomsOnly": 1,
"showFronts": 1,
"imageWidth": 2244,
"imageHeight": 1772,
"showFurniture": 1,
"showNumbering": 1,
"showWallDimension": 1,
"showFurnitureDimension": 1
}
]
},
pricing
The pricing
attribute groups settings related to the project pricing.
priceTopAssembly
Status | Type | Default value |
---|---|---|
Optional | boolean | true |
Indicates whether the assembly product prices should include the price of the top assembly or not. This only affects assembly products (i.e. BMA products). Single component products (i.e. BM3 products) are always priced with their own price.
Example
"pricing": {
"priceTopAssembly": false
},