Table of Contents

Orbit 3DM Publisher Service

This page is a glossary and bundles technical information about the Orbit 3DM Publisher Service including Orbit Enterprise Orbit Service (EOS) and Internet Orbit Service (IOS) used for HTTP Web Service.

Table of Contents

Legacy EOS

The “Enterprise Orbit Service” or shortened “EOS” is Orbit's core server technologies for central storage, management, and sharing of Reference GIS and 3DM Mapping, Reality Resources.
EOS enables corporate management of users, permissions, workspaces, and licenses. It is the backbone of Orbit 3DM Publisher.

Server Config updates require Restart

Orbit Server configurations are loaded at Service Start. Changing server configurations requires the Orbit Service to be restarted.
Service installation changes (procrun and proxy settings) require the Orbit Service to be re-installed.

Cloud Storage Configuration

Configuration to connect and load resources from supported cloud blob storages.

Amazon S3 Bucket

type amazon
access.key xxx
secret.key xxx
region.name xxx
bucket.name xxx
readonly true
cache true
cache.expire.time 7200.0
file.content.read.thread.count 12

Amazon S3 compatible storage provider

endpoint.url https://play.min.io
forcePathStyle true

Azure Container

account.name xxx
account.key xxx
container.name xxx
readonly true
cache true
cache.expire.time 7200.0
file.content.read.thread.count 12

MinIO Object Store

type minio
endpoint.url xxx
access.key xxx
secret.key xxx
bucket.name xxx
readonly false
cache true
cache.expire.time 7200.0
file.content.read.thread.count 12

As of the 25.3.0 release the connection to MinIO storage will be done by using the Amazon S3 configurations.

Follow these migration steps:

Caching

Each storage connection has settings for caching file content. This prevents reading from a slow connection for parts of files that have already been read before. Disable the cache if you always want to read live content.

  1. cache is a boolean so either “true” or “false” (default is true)
  2. cache.expire.time is a number in seconds to keep a cache entry alive (default is 3600 seconds)
  3. file.content.read.thread.count is the number of concurrent connection threads to the storage (default is 10)

Global cache settings exist as well, they apply to all storage connections. The settings are defined in the global configuration file of the application.

  1. file.content.cache.block.size is the number of bytes in a cache entry (default is 262144 or 256KB)
  2. file.content.cache.block.count is the maximum number of cache entries (default is 0)
  3. file.content.cache.mem.percent is the percentage of memory available for caching (default is 0)

If both the block count and mem percent are zero then the number of cache entries defaults to 400 (100MB total cache size). But the recommendation is to set the mem percent to 50 to allow room for normal operations in addition to caching.

Cross-origin resource sharing

Configuration to set Cross-origin for Publisher service.
More information about CORS concepts

When embedding and accessing the Publisher from a different domain (for example from an SDK integration), all browsers apply cross-origin resource sharing restrictions.

Server Configurations

SDK Configuration

To enable cross-domain cookies, the SDK needs to get a specific startup option.
This may be needed for example when using Publisher with a load balancer that needs cookies to maintain session stickiness.

Example: Enable Cross-Domain with Cookies

Download Time-Out

Configuration to set URL to connect and download time-out.

Server Configurations

urldownloader.timeout.connect      120000
urldownloader.timeout.read         120000

DOX

Desktop Client-Server Communication

The Orbit toolkit is network-neutral. Connectivity requires an IP-resolve system (such as a DNS). The Data Orbit eXchange protocol or shortened “DOX” protocol is Orbit's proprietary communication protocol between the Orbit tiers.

DOX requires only 1 port to be accessible from the outside. Firewalls thus need only to open 1 port to allow remote access to an Orbit server system (in contradiction to standard Java RMI connectivity).
DOX is a compressed and binary way to do the communication between Orbit Client and Orbit Server in the most secure, simple, and fast way. It has no relation with HTTP or the alikes, but of course, runs over Tcp/Ip.
DOX does not influence any other protocol and cannot be hacked.

All Orbit Products are able to access remote EOS resources and instantly become client/server applications, providing access to corporate resources. Most Orbit products are available both in Standalone as in Client-Server.

File Access and Permission

The Orbit EOS service reads all resource requested by Orbit Clients and read & writes configurations as set by the EOS Console.
Consequently, Orbit EOS Service requires read access on all used resource files and read & write access to all Orbit setup and configuration files.

Access to network resources

