Install & update Orbit 3DM Publisher

This page describes the installation of “Orbit 3DM Publisher”.
The 3DM Publisher can be licensed via the Bentley Connection Client or the legacy Orbit GT License Service.

A well-prepared installation will take no longer than 15 minutes.

Review the hardware and operating system requirements.
Requirements for Orbit 3DM Publisher

Verify your product entitlement.
Bentley Communities > Entitlement Management Overview

1. Download from Software Downloads
   https://softwaredownloads.bentley.com/ > Brand: Orbit > Product: Orbit 3DM Publisher
2. Install in a directory with full access
   e.g. C:\Programs\Bentley\Orbit 3DM Publisher <Version>\
3. Complete 3DM Publisher Installation Wizards
4. Close “CONNECTION Client” window without signing in.

Download the installation package according to the purchased product.

• sftp://orbitgtftp.blob.core.windows.net
  • Protocol: SFTP
  • Host: orbitgtftp.blob.core.windows.net
  • Login: orbitgtftp.orbitsetups
  • Password : S188b0HW8Bu6VgCpyzQ72VQBgiqqBtOC

• Request your Activation Key to validate your updated Product, contact Sales at Orbit GT.
  
• Read the updated license system, online connectivity is required : Orbit Product License & Activation.

• Legacy Orbit Publisher is available for Windows and Linux.
  
• Read more, System Requirements.

Only required for Bentley CONNECT installation.

• The Bentley License Client is automatically installed with “Orbit 3DM Publisher CONNECT Edition”.
• To license the Orbit 3DM Publisher, the Bentley License Client needs to be re-configured from the default “Desktop” to “Server” mode.
• It is not recommended to run both CONNECT Edition “Desktop” and “Server” mode licensed products simultaneously on one and the same machine.

1. Open Command Prompt as Administrator
   1. Go to “cd \Program Files\Common Files\Bentley Shared\CONNECTION Client\LicService”
   2. Run “Bentley.Licensing.ActivationWizard.exe /serversetup” ¹⁾
   3. Wait for the “Bentley Login Client” window to pop-up.
2. Log in to “Bentley Login Client”
   1. Enter user credentials
   2. Wait for “The Login has completed successfully. You can exit now.”
   3. Close “Bentley Login Client” window
   4. Wait for the “Bentley Activation Wizard” window to pop-up
3. Proceed with “Bentley Activation Wizard”
   1. Choose “Register Server”
   2. Register this machine for Bentley Server Products
      1. Review Machine Name
      2. Select Country
      3. Do not activate “Allow user outside of Bentley Systems Inc to use server”
      4. Close dialog “Bentley Activation Wizard”
   3. Close the Command Prompt

Only if required - Settings for proxy and firewall for Bentley Connexion Client and Bentley Licensing Tool in server mode https://bentleysystems.service-now.com/community?id=kb_article&sysparm_article=KB0018790

Only one instance of Orbit 3DM Publisher Service can run using the default configurations.
Stop and uninstall previously installed Orbit 3DM Publisher Service. The Service must be un-installed, but keep the previous version <Install Dir> as backup or to roll back when needed.

1. Verify the Operating System Services and the current status of “Orbit 3DM Publisher Service”
2. Stop “Orbit 3DM Publisher Service”
   <Install Dir>/program/bin/ServiceStop.bat (Run as administrator)
3. Remove “Orbit 3DM Publisher Service”
   <Install Dir>/program/bin/ServiceRemove.bat (Run as administrator)
4. Verify Windows Services, “Bentley Orbit 3DM Publisher Service” to be removed.

1. Install “Orbit 3DM Publisher Service”
   <Install Dir>/program/bin/ServiceInstall.bat (Run as administrator)
2. Start “Orbit 3DM Publisher Service”
   <Install Dir>/program/bin/ServiceStart.bat (Run as administrator)
3. Verify Windows Services, status of “Bentley Orbit 3DM Publisher Service” to be “Running”
4. Verify Orbit 3DM Publisher Product Entitlement
   1. Orbit 3DM Publisher Console, default configuration: Http://localhost:1111/console (password “admin”)
   2. Navigate to System > Connect License > Green, Validated
5. Change the default password (“admin”) to a personal password
   1. Navigate to System > Admin user > Change Password

Required at every installation or update. Copy private customization if applicable from your previous installation.
These customizations do not come with a new installation. Private customization are added manually and need to be manually copied from <Previous Install Dir> to the <New Install Dir> if used.

1. Stop “Orbit 3DM Publisher Service”
2. Copy custom files and configurations
   • Java Install options, Proxy configuration
     Copy configuration: ./program/bin/ServiceInstall.bat
     set JAVA_OPTIONS=-Dhttps.proxyHost=xxx;-Dhttps.proxyPort=xxx;-Dhttps.proxyUser=xxx;-Dhttps.proxyPassword=xxx
     Edits to the ServiceInstall.bat requires the the “Orbit 3DM Publisher Service” to be removed and re-installed!
   • Cloud Storage configuration.
     Copy files: ./program/config/<cloud-storage-provider>.store.*.ini
   • Port forwarding insecure 80 to secure 443
     Copy folder: ./program/services/http80
   • Private published files
     Copy private files and folders: any added customizations to the ./program/wwwwroot
   • Copy Bentley IMS callback file
     ./program/wwwroot/viewer/assets/oauth-flow-callback.html
   • Review Service Logon Properties
3. Start “Orbit 3DM Publisher Service”

Since version 26.2.0 Cloud Storage Configuration files can be moved to the <Install Dir>/../Orbit 3DM Publisher Service Data/storage folder. This had the advantage that they don't need to be copied on server updates.

Migrate Orbit 3DM Publisher Service Data from version 23.1 or higher to another installation. For example to migrate your 3DM configurations to a new clean setup.

1. Stop “Orbit 3DM Publisher Service”
2. Copy the “Orbit 3DM Publisher Service Data” folder from the previous installation and paste to replace the existing files in the parent directory of the new installation folder.
   • Copy folder: <Previous Install Dir>/../Orbit 3DM Publisher Service Data
   • Paste to replace the existing files in <New Install Dir>/../Orbit 3DM Publisher Service Data/
3. Delete file: <New Install Dir>/../Orbit 3DM Publisher Service Data/licenses_*.ini ²⁾.
4. Start “Orbit 3DM Publisher Service”

A one-time migration of Orbit 3DM Publisher Service Data when updating from version 22.10 or older to version 23.1 or higher.
From version 23.1, Publisher Setups share the Service Data folder from the Parent Install Dir.

1. Stop “Orbit 3DM Publisher Service”
2. Copy files/folders from the previous installation directory and paste to replace the existing files in the “Orbit 3DM Publisher Service Data” folder. The Service Data folder is new from version 23.1 and created at the first start of the“Orbit 3DM Publisher Service” in the parent directory of the Publisher installation folder.
   • Copy files: <Previous Install Dir>/server/program/services/http/keystore.*
   • Copy folder: <Previous Install Dir>/server/program/services/publisher_3dm
   • Copy folder: <Previous Install Dir>/server/program/services/wfs (only if WFS configurations have been used)
   • Copy folder: <Previous Install Dir>/server/program/services/wms (only if WMS configurations have been added)
   • Copy file: <Previous Install Dir>/server/program/system/connections.xml
   • Paste to replace existing files in <Install Dir>/../Orbit 3DM Publisher Service Data/
3. Review HTTP service configuration
   • Edit file: <Install Dir>/../Orbit 3DM Publisher Service Data/http/configuration.ini (port, secure)
4. Start “Orbit 3DM Publisher Service”