<?xml version='1.0'?>
<?xml-stylesheet type='text/xsl' href='AviXUserMan.xsl'?>
<chapter><maintable><ChapterName>INSTALLING AVIX SERVER / SFV</ChapterName>

<Title>Overview</Title>
<paragraph>
This is what you will do:<br/><br/>
  <unorderedlist>
    <listitem>[Optional] move storage and prefs. &lt; 2 min.</listitem>
    <listitem>[Optional] copy and save settings &lt; 5 min</listitem>
    <listitem>[Optional] update Java Classpath &lt; 4 min.</listitem>
    <listitem>[Optional] uninstall AVIX Server &lt; 2 min.</listitem>
    <listitem>Install AVIX Server &lt; 2 min.</listitem>
    <listitem>NOTE that there is a troubleshooting guide further down. If you have any problems, check the link "SFV problems and solutions".</listitem>
  </unorderedlist>
  Total estimated time less than: 4-15 min. 
</paragraph>

<Title>Requirements for AVIX server and SFV</Title>
<paragraph><link><address>SFV_requirements.xml</address><text>Requirements</text></link><br/></paragraph>

<Title>Before we start</Title>
<paragraph>
Before you start installing, there are some cases to consider.<br/>
1. Do you already have an AVIX server installed?<br/>
2. Have you made any changes to its settings that you need to transfer to the new install?<br/>
3. Are there storages or preferences that you want to keep?<br/>
4. Are you going to access a shared folder for AVIX videos?<br/>
If you follow these steps, we will handle those cases.<br/>
</paragraph>

<Title>Handle different cases</Title>

<paragraph><unorderedlist>
<listitem>If you already have an AVIX Server installed on the server computer, go here: 
<link><address>EU_uninstalling_AVIXserver4.xml</address><text>LINK</text></link></listitem>
<listitem>Do you have a plan for storing AVIX videos? This is what you need to know: <link><address>EU_uninstalling_AVIXserver8.xml</address><text>LINK</text></link><br/></listitem>
<listitem>If this is a clean install, meaning there is no AVIX server installed, continue with the installation instruction below.</listitem>
</unorderedlist></paragraph>

<Title>INSTALL OF AVIX SERVER</Title>

<paragraph><unorderedlist>
<listitem>
To install over a previous installation without uninstalling, usually works. Try this first<br/>
A clean install is a good way to make it work if you are having issues.<br/>
It is a clean install if you don't have any AVIX server installed.<br/>
If you have an AVIX server that you want to uninstall to make a clean install:  
<link><address>EU_uninstalling_AVIXserver2.xml</address><text>GO HERE</text></link><br/>
</listitem>

