FICO Xpress Installation

Introduction

This document describes how to install the FICO Xpress Optimization Suite and the licensing configuration options for the software.

For installation instructions pertaining to FICO^® Xpress Insight, please see the Xpress Insight Installation guide.

Note: For the purposes of this guide, Option_1 (Node Locked) and Option_2 (USB Dongle) licenses are referred to as "static" licenses. Option_3 (Floating) licenses are referred to as "floating" licenses.

If you have any problems with your Xpress license, please refer to the sections on Troubleshooting Licensing Issues, and Licensing Error Messages and Suggested Resolutions. These sections also tell you what information you must supply to FICO Support if you cannot resolve the problem on your own.

Obtaining a License File

You must obtain a license file, xpauth.xpr, from FICO Sales (or your Xpress supplier) before you can use Xpress. This applies to both new users and users upgrading from earlier releases. To request a license file, for each license required, send the output of the Xpress Host ID tool to your supplier. (When obtaining a floating license, run xphostid on the server machine rather than the client.) Using Microsoft Windows, you can run this tool from the Start menu, or by browsing in Windows Explorer to navigate to the <installationdir>\bin folder and double clicking xphostid.exe. If you use Unix, the tool is installed in the <installationdir>/bin folder as xphostid.

If you are upgrading from an earlier release, you must also supply their ASSC (support) reference number.

A license authorizes the use of all minor releases within a major release. For example, a license file for Xpress 8.4 authorizes the installation of all 8.4 minor releases (8.4.1, 8.4.2, and so forth). A new license file is required for a new major release such as Xpress 8.5.

Downloading the Installation Packages

To install Xpress, use the installer packages available from the downloads area of the FICO Xpress website. When downloading a new release, make sure that you pick the correct installer for your system and license. For example, if you want to use a Solaris Sparc 64-bit Xpress, make sure this is the package you download (and not, for example, Solaris x86 64-bit or Solaris Sparc 32-bit).

There are two types of installer; an InstallShield Windows version (Windows 32-bit, 64-bit) and an install script version for all the Linux and Unix installers.

To install an Xpress patch rather than a full Xpress installation, see the section Patch Installation.

Installing Xpress on Microsoft Windows

Use the Microsoft Windows InstallShield installers, which are contained and run from the self-extracting zip files downloaded from the FICO Xpress website.

Installation Prerequisites for Windows Installation

There are no perquisites for Windows installations.

To install the software, double-click the left mouse button on the file you downloaded; this causes the self-extracting zip file to display the following dialog:
Click Setup and wait a few moments for the files to be prepared and the installer to run. Once the files have been extracted from the package, the InstallShield installer displays the following window:
Click Next to continue with the installation. Click Back if you want to return to the previous screen.
Next you will be presented with the Xpress licensing agreement as shown below:

It is important that you read this agreement and make sure that you agree to its terms and conditions. Use the scroll bar (highlighted in green) to read the complete agreement. Click Print to print the agreement text.
Click Yes if you agree with the terms. (If you click No, the installer will automatically close.)
Accept the default installation location (or navigate to the desired location) then select what type (static or floating) of license you wish to use:
- If you are installing on one machine and do not require other machines to use Xpress, or if you are evaluating Xpress, select the Static licensing option. This corresponds to Option_1 and Option_2 licenses. Click Next. See Installing a Static License to continue the installation.
  
  Note that if you select the Static licensing option and plan on using a dongle to license Xpress, you will be able to move the dongle between machines, but only one machine at a time can access the software.
- If you will be licensing over a network and require a floating client/server (Option_3) installation, select the Floating licensing option. Click Next. See Installing a Floating License to continue the installation.

Installing a Static License

Select where you want the software installed. The default location of C:\xpressmp is suitable for most installations, unless you already have a folder on your C drive named xpressmp, or if you do not have permission to install software to the default location.
Click Next.
To continue the installation, see Specifying Additional Installation Options (For Static or Floating License).

Installing a Floating License

At this point you will be prompted to specify whether the installation is for the client (the machine that runs the Xpress software and requests licenses from elsewhere), or the server (the machine that runs the license manager and grants or refuses licenses to client machines). For more information see FICO Xpress Licensing.

