Parameters for a Worktop
This document contains all the possible or required parameters to set up a worktop in the Kitchen application.
➡️ See the tutorial Set Up Worktops for a concrete case on the use of parameters in 3DCloud and Assembly Editor.
Mandatory Parameters
The following parameters are mandatory and must be set for a worktop.
| Name | Type | Default Value | Possible Values | Visible | Function |
|---|---|---|---|---|---|
width | real | – | [0 ;∞] | NO | Defines the product size of the model on the X-axis (from left to right of the cabinet). |
depth | real | – | [0 ;∞] | NO | Defines the product size of the model on the Y-axis (from front to back of the cabinet). |
height | real | – | [0 ;∞] | NO | Defines the product size of the model on the Z-axis (from bottom to top of the cabinet). |
Optional Parameters
Reserved names
The following parameters are optional and the name of the parameter are reserved words (can not be modified). To set up these parameters you should use the exact name of the parameter.
| Name | Type | Default Value | Possible Values | Visible | Function |
|---|---|---|---|---|---|
adjacentEdgeFinish | product | optional | – | external dbID | Specifies the default edge product for edge adjacent to high cabinet. |
arcOperationPossible | boolean | TRUE | TRUE / FALSE | NO | Specifies whether an arc is possible or not. It is used in ArcsConvexConcaveCutRule |
backEdgeFinish | product | optional | – | external dbID | Specifies the default edge product for back edge. |
bottomMaterial | material | – | – | – | Defines the material of the bottom part of the worktop. In this case, the main material resource is not used. |
cutOutEdgeCompatibility | product | – | – | NO | Specifies what cut out edges are possible. |
doubleSided | boolean | FALSE | TRUE / FALSE | NO | Specifies whether the horizontal boards can be double sided or not. |
doubleSidedWaterfall | boolean | FALSE | TRUE / FALSE | NO | Specifies whether the waterfall boards can be double sided or not. If waterfallProduct is specified, doubleSidedWaterfall must be defined on the targeted waterfall product instead of the main worktop product. |
doubleSidedProduct | product | – | – | NO | This parameter must be defined on each worktop boards, not on the worktop generic product. If doubleSided is TRUE (or if doubleSidedWaterfall is TRUE for waterfall boards), it represents the double sided product. |
ecoFeeCategory | string | – | - | NO | Defines the category id of linear product to find the weight of linear in range and retrieve the ecoFee value. It is used in EcoFeeRule. |
edgeCompatibility | product | – | – | NO | Defines a list of products that can be specifically used as edge finishing for worktop. |
edgeMaterial | material | – | – | – | Defines the material of the edge part of the worktop. In this case, the main material resource is not used. If edgeMaterial is not defined, topMaterial is applied. |
frontEdgeFinish | product | optional | – | external dbID | Specifies the default edge product for front edge. |
minDepth | real | – | [0 ;∞] | NO | Defines the min product depth of the worktop. |
minWidth | real | – | [0 ;∞] | NO | Defines the min product width of the worktop. |
noBoardOptimization | boolean | false | TRUE / FALSE | NO | Disable the pricing optimization. |
nonVisibleEdgeFinish | product | optional | – | external dbID | Specifies the default edge product for non visible edge. |
operationCompatibility | product | – | – | NO | Defines a list of products compatible as a cut, cut-out or shape operation for the worktop. |
polishedUnderside | product | – | – | NO | Defines the polished underside product |
roundedCutAllowedNumber | integer | – | [0 ;∞] | NO | Defines the number of rounded outer cuts on a worktop. The number of rounded corners must match one of the possible values. It is used in ArcsConvexConcaveCutRule |
surfaceWeight | number | – | - | NO | Defines the weight per surface area of the worktop to calculate the overall weight of board. It should be in kilograms per square meter, supporting either 2 or 3 decimals (with 3 decimals the retailer can be precise to the gram). It is used in EcoFeeRule. |
topMaterial | material | – | – | – | Defines the material of the top part of the worktop. In this case, the main material resource is not used. |
waterfallInsetEnd | integer | – | [0 ;∞] | NO | The inset from the end of the worktop in mm. |
waterfallInsetFront | integer | – | [0 ;∞] | NO | The inset from the front edge of the worktop in mm. Also used from the worktop back, when cabinet is not touching a wall. |
waterfallJointProduct | product | – | – | NO | if waterfall is TRUE, lists the external ID of the waterfall joint product. |
waterfallProduct | product | – | – | NO | Define the waterfall product. It must be a worktop generic product. This parameter can be specified only if waterfallPossible is set to 'true'. |
waterfallPossible | boolean | – | TRUE / FALSE | NO | specifies whether a waterfall is possible or not. |
waterfallType | string | – | straight / angled | NO | specifies what type of waterfall is possible. |
worktopMaterial | string | – | acrylic / laminate / quartz / wood | NO | Defines the material of the worktop. Also used to filter products in the catalog browser. Maximum of 49 values. |
worktopType | string | – | custom / precut | NO | Defines the type of worktop. Also used to filter worktops in the catalog browser. (See more details about searchable parameters translation) |
Recommended names
The following parameters are optional and the name of the parameter are recommended (can be modified). To set up these parameters you can chose whatever the name you want.
| Name | Type | Default Value | Possible Values | Visible | Function |
|---|---|---|---|---|---|
worktopThickness | string | – | – | NO | Defines the size of worktop. Also used to filter worktops in the catalog browser. (See more details about searchable parameters translation) |