<listitem>Download AVIX server [<link><address>https://community.solme.se/nextcloud/index.php/apps/files/files/119557?dir=/AVIX%20v5/AVIX%20v5.1/AVIX%205.1%20Server</address><text>AVIX server </text></link>] 
Download the (64-bit).exe (Not the zip)<br/>
<italic>If you don´t see the AVIX server folder on our community site, then you need added permission. <br/>Ask your contact at Solme AB.</italic></listitem>
<listitem><bold>IMPORTANT!</bold> <br/><bold>READ CAREFULLY!</bold><br/>If SFV (ShopFloor Viewer) is going to access videos, then the AVIX server service needs to be running as a user that has read permissions for the folder that contains the videos.<br/>
  We recommend using the server computer where AVIX server/SFV is installed, as a file server and create a folder where AVIX videos will be stored and then share that folder on the network so the AVIX clients can reach it.<br/>
  This way, both AVIX and the AVIX server/SFV can access it.<br/>
  Keep in mind that SFV cannot access content on web pages like Sharepoint.  </listitem>
<listitem>AVIX server can only be used with AVIX client version 4.8.13 or newer.</listitem>
<listitem>Some versions need client and server to have matching version numbers. Like AVIX 5.1.14. This is noted in the release notes on the client download page.</listitem>
<listitem>Install AVIX server (instructions below)</listitem>
</unorderedlist>
<note>BACKUPS<br/>
<br/>
AVIX server/SFV makes backups.<br/>
The restore functionality is only available in AVIX5. [November 2025]<br/>
<br/>
The backup delete policy is as follows and is currently not configurable:<br/>
- Keep all backups made "today".<br/>
- Keep one backup per day for a week.<br/>
- Keep one backup per week for a month.<br/>
- Keep one backup per month for three months.<br/>
<br/>
The backup is always enabled and can currently not be disabled. <br/>
The location of the backup is configurable via the se.solme.avix.prefs file. <br/>
<br/>
[se.solme.avix.io.storageloader]<br/>
backup-default-path=C:\Solme AB\AVIX Server\backups<br/>
<br/>
In the future we will add more configurability to the backup function, as well as document it on docs.solme.se<br/>
Backup files can be deleted and this should not interfere with server functionality or future backups.
</note>
</paragraph>

<Title>AVIX SERVER / SHOP FLOOR VIEWER</Title>
<paragraph><Title2>SETTING UP AND CONFIGURATION</Title2></paragraph>
<paragraph><note>NOTE: AVIX files saved in AviX4.7.1 and earlier are not compatible with the Shop Floor Viewer. </note>
<picture><address>AVIXserverIcon.png</address></picture><br/>Install AVIX server.</paragraph>
<paragraph>
<picture><address>installSFV01.PNG</address></picture><br/><br/>
If you are installing over an existing AVIX server, you must stop the SolmeAviXServer service or let the installer stop the service and you need to wait until it is stopped
This can take up to 1 minute.<br/><br/> 
<picture><address>installSFV01b.PNG</address></picture><br/><br/>
<picture><address>installSFV04.PNG</address></picture><br/><br/>
If you are installing over AVIX server in order to keep a "Logon as" user password, <br/>
then leave the "Install the service as a service" unchecked.<br/>
Or else it will overwrite the password.<br/><br/>
### If you are doing a clean install should check the box and it will install the new service and start it.<br/>
<br/>
<picture><address>installSFV05.PNG</address></picture><br/><br/>
If you left the "Install the server as a service" unchecked, <br/>you can now update the Java Classpath setting: <link><address>EU_uninstalling_AVIXserver6JavaClasspath.xml</address><text>LINK</text></link><br/>
<br/>
If you made backups of storages and prefs file, restore them now: <link><address>EU_uninstalling_AVIXserver3restore.xml</address><text>LINK</text></link><br/><br/>
If you saved the settings for the service before installing, restore them now: <link><address>EU_uninstalling_AVIXserver1restore.xml</address><text>LINK</text></link><br/><br/>
To setup the service for the shared videos folder, do this: <link><address>EU_uninstalling_AVIXserver8.xml</address><text>LINK</text></link><br/><br/>
The service should now be running.<br/><br/>
<picture><address>installSFV06.PNG</address></picture>
</paragraph>
<paragraph>Open a browser on the server (Chrome works well) and enter the address: <link><address>http://localhost:45500/dwi/</address><text>http://localhost:45500/dwi/</text></link>
<br/>
When testing from another computer, replace "localhost" with the ip-number/hostname of the server.<br/>
If there is a firewall filtering the traffic, TCP port 45500 needs to be opened.
<br/><br/>
You will now see the login page. <br/>
The SFV guest account can do most things by default, but not administration of user accounts. <br/>
Click the "Continue as guest" button to login using the guest account. <br/>
There are also two restricted accounts, "kal" and "ada", without password, that can be used for testing.<br/><br/>

<picture><address>InstallAVIXserver/SFVlogin.png</address><width>500</width></picture><br/><br/>
<picture><address>InstallAVIXserver/SFV_Home.png</address><border>1</border></picture><br/><br/>
SFV problems and solutions: <link><address>AVIXserverFaulSearch.xml</address><text>LINK</text></link> (for IT )
<br/><br/>
You can also use https. It has a self signed certificate. It uses the port 45543. <br/>
<italic>(<link><address>SFVsslCertificateConfiguration.php</address><text>How to configure HTTPS/SSL</text></link>)</italic><br/>
The usage of https and certificates enforces the use of the domain name of the host.<br/>
So you cannot use localhost. <br/>
If your server name is abc123 and your domain is bigcompany.com then you will use: <link><address>https://abc123.bigcompany.com:45543/dwi/</address><text>https://abc123.bigcompany.com:45543/dwi/</text></link>
<br/>
<br/>
In this case you need to open this port in the firewall (port 45543).
<br/><br/>

<note>45500 is the default port, it may be configured, see further in this document. If changing the port number, the address entered will have to change accordingly.</note>
<note>If you are using AVIX5, this AVIX client will also start a server and it will try to use the same default port, 45500. 
If SFV is started after AVIX5 (on the same computer) it will try to use the next port SFV, 45501 since 45500 is already allocated by the client.</note></paragraph>

<paragraph><bold>Default path setting</bold><br/>
Note that videos are NOT uploaded from AVIX to the ShopFloorViewer.<br/>
Therefore videos need to be located in a (network) folder where both the AVIX client and the ShopFloorViewer server can reach them.<br/>
You must tell the ShopFloorViewer where the videos are located.<br/>
This is done using the document default path.<br/>
The document default path only works if it is also set in AVIX. <br/>
You will need to set the correct document default path for videos, i.e. where should the SFV be looking for the videos used. (<italic><link><address>../AVIXusermanual/AviXUserMan-FolderStructure.php</address><text>Learn more about Document default path</text></link></italic>)<br/><br/>
For the Shop Floor Viewer to be able to read the files, like videos/images, in a folder or to connect to a network drive, 
the user that the SFV service is executing as, must have access privilege to read this folder or to mount this drive.<br/>
If the AVIX server service is running as a user that have access to the network drive where the videos are located, then it should be able to read the video folder on that drive if it is specified using the network path.<br/>
Another possibility for a network drive, is that you could login to the server computer using the same account as the AVIX server service is running as and mount the drive in windows and then restart the SFV service. <br/>
Then the videos folder can be specified using the drive letter in the document default path. <br/>
Just monting the network drive with your regular user account in windows will not work if the SFV service is running as another user.<br/>
This is a task for an IT person. If you are a regular user and don't know how to do this, you need to ask your IT for help.<br/>
<br/>
Setting the default path in SFV:<br/>
menu button -&gt; Settings<br/><br/>
<picture><address>InstallAVIXserver/SFV_Menu_Settings.png</address><width>250</width></picture><br/>
<br/>
Here you can add the Default path to eg videos. <br/><br/>
<picture><address>InstallAVIXserver/SFV_SettingsPage.png</address><width>650</width><border>1</border></picture><br/>
<br/>

If you have created a network share folder for AVIX videos, <br/>
make sure that the user account running the SFV service has read access to this folder. <br/>
You can set the path to this folder in the SFV settings under the "Default path" section.<br/>
Click on the 3 dots menu in the default path field and navigate to the desired Default path folder, eg. \\server\share\videos<br/>
If you can not see the target folder when navigating, this is probably because the user account running the SFV service does not have read access privileges to this folder.<br/>
<bold>So don't type the path manually, always use the 3 dots menu to navigate to the folder</bold>.<br/>
Because you could type a path that SFV doesn't have access to and then SFV will not be able to read the videos and you will not get any feedback that the path/folder cannot be reached.<br/>
Navigating instead of typing ensures that the SFV server can access the videos.<br/>


<note>The user account running the server need read access to the videos.</note>
<bold>Publishing/viewing data</bold><br/>
To publish data on the SFV server, you can either:<br/><br/>

<unorderedlist><listitem>upload an AVIX file from the SFV webpage, or</listitem>
<listitem>publish/upload the file from AVIX (from AVIX 4.8.14).</listitem></unorderedlist>
Publishing/uploading files from AVIX using https/ssl is supported from version 4.8.14.<br/>
This means that if you are using 4.8.13 or earlier, then you need to upload files from within SFV.<br/><br/>

<bold>Uploading from SFV</bold>
<br/>To upload an AVIX-file from SFV, go to "settings" and then the Workspaces tab. Click "Choose File", then "add Workspace"<br/>
<br/>
<picture><address>InstallAVIXserver/SFV_SettingsPageWorkspaces.png</address><width>600</width><border>1</border></picture>

<br/><br/><bold>Publishing/uploading from AVIX</bold>
<br/>To publish a file from AVIX, you need to set the server IP/hostname and the port number of the SFV server in AVIX preferences.
<br/> 
<br/>Go to AVIX  preferences -&gt; Connection preferences [for AVIX4 -&gt; Server preferences] </paragraph>
<paragraph>AVIX5<picture><address>SFV05a.PNG</address><width>650</width><border>1</border></picture><br/><br/>
AVIX4<picture><address>SFV_AVIXserverPrefs48.png</address><width>650</width><border>1</border></picture><br/><br/>
Enter the the actual hostname/IP of YOUR AVIX server/SFV server.<br/>
And in AVIX5 it must be in this format: http://HOSTNAME:45500 or http://IP-ADDRESS:45500<br/>
NO trailing slash at the end or it will NOT work. <br/> 
AVIX5 example: If the hostname for the SFV server computer is "avixserver01" then enter: http://avixserver01:45500<br/>
<br/><br/>
<note>If you changed the server address or port number when setting up the SFV server, then these settings must be used in the browser/AVIX to access SFV.</note>

Then upload from AVIX by clicking the Publish/upload button<br/><br/>
<picture><address>SFV_PublishFromAVIX.png</address></picture><br/><br/>
or publish from the file menu...<br/><br/>
<picture><address>SFV_PublishFromAVIXmenu.png</address></picture><br/><br/>
If you get the error "Failed to send file to server! Please try later." when trying to publish,<br/>
then you have not entered the correct hostname or IP address of <br/>
the SFV server in the AVIX preferences -> Server preferences. 
</paragraph>

</maintable></chapter>