The following screen will display:
Click Yes if you want the XPserver license manager to be run as a Windows service. (This means that the license server will be started automatically in the background, which is often the easiest and best way to run the license manager.)

You can also start the license manager as a standard program by running the runlmgr.bat file. For more information see FICO Xpress Licensing.
Click Next.
For the installer to fully setup your configuration, it needs to know from which server to make license requests. If you do not know what the server is called, then ask your system administrator for the name of the FICO Xpress license server.

If the name of the server is unknown, but you would like to continue with the installation, leave Server empty and click Next. This creates a license file with an empty field for the server name. Once the server name is known, you can open the license file (located in <installationdir>\bin) with any text file editor and type the server name between the quotes in the line use_server server="".
To continue the installation, see Specifying Additional Installation Options (For Static or Floating License).

Specifying Additional Installation Options (For Static or Floating License)

At this point in the installation, you can specify whether you intend to use dongles as your licensing key. (Dongles are small USB objects that look similar to a USB memory stick.) Dongles can be used if you want to use Xpress on multiple machines, running the software on one machine at a time. This option is useful when you do not want to lock the license to one particular computer but rather to one particular dongle.
Specify whether you intend to use dongles:
- Select Yes and click Next if you wish to use dongles. This step ensures that the driver software, required by Windows so that it can understand the dongle, is installed during the Xpress installation process.
- If you select No and then later decide you do need the dongle drivers, see Dongle Licenses (for Microsoft Windows Machines). Click Next.
Specify whether you want to install the Xpress Kalis constraint programming add-on. This add-on can be used within the Mosel modeling environment. The default option is to install this add-on, but you must have a license which allows its use in order to use the Kalis functionality. If you select to install this option, you must agree to the Artelys Kalis terms and conditions.

Click Install.

The software will now install. This may take a few minutes.
After the software has installed, you will be prompted to point to the license file and the environment variables must be set.
- If you have a license file from FICO Support, click Browse and enter the folder in which the license file (xpauth.xpr) is located. Click Next.
- If you do not have a license file from FICO Support, you can continue; however the license file created in the Xpress installation directory will not be a valid file, just a temporary placeholder until you have a valid license.
Click Yes if you want to have the Xpress software added as an option on the Windows Start menu.

You have now successfully installed Xpress.

Note: Should the installer fail to function correctly then the software can be installed manually. See Manual Installation for details.

Installation on Linux or Unix

To install Xpress on Linux and Unix variants, use the install script contained within the downloaded tar archive file. You must untar the required files from the downloaded file. As such, it is recommended that you not perform this task from your base directory.

Prerequisites for Linux Installations

glibc.i686 (for 32-bit Xpress on 64-bit Linux)

Note: If you have an Xpress license, it is recommended that you make a note of the full directory path that contains the file (xpauth.xpr) before you begin installation since you will need this information.

To extract the files from the tar archive and start the installation script, enter the following commands. (For this example the installation is for an 8.4 Linux 64-bit version; as such, your tar file may have a slightly different name depending on the Xpress version and system on which you are installing.)
```
tar xf xp8.4_linux_x86_64_setup.tar
./install.sh
```
After script start up, you will be prompted to answer a series of questions to set up the installation. (You can exit the installation process at any time by pressing the Ctrl and c at the same time.)
Specify the type of licensing you wish to use: choose from static (one computer, or a dongle for a non-server installation) or floating. Also note the following when responding to the prompts:
- In this and all of the other installation questions, valid options are visible in the question text surrounded by square brackets. For example, at this point there are two options: (s)tatic or (f)loating. Therefore valid entries are s or f.
- When the question requires a yes/no answer, you must type y or n.
- When entering a directory path, type the full path, or press Enter to accept the offered default path.
If you opted to install a floating license, you will be prompted to indicate whether you want a (s)erver or a (c)lient installation. If you will be connecting to another computer (or another XPserver Xpress license manager on the same machine) then enter c; if you want to make this machine the license server then enter s.
Determine where to install the software: The default is /opt/xpressmp. Press Enter to accept the default. To install to a different location, enter the full path, making sure to use forward slashes "/". You may enter the relative path if you wish, but this may affect how the environment variables are set later in the installation process. The supported method is to enter the full path.
Using the Xpress Kalis constraint programming engine: this is an optional component for use in the Mosel modeling environment. It requires the relevant licensing option in order to authorize its use; however, anyone can install the add-on provided they accept the terms and conditions.

