Data installation and update process
The first step towards installation of data packs is to check the availability of Install Manager in the API installation folder. If the Install Manager is not available, the Install Manager installer should be used to first install the Install Manager. Then the data packs can be downloaded and installed using the Install Manager.
To summarize the recommended steps for installation are as follows:
- Install the Install Manager, if not already installed in the Loqate API Installation Folder (You will need the Install Manager Installer from Loqate, to install the Install Manager)
- Request a license key from Loqate Support at email@example.com or use local data packs if available
- Execute the Install Manager and use it to install the data packs as needed
Important Note: Please ensure Loqate is installed outside of program files. Even if you enable read/write permissions while inside program files, there may still be permissions issues, we recommend installing Loqate outside of program files.
Install Manager is a java application that was introduced in 2013Q2.0 to handle the installation of the GKR. Install Manager can be run in graphical user interface (GUI) mode or in command line mode. Install Manager uses a web service running at licensing.loqate.com to provide the information on compatible data packs for a given Local API version. Install Manager requires either a license key or license pack that can be obtained by contacting firstname.lastname@example.org.
Graphical User Interface Mode
Install Manager can be started in GUI mode by providing the command line option: mode=gui. GUI mode is the default mode on Windows platforms. On Windows platforms, Install Manager can be launched by double clicking on InstallManager.bat.
The first screen displays the version of the Local API currently installed, at the lower left corner.
If a proxy server is used, the checkbox “Use Proxy Server” needs to be checked and the Proxy server name and port need to be entered as shown below. If the proxy server needs authentication, the checkbox “Use authentication for proxy server” should also be checked & the user name and password need to be provided.
The first step is to provide the installation folder.
The next step is to either provide a license key or provide the full path to a license pack. The license pack is named “loqateLicense”. If a license key is entered, Install Manager will communicate with licensing.loqate.com. If the license key is valid, the server will return the corresponding license pack to Install Manager and then Install Manager will write the license pack to the installation folder.
If the older format license pack “loqateLicense” is selected, it will be changed to the new format “license.lfs”
Once the license pack is saved to disk, Install Manager will display the contents of the license for reference.
There are 2 options available for downloading as shown below. One can either just download the data packs or install the data packs that are already downloaded to the local machine.
After a valid option is selected, Install Manager will communicate with licensing.loqate.com and fetch details about the latest available licensed data packs that are compatible with the Local API version that is currently installed. The details of available data packs to install will be shown next. In the case a user selects an existing data folder for installation, it will show newer data packs available to download and install. The release date of the available data packs will also be displayed. The user can select the required data packs from this screen by checking the checkboxes next to each product.
If the user selects the download option, Install Manager will download the data packs.
The download can be paused and resumed at any point. If the “Pause Download” button is pressed the UI will change as follows:
The next screen displays location where the downloaded data packs will be installed.
Next, the user is shown the Loqate data license agreement.
Once the user accepts the license agreement, the next screen will proceed to installing the selected data packs.
Finally, Install Manager will complete the installation as shown.
Command Line Interface Mode
Install Manager can be started in command line mode by providing the command line option: mode=commandline. Command line mode is the default in Linux and UNIX platforms. On Linux/Unix platforms, Install Manager can be launched by running the script InstallManager.sh.
The first screen displays the version of the Local API currently installed.
If a proxy server is used, the Proxy server name and port need to be entered as shown below. If the proxy server needs authentication, the user name and password need to be provided.
The first step is to provide the installation folder. If the user selects an empty folder the installation will proceed as a fresh installation of the data packs. If the user selects an existing data folder, the installer will proceed as an update installation.
The next step is to either provide a license key or provide the full path to a license pack. The license pack is named “loqateLicense”. From 2015Q1 release the license pack format is changed from “loqateLicense” to “license.lfs”. If a license key is entered, Install Manager will communicate with licensing.loqate.com. If the license key is valid, the server will return the corresponding license pack to Install Manager and then Install Manager will write the license pack to the installation folder.
There are 3 options available for downloading and installing as shown below.
One can either just download the data packs or install the data packs that are already downloaded to the local machine.
When the list of available data packs is shown, enter “all” to select all data packs. Alternatively, if only certain products are desired for installation, enter the numbers next to those products, ending the selection by entering “done”.
The screen below shows the Loqate License agreement.
Depending on the choice made for download and installation, Install Manager may download data packs from download.loqate.com and install them.
Installation Troubleshooting Tips
If you receive the error message ‘license expired’ but your license key is still valid, we have listed the below recommendations.
1. Insufficient permissions
Install Manager needs both read and write permissions to update the license pack. Make sure you have permission to create/overwrite license.lfs, otherwise the license pack will not update.
Linux: Since the Linux install of license.lfs has default permissions of 644, only the owner of license.lfs has write permissions. If you are accessing license.lfs from a shared folder or someone else’s
folder, you will need to change the permissions to 664 or 666 first.
Windows: If you are installing data anywhere inside Program Files, Program Files (x86), or Windows (for example C:Program FilesLoqatedata), you will need to provide admin permissions, either by
running InstallManager as administrator through Command Prompt, or installing outside of Program Files and copying the installed data into the desired location.
2. Older version of Install Manager
If you are using an older version of the Install Manager from 2015, which had a bug, you will need to download the latest InstallManager from the Loqate FTP site. To retrieve the login info, please either ask your account manager or submit a ticket to email@example.com
3. Proxy/Firewall access
Install Manager needs internet access and will connect to our licensing servers to validate the license key and to fetch the information about the latest compatible reference data for download. If there are any Proxy/Firewall settings in place that may block the access to our servers. Please check that the following URLs are not blocked by your settings. If the following URLs are blocked, please update your firewall settings or use the proxy authentication specified during the Install Manager process (on the first screen). The following URLs are needed so that the Install Manager can connect to our server to verify the license key and get the reference datapacks.
Important Note: The URL has been changed from https://download.loqate.com to https://data.loqate.com. This change was made in the 2018Q4.0 Release. Additional information on the update can be found in the release notes here.
https://licensing.loqate.com port 443
https://data.loqate.com port 443
Test the connections by using these curl commands
$ curl https://licensing.loqate.com:443
$ curl https://data.loqate.com:443
4. No Internet connection
If you do not have internet connection on your server or are unable to open up the firewall on the server, we recommend to follow the online + offline instructions available on our website. Basically, you have to download the datapacks on a machine that can connect to our licensing servers. Copy them over to your servers and install those datapacks.
Online and Offline installation scenarios: http://www.support.loqate.com/getting-started/installers/example-of-installation-scenarios/