====== Install Orbit 3DM Publisher - CONNECT Edition ======

This page describes the installation of "Orbit 3DM Publisher CONNECT Edition". 

===== Prepare ======

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

=== Server Requirements ===

Review the hardware and operating system requirements. \\
[[231:technology:platforms:specs_server|]]

=== 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]]

===== Download 3DM Publisher Installer =====

  - 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.

===== Configure Bentley License Client - Server Mode =====

=== Notes ===

  * 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 possible 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 ===

  - Open Command Prompt as Administrator
    - 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>))
    - Close "CONNECTION Client" window without signing in.
    - Wait for the "Bentley Login Client" window to pop-up. 
  - Log in to "Bentley Login Client"
    - Enter user credentials
    - Wait for "The Login has completed successfully. You can exit now."
    - Close "Bentley Login Client" window
    - Wait for the "Bentley Activation Wizard" window to pop-up
  - Proceed with "Bentley Activation Wizard"
    - Choose "Register Server"
    - Register this machine for Bentley Server Products
      - Review Machine Name
      - Select Country
      - 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 the Command Prompt

=== Bentley CONNECTION Client - Offline Activation ===

  - [[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]]

===== Install Orbit 3DM Publisher Service =====

=== Stop and Remove Old Instance ===

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 "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)
  - Verify Windows Services, “Bentley Orbit 3DM Publisher Service” to be removed.

=== Install and Start New Instance ===

  - 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)
  - Verify Windows Services, status of "Bentley Orbit 3DM Publisher Service" to be "Running"
  - Verify Orbit 3DM Publisher Product Entitlement 
    - Orbit 3DM Publisher Console, default configuration: Http://localhost:1111/console (password "admin")
    - Navigate to System > Connect License > Green, Validated 

===== Copy Orbit 3DM Publisher Setup Configurations =====

Copy customization from the previous installation (required at every installation).

  - Stop “Orbit 3DM Publisher Service”
  - Copy files/folder from the previous installation directory and paste replacing existing files into the new installation directory.
    * Copy & paste files: program/config/amazon.store.*.ini
    * Copy & paste files: program/config/azure.store.*.ini
    * Copy & paste folder: program/services/http
    * Copy & paste folder: program/services/http80
  - Copy customizations from program/bin/ServiceInstall.bat (Do not copy the file!)
     * Https proxy configuration \\ ''set JAVA_OPTIONS=-Dhttps.proxyHost=xxx;-Dhttps.proxyPort=xxx;-Dhttps.proxyUser=xxx;-Dhttps.proxyPassword=xxx''
  - Start “Orbit 3DM Publisher Service”
===== Migrate Orbit 3DM Publisher 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. 

  - Stop “Orbit 3DM Publisher Service”
  - Copy files/folders from previous installation directory and paste replacing existing files into "Orbit 3DM Publisher Service Data".
    * Copy folder: <Previous Install Dir>/server/program/services/publisher_3dm
    * Copy folder: <Previous Install Dir>/server/program/services/wfs (Optionally if WFS configurations added)
    * Copy folder: <Previous Install Dir>/server/program/services/wms (Optionally if WMS configurations added)
    * Copy file: <Previous Install Dir>/server/program/system/connections.xml
    * Paste replacing existing files into <Install Dir>/../Orbit 3DM PUblisher Service Data/
  - Start "Orbit 3DM Publisher Service"