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 - 2023 CAM2 - 2018 CAM2 - Measure 10 CAM2 - Measure Q CAM2 - Measure X CAM2 - Measure 3/4 CAM2 - AnthroCAM CAM2 - 2019 CAM2 - 2020
CAM2 CAM2 - 2021                  
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 Connect FARO Connect - Connect                  
FARO Zone present4D - present4D                  
FARO Zone 2D FARO Zone 2D - 2018 FARO Zone 2D - 2019 FARO Zone 2D - 2020 FARO Zone 2D - 2021 FARO Zone 2D - 2022 FARO Zone 2D - 2023        
FARO Zone 3D FARO Zone 3D - 2018 FARO Zone 3D - 2019 FARO Zone 3D - 2020 FARO Zone 3D - 2021 FARO Zone 3D - 2022 FARO Zone 3D - 2023 FARO Zone 3D - 2024      
FARO Zone 3D Advanced FARO Zone 3D Advanced - 2018 FARO Zone 3D Advanced - 2019 FARO Zone 3D Advanced - 2020 FARO Zone 3D Advanced - 2021 FARO Zone 3D Advanced - 2022          
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 FaroArm/ScanArm - Gage FaroArm/ScanArm - Quantum S Max FaroArm/ScanArm - Quantum M Max FaroArm/ScanArm - Quantum E Max FaroArm/ScanArm - Gage Max        
GeoSLAM Software GeoSLAM Software - Connect GeoSLAM Software - Draw GeoSLAM Software - Hub GeoSLAM Software - Volumes            
GeoSLAM ZEB GeoSLAM ZEB - Horizon GeoSLAM ZEB - Horizon RT GeoSLAM ZEB - Revo GeoSLAM ZEB - Revo RT GeoSLAM ZEB - Go          
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 3D Hand Held Scanner - Freestyle 2          
Language Quality HT MT AT NT INT - Internal Sales - Internal Resources Sales - Order and Quote Sales - Product Info Sales - Sales Readiness Sales - Training
Language Quality Sales - Product Launch Sales - Promotions CS - Quote to Invoice CS - Phone System CS - New Hire Training CS - General CS - Product Info CS - Licensing CS - Procedures General CS - Procedures Salesforce
Language Quality CS - Procedures Loaner CS - Procedures SAP                
Languages Language - English Language - Japanese Language - German Language - Chinese Language - Spanish Language - Italian Language - Portuguese Language - French Language - Korean  
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 3D Laser Scanner - Swift 3D Laser Scanner - Focus Premium
Laser Scanner 3D Laser Scanner - Focus Core                  
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 Gage Legacy Gage - Bluetooth Legacy Gage - Plus Legacy Gage - Standard Legacy Gage - Power            
Legacy Software Legacy Software - CAM2 Gage Legacy Software - Gage Software Legacy Software - Insight              
Mobile Scanner Mobile Scanner - Orbis                  
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                  
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 2Go App SCENE - 2018 SCENE - 7.x SCENE - 6.x SCENE - 5.x SCENE - 4.x SCENE - LT SCENE - 2019
SCENE SCENE - 2go App SCENE - 2020 SCENE - 2021 SCENE - 2022 SCENE - 2023          
Serial FaroArm Serial FaroArm - Silver Serial FaroArm - Gold Serial FaroArm - Bronze              
Sphere FARO Sphere - Sphere                  
Visual Inspect Visual Inspect - App Visual Inspect - CAD Translator                
WebShare WebShare - Enterprise WebShare - WebShare Cloud                



FARO® Knowledge Base

Advanced Configuration of Processing Jobs in WebShare Enterprise



This document describes advanced configuration of processing jobs in WebShare Enterprise. You only need to consider these options if you encounter frequently failing jobs. Also please check that your server fulfills the system requirements for WebShare Enterprise.

We refer to long-running CPU-intensive jobs as “processing jobs”. Every user with the Domain Administrator role can see all current or previous jobs in the Job Queue Administration UI.

General Guidelines

  • All configuration files mentioned here use the YAML file format.
  • Lines starting with a hash character # are YAML comments, and don’t have any effect.
  • To edit a file with root permissions on the commandline, you can use e.g. the “Nano” editor: $ sudo nano <FILE>
  • Any changes made to these configuration files will be reverted once you install an update of WebShare Enterprise. Therefore it is recommended to take a note of your changes, in case that you want to apply them again later.