Special attention is required regarding file access permissions for the Operating System User running the EOS service.
Additional note on Windows, Mapped Network Drives are not available to Operating System Services, use of Uniform Naming Convention (UNC) is required.

When adding resources to EOS, using the Publisher Console ensure the EOS service has access to the added resources at all time.

Access to system configuration files

Disk space or file access issues on EOS configuration files will result in corrupted configurations and software malfunction. Ensure there is enough disk space and all EOS configuration files are accessible at all times.

User Account in Server Configurations

Orbit EOS Service account settings are applied at Service Install.
One can use the Operating System services management console to update the User Account or add User credentials into the Orbit service installation files.
Configuration update on the Service installation files requires the Orbit Service to be be stopped, removed, updated, re-installed, and restarted. Verify the update using the OS Services Management Console. 

set SERVICE_USER=--ServiceUser=<Domain>\<UserName> --ServicePassword=<UserPassword>

HTTP Proxy

The default configurations for all outgoing HTTP and HTTPS requests can be updated. However, we do advise using the default operating system proxy settings.

Proxy configurations are set at Service Install. Changing these configurations requires the Orbit Service to be stopped & removed, installed & restarted.

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

Add the following Java VM arguments into :

Set system proxy settings 

-Djava.net.useSystemProxies=true

Set other proxy settings
Below for https, for http replace “-Dhttps” by “-DHttp” : 

-Dhttps.proxyHost=0.0.0.0
-Dhttps.proxyPort=0000
-Dhttps.proxyUser=xxx
-Dhttps.proxyPassword=xxx

When using a proxy that doesn't require user validation, parameters “proxyUser” and “proxyPassword” should not be added.

Example : 

set JAVA_OPTIONS=-Djava.net.useSystemProxies=true;-Dhttps.proxyHost=0.0.0.0;-Dhttps.proxyPort=0000

Https example for Linux : 

# Java Additional Parameters
wrapper.java.additional.1=-Xrs
wrapper.java.additional.2=-Djava.awt.headless=true
wrapper.java.additional.3=-Dhttps.proxyHost=0.0.0.0
wrapper.java.additional.4=-Dhttps.proxyPort=0000
wrapper.java.additional.5=-Dhttps.proxyUser=xxx
wrapper.java.additional.6=-Dhttps.proxyPassword=xxx

HTTP Redirect to HTTPS

To redirect incoming HTTP traffic to the HTTPS web service.

  1. Create a new folder http80 into <Install Dir>/program/services
  2. Create a new file service.ini into the newly created folder <Install Dir>/program/services/http80
    Copy, paste and save the snippet below into the service.ini file.
Services=
 Service=
  Name=HttpService80
  ClassName=com.orbitgis.toolx.network.interfaces.http.server.HTTPService
  Parameters=
   Parameter=secure:false
   Parameter=host:all
   Parameter=port:80
   Parameter=http.get.enable:false
   Parameter=http.get.wwwroot:<SYSTEMPATH>/wwwroot
   Parameter=run.service.enable:false
   Parameter=redirect.to.secure:true

HTTP Strict Transport Security

Configuration to configure HSTS for the Publisher service.

Server Configurations

HTTP Workthreads

The default number of concurrent Threads is 32 and a backlog of 64 Tasks.
Related to the available Cores the number of concurrent threads and backlog tasks can be increased.

Server Configurations

portserver.HTTP.workthread.count 32 
portserver.HTTP.maximum.pending.requests 64

HTTPS

WebClient - Server communication

The Orbit Publisher includes an HTTP or HTTPS Web Server. One or the other, not both together. Incoming HTTP requests can be redirected to HTTPS services, see below Redirecting from HTTP to HTTPS

By default, an HTTP Web Service is configured. Below desribes the documentation on how to configure an HTTPS Web Service.

The Http(s) Web Service is used for Publisher WebClient (“Publication”) - Server and EOS WebClient (“EOS Console”) - Server communication.

KeyStore File

When using https, a certificate file is mandatory. Orbit supports PKCS 12 (.p12), Java KeyStore (.jks) and more (see below).
The password-protected KeyStore file must contain your Private Key and full Certificate Chain from Root to Public Domain Certificate.

Certificate signing and creation is an independent process from the Publisher installation. This must be completed prior to configuring the Orbit Web Server from HTTP to HTTPS. This can be done manually such as Manual CSR Generation or with online tools such as Generate CSR. As CSR generation is different based on each hosted web server, it is not possible to document every method.

