Deployment‎ > ‎

Local deployment

How to install a local NOL server on a Windows machine

  1. It is assumed you downloaded a file usually named bim.zip that contains two folders, NOLClient and NOLServer.
  2. System requirements: Windows 10 and Revit 2018 or 2019
  3. Extract bim.zip into C:\bim, then you should have this folder structure:
      • C:\bim
        • NOLClient   -   Plugins for Archicad. Revit and Rhinoceros, see also contained readme.txt file
          • archicad   - The NOL plugin for Archicad up to version 2017 (that might work for later versions as well)
          • cache  -  Cached contents that can be disposed of any time with no harm
            • RevitFamilies   -   contains generated RFA files to be reused
          • debug  -  Logs Revit NOL performance metrics but also problems with the NOL plugin
          • revit  -    Contains all Revit relevant files and folders
            • plugin\bin\Release    -    Contains the NOL assembly for Revit 2018/2019
            • templates   -     NOL-generated families are based on these templates
          • rhinoceros  -   NOL plugin for Rhino - no geometry support yet
        • NOLServer   -   Contains the server components, see also contained readme.txt file
          • apache-tomcat    -     The web server containing the NOL web application at webapps\raascms.war
          • cache    -   Cached contents that can be disposed of any time with no harm 
            •  transformations   -   Caches transformation results, e.g. the conversion of an IFC file to a COLLADA file  
          • db  -   Contains the h2 database data (as PostgreSQL would need a proper system installation, h2 is the default)
          • gltf   -   Converter from Collada to glTF graphics format
          • IfcConvert    - Converter from IFC to Collada graphics format
          • openjdk    -    AdoptOpenJDK is used by default as JRE for tomcat
          • raasserver   -    Contains configuration file cdo-server.xml which let you change various database mapping aspects
  4. You can start the NOL server by the update_and_restart.bat command in the NOLServer directory. Readme.txt contains further advice.
    • A Tomcat window will open. To shut down your web server, close this window
    • Open http://localhost:8123/raascms/ui in your web browser (Chrome is recommended). Note: if the content does not load immediately, press F5 to refresh the page
  5. To update to a new version of the NOL client/server:
    1. You should close all CAD software that have NOL plugins loaded and you should close the Tomcat window as well
    2. Delete C:/bim and proceed at step 1 at the very top
      • If you want your database contents preserved, you should copy the C:\bim\NOLServer\db folder to somewhere else, and after extracting the bim.zip replace the pre-existing database content at C:\bim\NOLServer\db with your copy

FAQ
  •  I am having trouble when “Consulting the NOL” The error message is Failed to look up template "Walls" in the Object Libary
    • This is not a bug, it rather means that there is no "generic" Cobie template for Walls that is expected to be found at RepositoryRoot/Templates/Wall_USERDEFINED_US . It has been only provided exemplary for the Window type by copying RepositoryRoot/Product Lines/Windows/Aluminium Windows/Windows_Sliding-600hx1200w-(200)Generic to RepositoryRoot/Templates/Window_USERDEFINED_US, but it should be done in a more systematic way.
  • I don't see the "Consult National Object Library" in Revit under Add-ins -> External Tools
    • You probably forgot to copy C:\bim\NOLClient\revit\NationalObjectLibrary.addin to C:\ProgramData\Autodesk\Revit\Addins\2018\ or C:\ProgramData\Autodesk\Revit\Addins\2019\  
  • Should the http://localhost:8123/raascms/ui address be somewhere in the config.ini files?
    • The value for the RAASCMSURL entry in C:\bim\NOLServer\config.ini determines the web address that the NOL plugin in Revit or Archicad navigates to contact the National Object Library. So theoretically you could use also http://google.com in the config.ini, and Google would open up when executing Consult National Object Library, and if Google would support the NOL API REST interface, it would actually work to use Google as Object Library! Until this happens, you should keep addressing the web server that is started by executing the update_and_restart.bat script which is launching a local tomcat server. You can even modify that URL in some parts:
      • To change the port number, open C:\bim\NOLServer\apache-tomcat\conf\server.xml in an editor and search for port="8123" and change it e.g. to port="8080" 
      • To change the "raascms" part to e.g. "nol", rename raascms.war in C:\bim\NOLServer\apache-tomcat\webapps\ to nol.war
      • The NOL web app will then be available at http://localhost:8080/nol/ui and this address should be used then in the config.ini 
  • I have Java 11.0.2.0 installed. Do I still need to change this?
    • The NOL server is using the JDK found in C:\bim\NOLServer\openjdk, so you can have any - or none at all - Java version installed on your system, it will not be picked up anyways. If you want to use a specific JDK (e.g. to increase performance of the web server), provide the path to its installation folder in the line starting with set JAVA_HOME= in update_and_restart.bat .
  • I now have the Addin in both Revit 2018 & 2019, but after activating NOL & Tomcat, and then opening Revit, it doesn't activate the NOL. It works separately in the browser OK, but I would like to have it to work from Revit too.
    • If you see the Consult National Object Library action in Revit but clicking it doesn't do anything, it is likely that a virus scanner has blocked the NOL DLL from being loaded. In this case, in your C:\bim\NOLClient\revit\plugin\bin\Release folder, right click the dll file and in the properties panel, click Unblock .
  • When I delete the files in the C:\bim\NOLClient\debug folder then opened Revit and tried the NOL, It still didn't initiate. there was nothing written into the debug folder  Any clues with that?
    • Same reason like previous point. If the NOL plugin can't be executed for any reason, it can't write log information into the debug folder.
  • What is the password for Librarian and Operator?
    • Both have the same password.
  • If you still are stuck with Revit & NOL, please zip the C:\bim\NOLClient\debug  and the C:\Users\%USERNAME%\AppData\Local\Autodesk\Revit\Autodesk Revit 2018\Journals folders and send to your NOL specialist! Best you delete all files in the C:\bim\NOLClient\debug folder first, then open Revit and reproduce the bug in Revit to write out minimal log information.