Parameters for an Operation

This document lists all the possible or required parameters to set up a linear operation in the Kitchen application.

Linear operation types

The following table lists all supported linear operations by type.

ID	Operation type	Description
singleCut	corner cut	corner single cut
doubleCut	corner cut	corner double cut
roundCut	corner cut	corner rounded cut (convex)
invertedCut	corner cut	corner rounded cut (concave)
tripleCut	edge cut	edge triple cut
arc	edge cut	edge rounded cut (convex or concave)
rectangularCutOut	cut-out	rectangular cut-out
rectangularCutOutPolished	cut-out	rectangular cut-out polished
rectangularCutOutUnpolished	cut-out	rectangular cut-out un-polished
circularCutOut	cut-out	circular cut-out
circularCutOutPolished	cut-out	circular cut-out polished
circularCutOutUnpolished	cut-out	circular cut-out un-polished
jointOperation	board joint	board joint
circularShape	board shape	circular shape
arcEndShape	board shape	rectangular shape with an arc on its end
arcLengthShape	board shape	rectangular shape an arc along the length
mushroomShape	board shape	mushroom shape
depthReduction	depth reduction	depth reduction for worktops
polishedUnderside	polished underside	polished underside for worktops and wallpanels

Mandatory Parameters

The following parameters are mandatory and must be set for any kind of operation.

The board joint operation is an exception as it does not require the type parameter. Instead use the closed-tag Joints to identify it as such.

Name	Type	Default Value	Possible Values	Visible	Function
type	string	one of the operation ID listed above	–	NO	The type of operation Note: the type jointOperation is managed differently. For this type of operation the type parameter is not necessary and the product type (closed-tag) must be set to Joints.

For a corner single cut

The following parameters are mandatory and must be set for any corner single cut operation.

Name	Type	Default Value	Possible Values	Visible	Function
length	real	–	[0 ;∞]	NO	Defines the length information for the cut. Minimum, maximum and default values are used in the planner.
fullDepthLength	real	–	[0 ;∞]	NO	Defines the length information for the cut in case of a full depth cut. Minimum, maximum and default values are used in the planner.

For a corner double cut

The following parameters are mandatory and must be set for any corner double cut operation.

Name	Type	Default Value	Possible Values	Visible	Function
length	real	–	[0 ;∞]	NO	Defines the length information for the cut. Minimum, maximum and default values are used in the planner.
leftOffset	real	–	[0 ;∞]	NO	Defines the left offset information for the cut. Minimum, maximum and default values are used in the planner.
rightOffset	real	–	[0 ;∞]	NO	Defines the right offset information for the cut. Minimum, maximum and default values are used in the planner.

For a corner rounded cut

The following parameters are mandatory and must be set for any corner rounded cut operation (convex or concave).

Name	Type	Default Value	Possible Values	Visible	Function
radius	real	–	[0 ;∞]	NO	Defines the radius information for the cut. Minimum, maximum and default values are used in the planner.

For an edge triple cut

The following parameters are mandatory and must be set for any edge triple cut.

Name	Type	Default Value	Possible Values	Visible	Function
width	real	–	[0 ;∞]	NO	Defines the width information for the cut. Minimum, maximum and default values are used in the planner.
depth	real	–	[0 ;∞]	NO	Defines the depth information for the cut. Minimum, maximum and default values are used in the planner.
leftOffset	real	–	[0 ;∞]	NO	Defines the left offset information for the cut. Minimum, maximum and default values are used in the planner.
rightOffset	real	–	[0 ;∞]	NO	Defines the right offset information for the cut. Minimum, maximum and default values are used in the planner.

For an edge rounded cut

No parameter is required for an edge rounded cut (convex or concave).

For a rectangular cut-out

The following parameters are mandatory and must be set for any rectangular cut-out (normal, polished or un-polished).

Name	Type	Default Value	Possible Values	Visible	Function
width	real	–	[0 ;∞]	NO	Defines the width information for the cut-out. Minimum, maximum and default values are used in the planner.
depth	real	–	[0 ;∞]	NO	Defines the depth information for the cut-out. Minimum, maximum and default values are used in the planner.
cornerRadius	real	–	[0 ;∞]	NO	Defines the corner radius information for the cut-out. Minimum, maximum and default values are used in the planner.

For a circular cut-out

The following parameters are mandatory and must be set for any circular cut-out (normal, polished or un-polished).

Name	Type	Default Value	Possible Values	Visible	Function
diameter	real	–	[0 ;∞]	NO	Defines the diameter information for the cut-out. Minimum, maximum and default values are used in the planner.

For a board joint

No parameter is required for a board joint.

For a board shape

No parameter is required for a board shape, no matter the kind of shape.

For a depth reduction

No parameter is required for a depth reduction.

For a polished underside

No parameter is required for a polished underside, but the pricingMethod must be squareMeter or squareFeet (it is a surface pricing)