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/02/13 20:11]
jeroen [Copy Customizations] 		dev:technology:platforms:install_publisher_connect [2024/03/22 13:46] (current)
glen [Copy Private Customizations]
Line 1: Line 1:
-====== Install Orbit 3DM Publisher - CONNECT Edition ======+====== Install Orbit 3DM Publisher ======
  
 This page describes the installation of "Orbit 3DM Publisher CONNECT Edition".  This page describes the installation of "Orbit 3DM Publisher CONNECT Edition". 
  
-===== Preparations ======+===== Prepare ======
  
 A well-prepared installation will take no longer than 15 minutes.  A well-prepared installation will take no longer than 15 minutes. 
Line 9: Line 9:
 === Server Requirements === === Server Requirements ===
  
-Review the hardware and operating system requirements. +Review the hardware and operating system requirements. \\ 
-    * [[dev:technology:platforms:index|]] +[[dev:technology:platforms:specs_server|]]
-    * [[dev:technology:platforms:specs_server|]]+
  
 === Bentley Product Entitlement === === Bentley Product Entitlement ===
  
-Verify your product entitlement: \\ [[https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/38028/entitlement-management-overview|Bentley Communities > Entitlement Management Overview]]+Verify your product entitlement. \\ 
 +[[https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/38028/entitlement-management-overview|Bentley Communities > Entitlement Management Overview]]
  
-===== Download installer  =====+===== Download 3DM Publisher Installer =====
  
