Parameters for a Base Cabinet

 

This table contains all the possible or required parameters to set up a base cabinet in the Kitchen applications (3DCloud, Assembly Editor).

➡️ See the tutorial Create a Base Cabinet 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 base cabinet.

Parameter Name	Parameter Type	Status	Default Value	Possible Values	Function
width	real	mandatory	–	[0 ;∞]	Defines the product size of the model on the X-axis (from left to right of the cabinet).
depth	real	mandatory	–	[0 ;∞]	Defines the product size of the model on the Y-axis (from front to back of the cabinet).
height	real	mandatory	–	[0 ;∞]	Defines the product size of the model on the Z-axis (from bottom to top of the cabinet).

---

Optional Parameters

Reserved name parameter

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.

Parameter Name	Parameter Type	Status	Default Value	Possible Values	Function
allowWallPanelAutoCompletion	boolean	optional	TRUE	TRUE / FALSE	Enables to set automatically wall panel option to a cabinet if this cabinet is added in a linear where a wall panel is already set. Requires wallPanelOption [boolean].
backCoverOption	boolean	optional	FALSE	TRUE / FALSE	Enables to activate the automatic behavior of the back side panel of a cabinet if this one is not in contact with the wall. Requires backCoverPanel [product].
backCoverPanel	product	optional	–	–	Dedicated parameter for the back cover panel.
commercialDepth	integer	optional	–	–	Contains commercial depth used as filters in the catalog browser (e.g."60 cm"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation)
commercialDimensions	string	optional	–	–	Contains commercial descriptions for dimensions displayed in the product information panel (e.g. "W400 x D600 x H880"). Needs to use parameter display fields for translation.
commercialWidth	integer	optional	–	–	Contains commercial width used as filters in the catalog browser (e.g." 40 cm"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation)
coverPanelDepth	real	DEPRECATED	13	[0 ;∞]	DEPRECATED Defines the thickness of the cover panels for cover panel building and cabinet placement.
leftCoverOption	boolean	optional	FALSE	TRUE / FALSE	Enables to activate the automatic behavior of the left side cover panel of a cabinet if this one is the last cabinet on the right. Requires leftCoverPanel [product].
leftCoverPanel	product	optional	–	–	Dedicated parameter for the left side cover panel.
leftLegOption	integer	optional	1	1/2/3/4	Enables the FurnitureLegRule to handle the leg configuration.
leftWallPanel	boolean	optional	FALSE	TRUE / FALSE	Enables the customer to activate a wall panel to the wall on the left side of the cabinet. Requires wallPanelOption [boolean].
leg	product	optional	–	–	Dedicated parameter for the leg.
legHeight	real	optional	–	–	Dedicated parameter to change the height of the leg, which will change the vertical position of the box.
plinthOption	boolean	optional	TRUE	TRUE / FALSE	Enables the customer to activate and choose a plinth.
railOption	product	optional	–	–	Enables the customer to activate and define a suspension rail product.
rightCoverOption	boolean	optional	FALSE	TRUE / FALSE	Enables to activate the automatic behavior of the right side cover panel of a cabinet if this one is the last cabinet on the left. Requires rightCoverPanel [product].
rightCoverPanel	product	optional	–	–	Dedicated parameter for the right side cover panel.
rightLegOption	integer	optional	1	0/1/2	Enables the FurnitureLegRule to handle the leg configuration.
rightWallPanel	boolean	optional	FALSE	TRUE / FALSE	Enables the customer to activate a wall panel to the wall on the right side of the cabinet. Requires wallPanelOption [boolean].
wallEdgeStripOption	boolean	optional	FALSE	TRUE / FALSE	Enables the customer to activate and choose a wall edge strip.
wallPanelOption	boolean	optional	FALSE	TRUE / FALSE	Enables the customer to activate and choose a wall panel.
worktopOption	boolean	optional	TRUE	TRUE / FALSE	Enables the customer to activate and choose a worktop style that is automatically generated by the kitchen application. Requires to define paths in the BMA.
worktopThick	real	optional	–	[0 ;∞]	Enables the Range Manager to use thickness of the worktop to calculate the position of other products in the cabinet assembly (e.g. sinks or cooktops). This value should be a range from 0 to the maximum possible worktop thickness. If the cabinet has no worktop, the value of this parameter is 0.

Recommended name parameter

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.

Parameter Name	Parameter Type	Status	Default Value	Possible Values	Function
box	product	optional	–	–	Dedicated parameter for the box.
boxAssembly	product	optional	–	–	Dedicated parameter for the box at assembly level.
damper	product	optional	–	–	Dedicated parameter for the damper.
doorAssembly	product	optional	–	–	Dedicated parameter for the door at assembly level.
drawer	product	optional	–	–	Dedicated parameter for the drawer.
drawerFront	product	optional	–	–	Dedicated parameter for the drawer front.
drawerLight	product	optional	–	–	Dedicated parameter for the drawer light.
front	product	optional	–	–	Dedicated parameter for the front.
function	string	optional	–	–	Contains commercial functionnal description used as filters in the catalog browser (e.g."Door & drawer"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation)
handle	product	optional	–	–	Dedicated parameter for the handle.
handleLayout	integer	optional	1	0/1	Enables the customer to define the position of the handle: either centered or on a side. To define which side, the side parameter is required. Values are : ▪️ 0 = Force the position to center ▪️ 1 = Keep the position defined by the side parameter.
handleOrientation	integer	optional	1	0/1	Enables the customer to change the handle orientation Available only if handleLayout = 1. Values are: ▪️ 0 = horizontal ▪️ 1 = vertical
hinge	product	optional	–	–	Dedicated parameter for the hinge.
shelf	product	optional	–	–	Dedicated parameter for the shelf.
side	integer	optional	-1	-1 / 1	Enables the customer to change the door opening side of the cabinet, and the handle position in the same time. Values are: ▪️ -1 (Left) ▪️ 1(Right)
sinkCutOutEdge	product	optional	–	–	Based on the sink base cabinet, defines what cut out edges are possible.
zLeftCoverPosition	real	optional	–	–	Enables the Range Manager to define the height at which the left cover panel starts from the floor Requires leftCoverPanel [product].
zRightCoverPosition	real	optional	–	–	Enables the Range Manager to define the height at which the right cover panel starts from the floor Requires rightCoverPanel [product].