The first step towards installation of data packs is to first install the local API. If the Install Manager is not available, the Local API Installer should be used to first install the Install Manager as part of the install. Then the data packs can be downloaded and installed using the Install Manager.
You should be able to access the API installer through this web portal
You may need to click advanced and continue through the site, login using below info:
Then locate the latest version folder(ex: 2020Q3.1) and download the appropriate installer for your OS from the folder labelled "app-installer-mt". Make sure to download the installer from the -mt folder and NOT the -st folder, since our software is multithreaded. Clients with CASS data need to download the 32 bit installer(x86 version), and clients without the CASS data integrated into mSQL/matchIT Web/findIT S2 can download either.
When installing the local API installer, you should
A) change the default install path to be outside of Program files (CASS won't download all the files if you install to program files because of permissions)
B) uncheck the box to install the sample US data (the install manager may not overwrite the sample data)
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 Support by entering a ticket support.syniti.com, or use local data packs if available
- Execute the Install Manager and use it to install the data packs as needed
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 by opening a ticket at support.syniti.com.
Once you've installed the local API, then you can run the installmanager.bat file to download the data. The machine where you install the local API needs to be able to access the internet to download the data. Its common for clients to install the loqate local api on a separate machine from their server to download the data, then copy the files to a machine that is behind a firewall where they're doing the actual processing.
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, we suggest changing the default install path to be outside of the program files directory, ie: C:\Loqate\Data
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.