Knowledge Base
Recent Changes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
dev:technology:platforms:install_publisher_connect [2023/05/14 14:36]
jeroen [Copy Install Customizations] 		dev:technology:platforms:install_publisher_connect [2026/07/16 08:34] (current)
pieter [Copy Private Customizations]
Line 1: Line 1:
-====== Install Orbit 3DM Publisher - CONNECT Edition ======+====== Install & update Orbit 3DM Publisher ======
  
-This page describes the installation of "Orbit 3DM Publisher CONNECT Edition". +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.  
  
 ===== Prepare ====== ===== Prepare ======
Line 18: Line 19:
  
 ===== Download 3DM Publisher Installer ===== ===== Download 3DM Publisher Installer =====
 +
 +==== Bentley CONNECT Installer ====
  
   - Download from Software Downloads \\ [[https://softwaredownloads.bentley.com/|]] > Brand: Orbit > Product: Orbit 3DM Publisher   - Download from Software Downloads \\ [[https://softwaredownloads.bentley.com/|]] > Brand: Orbit > Product: Orbit 3DM Publisher
Line 24: Line 27:
   - Close "CONNECTION Client" window without signing in.   - Close "CONNECTION Client" window without signing in.
  
-===== Configure Bentley License Client - Server Mode =====+==== Legacy Orbit Installation Setup ==== 
 + 
 +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 : [[dev:technology:core:online_license_activation|]]. 
 + 
 +  * Legacy Orbit Publisher is available for Windows and Linux. \\ 
 +  * Read more, [[dev:technology:platforms:index|]]. 
 + 
 + 
 +===== Configure Bentley License Client =====
  
-=== Notes ===+Only required for Bentley CONNECT installation.
  
   * The Bentley License Client is automatically installed with "Orbit 3DM Publisher CONNECT Edition".    * 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.   * 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 possible to run both CONNECT Edition "Desktop" and "Server" mode licensed products simultaneously on one and the same machine.+  * It is not recommended to run both CONNECT Edition "Desktop" and "Server" mode licensed products simultaneously on one and the same machine.
  
 === Set Bentley License Client to Server Mode - Online Activation === === Set Bentley License Client to Server Mode - Online Activation ===
Line 36: Line 56:
   - Open Command Prompt as Administrator   - Open Command Prompt as Administrator
     - Go to "cd \Program Files\Common Files\Bentley Shared\CONNECTION Client\LicService"     - Go to "cd \Program Files\Common Files\Bentley Shared\CONNECTION Client\LicService"
-    - Run twice "Bentley.Licensing.ActivationWizard.exe /serversetup" ((To switch back to Desktop Mode, run <nowiki>Bentley.Licensing.ServerModeSetup.exe --clear</nowiki>)) +    - Run "Bentley.Licensing.ActivationWizard.exe /serversetup" ((To switch back to Desktop Mode, run <nowiki>Bentley.Licensing.ServerModeSetup.exe --clear</nowiki>))
-    - Close "CONNECTION Client" window without signing in.+
     - Wait for the "Bentley Login Client" window to pop-up.      - Wait for the "Bentley Login Client" window to pop-up. 
   - Log in to "Bentley Login Client"   - Log in to "Bentley Login Client"
Line 50: Line 69:
       - Select Country       - Select Country
       - Do not activate "Allow user outside of Bentley Systems Inc to use server"        - Do not activate "Allow user outside of Bentley Systems Inc to use server" 
-    - Add or Remove Products to Activate 
-      - Do not add any product. 
-      - Verify display, left lower corner red-colored, "Server Mode: On" 
-      - Verify display, left lower corner red-colored, "Server Registered Successfully" 
       - Close dialog "Bentley Activation Wizard"       - Close dialog "Bentley Activation Wizard"
     - Close the Command Prompt     - Close the Command Prompt
  
-=== Bentley CONNECTION Client - Offline Activation ===+**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
  
-  - [[https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/37164/installation---deployment-image|Get Bentley CONNECTION Client offline - deploy image]] +===== Install Orbit 3DM Publisher =====
-  - [[https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50541/server-product-access-keys|Server Product Access Keys]] +
- +
-===== Install Orbit 3DM Publisher Service =====+
  
 === Stop and Remove Old Instance === === Stop and Remove Old Instance ===
Line 69: Line 81:
 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.  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. 
  
 +  - Verify the Operating System Services and the current status of “Orbit 3DM Publisher Service”
   - Stop "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceStop.bat (Run as administrator)   - Stop "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceStop.bat (Run as administrator)
   - Remove "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceRemove.bat (Run as administrator)   - Remove "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceRemove.bat (Run as administrator)
Line 81: Line 94:
     - Orbit 3DM Publisher Console, default configuration: Http://localhost:1111/console (password "admin")     - Orbit 3DM Publisher Console, default configuration: Http://localhost:1111/console (password "admin")
     - Navigate to System > Connect License > Green, Validated      - Navigate to System > Connect License > Green, Validated 
 +  - Change the default password ("admin") to a personal password
 +    - Navigate to System > Admin user > Change Password
  
-===== Copy Install Customizations =====+===== Copy Private Customizations =====
  
-Copy private customization if applicable from the previous installation (required at every installation). \\ +Required at every installation or update. Copy private customization if applicable from your previous installation. \\ 
-These customizations do not come with a default installation and need to be copied manually into the same location from the previous to the new setup. +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.
  
   - Stop “Orbit 3DM Publisher Service”   - Stop “Orbit 3DM Publisher Service”
   - Copy custom files and configurations   - Copy custom files and configurations
-    * Cloud Storage configuration. \\ Copy files: program/config/<cloud-storage-provider>.store.*.ini +    * 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! 
-    * Java Install options \\ Review Https proxy 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 
-    * Portforwarding insecure 80 to secure 443 \\ Copy folder: ./program/services/http80 +    * Port forwarding insecure 80 to secure 443 \\ Copy folder: ./program/services/http80 
-    * Private published files \\ Copy private files and folders: ./program/wwwwroot+    * 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
   - Start “Orbit 3DM Publisher Service”   - Start “Orbit 3DM Publisher Service”
-===== Migrate Service Data ===== 
  
-One-time migration of Orbit 3DM Publisher Service Data when updating from version 22.10 or older to version 23.1 or higher. \\ +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. 
-From version 23.1, Publisher Setups are sharing the Service Data folder from the Parent Install Dir.+ 
 +===== Migrate Service Data (New Server) =====  
 + 
 +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.
  
   - Stop “Orbit 3DM Publisher Service”   - Stop “Orbit 3DM Publisher Service”
-  - Copy files/folders from the previous installation directory and paste replacing existing files into "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 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/ 
 +  - Delete file: <New Install Dir>/../Orbit 3DM Publisher Service Data/licenses_*.ini ((When migrating Service Data from Legacy Orbit to Bentley Connect.)).  
 +  - Start “Orbit 3DM Publisher Service” 
 + 
 +===== Migrate Service Data (Update from 22.10 or older) ===== 
 + 
 +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. 
 + 
 +  - Stop “Orbit 3DM Publisher Service” 
 +  - 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 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/publisher_3dm
-    * Copy folder: <Previous Install Dir>/server/program/services/wfs (if WFS configurations added) +    * 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 (if WMS configurations added)+    * 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     * Copy file: <Previous Install Dir>/server/program/system/connections.xml
-    * Paste replacing existing files into <Install Dir>/../Orbit 3DM PUblisher Service Data/+    * Paste to replace existing files in <Install Dir>/../Orbit 3DM Publisher Service Data/
   - Review HTTP service configuration   - Review HTTP service configuration
-    * Edit file: <Install Dir>/../Orbit 3DM PUblisher Service Data/http/confiugration.ini (port, secure/insecure)+    * Edit file: <Install Dir>/../Orbit 3DM Publisher Service Data/http/configuration.ini (port, secure)
   - Start "Orbit 3DM Publisher Service"   - Start "Orbit 3DM Publisher Service"
 +
 +
 
Last modified:: 2023/05/14 14:36