If you select the default option (to install Kalis) the Kalis licensing agreement is displayed. This can be scrolled through quickly using the Space bar key, or scrolled through slowly using the up and down arrow keys or Enter. Pressing q stops the display of the licensing agreement, at which point you will be asked if you agree to its terms. Press n or y.
License file: you will be prompted to indicate whether you have an Xpress license file from FICO Support.
- If you do not have a license, enter n. At this point, you can stop the installation in order to obtain the license file from FICO Support and then perform the installation once you have it. Or you can continue with the installation and get the license file at a later date. If you choose the latter option, you will need to place the license file in the bin directory of your Xpress installation. For instance, in the preceding example, (/opt/xpressmp) you would copy the xpauth.xpr license file in to the /opt/xpressmp/bin directory.
- If you indicated earlier that you have an Xpress license and provided its location, you will be prompted whether you want to copy the license file to the default directory (which is /opt/xpressmp/bin for this example). This is the default option.
  
  If you decide not to use the default location for the Xpress license, Xpress will still work correctly; however you should make a careful note of where the license file is stored in case it requires updating at a later date. (Once installation is complete, the location you have set for the license file should be pointed to by the XPRESS environment variable.)
The files will now be extracted from the tar archive. Depending on the speed of the computer, this may take only a few seconds or it may take as long as a few minutes.
If you indicated earlier that you were installing a floating client, you will now be prompted for the name of your license server. If you know the name, enter it now. If you do not know the server name, press Enter and make a note of the onscreen instructions for entering the server name at a later date. (You can alter the server name in the xpauth.xpr license file using any text editor, such as Emacs or Vi.)
On completion, the installer generates two script files, one for the Bourne shell (xpvars.sh) and another for the C shell (xpvars.csh). These scripts should be run, as detailed in the installer output, to set up the shell environment so that Xpress runs correctly. Add them to any user profiles or service startup scripts that will be making use of Xpress.
If you need to set any custom environment variables for Xpress (in the Bourne shell) you can create a file called xpvars.local.sh alongside the generated xpvars.sh file and export custom environment variables from this script.
If you did not have your license file while performing the installation, you will need to set the XPRESS environment variable to point to it once you do have it. The instructions for doing this from the command line are described within the installer output.
If you want to add the change to XPRESS to a more permanent script that can be run whenever the shell is opened, then the best option would be to edit the relevant xpvars script in the bin directory of your Xpress installation. You can edit these files with any Linux/Unix text editor by altering the line relating to the XPRESS environment variable (since this is the location of the license file).
If you indicated earlier that you were installing a floating server installation, the install script attempts to start the XPserver license manager.
If you do not have a server license, then an error message is displayed. If it starts successfully, then any log messages from it will be output in to the xpress.log file. By default the xpress.log file is written to /var/tmp/xpress.log. For more information, see FICO Xpress Licensing.

Once the environment variables have been set using the script and a valid license file is present, then the Xpress software is ready to use.

Automated installation on Linux or Unix

As well as the guided installation detailed in the previous section you can also use the Xpress installation script as an automated installer by providing command-line options.

To get a list of the available options run:

./install.sh -h

You can specify as many options as you like, if there are any required options missing you will be prompted for these with interactive prompts. If you require the installation to be fully automated make sure you supply all the necessary options so that the interactive prompts do not appear.

Here is an example of a fully automated installation assuming you are in a directory containing the Xpress tar archive and a valid xpauth.xpr license file:

mkdir xp84
tar xf xp8.4_linux_x86_64_setup.tar -C xp84
pushd xp84
./install.sh -l static -a .. -d /opt/xpressmp -k yes
popd

Manual Installation

In the unlikely event that the provided installers fail to function correctly, the software can be extracted manually.

To perform a manual installation on Windows, you must have a program capable of uncompressing zip files. WinZip or WinRar are suitable, although any program with this functionality should work.

