Skip to main content
                     
As-Built As-Built - Revit As-Built - AutoCAD VirtuSurv - VirtuSurv 2018 As-Built - Modeler VirtuSurv - VirtuSurv 2019          
BuildIT BuildIT - Projector BuildIT - Construction BuildIT - Metrology              
CAM2 CAM2 - SmartInspect CAM2 - 2018 CAM2 - Measure 10 CAM2 - Measure Q CAM2 - Measure X CAM2 - Measure 3/4 CAM2 - AnthroCAM CAM2 - 2019    
Cobalt 3D Imager 3D Imager - Cobalt                  
Cobalt Design Cobalt Design - M Cobalt Design - S Cobalt Design - Dual              
Computers Computers - All Computers                  
FARO Aras 360 & CAD Zone FARO CAD Zone - Fire & Insurance FARO CAD Zone - Crime & Crash FARO CAD Zone - CZ Point Cloud FARO CAD Zone - First Look Pro FARO 360 - Reality FARO 360 - HD FARO 360 - Blitz FARO 360 - Genius    
FARO Zone present4D - present4D                  
FARO Zone 2D FARO Zone 2D - 2018 FARO Zone 2D - 2019                
FARO Zone 3D FARO Zone 3D - 2018 FARO Zone 3D - 2019                
FARO Zone 3D Advanced FARO Zone 3D Advanced - 2018 FARO Zone 3D Advanced - 2019                
FaroArm/ScanArm FaroArm/ScanArm - Quantum S FaroArm/ScanArm - Quantum M FaroArm/ScanArm - Quantum E FaroArm/ScanArm - Edge FaroArm/ScanArm - Fusion FaroArm/ScanArm - Prime FaroArm/ScanArm - Platinum FaroArm/ScanArm - Legacy Quantum FaroArm/ScanArm - Titanium FaroArm/ScanArm - Advantage
FaroArm/ScanArm FaroArm/ScanArm - Digital Template                  
Gage Gage - Bluetooth Gage - Plus Gage - Standard Gage - Power            
Hand Held Scanner 2D Hand Held Scanner - ScanPlan 3D Hand Held Scanner - Freestyle3D 3D Hand Held Scanner - Freestyle3D X 3D Hand Held Scanner - Freestyle3D Objects            
Language Quality HT MT AT NT INT - Internal          
Languages Language - English Language - Japanese Language - German Language - Chinese Language - Spanish Language - Italian Language - Portuguese Language - French    
Laser Projector RayTracer - RayTracer Laser Projector - Tracer M Laser Projector - Tracer SI              
Laser Radar Imaging Laser Radar - VectorRI                  
Laser Scanner 3D Laser Scanner - Focus S 3D Laser Scanner - Focus M 3D Laser Scanner - Focus3D 3D Laser Scanner - Focus3D X 3D Laser Scanner - Focus3D X HDR 3D Laser Scanner - Focus3D S 3D Laser Scanner - Photon 3D Laser Scanner - Focus S Plus    
Laser Tracker Laser Tracker - Vantage Laser Tracker - ION Laser Tracker - Vantage S Laser Tracker - Si Laser Tracker - X Laser Tracker - Xi Laser Tracker - Vantage E Laser Tracker - Vantage S6 Laser Tracker - Vantage E6  
Legacy Software Legacy Software - CAM2 Gage Legacy Software - Gage Software Legacy Software - Insight              
Open Tech Dental Open Technologies Scanner - NeWay Open Technologies Scanner - Click Open Technologies Scanner - Deluxe Open Technologies Scanner - Smart Open Technologies Scanner - Easy Open Technologies Software - 1Click Open Technologies Software - Optical RevEng Dental Open Technologies Software - ScanWay    
Photonics Scan Head - Digi-Cube Scan Head - Xtreme Scan Head - 3D-Contour Scan Head - 3D-Ultralight Scan Head - 3D-XB Controller - LEC Series Controller - Maestro 3000 Nutfield - Nutfield Hardware Nutfield - Nutfield Software Scan Head - Blink Focuser
Photonics WinLase - Pro WinLase - LAN WinLase - 6              
PointSense PointSense - Basic PointSense - Pro PointSense - Building PointSense - Plant PointSense - Heritage PointSense - Revit CAD Plugin - TachyCAD Building CAD Plugin - TachyCAD Archeology CAD Plugin - TachyCAD Interior CAD Plugin - PhoToPlan Basic
PointSense CAD Plugin - PhoToPlan CAD Plugin - PhoToPlan Pro CAD Plugin - PhoToPlan Ultimate CAD Plugin - DisToPlan CAD Plugin - MonuMap CAD Plugin - hylasFM CAD Plugin - VirtuSurv      
RevEng RevEng - RevEng                  
Scan in a Box Scan in a Box - M Scan in a Box - S                
ScanArm ScanArm - Design ScanArm 2.0 ScanArm - Design ScanArm ScanArm - Forensic ScanArm ScanArm - Design ScanArm 2.5C            
SCENE SCENE - Capture and Process SCENE - WebShare Server and 2Go SCENE - WebShare Cloud SCENE - WebShare 2Go App SCENE - 2018 SCENE - 7.x SCENE - 6.x SCENE - 5.x SCENE - 4.x SCENE - LT
SCENE SCENE - 2019 SCENE - 2go App                
Serial FaroArm Serial FaroArm - Silver Serial FaroArm - Gold Serial FaroArm - Bronze              
Visual Inspect Visual Inspect - App Visual Inspect - CAD Translator                

