Skip to main content

Install AVIX5 Server as Windows service

Preparations

Download the installation media, the server zip archive. If you don´t have a download URL, ask your contact at Solme AB to get one. The downloadable unit is entitled  "se.solme.avix.server.product-win32.win32.x86_64.zip" or similarly. 

 

AVIX

UNZIP ShopSERVER Floor Viewer as a Windows service (on a server)

ZIP
Setting up and configuration

MoveUnzip the downloaded Shop Floor Viewer "server"server zip to a suitable placefile at the host where you intend to install it. Unzip it. 

Avoid white spaces in the path!

The unzipped structurecontent will look like this:

image-1644855259326.jpg

image-1645687432638.png

  • Open a command prompt with administrative privileges.
    • Press Windows key to open the Start meny. Start typing "cmd" to get Command Prompt application to appear
    • Right-click and "Run as administrator"
  • In the open Command prompt, navigate to the unzipped AVIX5 server
    • Tip: use the change directory command. Example: "cd .." to move one step up. "cd temp" to open a directory called temp.
    • Tip: The command "dir" will display contents of current directory.
  • Assert you are in the root directory of the AVIX5 server. In the example above - the "AVIX5_server_5_0_10" directory.
  • Install the service:
    • commons-daemon\register_service.bat (tip: start typing ”co..” and press TAB)

image-1644855275658.jpg

Carry-over from old server installation

This is only relevant, of installing a new version of the server. I.e. there is an existing installation, with some stuff that needs to be carried over.

  • The database folder (in case h2 is used)
  • configuration/se.solme.avix.prefs
  • xml
  • xml
  • id
  • Also, check that the jvm parameters are to your liking
    • They are reset when re-installing (as per contents in "register_service.bat" script)
    • Set options for the service can be reviewed by running commons-daemon/SolmeAviXServer.exe service manager application.
      • Should you change say the XMX, a restart of the service is needed.
Verify service installation

Open Windows Services manager. Locate the "Solme AviX Server Service":

image-1644855304639.jpg

Verify that the service is running the AVIX5 server you just installed: Right-click and select "Properties":

Verify server installation

Check that ports are open (by default TCP 2036 and 45500)

If you test it on the same machine (as the server is installed on), try: http://localhost:45500/services

image-1644855318740.jpg

Additional configurations

If you need to do further configurations or are experiencing problems, below chapters are useful.

Ports and firewalls

Verify ports are open (by default TCP 2036 and 45500).

Check that firewall is open on server host for the ports:

image-1644855333063.jpg

If you need to change the ports of the AVIX5 (Shop Floor Viewer) server, do the following:

  • Stop the windows service
  • Open the "se.solme.avix.prefs" file of the AVIX5 (Shop Floor Viewer) server
  • Under the preference section for [se.solme.avix.server.cdo], you can specify the following port (to another value than default being 2036):
    • server.tcp.ports=2050
  • Under the preference section for [se.solme.avix.server], you can specify the following port (to another value than default being 45500):
    • server.tcp.port=45510
  • Start the windows service

Assign more memory

Currently, when the server is installed as a service, the memory allocated to the java server app is stated in the install script (commons-daemon\register_service.bat)

--LogPath=%CURRENT_DIR%\logs\^
++JvmOptions=-Xms256m^
++JvmOptions=-Xmx4096m^
++JvmOptions=-Dosgi.configuration.area=%CURRENT_DIR%\configuration\^
++JvmOptions=-Dosgi.install.area=%CURRENT_DIR%\commons-daemon\prunsrv.exe //ES/SolmeAvixServer

If ”out of memory” errors start happening on the server, the ”xmx” can be increased. Either by re-installation (with a higher value), or by stopping the server service, and then editing the registry value:

image-1644855365008.jpg

The easiest way to affect the correct registry value is by running the ”service manager” executable. It is found here:  commons-daemon\SolmeAviXServer.exe. Run it, and look on the Java tab:

image-1644855380134.jpg

Try assigning more xmx. Example values (depending on how much physical memory the machine has): 16384m, 8192m, 4096m, 2048m.

After changing the registry value, restart the server service.

Other settings

se.solme.avix.prefs
Remove the # to activate a setting.

image-1644855402735.jpg

Templates.emf is used to point out .avx4t files. However, we recommend not to use this setting since it will be changed in the future. To achieve the same result (to load custom .avx4t files) place the .avx4t-files in the folder configuration end remove the default .avx4t file if redundant.

#[se.solme.avix.configuration]
#templates.emf =

Below controls which port to communicate on. Default port is 45500.

[se.solme.avix.server]
http.server.tcp.port = 45500

Below controls where Shopfloor Viewer should look for the file load_storages.xml. Load_storage.xml controls which folders and/or AviX-files that should be loaded on startup of the server.

As an alternative. users logged in as admin may upload any AviX-file manually.

#[se.solme.avix.io.storageloader]
#LOAD_STORAGE_ON_STARTUP =  C:\\Solme AB\\shopfloorviewer_export_2018061201\\configuration\\load_storages.xml

Below controls which languages should be available in the application

#[se.solme.avix.i18n]
#PREF_SELECTED_INSTRUCTION_LOCALES = en;sv;nl;fr;pt_BR

Load_storages.xml (example)

<?xml version="1.0" ?>
<load_storage_config>
<load_storage workspace="Workspace1" storage="C:\Solme AB\my_test\test of config2222.avx4"/>
<load_storages workspacePrefix="ws2_" storageDirectory="C:\Solme AB\my_test_directory\" uploadtarget="true"/>
</load_storage_config>

The file load_storage.xml shall be encoded in UTF-8. Be aware if you use Notepad, it may result in a different encoding and the file won´t work. Notepad++ or similar text editors work well.

 

 

Back to top