This is documentation of an archived release.
For documentation on the current version, please check Knowledge Base.

Orbit Desktop Client Installation

This page documents the options to install the Orbit Desktop Client.

Concepts

Centralized vs Distributed

The Orbit Desktop Client can be installed “Centralized” or “Distributed” as local clients.
Both options have pros and cons. Centralized clients maximize setup and maintenance efficiency. Distributed clients reduce the network requirements.

Solid Network Connection

Ensure at all times that the connection between Orbit Desktop Client and Orbit EOS Service, and the connection between the Java Runtime and the Desktop Client setup folder are not interrupted.
These network interruptions might cause respectively Client-Server DOX errors or the Java Runtime to crash.

Centralized Client

One Orbit Client is installed on the same computer as the Orbit Server.
All the Orbit users within the local network can start the Orbit Client via a shortcut that is using a network share to the Orbit Client directory.

Pros and Cons

This configuration is advised if Client and Server are in the same LAN having at least a 1GB network connection.

  • It makes updates and maintenance of Client and Server easy.
  • No special attention required regarding Client data management.

At startup of the Desktop Client, software and Java JRE are transferred from Server to Client generating +-300MB network traffic. Once started network traffic is limited to map, tabular data configuration updates.

Installation

  1. Share the Orbit Client directory with required permissions. If Clients generate Client Data, sharing should allow read and write.
  2. Point the client to communicate with the server :
    • Configuration file : <Orbit installation directory>/client/program/login.ini
    • Parameter : ServerLocation dox://<server ip or server name>:1100/
  3. Verify network communication is allowed.
    Client and Server communicate using DOX on a configured Port is allowed and not blocked by a Client or Server Firewall.
    More information about the DOX port, see Orbit Enterprise Service.
  4. Start Orbit Desktop Client
    //<server>/<client share>/program/bin64/Orbit.exe
    If a Shortcut is used, do set the “Start in” directory :
    //<server>/<client share>/program/bin64/
    Depending the Network Security settings, it might be required to run the Orbit Desktop Client as Administrator the first time only to register the Client on Server correctly.

Distributed Local Clients

Instead of one Central Client installation, a Local Client copy can be used to startup the Orbit Desktop Client.

Pros and Cons

Data, users, and workspaces are still centrally managed but the Orbit Desktop Client will start from a local copy. Consequently there no network traffic is generated when starting the Orbit Desktop Client application.
A Local Client copy can be used by multiple users, e.g. as a 2nd application server in a remote office.

Special attention is required at software updates. Next, some additional configurations must be enabled to maintain central storage of all client-side generated data.

Installation

Similar as for a single Central Client installation, but pointing the Orbit Desktop Client to a local copy of the Orbit “client” directory as available on the server. Before testing a Local Client installation, we advise testing first startup via the Central Client installation used as a reference to copy the Local Client.
When installing the Client on multiple computers, we advise copying the client setup to the same location for each computer. It simplifies updates and enables re-use of shortcut configurations.

Special attention is required when using Asset Inventory, contact support at Orbit GT.

Distributed Local Java Runtime

By default Orbit Clients use the bundled Java JRE.
It is possible to adjust the startup parameters to use the Java JRE installed on the client workstation.

Installation

Point the client to communicate with the server :

  • Configuration file : <Orbit installation directory>/client/program/bin64/Orbit.ini
  • Parameter : “..\jre\bin\javaw.exe”, replace by locally installed JRE, e.g. “c:/jre6/bin/javaw.exe”.
 
Last modified:: 2023/01/09 12:48