BuildIT

Metrology

FARO® Knowledge Base

Creating and Using a User Form Report Template in BuildIT Metrology

Overview

One of the key features of BuildIT is the generation of extensive reports, including several layouts and formats. Therefore, if the user does not have any report templates already created, as recommended, the user may select from any of the default report schemes. However, in cases when the user has already a report (ex. Excel report) and needs to maintain the same report layout, the User Form report is a great tool that allows this. The BuildIT User Form currently supports Excel (*.xlsx) and PowerPoint (*.pptx) report formats. This article explains how to create and use a User Form report template.

Detailed Steps

For the purpose of these instructions, "User Form (xlsx)" is used. If "User Form (pptx)" will be used instead, the instruction will be similar. If there is a difference in procedure, it will be specified for Excel and PowerPoint formats respectively.

Create a User Form Report

  1. Refer to your existing report, (which will be used as the template for future workflows), to identify all entities that are required to be included.
  2. Generate all entities that are required in your report (Ex.: Inspections, Annotations, Views, GD&T Features, Tolerances, etc.). You may obtain the entities by either:
    • Option 1: Using a BuildIT file previously produced by going through the actual workflow. Make sure it contains all desired entities. If it doesn't, you may proceed to Option 2 using this file as your starting point.
    • Option 2: Using Device Simulators in the Device Manager to simulate the workflow (for any measurement), generate the entities.
  3. Add the required entities to the report outline.
    1. Go to the "Manager" tab.
    2. Right-click on the needed elements and click "Add to report". Repeat until all needed elements are added to the report (you may verify the added elements on the "Report" tab).

      BuildITUserFormReport_AddandVerifyReportTab.png
  4. Make sure that the report format is "User Form (xlsx)".
    1. Go to the "Report" tab and click on "Report Settings" BuildITUserFormReport_ReportOptionsIcon.png.
    2. Change the Format to "User Form (xlsx)" and click OK.
      BuildITUserFormReport_ReportOptions.png
  5. Generate the User Form report.
    1. Click on "Generate Report" BuildITUserFormReport_GenerateReportIcon.png.
    2. Save the file with any name (in any folder) that does not contain an existing file named "template", then click "No" on the following popup message.
      BuildITUserFormReport_ReportTemplateNotFoundPopup.png
    3. If you are creating a new template, the following message should appear. Click "OK".
      BuildITUserFormReport_NewTemplatePopup.png
    4. A report will be generated with your selected entities and values. The report will appear as shown below (for Excel and PowerPoint, respectively) and will include screenshots of the project. See all the sheets/slides to view all the included entities and values.

      Excel format:
      BuildITUserFormReport_GeneratedReportExcel.png

      PowerPoint format:
      BuildITUserFormReport_GeneratedReportPowerpoint.png

Modify your template with the information from the User Form Report

  1. Rename your template file to "template.xlsx". Below are examples of a pre-made report template (for Excel and PowerPoint, respectively).

    Excel format:
    BuildITUserFormReport_ModifyTemplateExcel.png

    PowerPoint format:

    BuildITUserFormReport_ModifyTemplatePowerpoint.png
  2. Relocate the values from the User Form report to your template report.
    1. Cut and paste the values generated from the User Form report into the desired location of the template file. For the Excel format, cells with the red triangle in the upper right corner (macro) should be copied. For the PowerPoint format, text boxes and/or images should be copied.

      BuildITUserFormReport_CutAndPasteValues.png
    2. Make sure to delete the values from your template. For the Excel format, select the boxes with red triangles and press delete. This will keep the macro but remove the values. For the PowerPoint format, delete the content of text boxes only. The empty text box should be selectable. If the text box is not selectable after deleting the content, press CTRL+Z (undo). Save your template keeping the same name (see step 1).

      BuildITUserFormReport_DeleteValues.png
       
    3. Locate the template file in either:
      • Option 1: Same folder as the BuildIT model file. In this case, when the final reports are generated, they may be saved in any location.
      • Option 2: Same folder as the reports generated by BuildIT will be saved. In this case, when the final reports are generated, they need to be saved in the same location as the template file.
      • Option 3: BuildIT report format folder "C:\Program Files\BuildIT\BuildIT profile 20xx.x\reports\entity-based\User Form.xlsx". In this case, you may access the template for generating the report with any model file. You may also change the name of the folder "User Form (xlsx)" to any name desired. This name will replace the name in the format list. You may save the generated report in any location.
        BuildITUserFormReport_CustomizedName.png