Unix and Linux variants should by default contain the necessary programs to unzip and extract from the tar archives. If you do not have an extraction program, you will need to install one. If this is the case and your previous attempt at automatic installation using the install script failed, then the lack of an extraction program may be the cause. In this case, install the required tools and attempt an automatic installation again.

The differences between the automatic and manual installation methods are as follows:

Files are not installed selectively as the whole archive will be uncompressed.
Not all environment variables are automatically set.
The dongle driver installation will not be run automatically (Windows).
The file shortcuts will not automatically be added to the Start menu (Windows).
The XPserver license manager will not be automatically configured to run as a service.

Manual Microsoft Windows Installation

Should the InstallShield installation fail, the files may be extracted using any program capable of reading and extracting from zip files as follows:

Rename the downloaded installation file extension from .exe to .zip.
Extract the files from the zip file to the folder from where you want to install.
Copy your license file in to the bin folder of the installation directory.
Read the license.txt file in your installation folder and make sure you agree with the terms and conditions. (If you do not agree, then cancel the installation and delete the software.)
Add the XPRESSDIR environment variable and point towards the xpressmp folder of the installation directory. You can set this by going to the Start menu » Settings » Control Panel » System » Advanced » Environment Variables, and creating a new environment variable. Use the full path.
Add the path %XPRESSDIR%/bin to the PATH environment variable. (This allows the system to find the relevant Xpress libraries and executables.)
To add links to the programs on the Start menu, select Start menu » Settings » Taskbar and Start Menu. Click on the Start Menu tab and click Customize.
Click Add. The Microsoft Windows wizard will display so that you can add the programs to the Start menu. You may want to add optimizer.exe and xpworkbench.exe as basic links, although a number of other executables are available. (See the bin folder in the installation directory.)
If you installing a floating server license, you need only add links to XPserver.exe, or the configuration batch file runlmgr.bat.
If you installing a floating server license, you can delete all files and folders except the following:
- xpserver.exe in the bin folder.
- xphostid.exe in the bin folder.
- xplicstat.exe in the bin folder.
- xprl.dll in the bin folder.
- runlmgr.bat in the bin folder.
- The tools folder, if you require dongle licensing, from the main Xpress folder.
- License.txt from the main Xpress folder.
- The licensing folder from the docs folder.
If you are going to use dongles for licensing, then install the dongle drivers found in the tools\dongle\hasp directory of your Xpress folder. Use a Windows console as it requires the addition of command-line arguments. You can open a Windows console by running cmd using the Start » Run menu. See Dongle Licenses (for Microsoft Windows Machines) for more information.
Set up the XPserver license manager. See FICO Xpress Licensing for instructions.

Manual Linux/Unix Installation

As mentioned previously, if the installation fails, it is likely that there was a problem using the standard zip and tar programs. If this is not the case, then you can manually install the software by following these steps:

If you have not done so, untar the downloaded installer (if you have attempted to install via the automated install script then you have already performed this step). This command extracts the files from the tar archive:
```
tar xf name_of_downloaded_installer.tar
```
The extracted files include the installation script install.sh. Move the .gz file to the directory where you want to install the software.
Decompress the .gz file using the following command:
```
gunzip name_of_gz_file.gz
```
The preceding command extracts another tar archive which itself contains the installation files and may be unarchived using the following:
```
tar xf name_of_new_tar_file.tar
```
The installation directory should now contain several directories of files and several license and html files. Read the license files and make sure you agree with the terms and conditions; if you do not agree to them, delete the software and discontinue the installation.
Copy your xpauth.xpr license file to the bin directory of the Xpress installation.
Set the relevant environment variables so that your system can find the Xpress executables, runtime libraries and license file. For example, on a Linux system using the C shell:
```
setenv XPRESSDIR your_xpress_install_directory
setenv PATH $XPRESSDIR/bin:$PATH
setenv LD_LIBRARY_PATH $XPRESSDIR/lib:$LD_LIBRARY_PATH
setenv CLASSPATH $XPRESSDIR/lib/xprs.jar:$CLASSPATH
setenv CLASSPATH $XPRESSDIR/lib/xprb.jar:$CLASSPATH
setenv CLASSPATH $XPRESSDIR/lib/xprm.jar:$XLASSPATH
setenv XPRESS $XPRESSDIR/bin
```
The name of the environment variable used to find shared libraries varies by system; on Linux and Solaris it's usually LD_LIBRARY_PATH, on AIX systems it's LIBPATH, HP-UX uses SHLIB_PATH and on the MacOS you should use DYLD_LIBRARY_PATH instead. If unsure, consult your system administrator.
You may find it useful to create a small shell script that sets these variables, or to set them in a script that runs automatically as you log in.
If you plan to use the xssh: protocol to connect to a Mosel optimization service running from this installation of FICO Xpress, execute the following commands to generate a unique machine key:
```
cd $XPRESSDIR/bin
./xprmsrv -key new
```
If you are performing a Linux installation and require the use of dongles for licensing, install the dongle drivers now. See Dongle Licenses (for Linux Machines).
If you are installing a floating server license, you only need a few of the files and can remove the rest. You must keep the following files in order for the XPserver license manager to function correctly:
- xpserver in the bin directory.
- xplicstat in the bin directory.
- runlmgr in the bin directory.
- All files which begin with libxprl in the lib directory.
- The licensing directory in the docs directory.
- xphostid in the utils directory.
- license.txt from the main Xpress installation directory.
To setup the XPserver license manager, follow the instructions as described in FICO Xpress Licensing.

