![Abstract composition of blue triangles and scattered triangles on white background (no text or symbols)](.vortex-link-installation-guide/2d4f6fca5897e44619b3a70c59001b73dc1df2ef8706546e6fbac7bffce5e6ca.jpg) # # LINK # Installation Guide Release 3.0.1 # Contents # 1 Requirements 1 1.1 Software dependencies . # 2 Installation 2 2.1 Obtain the Vortex Platform installation file 2 2.2 Run the Vortex Platform Setup Wizard 2 2.3 Uninstalling Vortex Platform . 9 # 3 Licensing Vortex Link 13 3.1 General 13 3.2 Development and Deployment Licenses 13 3.3 Installing the License File 13 3.4 Running the License Manager Daemon 14 3.5 Utilities 15 # 4 Troubleshooting 16 # 5 Contacts & Notices 17 5.1 Contacts 17 5.2 Notices 17 # 1 # Requirements # Software dependencies # Required before installation The following software must be installed on your host system before installing Vortex Link: • A Java Runtime Kit (JRE) v6 minimum (ensure that the java executable is in your PATH). # Other noteworthy dependencies Vortex Link use the following open source libraries, which for convenience are bundled in the installation zip file (you don’t need to install them separately). • Netty (http://netty.io/) : for DDSI protocol implementation over UDP and TCP. • Trove4j (http://trove4j.sourceforge.net) : high performance Java collections. • Apache Commons (http://commons.apache.org/) : various utility classes. • SLF4J (http://www.slf4j.org/) : a unified logging API. • Logback (http://logback.qos.ch/) : a logging back-end for SLF4J. # Environment These environment variables must be set: • PATH (must include the JDK bin directory) • any environment variable required to check your license (see std,std-refLicensing Vortex Link) # 2 # Installation # Obtain the Vortex Platform installation file Check that the file that you have obtained (by downloading or other method) is the appropriate one for your system. The name of the file indicates the target platform as well as the Vortex Platform version. Example installer file names: ```txt VortexPlatform_v2-linux-x32-installer.run VortexPlatform_v2-linux-x64-installer.run VortexPlatform_v2-windows-x32-installer.exe VortexPlatform_v2-windows-x64-installer.exe ``` (It is possible to install a 32-bit version of Vortex on a 64-bit system, but for the best performance you should install the 64-bit version.) If you wish to install on a system other than Windows or Linux, then you can obtain an archive file from ADLINK and unzip that instead of using the installer. # Run the Vortex Platform Setup Wizard # Start the installer Navigate to the directory which contains the Vortex installer file. If you are using a GUI, you can usually just double-click on the installer to run it. If you are using a console (‘command line’), enter the appropriate command for your platform. (On most versions of Windows and Linux this means typing the file name, excluding the .exe or .run extension, and pressing the <Enter> key.) # Linux Windows Once it starts, the operation of the installer is the same on both Windows and Linux platforms; the example screens shown in the following steps are from a Windows system. The Vortex installer splash screen appears briefly before the Setup Wizard ‘Welcome’ screen is displayed. # Proceed with the Setup Wizard Click Next. ![Setup\nSetup - VortexPlatform_v2\nWelcome to the VortexPlatform_v2 Setup Wizard.\nADLINK\n( Back Next ) Cancel](.vortex-link-installation-guide/ba69ef42a9274c3a1d96b857cbee43949c2ce52873a6509f75a1d0f4823a36e4.jpg) Fig. 2.1: Figure 1 Welcome to the Setup Wizard ![Setup\nLicense Agreement\nPlease read the following License Agreement. You must accept the terms of this\nagreement before continuing with the installation.\nSOFTWARE LICENSE AGREEMENT\nThis license agreement ('Agreement') is a legal agreement between\nyou, a single corporate entity ('Licensee') and the PrismTech\nGroup Limited company with which your purchase order is placed and\naccepted ('Licensor'), for use of Licensor's (and / or its\naffiliates) and / or its licensor's proprietary software products,\nwhich include any computer software, printed materials, 'online'\nor electronic documentation and any upgrades or modifications\nDo you accept this license?\n○ I accept the agreement\n○ I do not accept the agreement\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/21657722b9603b4eff317ab645bf1d2b2c801560ffe2c8d0243985f6cd23b113.jpg) Fig. 2.2: Figure 2 Accept the License Agreement # 2.2. Run the Vortex Platform Setup Wizard # Accept the License Agreement If you do not accept the terms of the license, the installation is cancelled. Click Next. # Choose a location for the Vortex Platform installation ![Setup\nInstallation Directory\nPlease specify the directory where VortexPlatform_v2 will be installed.\nInstallation Directory C:\Program Files\ADLINK\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/ff09e74ad18e6ec8c26c328a81675b46cce253b8896ab2ec2b029c9a8e343f7a.jpg) Fig. 2.3: Figure 3 Choose a location for the Vortex Platform installation You can either accept the default destination directory or choose a different location by typing its path or by navigating to it using the ‘browse’ button. # Windows On Windows, the default installation directory (shown in Figure 3) is: $\mathsf { C } : \mathsf { \backslash P r o g r a m \mathsf { F i l e s \backslash A D L I N K } }$ (For this example, the Vortex Platform will be installed in C:\apps\ADLINK\Vortex\_v2.) # Linux On Linux, the default installation directory is: $/ \mathrm { h o m e / < u s e r > / \bar { A } D L I N K / V o r t e x \_ v 2 }$ Click Next. # Choose which components to install Click on a component name to display a description of the component. All Vortex Platform components are selected for installation by default. # 2.2. Run the Vortex Platform Setup Wizard ![Setup\nSelect Components\nSelect the components you want to install; clear the components you do not want to install. Click Next when you are ready to continue.\n✓ Vortex Cafe 2_3_3\n✓ Vortex Cloud 2_1_2\n✓ Vortex Fog 2_1_2\n✓ Vortex Gateway 2_3_1\n✓ Vortex Web 1_2_5\n✓ Vortex Insight 2_1_0\nClick on a component to get a detailed description\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/b05e9716bda2904a03b928d4b6ea5143397693c0e493483b152dcf9d05798f8f.jpg) Fig. 2.4: Figure 4 Choose which components to install If any Vortex Platform components are already installed in the location chosen at Choose a location for the Vortex Platform installation, their names are greyed-out and they cannot be de-selected. (To remove Vortex Platform components from your system, use the uninstaller described in the Uninstallation section Uninstalling Vortex Platform). Click Next. # Enter the location of your license file If you do not yet have a license file, leave No selected (the default) and click Next. You will have to obtain a license file and install it manually according to the instructions in the separate Vortex Licensing Guide before you can run Vortex. If you already have a license file, choose Yes; the Setup Wizard will then perform the necessary configuration steps automatically. Information about these changes is saved in the etc directory where Vortex is installed (C:\apps\ADLINK\Vortex\_v2 in this example). Click Next. If you chose Yes, a dialog appears where you can enter the path to your license file, or use a browse button to navigate to it; otherwise the Setup Wizard proceeds to the next step. # Install for current or all users? # Windows # WINDOWS ONLY On Windows platforms, you can choose whether to install Vortex for all users or only for the current logged-in user. The default is for Vortex to be installed only for the current user. # 2.2. Run the Vortex Platform Setup Wizard ![Setup\nObtaining a license\nSelect option below to automatically configure your installation with an existing license file.\n○ Yes\n● No\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/277e5234a9e4f0ace4cd94c17095e9a4bd19c4cf277e01f5efc189f165ed705e.jpg) Fig. 2.5: Figure 5 Indicate location of existing license file (1) ![Setup\nPlease provide an existing license file (if available ...)\nIf you already received a license file for this release, provide it here to get it installed automatically.\nLicense file to install automatically.](.vortex-link-installation-guide/c898025f074c0319a6a382bf5776bc6f7c753f7cec5c123a186c047c2f90cc80.jpg) Fig. 2.6: Figure 6 Indicate location of existing license file (2) ![Setup\nVortex Installation Scope\nDo you wish to install the Vortex Product Suite for only the current user or for all users of\nthe machine?\nPlease note that the current user must have administrative privileges in order to install\nVortex Product Suite for all users.\n● Current user only\n○ All users\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/0fa02de5155f7219da1affc4cf2290e4b2860ab56d75233abd072f0f52eedf7d.jpg) Fig. 2.7: Figure 7 Install for current or all Windows users If Vortex is to be made available to all users, then the current user (performing the installation) must have Administrator privileges. Click Next. # Begin installation The Setup Wizard is now ready to begin the actual installation. If you want to review or change any of the choices or entries you have made, you can use the Back and Next buttons until you return to this screen. Click Next to proceed and install Vortex on your system. Click Cancel if you decide to abandon the installation. No changes will be made to your system, and any information you have entered will be lost. You will have to run the installer again if you decide to install Vortex later. # Wait whilst installation proceeds The Setup Wizard displays a progress bar and a slideshow describing the Vortex Suite components whilst files are installed on your system. If you click the Cancel button during this phase, then you may be left with a partial installation. For those Vortex components installed you will have an uninstaller that can be invoked to remove it. # Installation completed When all of the necessary files have been installed and the Vortex components have been configured, the Setup Wizard displays a final dialog. # 2.2. Run the Vortex Platform Setup Wizard ![Setup\nReady to Install\nSetup is now ready to begin installing VortexPlatform_v2 on your computer.\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/57eba64e244a0149b7fc781c9c4315637c15ebf121de9fadea924bdeadfeda61.jpg) Fig. 2.8: Figure 8 Proceed or Cancel installation ![Setup\nVORTEX CLOUD\nEnabling ubiquitous data-sharing and WAN connectivity for Vortex systems and systems of systems\nUniversally accessible Routing and Discovery Services\nplease wait for the installation to complete\nADLINK\nInstalling\nInstalling Vortex Cloud....\nInstallBuilder\n( Back Next ) Cancel](.vortex-link-installation-guide/23752364f5bb2cba9286c0f062419f375701ec7dd613576a60491b233a649c09.jpg) Fig. 2.9: Figure 9 Progress of installation process ![Setup\nCompleting the VortexPlatform_v2 Setup Wizard\nSetup has finished installing VortexPlatform_v2 on your computer.\nADLINK\n( Back Finish Cancel](.vortex-link-installation-guide/dda30759de9c37bd5472033ace750a8649a7f8aea10b76d8e4bb8d519697842a.jpg) Fig. 2.10: Figure 10 Finish the Setup Wizard Documentation for the components of the Vortex Platform is installed in docs directories within the individual component directories. For example, on the Windows system used to illustrate the steps above, the documentation for Vortex Link is installed in C:\apps\ADLINK\Vortex\_v2\Link\VortexLink\1.3.0\docs. # Uninstalling Vortex Platform The Vortex Platform includes a convenient uninstallation utility for either complete or partial removal of the software from your system. # Location of the uninstaller The Vortex Platform Setup Wizard creates the uninstaller in the VortexPlatform installation directory, which was chosen during the running of the Setup Wizard (see std,std-refChoose a location for the Vortex Platform installation). # Windows On Windows, the default installation directory is $\mathsf { C : \backslash P r o g r a m \ F i l e s \backslash A D L I N K \backslash V o r t e x P l a t \ f o r m \_ c v e r s i o n \textgreater }$ and the uninstaller is named uninstall-VortexPlatformV<version>.exe. # Linux On Linux, the default installation directory is $/ \mathrm { h o m e / < u s e r > / \bar { A } D L I N K / V o r t e x P l a t f o r m \_ < v e r s i o n > }$ and the uninstaller is named uninstall-VortexPlatformV<version>.run. # 2.3. Uninstalling Vortex Platform # Start the uninstaller # Windo ws Start the uninstaller either • from the Windows Start menu: Start > ADLINK > VortexPlatform <version> > Uninstall VortexPlatform <version> or • navigate to the Vortex Platform installation directory (see Location of the uninstaller above) and run uninstall-VortexPlatformV<version>.exe. # Navigate to the Vortex Platform installation directory (see Location of the uninstaller above) and run uninstall-VortexPlatformV<version>.run. # Linux # Windo ws Once it starts, the operation of the uninstaller is the same on both Windows and Linux platforms; the example screens shown in the following steps are from a Windows system. # Choose whether to uninstall VortexPlatform completely or just some components ![Uninstallation mode\nDo you want to uninstall all VortexPlatform_v2 components or individual components?\n○ All VortexPlatform_v2 components\nRemoves all components and all files installed by VortexPlatform_v2\n● Individual components\nRemoves individual components while leaving other VortexPlatform_v2 components installed\n( Back Next ) Cancel](.vortex-link-installation-guide/30cb5d004d829689cf918229d05005d8ddddc0d6d17c29d86891b05c902724e9.jpg) Fig. 2.11: Figure 12 Uninstall entire application or individual components The names of components which are not installed are greyed-out and they cannot be selected. Click Next. In case you selected all the components, you’re asked to confirm that you really want to uninstall the full Vortex Platform. # 2.3. Uninstalling Vortex Platform ![The image features a low-resolution, pixelated icon. It depicts a teal-green arrow pointing to the right, centered on a yellow square background. The background has a darker, orange-brown shadow on its right edge, creating a subtle 3D effect. There is no text present.](.vortex-link-installation-guide/ae257918a661c79bbc03086a440a60e7c707c15255677c8aa1917f713ebc8a32.jpg) Setup # Select Components To Unistall ![A single, dark gray horizontal dash centered on a white background.](.vortex-link-installation-guide/029a70f0a0ec9e484d8974eb723b0d411311f189738784623deede469b08ecf6.jpg) ![The image features two identical rectangular outlines stacked vertically. They are white with thin grey borders. There is no text visible in the image.](.vortex-link-installation-guide/fbb69ce0515289e8cc2d38e62ee3b3795e045995877cae745930d884452bcf0b.jpg) ![A low-resolution, pixelated image displaying a dark 'X' shape centered between two vertical white bands.](.vortex-link-installation-guide/4e91f64221ec171eaf7d3dd09c945b863ae8a5858c94b1242a1d2e716eb627f1.jpg) ![The image displays a logo consisting of a solid red triangle pointing upward. Inside the lower portion of the triangle are three horizontal white stripes that curve slightly upwards. To the right of the triangle is a small registered trademark symbol (®).](.vortex-link-installation-guide/5f5db378f7217e3e582c8f58682f48cd9ac9071ffbceb7d509b5742e9f436fa0.jpg) Select the components you want to uninstal: clear the components you do not want to remove. Click Next when you are ready to continue. Vortex Cafe 2\_3\_3 Vortex Cloud 2\_1\_2 Vortex Fog 2\_1\_2 Vortex Gateway 2\_3\_1 Vortex Web 1\_2\_5 Vortex Insight 2\_1\_0 Click on a component to get a detailed description < Back Next > Cancel Fig. 2.12: Figure 13 Choose components to uninstall ![The image features a vertical line on the far left side. To the right of this line is a yellowish, rectangular area containing a blurry green arrow pointing to the right.](.vortex-link-installation-guide/94b64a369c11edcac98937e8cb8d634520e5ff82139007731ecb2476f2d77b70.jpg) Question ![The image features a blue circle centered on a white background. Inside the circle is a large, white question mark symbol.](.vortex-link-installation-guide/6e03ce5b973f4ab49283e68c2e5785fd220bdf33a03b5866cce4c716a511ca72.jpg) You are about to uninstall VortexPlatform\_v2 - do you wish to continue Yes No Fig. 2.13: Figure 14 Confirm uninstallation Click Yes to proceed, or No to cancel the operation. # Uninstallation progress A progress bar is displayed as the uninstallation proceeds. ![Setup\nUninstalling VortexPlatform_v2\nUninstall Status\nUninstalling VortexPlatform_v2\nUninstalling Vortex Cloud....\n( Back Next ) Cancel](.vortex-link-installation-guide/1da0cf91c596a791be4bcd42b1f742de4fadab720c0d1b00bb0bc2999a6a26ca.jpg) Fig. 2.14: Figure 15 Progress of uninstallation process # Uninstallation completed ![Info\ni Uninstallation completed\nOK](.vortex-link-installation-guide/687c6f176051ff443b160243a8c871963208737e0b4ac76fd470f9fd5bacdc41.jpg) Fig. 2.15: Figure 16 Uninstallation completed Click OK. # 2.3. Uninstalling Vortex Platform # 3 # Licensing Vortex Link Vortex Link use Reprise License Manager (RLM) to manage licenses. This section describes how to install a license file for Vortex Link and how to use the license manager. # General The licensing software is automatically installed on the host machine as part of the Vortex Link distribution. The software consists of two parts: • Vortex Link binary files which is installed respectively in <Vortex\_Link\_Install\_Dir>/bin (where Vortex\_Link\_Install\_Dir is the directory where Vortex Link is installed) • License files which determine the terms of the license. These will be supplied by ADLINK. ![The image displays a lowercase letter 'i' in a white, serif typeface centered on a solid blue square background.](.vortex-link-installation-guide/e1fa1a887f578e214b1ce704f33ecb324e8cf5c4b50aea8b891d75e10b223ed0.jpg) Licenses: ADLINK supplies a license file for named license.lic for Vortex Link. This file is not included in the software distribution, but is sent separately by ADLINK. # Development and Deployment Licenses Development licenses are on a per Single Named Developer basis. This means that each developer using the product requires a license. Vortex Link are physically licensed on enterprise platforms for deployment. # Installing the License File Usually you get a license file for multiple Vortex products (Link and others). The simplest way to install such a license file is to copy this file to the \${VORTEX\_HOME}/license directory. \${VORTEX\_HOME} is an environment variable set by the Vortex Platform installer and pointing to the installation directory of all Vortex products. This is the recommended location for the license file but you can put the file in any location that can be accessed by the license manager rlm. If another location is used or the environment has not been setup, then an environment variable, either RLM\_LICENSE or ADLINK\_LICENSE or prismtech\_LICENSE, must be set to the full path and filename of the license file (either variable can be set; there is no need to set both). For example: $\mathtt { A D L T N K \_ L I C E N S E } { = } / \mathtt { m y } / \mathtt { l i c } / \mathtt { d i r } / \mathtt { l i c e n s e . l i c }$ If licenses are distributed between multiple license files, the RLM\_LICENSE or ADLINK\_LICENSE or prismtech\_LICENSE variable can be set to point to the directory which contains the license files. If no valid license file can be found in the above locations, Vortex Link will also search for a valid license file in the following directories: • \${VORTEX\_HOME}/Link/VortexLink/<version>/etc • \${VORTEX\_HOME}/etc • \${HOME}/etc • /etc # Running the License Manager Daemon It is only necessary to run the License Manager Daemon for floating or counted licenses. In this case, the license manager must be running before Vortex Link can be used. The license manager software is responsible for allocating licenses to developers and ensuring that the allowed number of concurrent licenses is not exceeded. For node-locked licenses, as is the case with all evaluation licenses, then it is not necessary to run the License Manager Daemon but the RLM\_LICENSE or prismtech\_LICENSE variable must be set to the correct license file location. To run the license manager, use the following command: ```txt rlm -c <location> ``` where <location> is the full path and filename of the license file. If licenses are distributed between multiple files, <location> should be the path to the directory that contains the license files. The rlm command will start the ADLINK vendor daemon prismtech, which controls the licensing of the Vortex Link software. To obtain a license for Vortex Link from a License Manager Daemon that is running on a different machine, set either the RLM\_LICENSE or prismtech\_LICENSE environment variable to point to the License Manager Daemon, using the following syntax: ```txt RLM_LICENSE=<port>@<host> ``` where <port> is the port the daemon is running on and <host> is the host the daemon is running on. The port and host values can be obtained from the information output when the daemon is started. The format of this output is as shown in the following example: ```txt 07/05 12:05 (rlm) License server started on rhel4e 07/05 12:05 (rlm) Server architecture: x86_12 07/05 12:05 (rlm) License files: 07/05 12:05 (rlm) license.lic 07/05 12:05 (rlm) 07/05 12:05 (rlm) Web server starting on port 5054 07/05 12:05 (rlm) Using TCP/IP port 5053 07/05 12:05 (rlm) Starting ISV servers: 07/05 12:05 (rlm) ... prismtech on port 35562 07/05 12:05 (prismtech) RLM License Server Version 9.1BL3 for ISV "prismtech" 07/05 12:05 (prismtech) Server architecture: x86_12 Copyright (C) 2006-2011, Reprise Software, Inc. All rights reserved. RLM contains software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org) Copyright (c) 1998-2008 The OpenSSL Project. All rights reserved. Copyright (c) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved. ``` # 3.4. Running the License Manager Daemon ```txt 07/05 12:05 (prismtech) 07/05 12:05 (prismtech) Server started on rhel4e (hostid: 0025643ad2a7) for: 07/05 12:05 (prismtech) Vortex_Cafe_product1 Vortex_Cafe_product2 07/05 12:05 (prismtech) 07/05 12:05 (prismtech) License files: 07/05 12:05 (prismtech) license.lic 07/05 12:05 (prismtech) ``` The <port> value should be taken from the first line of the output. The <server> value should be taken from the last line. From this example, the value for RLM\_LICENSE or prismtech\_LICENSE would be: 35562@rhel4e # Utilities A utility program, rlmutil, is available for license server management and administration. One feature of this utility is its ability to gracefully shut down the license manager. To shut down the license manager, preventing the checkout of licenses for the Vortex Link software, run either of the following commands: ```txt rlmutil rlmdown -vendor prismtech rlmutil rlmdown -c <location> ``` where <location> is the full path and filename of the license file. The rlmutil program is also used to generate a host identification code which is used to generate your license key. To generate the code, run the following command on the license server: # Linux ```txt rlmutil rlmhostid ``` # Windo ws ```txt rlmutil rlmhostid ether ``` This returns an ID code for the server, which will look similar to: Hostid of this machine: 0025643ad2a7 This ID code must be supplied to ADLINK so that your license key can be generated. # 4 # Troubleshooting If you experience any problems with Vortex Link installation or usage then you can contact ADLINK support. Please provide a full description of your platform, including the versions of tools you are using (such as JRE, etc. ). # 5 # Contacts & Notices # Contacts # ADLINK Technology Corporation 400 TradeCenter Suite 5900 Woburn, MA 01801 USA Tel: +1 781 569 5819 # ADLINK Technology Limited The Edge 5th Avenue Team Valley Gateshead NE11 0XA UK Tel: +44 (0)191 497 9900 # ADLINK Technology SARL 28 rue Jean Rostand 91400 Orsay France Tel: +33 (1) 69 015354 Web: http://ist.adlinktech.com E-mail: ist\_info@adlinktech.com # Notices Copyright © 2018 ADLINK Technology Limited. All rights reserved. This document may be reproduced in whole but not in part. The information contained in this document is subject to change without notice and is made available in good faith without liability on the part of ADLINK Technology Limited or ADLINK Technology Corporation. All trademarks acknowledged. [🔗 Link to the original document](.vortex-link-installation-guide/vortex-link-installation-guide.pdf)