Skip to main content
Version: Pre-Released

Plinth Accessories BOM

BOM Rule​

PlinthAccessoriesBOMRule

Computes the correct amount of plinth accessories in the project and add these accessories in the BOM. Notification level: Not applicable | Key | Value | | --- | --- | | ID | PlinthAccessoriesBOMRule | | Translation key | Not applicable |

Behavior​

This rule computes the correct amount of plinth accessories in the project and updates the Bill Of Materials (BOM). The computation is based on below use cases :

  • If the Plinth forms a angle/corner, an item "Angle connector" should be added to the BOM.
  • If the length of the Plinth is more than length of 1 unit of plinth and requires multiple units of plinths, an item "Connecting piece" should be added to the BOM for each additional unit of plinth.
  • For each endpoint of the plinths (for example, if the Plinth is against a wall or a cover panel), an item "End piece" should be added to the BOM.

Trigger Conditions​

BOM computation.

Overload Parameters​

The overload must be an array of objects, where each object contain four parameters: plinthID, angleConnectorID, simpleConnectorID and endConnectorID.

plinthID​

Mandatory parameter – Type: string Plinth ID for which we need to add accessories in BOM.

angleConnectorID​

Mandatory parameter – Type: string Angle connector ID of accessories supported for this rule. Angle connector connects 2 plinths that form an angle.

simpleConnectorID​

Mandatory parameter – Type: string Simple connector ID of accessories supported for this rule. Simple connector connects 2 units of plinths that are aligned.

endConnectorID​

Mandatory parameter – Type: string End connector ID of accessories supported for this rule. End connector is used at the endpoints of the plinths

Sample Overload value​

Here is an example of the overloads for this rule.

[
    {
        "plinthID": "15772",
        "angleConnectorID": "15759",
        "simpleConnectorID": "15728",
        "endConnectorID": "15727",
   },
    {
        "plinthID": "13950",
        "angleConnectorID": "15750",
        "simpleConnectorID": "15760",
        "endConnectorID": "15770",
   },
]

Illustration​

The accessories should be added to the BOM when the plinths meet a set of criterias:

  • If the Plinth forms a angle/corner, an item "Angle connector" should be added to the BOM.
  • If the length of the Plinth is more than length of 1 unit of plinth and requires multiple units of plinths, an item "Connecting piece" should be added to the BOM for each additional unit of plinth.
  • For each endpoint of the plinths (for example, if the Plinth is against a wall or a cover panel), an item "End piece" should be added to the BOM. Plinth accessories The illustration above have 0 angle connectors, 1 simple connector and 4 end connectors.