Patch Installation

Patch, or maintenance, releases are releases that only include updated files for parts of the Xpress software. They may be released to fix a particular bug, improve performance or to add a new feature. The larger maintenance releases can be downloaded from the FICO Xpress website. They are bundled with installers and can be installed by themselves. The patch releases (which are often individual files or programs) are usually found on the FICO Xpress download site and must be applied to a previous installation of FICO Xpress.

If you have reported an issue with the software and a fix is now available, you are usually notified by email from the Support system that the fix is available to download using the ftp site and where on the site to download the fix.

Windows Patch Installation

Using your zip file extraction program (such as WinZip or WinRar) extract the patch files. In most cases, these will be replacements for library or executable files found in the bin folder of the Xpress installation, or the .dso files found in the dso folder of the installation.
If you know where the replacement file(s) should be copied, copy them to the correct destination, overwriting the older file. (You can always rename the older file if you still want access to it.)
If you are uncertain where the new file should go, search from the Xpress installation directory for the name of the file. To do this, right-click on the Xpress installation folder and select Search from the menu. Enter the name of the file you wish to replace in the All or part of the file name box and click Search. The resulting list indicates where in the Xpress installation the file can be found.

Once the patch is placed in the correct location in the installation, the software may be run as normal and the updated files will be automatically used.

Note: If you plan to install multiple copies of Xpress on one system, make sure that the folder you are applying the patch to is the correct one and that the XPRESS, PATH and MOSEL_DSO environment variables point towards the correct folders.

Linux/Unix Patch Installation

Using your gunzip file extraction and tar archive programs, extract the patch files. On most systems this can be achieved using:
```
gunzip patchfilename.tar.gz
tar xf patchfilename.tar
```
In most cases, these will be replacements for library or executable files are found in the lib and bin folders of the Xpress installation, or the .dso files found in the dso folder of the installation.
If you know where the replacement file(s) should be copied, copy them to the correct destination, overwriting the older file. (You can always rename the older file if you still want to have access to it.)
If you are uncertain where the new file should go, search on the Xpress installation directory for the name of the file. You can do this using the find command from the Xpress installation directory:
```
find . -name name_of_file_to_be_replaced
```
Running the preceding command results in generating a list of files with matching names. You may find that if you are searching for a particular minor revision of a file, such as libxprs.so.18.10.05, that no matching name is found. This is to be expected as the Linux/Unix library files are named as per their revision and contain symbolic links (libxprs.so and libxprs.so.18.10 in this case) which point to the actual library file.

Once the patch is placed in the correct location in the installation, the software can be run as normal and the updated files will be automatically used.

If you are attempting to install multiple copies of Xpress on one system, ensure that the folder you are applying the patch to is the correct one and that the XPRESS, XPRESSDIR, PATH, LIBPATH (or SHLIB_PATH or LD_LIBRARY_PATH, depending on the system used) and MOSEL_DSO environment variables point towards the correct folder.

Contents

Index

Glossary

Search Results