Install the adapter

You can install adapters on either a Windows or Linux operating system. Before installing the adapter, see the respective system requirements to ensure your machine is properly configured to provide optimum adapter operation.

The installation and configuration directories can be found here:

• Windows

  Configuration: C:\ProgramData\OSIsoft\Adapters\Structured Data Files

  Installation: C:\Program Files\OSIsoft\Adapters\Structured Data Files

• Linux

  Configuration: /usr/share/OSIsoft/Adapters/Structured Data Files

  Installation: /opt/OSIsoft/Adapters/Structured Data Files

Windows

Download the install file

To download the Windows installation file:

1. Download the Windows AVEVA-Adapter-for-Structured Data Files-1.1.0.493-x64_.msi file from the Customer Portal.

   Note: Customer login credentials are required to access the portal.

2. Copy the AVEVA-Adapter-for-Structured Data Files-1.1.0.493-x64_.msi file to the file system of the device.

Run the installation wizard

To install Structured Data Files on Windows using the installation wizard:

3. Start the installer by double-clicking the .msi file in Windows Explorer.

4. In the Setup window, select Next.

5. (Optional) Change the installation folder and port number.

   AVEVA recommends you use the default installation path. Valid values for the port number range from 1024 to 65535 and only an unused port number should be entered. The default port is 5590.

6. Select Next > Install.

7. Select Finish.

Run the installation from a command line

To install Structured Data Files on Windows from the command line:

8. Open a command window, by running as an administrator, and change the working directory to the location of the AVEVA-Adapter-for-Structured Data Files-1.1.0.493-x64_.msi file.

9. Enter the msiexec command and specify parameters to run the installation, using the following example as a guide.

   msiexec /quiet /i AVEVA-Adapter-for-Structured Data Files-1.1.0.493-x64_.msi PORT="<number>" INSTALLFOLDER="<file_path>"

   Parameters:

   • /quiet – The installation runs in silent mode.

   • /i – This is the install flag.

   • PORT – Specify a port other than the default of 5590. If the "quiet" or "no ui" flag for msiexec is specified and the PORT value on the command line is not valid, the install will proceed with the default 5590 value.

   • INSTALLFOLDER – Specify an alternate location for the binary components other than the default location of "%PROGRAMFILES%\OSISoft\Structured Data Files". AVEVA recommends you use the default installation path.

Note: If you do not specify a parameter, the default value for the parameter is used. Property names must be in all capital letters, for example, PORT.

Linux

Complete the following steps to install an adapter on a Linux computer:

Download the distribution file

To download the appropriate file for your device:

10. Download the Linux distribution file from the AVEVA Customer Portal.

    Note: Customer login credentials are required to access the portal.

11. Copy the Linux distribution file to the file system of the device.

Install on a Linux device

To install Structured Data Files on Linux:

12. Open a terminal window and change the working directory to the location of the distribution file.

13. Run the apt install command for the distribution file appropriate to your operating system and processor.

    Debian 11 or later (Intel/AMD 64-bit processors)

    sudo apt install ./AVEVA-Adapter-for-Structured Data Files-1.1.0.493-x64_.deb

    Debian 11 or later (ARM32, Raspberry PI)

    sudo apt install ./AVEVA-Adapter-for-Structured Data Files-1.1.0.493-arm_.deb

    Debian 11 or later (Raspberry PI, Ubuntu ARM64 Server)

    sudo apt install ./AVEVA-Adapter-for-Structured Data Files-1.1.0.493-arm64_.deb

    A validation check for prerequisites is performed.

14. If the install fails, run the following commands from the terminal window and try the install again:

    sudo apt update sudo apt upgrade

15. (Optional) Change the port number and press Enter. The default port is 5590.

    Note: If you specify an invalid value for the port, the install will proceed with the default value of 5590.

Silent install on a Linux device

To perform a silent install of the Structured Data Files adapter on Linux with all default options:

16. Open a terminal window and change the working directory to the location of the distribution file.

17. Run the apt-get install command for the distribution file appropriate to your operating system and processor.

    sudo apt-get install -q -y ./Adapterinstallfile.deb < /dev/null

    Parameters:

    • -q – Specifies a silent install.

    • -y – Responds Yes to installing prerequisites.

    • Adapterinstallfile.deb – The name of the distribution file.

    • < /dev/null – All defaults are used in the installation.

Silent install on a Linux device with specified parameters

Complete the following steps to perform a silent install of the Structured Data Files on Linux using a parameter file to customize the installation:

18. Create a file called silent.ini with the following parameters on separate lines:

    • <port_number>

    For example:

    4567 Y N

19. Open a terminal window and change the working directory to the location of the distribution file.

20. Run the apt-get install command for the distribution file appropriate to your operating system and processor.

    sudo apt-get install -q -y ./Adapterinstallfile.deb < silent.ini

    Parameters:

    • -q – Specifies a silent install.

    • -y – Responds Yes to installing prerequisites.

    • Adapterinstallfile.deb – The name of the distribution file.

    • < silent.ini – The file with the installation properties.