Generate the report using the new template

  1. Select the appropriate Report Outline in the "Report" tab. The report will be populated following the template file format.
    BuildITUserFormReport_ReportOutline.png
  2. Make sure that the report format is "User Form (xlsx)" or the customized name format.
    1. Go to the "Report" tab, and click on "Report Settings" BuildITUserFormReport_ReportOptionsIcon.png.
    2. Change the format to "User Form (xlsx)" or to the customized name format created (see Option 3 of step 2c. from Section "Modify your template with the information from the User Form report"), and click OK.
      BuildITUserFormReport_ReportOptionsSelectUserForm.png
  3. Generate the report.
    1. Click on "Generate Report" BuildITUserFormReport_GenerateReportIcon.png.
    2. Save the file with any name in the folder according to the chosen option (see step 2.c. from Section "Modify your template with the information from the User Form report").
    3. If BuildIT finds the "template.xlsx" file, the message below should be displayed. You may click OK and the report will be generated automatically base on the "template.xlsx" file.
      BuildITUserFormReport_ReportSuccessPopup.png
    4. If BuildIT did not find the "template.xlsx" file (typically because the report was not saved on the same location as the "template.xlsx" file), the following message will be displayed.
      BuildITUserFormReport_TemplateNotFoundPopup.png

Populate your Template with Multiple User Form Reports

If you need to fill up your template with different reports, you will need to generate multiple User Form reports with the respective needs.

This would be useful for (among others):

  • Filling up a report with information referenced to more than one coordinate systems
  • Filling up a report over time
  • Filling up a report from various models or parts (i.e. various BuildIT files)

Note: Populating a template with multiple User Form reports will only be available in BuildIT version 2020 and later.

  1. Follow all steps from “Create a User Form Report” section as many User Form reports are needed to fill up your template with the required entities on each report outline. Make sure to generate each User Form report with the necessary changes done prior to generating it (i.e. change coordinate system, BuildIT file, etc.)

    You may create a new outline for each User Form report needed within the same BuildIT file by clicking on the “Report” tab:
    • Option 1: “New Outline” command BuildITUserFormReport_NewOutlineIcon.png if different entities are needed. Then, add the required entities
    • Option 2: “Copy Outline” command BuildITUserFormReport_CopyOutlineIcon.png if all or most entities are the same as a previous outline. Then, add additional entities if needed
  2. Name each report outline according to its use (Ex. coordinate system) and select the appropriate User Form format by clicking the “Report Settings” command BuildITUserFormReport_ReportOptionsIcon.png. You may switch from among the different outlines by clicking the scroll-down arrow of the “Report” tab.
    BuildITUserFormReport_SwitchOutlines.png
    For example, if different coordinate systems are needed as reference for the same measurements, you may generate the same report outline with one coordinate system at a time to report the same entities with respect to each coordinate system. You may switch from among the different coordinate systems by clicking the scroll-down arrow of the “Units” toolbar.
    BuildITUserFormReport_SwitchCord.png
  3. Follow all steps from “Modify your template with the information from the User Form Report” section by repeating its step 2.a. for each User Form report generated in previous step above. At the end of this step you would have a complete template at the desired location.
  4. Follow all steps from “Generate the report using the new template” section for each report outlines needed to fill your report. Each time you want to add information to a report, you need to save the report with the same name and location when generating a report. After each repetition do the following:
    1. When saving click Yes on the message popup shown below.
      BuildITUserFormReport_ConfirmSaveAsPopup.png
    2. Then, click Yes to add new information to the existing report.
      BuildITUserFormReport_AddNewInfoPopup.png

FAQs

Once I generate the User Form report, the report is not created and BuildIT gives the following error message “Unable to generate report file” or it simple does nothing. What should I do?

To let BuildIT Support understand the issue and help you, you will need to repeat the generation of the User Form Report with the report debug option turned on. This option will allow creating the User Form report with Excel/PowerPoint visible and generate an additional log file. To turn this option on, follow the instructions below,

  1. Open “C:\Program Files\BuildIT\BuildIT VERSION 20xx.x\reports\entity-based\User Form (xlsx)”

  2. Right-click on “run.bat” and select “Edit”

    edit_batfile.png

  3. Change the value of “set DEBUG=0” to “set DEBUG=1” and save.

    set_debug1.png

  4. Try generating the User Form report again through BuildIT

    1. Take a screenshot of any error message generated on Excel/PowerPoint and on BuildIT and save them.

    2. Open the folder where you were saving the report and find the file “*.log” that was just generated.

  5. Send the screenshots and the log file to BuildIT Support at support@builditsoftware.com 

  6. You may turn it off by following the same steps but changing the value back to “set DEBUG=0”