Point and Scan Exports

Currently, always up to two jobs of each type (point or scan export) run in parallel. This limit is not configurable. This limit does not include jobs that have crashed and are stuck in “running” state. If needed, the administrator can configure the size limit and reserved disk space for point and scan exports. To do so, proceed as follows:

  1. Open /opt/faro-webshare/etc/template/docker-compose.template.yaml using an editor with root permissions.
  2. Replace all occurrences of --size-limit 100 with your preferred size limit for exports in gigabytes.
    • E.g. use --size-limit 123 for a limit of 123 GB. If the exported file is larger than this limit, the export will abort. In some cases, the user may still be able to download the partial export up to this point.
  3. Replace all occurrences of --reserved-space 2 with your preferred reserved disk space in gigabytes.
    • E.g. use --reserved-space 10 to make sure that the exporter won’t touch the last 10 GB of the disk. If the free disk space during a point or scan export is below this limit, the export will abort with an error. In some cases, the user may still be able to download the partial export up to this point.
  4. There are some further options that you can change if needed:
    • --thread-factor 2
      Number of threads = 2 * number of CPU cores. If your CPU is overloaded, choose a smaller value.
    • --creation-speedup-factor 1
      Trade-off CPU vs. memory usage. Small value = Long computation time but lower memory usage. Big value = Short computation time but higher memory usage. It is recommended to choose a value between 1 and 50.
    • --purge 7
      Delete each exported file after 7 days. Change according to your user’s needs.
  5. After you have saved your changes to this file, restart WebShare Enterprise using: sudo faro-webshare stop; sudo faro-webshare up -d

Point Cloud and Orthophoto Creation

By default, up to two jobs of each type (Orthophoto or Point Cloud) are run in parallel. This limit includes jobs that have crashed and are stuck in “running” state. Use the Job Queue Administration UI as described in the user manual to cancel or restart such jobs. To configure Orthophoto and Point Cloud job processing, please proceed as follows:

  1. Open /opt/faro-webshare/etc/template/webshare_ws.template.yml using an editor with root permissions.
  2. If you want to change the maximum number of jobs running in parallel, update the value of:
    wsworker_orthophoto.max_parallel or wsworker_projectpointcloud.max_parallel
  3. If you want to change the maximum RAM usage, in particular of the point cloud builder, update this configuration parameter:wsworker_projectpointcloud.max_heap or wsworker_orthophoto.max_heap (for the Orthophoto builder).
  4. In the lines below, only one of the properties ("mb", "percent_total"  or "percent_available") should be enabled; the other two should be commented out. (Lines starting with # are “commented out” = disabled.)
    • mb
      Configures the absolute memory limit in megabytes.
    • percent_total
      Configures the memory limit relative to the total RAM of your server (percentage).
    • percent_available
      Configures the memory limit relative to the currently available RAM of your server (percentage). The available RAM is measured when the job is started.
      • It is recommended to conservatively configure the memory limits. This means that you should keep enough RAM left for the operating system and WebShare Enterprise in general. If you allow the processing jobs to consume too much memory, your server may become unresponsive and need a reboot. Here are a few example configurations.
      • Example 1: Run max. 1 point cloud job in parallel, each job using up to 5000 MB of RAM:
        wsworker_projectpointcloud.max_parallel: 1
             mb: 5000
             #percent_total: 10
             #percent_available: 20
      • Example 2: Run max. 4 point cloud jobs in parallel, each job using up to 10% of your total RAM:
        wsworker_projectpointcloud.max_parallel: 4
             #mb: 5000
             percent_total: 10
             #percent_available: 20
      • Example 3: Run max. 2 point cloud jobs in parallel, each job using up to 20% of your available RAM:
        wsworker_projectpointcloud.max_parallel: 2
             #mb: 5000
             #percent_total: 10
             percent_available: 20

  5. After you have saved your changes to this file, restart WebShare Enterprise using: sudo faro-webshare stop; sudo faro-webshare up -d


  • Was this article helpful?