Configuring the 3DOrchestrate Distribution Server as a Windows Service

You can use the deployment utility to set up the TomEE application server to run the 3DOrchestrate Distribution Server as a Windows Service.

A Windows Service is an application that starts automatically and runs in the background without a user interface, similar to a Linux daemon process.

Note: This functionality is not available for a 3DOrchestrate Distribution Server running on Linux.

Before you begin:
  • The user account running the 3DOrchestrate deployment utility must have Administrator privileges or you must use the right-click option Run as administrator to start the utility.
  • The 3DOrchestrate Distribution Server software and the database must be installed, deployed, and running successfully.
  • You must have the 3DOrchestrate Distribution Server installed on a local physical disk on the computer in order for the Windows Service to work properly.
See Also
Installing the 3DOrchestrate Distribution Server
Deploying 3DOrchestrate in the Java Application Server
Starting and Stopping the 3DOrchestrate Distribution Server
  1. If the 3DOrchestrate Distribution Server application is running, stop it. You can use the Stop server action in the Deploy tab of the deployment utility or the shutdown[.bat|.sh] script to do this.
  2. Restart the deployment utility, if it is not running, and do the following:
    1. In the Deploy tab, select Create TomEE service (under Server Actions).
    2. Switch to the TomEE+ Settings tab. Enter a name for the Windows Service in TomEE Service Name. For example, you may want to change the name to "3DOrchestrate" for clarity.
    3. Enter the 3DOrchestrate version number in Version, for example "R2020x".
    4. Switch back to the Deploy tab, and click Execute.

The Windows Service is created with Automatic start-up type, and the service is started immediately for the first time. Startup of the 3DOrchestrate Distribution Server Windows Service is almost instantaneous, but the 3DOrchestrate Distribution Server application within TomEE may take three to five minutes to fully initialize itself. During that initialization period, a 3DOrchestrate Station will wait before connecting (or reconnecting).

The service will restart the 3DOrchestrate Distribution Server in TomEE any time the computer is restarted.

You can see log files for the service creation under:

<server_install_dir>\exe1\tomee\logs\

To check for the newly created service, open the Windows Services control panel by selecting:

Control Panel > System and Security > Administrative Tools > Services

Important: You will probably want to adjust the Java memory settings after you set up the 3DOrchestrate Distribution Server as a Windows Service—see JVM Settings for 3DOrchestrate Distribution Server Configured as a Windows Service.