-  - Download from [[https://softwaredownloads.bentley.com/|]] > Orbit 3DM Publisher +==== Bentley CONNECT Installer ====
-  - Install in a directory with full access, e.g. ''C:\Programs\Bentley\Orbit 3DM Publisher <Version>\''+
  
-===== Configure Bentley CONNECTION Client - Server Mode =====+  - Download from Software Downloads \\ [[https://softwaredownloads.bentley.com/|]] > Brand: Orbit > Product: Orbit 3DM Publisher 
 +  - Install in a directory with full access \\ e.g. ''C:\Programs\Bentley\Orbit 3DM Publisher <Version>\'' 
 +  - Complete 3DM Publisher Installation Wizards 
 +  - Close "CONNECTION Client" window without signing in. 
 + 
 +==== Legacy Orbit Installation Setup ==== 
 + 
 +Download the installation package according to the purchased product. \\ 
 + 
 +  * ftp://ftp.orbitgt.com 
 +  * Login: ''OrbitSetups'' 
 +  * Password : ''OrbitGT!'' 
 + 
 +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, [[2310:technology:platforms:index|]]. 
 + 
 + 
 +===== Configure Bentley License Client ===== 
 + 
 +Only required for Bentley CONNECT installation.
  
 === Notes === === Notes ===
  
-  * The Bentley CONNECTION 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 CONNECTION 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-licensed products simultaneously on one and the same machine.+  * It is not possible to run both CONNECT Edition "Desktop" and "Server" mode licensed products simultaneously on one and the same machine.
  
-=== Set Bentley CONNECTION Client to Server Mode - Online Activation ===+=== Set Bentley License Client to Server Mode - Online Activation ===
  
   - 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 Bentley.Licensing.ServerModeSetup.exe --clear)) +    - Run twice "Bentley.Licensing.ActivationWizard.exe /serversetup" ((To switch back to Desktop Mode, run <nowiki>Bentley.Licensing.ServerModeSetup.exe --clear</nowiki>)) 
-    - Wait 1 minute +    - Close "CONNECTION Client" window without signing in. 
 +    - Wait for the "Bentley Login Client" window to pop-up. 
   - Log in to "Bentley Login Client"   - Log in to "Bentley Login Client"
     - Enter user credentials     - Enter user credentials
     - Wait for "The Login has completed successfully. You can exit now."     - Wait for "The Login has completed successfully. You can exit now."
-    - Close dialog "Bentley Login Client" +    - Close "Bentley Login Client" window 
-    - Wait 1 minute+    - Wait for the "Bentley Activation Wizard" window to pop-up
   - Proceed with "Bentley Activation Wizard"   - Proceed with "Bentley Activation Wizard"
     - Choose "Register Server"     - Choose "Register Server"
-    - Register this machine for Bentley SErver Products+    - Register this machine for Bentley Server Products
       - Review Machine Name       - Review Machine Name
       - Select Country       - Select Country
-      - De-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     - Add or Remove Products to Activate
       - Do not add any product.       - Do not add any product.
-      - Verify display "Server Mode: On" +      - Verify display, left lower corner red-colored, "Server Mode: On" 
-      - Verify display "Server Registered Successfully"+      - Verify display, left lower corner red-colored, "Server Registered Successfully"
       - Close dialog "Bentley Activation Wizard"       - Close dialog "Bentley Activation Wizard"
 +    - Close the Command Prompt
  
 === Bentley CONNECTION Client - Offline Activation === === Bentley CONNECTION Client - Offline Activation ===
Line 57: Line 80:
   - [[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]]   - [[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]]
   - [[https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50541/server-product-access-keys|Server Product Access Keys]]   - [[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 ===== ===== Install Orbit 3DM Publisher Service =====
Line 64: Line 86:
  
 Only one instance of Orbit 3DM Publisher Service can run using the default configurations. \\ Only one instance of Orbit 3DM Publisher Service can run using the default configurations. \\
-Stop and uninstall previously installed Orbit 3DM Publisher Service if applicable. +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 "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)
 +  - Verify Windows Services, “Bentley Orbit 3DM Publisher Service” to be removed.
  
 === Install and Start New Instance === === Install and Start New Instance ===
Line 73: Line 96:
   - Install "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceInstall.bat (Run as administrator)   - Install "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceInstall.bat (Run as administrator)
   - Start "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceStart.bat (Run as administrator)   - Start "Orbit 3DM Publisher Service" \\ <Install Dir>/program/bin/ServiceStart.bat (Run as administrator)
-  - Verify Windows Services status of "Bentley Orbit 3DM Publisher Service" to be "Running"+  - Verify Windows Services, status of "Bentley Orbit 3DM Publisher Service" to be "Running"
   - Verify Orbit 3DM Publisher Product Entitlement    - Verify Orbit 3DM Publisher Product Entitlement 
     - 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 
  
-===== Copy Customizations =====+===== 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. \\ 
 +From version 23.1, Publisher Setups are sharing the Service Data folder from the Parent Install Dir.
  
-Copy customization from previous installation 
   - Stop “Orbit 3DM Publisher Service”   - Stop “Orbit 3DM Publisher Service”
-  - Copy files/folder from previous installation and paste replacing existing files into new installation, same relative directory +  - 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. 
-    * Files: program/config/amazon.store.*.ini +    * Copy files: <Previous Install Dir>/server/program/services/http/keystore.* 
-    * Files: program/config/azure.store.*.ini +    * Copy folder: <Previous Install Dir>/server/program/services/publisher_3dm 
-    * Folder: program/services/http +    * Copy folder: <Previous Install Dir>/server/program/services/wfs (only if WFS configurations have been used) 
-  - Copy customizations from program/bin/ServiceInstall.bat (Do not copy the file!) +    * Copy folder: <Previous Install Dir>/server/program/services/wms (only if WMS configurations have been added) 
-     * Procrun service: FIXME +    * Copy file: <Previous Install Dir>/server/program/system/connections.xml 
-     * Https proxy configuration, see ''set JAVA_OPTIONS=-Dhttps.proxyHost=xxx;-Dhttps.proxyPort=xxx;-Dhttps.proxyUser=xxx;-Dhttps.proxyPassword=xxx'' +    * Paste replacing existing files into <Install Dir>/../Orbit 3DM Publisher Service Data/ 
-  - Start “Orbit 3DM Publisher Service” +  - Review HTTP service configuration 
-===== Migrate Orbit 3DM Publisher Service Data =====+    * Edit file: <Install Dir>/../Orbit 3DM Publisher Service Data/http/configuration.ini (port, secure) 
 +  - Start "Orbit 3DM Publisher Service"
  
-One-time migration of Orbit 3DM Publisher Service Data when updating from version 22.10 or older to version 23.1 or higher. +===== Copy Private Customizations ===== 
 + 
 +Copy private customization if applicable from the previous installation (required at every installation or update). \\ 
 +These customizations do not come with a default installation. Private customization are added manually and need to be manually copied from <Previous Install Dir> into the new <Install Dir> if in use.
  
   - Stop “Orbit 3DM Publisher Service”   - Stop “Orbit 3DM Publisher Service”
-  - Copy folders/file from previous Installation and paste replacing existing file into "Orbit 3DM Publisher Service Data":  +  - Copy custom files and configurations 
-    * Copy folders +    * 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! 
-      * <Previous Install Dir>/server/program/services/publisher_3dm +    * Cloud Storage configuration. \\ Copy files: ./program/config/<cloud-storage-provider>.store.*.ini 
-      * <Previous Install Dir>/server/program/services/wfs (Optionally if WFS configurations added) +    * Portforwarding insecure 80 to secure 443 \\ Copy folder: ./program/services/http80 
-      * <Previous Install Dir>/server/program/services/wms (Optionally if WMS configurations added) +    * Private published files \\ Copy private files and folders: ./program/wwwwroot 
-    * Copy file  +    * Copy Bentley IMS callback file \\ ./program/wwwroot/viewer/assets/oauth-flow-callback.html 
-      * <Previous Install Dir>/server/program/system/connections.xml +  - Start “Orbit 3DM Publisher Service” 
-    * Paste into <Install Dir>/../Orbit 3DM PUblisher Service Data/ + 
-  - Start "Orbit 3DM Publisher Service"+
 
Last modified:: 2023/02/13 20:11