For more information on used concepts, see: Wikipedia Authorization Certificate, Wikipedia Public Key, Wikipedia Java Keystore, Wikipedia PKCS 12.

Installation of Certificate

Copy the KeyStore file keystore.xxx to <Install Dir>/../Orbit 3DM Publisher Service Data/http/.
Supported KeyStore files : .jks, .jceks, .p12, .pks, .pfx

KeyStore file Password

Add a keystore.pwd single line text file next to the KeyStore file.
The password can be saved as plain text or scrambled.
To get a scrambled keystore.pwd, create a Service Request to be contacted by a Support Engineer.

HTTPS Service

Configure the HTTP service to operate in HTTPS mode and port 443 : 

secure			true
port			443
HTTPS Console

Configure the Console to operate in HTTPS mode and port 443 : 

URL=https://<Publisher Server URL>/console/

Launch the Console.

Minimum TLS Version

File : <Install Dir>/program/config/server.ini 

ssl.setup.protocol	TLSv1.3

The following values can be used to set a different TLS policy:

Logging EOS

The activity and tasks completed by the EOS service are logged into the following directory :

These log files contain the most recent activity of the EOS service.
For reasons of disk space, only 10 files of 8MB each are stored. The most recent log file has no index suffix.

Server Configurations

system.logfile					<SYSTEMPATH>/log/eos/server.log
system.logfile.pagecount			8 
system.logfile.pagesize				16 
system.logall					true

Logging Portserver

The activity on Dox and HTTP ports can be logged (default “false”) into the following directory :

Server Configurations

portserver.logging.enabled			false
portserver.logging.interval			10
portserver.logging.location			<SYSTEMPATH>/log/portserver/<TIMESTAMP>.log

Port Allocation

By default the EOS service uses TCP port 1100 (DOX), the Orbit Web Service requires port 1111 (HTTP)

Communication between Client and Server must be available at all times. A client, server, or network blocking firewall on these ports will result in run time errors.
The default server and port configuration can be changed if required. However, we do advise to use a reverse proxy instead.

Server Configurations

Server-side Service configuration files :

Client Configurations

Desktop Client side configuration file :

Procrun Service

On Windows Orbit uses the Procrun Service to start and run the EOS Service.
The Procrun Service creates by default 2 log files :

The sum of all these files can become very big and may result in the C:/ partition running out of space. Disable this service logging to avoid a relatively small C partition to run out of space.
To disable Procrun logging following server-side configuration file must be updated.

Server Configurations

Procrun configurations are set at Service Install. Changing these configurations requires the Orbit Service to be stopped & removed, installed & restarted.

Logging enabled : 

--StdOutput=auto
--StdError=auto

Logging disabled : 

--StdOutput=
--StdError=

Service Install

EOS is a running operating system service and is preferably installed and started using an OS administrator account. The used account must have full permission to read and write into the entire Orbit server installation directory. Read access is required for all resources used by EOS.

A proper EOS service start, stop and remove are possible as OS administrator using the Orbit shortcuts within the Orbit installation directory :

Stop & Start

When updating the Orbit Server software or applying hardware maintenance it will be required to stop and restart the Orbit Service. The service needs to be installed before starting and stopped before removing.
Use of the Orbit Service shortcuts is recommended at all time, verify successful Service Install, Start, Stop and Remove using the OS Services Management Console.

Multiple instances

The name of an operating system service supposed to be unique.
To install multiple Orbit Services on a single server the Orbit Service Name of the second instance will need to be renamed before installing : 

..
set SERVICE_DISPLAY_NAME=Orbit 3DM Publisher Service 2
set SERVICE_DESCRIPTION=Orbit 3DM Publisher Service 2
...
.. //IS//publisher_3dm_2 ..

Test Service (Status Monitoring)

The availability of the HTTP Web Service or a specific Publication can be verified by requesting respectively the Web Service cross domain configuration or the publication html web page :

A TestService is available to request detailed runtime information about all EOS Services. Optionally a TestMask can be applied.

WMS and WFS Hosting

The 3DM Publisher server includes the capability to provide OGC compliant WFS (version 1.1.1 and 1.2.0) and WMS (version 1.1.0 and 1.3.0) services for Generic Resources.

More information about the OGC WFS and WMS specifications :

Resources are published on a Publication level. On the Share page of a Publication, you can enable or disable a dedicated WMS, WFS endpoint for the publication. Basic support for WFS Transactions (WFST) can be enabled separately.

The WFS service supports the following output formats :