Skip to main content
Version: v4.5

Bimpk file structure

Export your CAD model data to following files and in following folder structure, making sure to name the files and folders as listed below:

  • Bimpk
    • manifest.json
    • occ
      • 1
        • graphics.scz
        • hoops_node_mapping.json
        • graphics2d.scz
        • hoops_node_mapping2d.json
        • objects.json
        • thumbnail.png
      • 2
        • objects.json
      • n
        • objects.json
        • ...

For more information on each file, see the following break-down and click a file name to view its required data structure:

  • manifest.json: A JSON file that describes the package contents.
  • occ: Occurance folder that stores the model's files in numbered folders, the first folder for the main model and any following numbered folders for linked files.
    • 1: Stores the main model's files
      • graphics.scz: Stores the model's 3D geometry data
      • hoops_node_mapping.json: A Hoops node mapping file for the 3D model. The Platform viewer uses the file to find HOOPs nodes by element ID or visa versa. This file pairs with graphics.scz.
      • graphics2d.scz: Stores 2D view geometry data. It will be generated only only if user exports 2D views, and it main contain one or multiple 2D views.
      • hoops_node_mapping2d.json: A Hoops node mapping file for the 2D model. The Platform viewer uses the file to find HOOPs nodes by element ID or visa versa. This file pairs with graphics2d.scz.
      • objects.json: Stores model elements' metadata, such as the elements' type, properties, and relationships, for each model file. If you have linked files in a model, each linked file requires its own objects.json file.
      • thumbnail.png: Stores a thumbnail of the model as a PNG image.
    • n: Stores any files linked to the main model's file. Name the folders as sequential numbers, starting at 2.