﻿VIEWIQ CONNECT 0.3.13 - Revit plug-in
=====================================

With ViewIQ Connect you publish your Revit model to ViewIQ
(https://app.viewiq.nl) in a few clicks. Works in Revit 2023, 2024, 2025,
2026 and 2027.

Language: Connect is available in English, Dutch and German. This download
is set to English. To choose another language, go to the Add-Ins tab in
Revit > ViewIQ Connect > Settings > "Taal / Language / Sprache". Connect remembers your choice, also
after an update.
Messages from the coordinate check and the property check come from the
ViewIQ server in Dutch; this guide gives the Dutch text with a
translation. All other server messages appear in the language of
Connect, and the ViewIQ website is also available in English.


1. WHAT YOU NEED
----------------

- An account on https://app.viewiq.nl. You get one via an invitation link
  by email.
- A project in ViewIQ in which you are a MODELLER or ADMINISTRATOR.
  If you are an administrator of your organisation, you can create a
  project yourself: Projects > New project.
  Without such a project, Connect has nowhere to publish to.
- Revit 2023, 2024, 2025, 2026 or 2027. No administrator rights needed.
- Using a version older than 0.3.13? Install this version over the old
  one; your API key and settings keep working.


2. CHECK THE DOWNLOAD FIRST
---------------------------

ViewIQ Connect is not yet digitally signed; a signed version will
follow once our certificate (SSL.com) has been issued. Until then, Windows and Revit may show a
warning during installation. That is why you check YOURSELF, before you
install anything, that the zip really comes from ViewIQ and has not been
changed on the way. You do this with the SHA-256 checksum:

1. Open https://viewiq.nl/download/ and find the checksum of this
   version (0.3.13, English). It is also in the file
   ViewIQ-Connect-0.3.13-en.zip.sha256 next to the download.
2. Calculate the checksum of the zip you downloaded:
   - PowerShell:       Get-FileHash .\ViewIQ-Connect-0.3.13-en.zip -Algorithm SHA256
   - Command Prompt:   certutil -hashfile ViewIQ-Connect-0.3.13-en.zip SHA256
3. Compare the two. They must be EXACTLY the same (upper or lower case
   does not matter).

Do they not match? Then do NOT install anything and email
security@viewiq.nl.
Do they match? Then you know that the warnings below are only about the
missing signature, not about the content.


3. INSTALLING
-------------

1. Extract the WHOLE zip: right-click the zip > Extract All.
   Do not start anything from inside the zip itself.
2. Close Revit.
3. In the extracted folder, double-click Installeren.cmd (= install).
   Do you see "Windows protected your PC" (SmartScreen)? That can happen
   while the validation of our certificate is in progress.
   Only if the checksum matched: click More info and then Run anyway.
   Connect is installed for every Revit version (2023-2027) on your PC.
4. Start Revit. The first time, Revit asks whether you trust the add-in,
   as long as the signature has not been validated. Check that the message
   mentions "ViewIQ Connect" from "Nexorah Group B.V.". Only if the
   checksum matched: choose "Always Load". In doubt? Choose "Do Not Load"
   and email us.

You will now see the ViewIQ Connect panel on the Add-Ins tab, with the
Publish and Settings buttons. (Up to version 0.3.12 Connect had its own
ViewIQ tab; from 0.3.13 that tab is gone.) Need help? Point at a Connect
button and press F1 to open the user guide on viewiq.nl.

Installing without a script (if your company blocks scripts):
1. Check the checksum first (chapter 2).
2. Right-click the zip > Properties. Does it say "Unblock" at the bottom?
   Tick it, click OK and then extract the zip (again). Otherwise Revit
   will not load the files.
3. Close Revit.
4. Open in File Explorer:  %AppData%\Autodesk\Revit\Addins\<year>\
   (e.g. ...\Addins\2025\). If the folder does not exist, create it.
5. From the extracted folder <year>\, copy the file ViewIQ.addin and the
   folder ViewIQ to it. You then have:
     ...\Addins\2025\ViewIQ.addin
     ...\Addins\2025\ViewIQ\ViewIQ.Connect.Revit.dll  (and the other DLLs
                                                    and taal.txt)
6. Start Revit and choose "Always Load" (only after the check in step 1).

Does your company's IT department control which software may run
(AppLocker, WDAC)? Then give them the checksum and this README; as soon as
Connect is signed, they will be notified.


4. CREATING AND SETTING UP A KEY (once)
---------------------------------------

Connect signs in with an API key, not with your password.

1. Sign in at https://app.viewiq.nl.
2. Click your name at the top right > My account.
3. Go to "API keys (ViewIQ Connect)".
4. Enter a name, for example "Revit laptop".
5. Click New key and then Copy.
   You only see the key once. Lost it? Simply create a new one.
6. In Revit: Add-Ins tab > ViewIQ Connect > Publish (or Settings).
7. Leave the server address as it is (https://app.viewiq.nl), paste your
   key and click Save. Connect tests the key straight away.

The key is stored encrypted for your Windows account and belongs to the
server address for which you saved it. Connect only works with the
ViewIQ address https://app.viewiq.nl. Does someone ask you to enter a
different address in Settings ("support", "backup", a numeric address)?
Do not do it and report it to your administrator: Connect refuses such an
address, and after a change of address it always asks for your key again.
If an older ViewIQ address was still filled in from a previous version,
Connect changes it to https://app.viewiq.nl itself; your key keeps
working.

An account is personal, and Connect works per account on ONE PC.
The first PC you publish from is linked to your account.
New or different PC? Ask the administrator of your organisation to
release the old PC (in ViewIQ: Organisation > next to your name
"Release PC"). For this, Connect only sends an
encrypted computer code and the PC name, and your Revit user name.

Your ViewIQ account also belongs to ONE Autodesk account (your sign-in in
Revit, top right). The first time you work with Connect, ViewIQ links
your account to the Autodesk account Revit is signed in with. If someone
else works with their own Autodesk account under your ViewIQ account,
Connect says: "This ViewIQ account is linked to a different Autodesk
account. Ask your administrator to release the link." New colleague on
this account or a
different Autodesk account? The administrator of your organisation
releases the link (in ViewIQ: Organisation > next to your name
"Release Autodesk"). Connect only sends an
encrypted code of your Autodesk account, never your Autodesk name or
email address.
Not signed in to Autodesk (e.g. an offline licence)? You can still
publish; Connect tells you, and ViewIQ records that it happened without
an Autodesk sign-in.


5. PUBLISHING
-------------

1. Click Add-Ins > ViewIQ Connect > Publish.
2. Choose the project.
3. Choose:
   - "New model": enter a name and discipline, or
   - "New version of an existing model": this is preselected if there is
     a model with the same name in ViewIQ. If you still choose
     "New model", you get a second (duplicate) model.
4. Under "What is included", choose:
   - 3D view: only what is visible in that view is included (a section
     box and hidden elements count), or "Whole model".
     Connect preselects: the view from last time for this model,
     otherwise a view with ViewIQ, IFC or Dalux in its name, otherwise
     the 3D view that is open, otherwise the whole model.
     Tip: create a fixed 3D view "ViewIQ" without a section box.
     Below the choice you see how many elements are included and how many
     there were at the previous publication. If there are more than 30%
     fewer, Connect first asks whether that is right (half a model because
     of a section box or detail view?).
   - IFC setup: "ViewIQ default" (IFC4 Reference View, shared
     coordinates, properties and base quantities; shapes as triangles,
     which exports faster; elements, properties and GUIDs stay the same),
     or an IFC export setup saved in the model, for example the one from
     your BIM execution plan with a classification and a parameter
     mapping file for IfcName. You create such a setup in Revit via
     File > Export > IFC > Modify setup; save it in the model.
     IFC setups are saved per Revit model: create them in the model you
     publish. They are not available in another model.
     The parameter file must be in the same place on this PC; if it is
     not there, Connect says so below the choice.
   - Phase: "Default" (the phase of the view), or a fixed phase.
   Connect remembers these choices per Revit model.
5. Optionally enter a comment (what has changed?) and click Publish.
   Connect first asks ViewIQ whether anything has changed and whether the
   coordinates are right (see below). That takes a few seconds, not the
   export.
   If several levels get the same name in the IFC (for example because
   the IfcName parameter is the same on all levels), Connect warns you
   first: ViewIQ then shows them as one storey. Give each level its own
   IfcName, or leave that parameter empty; then the level name is used.
6. Revit does not respond during the IFC export. That is normal: do not
   close Revit. Connect lets ViewIQ know every minute that it is still
   working. For a large building services model, the export (by Revit
   itself) can take a long time. If you published this model before, you
   see beforehand and during the export how long it took last time, for
   example "Last time, exporting took 3 h 3 min.".
   A small window keeps count: how many elements Revit has processed (the
   same counter as in the Revit status bar), how long it has been running
   and roughly how long it will still take.
   After that, Connect packs the IFC file as .ifczip (a zip with the IFC
   file inside, usually 80 to 90% smaller). You see the size before and
   after, for example "IFC 555 MB -> packed 61 MB". Uploading and
   processing then run in the background.
7. Done? Click "Open in ViewIQ".

No changes:
- If the model is saved, has not changed since the last version, and the
  3D view, IFC setup and phase are the same, Connect does not export.
  You see "No changes since version N". This also works if a colleague
  published the previous version from another PC.
- Want a new export anyway? Click "Publish anyway".
- Unsaved changes? Then Connect always exports.

Coordinate check:
- Before the export, Connect sends the active project location of your
  model (angle, east-west, north-south, elevation). ViewIQ compares it
  with the model with the discipline Architectural in the
  project. The difference may be at most 10 mm and 0.01 degrees.
- If your model deviates, Connect warns you with a message from the
  server such as
    "Dit model staat 111 graden 39' 36" gedraaid, BWK staat op 0 graden."
    (This model is rotated 111 degrees 39' 36", the architectural model
    is at 0 degrees.)
  Publishing continues; the viewer also shows the warning.
  In Revit, check Manage > Location (Location Weather and Site) and,
  for linked models, whether the coordinates are shared.
- Does Connect stop before the export anyway? Then the block is switched
  on at the server. The project administrator can then publish: enter a
  reason and click "Publish anyway". That applies to that one publication
  and is recorded in the audit log. A modeller cannot override this.
- If the model has been aligned in the viewer with Align models, you
  only get a warning, even if the block is on.
- If there is no architectural model in the project yet, or it has not
  yet been published with Connect 0.3.5 or later, Connect warns you and
  continues. So publish the architectural model first with this version.
- If two architectural models deviate from each other, Connect stops for
  every model in the project until those two are aligned. The message
  names them.
- In the viewer, a deviating model shows a warning with the button
  Align models. Once you align it, the warning disappears.

Every minute, Connect reports to ViewIQ how far the publication has got
(model, project, step, time per step), even while Revit is not
responding. You do not see any of this; if reporting fails, publishing
simply continues.

A publication may be as large as the server allows (currently 3000 MB,
packed). Connect checks this right after packing. Too large? Publish from
a 3D view with less visible, for example only your discipline.

Workshared model / Autodesk Docs (ACC, BIM 360):
- Connect suggests the name of the central model, not that of your local
  copy. Publishing from your local copy is fine.
- Linked models are not included. Publish each discipline separately.

Models on top of each other (coordinates):
- Connect exports with the Revit default settings and shared
  coordinates. Preferably publish both the architectural and the building
  services models via Connect; then they line up in ViewIQ.
- If you choose your own IFC export setup, the coordinate settings from
  that setup apply. Then use the same coordinate base for all
  disciplines.
- Exporting manually anyway: File > Export > IFC, keep the default
  settings and choose "Shared coordinates" as the coordinate base. Do NOT
  switch on "Include IFCSITE elevation...". If you mix that setting,
  models are shifted in height.

Colours by system in the viewer:
- Elements with connectors (ducts, pipes, fittings, air terminals,
  equipment) are placed in their system and get the system colour.
- Insulation, hangers and generic models do not belong to a system.


6. TROUBLESHOOTING
------------------

Log file: click "Open log file" in the window, or open
  %AppData%\ViewIQ\connect.log
  Send that file along when you report a problem. Your key is not in it.

"Your API key does not work (any more)."
  Create a new key (see 4) and paste it in Settings.

"ViewIQ Connect only works with the ViewIQ address ..."
  The server address entered is not the ViewIQ address. Set it back to
  https://app.viewiq.nl. Has someone asked you to set a different
  address? Report it to your administrator.

"Your saved API key belongs to ..., not to ..."
  The server address was changed after the key was saved. Paste a key for
  this address in Settings (again).

"No connection to ViewIQ."
  Check your internet connection. Via a company proxy or VPN, Connect
  uses the Windows proxy with your Windows account.

"Your company's proxy server is blocking ViewIQ." (error 407)
  Ask your IT department to allow app.viewiq.nl.

"The IFC file is ... MB; ViewIQ accepts up to ... MB."
  Publish from a 3D view with less visible.

"You are not in any project yet" / "You are only a viewer"
  Ask the administrator to add you to a project as a modeller.

"The connection was lost during the upload."
  Click Resume. Connect continues where it left off.

"This model is open as read-only."
  Open the model normally (not read-only) and publish again.

"Note: ..% fewer elements than the previous publication"
  Check the chosen 3D view: is a section box on, are elements hidden, or
  is it a detail view? Otherwise choose your fixed export view or
  "Whole model". If it is right (e.g. the model was cleaned up), click
  Yes.

"Dit model staat ... gedraaid, BWK staat op ..." / "... verschoven ..."
  (This model is rotated / shifted compared with the architectural model.)
  See Coordinate check under 5. Publishing. Your model is not in the same
  place as the architectural model.

"De bouwkundige modellen wijken onderling af"
  (The architectural models deviate from each other.) Align those two
  first; until then it is not clear which one is the reference.

"Note: .. levels get the same name in the IFC"
  See step 5 under Publishing: give each level its own IfcName.

"... is in ViewIQ, but note: Dit model heeft geen eigenschappen."
  (This model has no properties.) The model is in ViewIQ, but without
  properties (or with far fewer than the previous version). Choose the
  ViewIQ default under IFC setup, or switch on the property sets in your
  own IFC setup (Revit property sets and IFC common property sets).
  Then publish again. With Revit 2026, use at least Connect 0.3.9.

"The IFC export with the setup ... failed."
  Choose the ViewIQ default under IFC setup, or open the setup in
  File > Export > IFC and export there yourself to see the error.

"The IFC export failed."
  Try File > Export > IFC yourself; that usually shows what goes wrong.

ViewIQ Connect panel is missing
  Since 0.3.13 Connect is on the Add-Ins tab, no longer on its own ViewIQ
  tab. Did you restart Revit after installing? Did you choose "Do Not
  Load" when Revit asked? Then install again.
  Did you create your own keyboard shortcut or Quick Access Toolbar
  button for Publish or Settings? Set it up again after the update; the
  old one still points to the ViewIQ tab.

Revoking a key (e.g. lost laptop)
  app.viewiq.nl > your name > My account > API keys > revoke.
  Changing your password revokes all your keys.

Uninstalling
  Close Revit and double-click Verwijderen.cmd (= uninstall) in the
  extracted folder.


Nexorah Group B.V. - viewiq.nl
