Language
Infor M3 Marketplace
Toggle Nav
My Cart
How it works
Search
Menu
Account
  • Home
  • eLink Installation Instructions

Installation Instructions

  1. General
  2. Steps to Download & Install
  3. Downloaded file (without Apache Tomcat)
  4. Downloaded file for Linux (with Apache Tomcat in TAR.GZ format)
  5. Downloaded file for Windows (with Apache Tomcat in ZIP format)
  6. Start Tomcat
  7. Stop Tomcat
  8. Access eLink
  9. Configure eLink
  10. Version < 6.0
  11. Version >= 6.0
  12. Upgrade eLink
  13. Common errors and instructions to troubleshoot

Installing LeanSwift eLink

Please watch the installation video on how to quickly install eLink on your own server

General

  1. This is a one time installation per M3 environment.
  2. You can install it on the server with a static ip and/or DNS/host name. Server must be publicly accessible on the given port and we recommend putting it in the DMZ.
  3. You only need to open port 8443 (or other port, if you have changed the default Tomcat configuration for HTTPS port number) to the server. The port and public ip and/or DNS/host name must be reachable from outside your company's network. You can lock down all other external access to the server.
  4. Internally the server needs to have full access to M3 servers, as well as your mail server (and be allowed to relay emails) for full functionality.
  5. Our recommended server requirements are

      6. Testing environment

    1. 64 bit OS
    2. 8 GB RAM
    3. 50 GB HDD
    4. 2 CPU cores
    5. JRE 7 or JRE 8
    6. Apache Tomcat 7 or 8

      Production environment

    1. 64 bit OS
    2. 16 GB RAM
    3. 100 GB HDD
    4. 2 CPU cores
    5. JRE 7 or JRE 8
    6. Apache Tomcat 7 or 8
  6. Note that eLink will run on both Linux and Windows OS.

Steps to Download & Install

  1. Login to your Infor M3 Marketplace account
  2. Go to your My Account -> My Downloadable Products page
  3. Download your preferred eLink version/package, with or without Apache Tomcat
  4. Make sure Java Runtime is installed on your server, if not you can download Java from here. JRE installation instructions can be found here. eLink has been tested on JRE 7 and JRE 8

Downloaded file (without Apache Tomcat)

  1. Install Apache Tomcat. Instructions to install can be found here.
  2. Place the WAR file inside TOMCAT_HOME/webapps where TOMCAT_HOME is the Tomcat installation path on your server. eLink is tested with Apache Tomcat 7.x and 8.x
  3. Configure SSL/TLS support on Tomcat. Instructions to do so are available here.
  4. Start Tomcat (For How to Start, see below)

Downloaded file for Linux (with Apache Tomcat in TAR.GZ format)

  1. Extract contents of the downloaded file in a desired installation path location on your server
  2. Go to extracted location "/eLink-CE-7.6.0_With_Tomcat/conf/server.xml" and set the attribute keystoreFile, to extracted path/eLink-CE-7.6.0_With_Tomcat/keystore
  3. Ex: If eLink is extracted to /opt, set the keystore attribute in server.xml as follows
  4. keystoreFile="/opt/eLink-CE-7.6.0_With_Tomcat/keystore"
  5. Start Tomcat (For How to Start, see below)

Downloaded file for Windows (with Apache Tomcat in ZIP format)

  1. Extract contents of the downloaded file in a desired installation path location on your server
  2. Go to extracted location "/eLink-CE-7.6.0_With_Tomcat/conf/server.xml" and set the attribute keystoreFile, to extracted path/eLink-CE-7.6.0_With_Tomcat/keystore
  3. Ex: if eLink is extracted to C:\Software, set the keystore attribute in server.xml as follows
  4. keystoreFile="C:\Software\eLink-CE-7.6.0_With_Tomcat\keystore"
  5. Install Tomcat as a service using the command below. More instructions on Installing the tomcat as a service here
  6. Ex:
  7. C:\> cd apache-tomcat-7.0.70\bin
  8. C:\apache-tomcat-7.0.70\bin> service.bat install
    • C:\apache-tomcat-7.0.70\bin>service.bat install
    • Installing the service 'Tomcat7' ...
      • Using CATALINA_HOME: "C:\apache-tomcat-7.0.70"
    • Using CATALINA_BASE: "C:\apache-tomcat-7.0.70"
    • Using JAVA_HOME: "C:\Java\jdk1.8.0_05"
    • Using JRE_HOME: "C:\Java\jdk1.8.0_05\jre"
    • Using JVM: "C:\Java\jdk1.8.0_05\jre\bin\server\jvm.dll"
    • The service 'Tomcat7' has been installed.
  10. (or)
  11. C:\> cd apache-tomcat-7.0.70\bin
  12. C:\apache-tomcat-7.0.70\bin> service.bat install << ServiceName >>, where ServiceName is any name that you provide. If not provided the default name will be used.
  13. Once the service is installed, you can open 'Services' window to find the service installed in the given name (default name - Apache Tomcat7.0 Tomcat7 or Apache Tomcat8.0 Tomcat8). Note that 'Services' is usually available in 'Administrative Tools' in the 'Control Panel'. Also accessible through the 'Services' panel in 'Task Manager'.
    14. Services
  14. Start Tomcat (For How to Start, see below)

Start Tomcat

Start Tomcat

Linux OS

  1. Start Tomcat using ./catalina.sh start file.
  2. Ex:

  3. ubuntu@ip-10-0-0-110:/eLink-CE-7.6.0_With_Tomcat/bin$ ./catalina.sh start

Windows OS

  1. Tomcat can be started in either of two ways - standalone or as a service
  2. Standalone : Run the startup.bat or catalina.bat from inside the bin folder in the tomcat installation path.

  3. Ex:

    C:\apache-tomcat-8.0.9\bin>startup.bat (or)

    C:\apache-tomcat-8.0.9\bin>catalina.bat

  4. Service: Open 'Services' window, find the Tomcat service installed with the given name (default name - Apache Tomcat7.0 Tomcat7 or Apache Tomcat8.0 Tomcat8) and right-click and start the service. Note that 'Services' is usually available in 'Administrative Tools' in the 'Control Panel'. Also accessible through the 'Services' panel in 'Task Manager'
    5. Services

Stop Tomcat

Stop Tomcat

Linux OS

  1. Stop Tomcat using ./catalina.sh file.
  2. Ex:

  3. ubuntu@ip-10-0-0-110:/eLink-CE-7.6.0_With_Tomcat/bin$ ./catalina.sh stop -force

Windows OS

  1. Tomcat can be stopped in either of two ways - standalone or as a service
  2. Service: Open 'Services' window, find the Tomcat service installed with the given name (default name - Apache Tomcat7.0 Tomcat7 or Apache Tomcat8.0 Tomcat8) and right-click and stop the service. Note that 'Services' is usually available in 'Administrative Tools' in the 'Control Panel'. Also accessible through the 'Services' panel in 'Task Manager'
    3. Services
  3. Standalone: Force kill the tomcat process running in windows.

Access eLink

Please Note: All communication with eLink is secure using https and SSL encryption. Infor M3 Marketplace works only on eLink installed with HTTPS support. So configuring SSL support on Tomcat is mandatory.

  1. Your eLink will be available on the url https://yourserver:8443/(eLink version name)

"Yourserver" is the public host name (or public ip) of your server and 8443 is the default port on which Tomcat runs. Make sure this URL is available externally from outside your company network.You can configure Tomcat to start in any other open port on the server by modifying TOMCAT_HOME/conf/server.xml.

For example: https://yourserver:8443/eLink-CE-7.6.0/

Configure eLink

  1. Go to your Infor M3 Marketplace account My Account -> eLink Config.
  2. In the field for eLink Host Name/IP enter the public DNS name or the server public IP (for example 52.26.237.171 or elink.leanswiftmarketplace.com).
  3. In the eLink Name dropdown select the version of eLink that you have installed (for example eLink-CE-7.6.0).
  4. In the Port field enter the port that you have configured your tomcat to run (for example 8443).

    5. For Versions < 6.0,

    1. Press Submit. This will save the eLink connection information and attempt to connect to your eLink instance. Any error messages at this stage is likely connection issues because your eLink cannot be reached from Infor M3 Marketplace. The host and port configured must be publicly accessible.

    2. Once access has been established enter configuration data corresponding to your M3 environment in the sections for M3 Database settings and M3 API settings. eLink will use these settings to connect to M3. Add details of your mail server (if applicable).

    3. 1) M3 Database Connection Pool Initial Size - 5 (recommended)

    4. 2) M3 Database Connection Pool Max Active Connections - 10 (recommended)

    5. Press Submit. Your eLink installation will be updated with the configuration and is now ready for use.

    For Versions >= 6.0,

    1. In the "Environment" Field enter the environment you want to configure with this eLink (for example DEV).

    2. Press Save. This will attempt to connect to your eLink instance. Any error messages at this stage is likely connection issues because your eLink cannot be reached from Infor M3 Marketplace. The host and port configured must be publicly accessible.

    3. Once access has been established, press Retrieve Configuration. If connection is established to your eLink instance, Global Settings and Application Settings sections will appear. Enter configuration data corresponding to your M3 environment in Global settings section. eLink will use these settings to connect to M3. Configure values in Application settings, if applicable.

    4. Please find below recommended values for some of the configurable settings.

    5. 1) M3 Database Connection Pool Initial Size - 5 (recommended)

    6. 2) M3 Database Connection Pool Max Active Connections - 20 (recommended)

    7. Press Save. Your eLink installation will be updated with the configuration.

Upgrade eLink

When upgrading Leanswift eLink to a newer version there are a few important steps to go through. But before you begin:

  1. Your settings are stored in eLink and not in the marketplace cloud service. Because of this your current configuration may need to be redone. To facilitate this please make sure to note down your current configuration of the eLink.
  2. Login into Infor M3 Marketplace. My Account -> eLink Config.
  3. Make sure "eLink Name" is set to your existing eLink version.
  4. Click on Retrieve Configuration and get all the existing configuration values.
  5. Note the values.

Once that is done, to proceed with upgrading eLink to a new version follow the steps below:

  1. Take a backup of database file.
  2. Download and install/update the latest WAR in Tomcat.
  3. Update configuration through Marketplace.
  4. Activating Licenses.

Take a backup of database file

  1. Stop Apache Tomcat (For How to Stop, refer)
  2. Take backup of database file from file path
    1. default path for v7.6.0 or later "tomcat directory/eLinkDB/eLink-CE-7.6.0/eLink.db"
    2. default path for v4.2 or later "tomcat directory/tomcat-Folder-Nameh2databaseStoreFile.db.mv.db" .

Note: A backup is recommended to be taken, as this contains data for eLink to work with applications and Marketplace.

Download and update the latest war in tomcat

  1. Get latest version of eLink 'war' file from here. Pick your version (CE or EE) and add to cart and proceed with checkout.
  2. Once Checkout is successful. Go to My Account -> My Downloadable Products, there you can see all the available products for download. Click on the eLink that you want to download (look at the Date column and make sure you are selecting the latest version), the download starts automatically.
  3. Replace WAR file in Apache Tomcat where your current version of eLink is installed. Steps to keep in mind while replacing WAR are as follows.
      Windows
    1. Go to tomcat-directory\webapps folder and take a backup of eLink-CE-6.0.1 war file and folder to a location outside of the tomcat directory path.
    2. Delete both eLink-CE-version.war file and the extracted WAR file folder eLink-CE-version from the webapps folder, that is already present inside Tomcat
    3. Right Click and Click on 'Delete' option to delete these.
    4. Place the new upgraded eLink - eLink-CE-version.war inside Apache Tomcat's webapps folder (Example: tomcat-directory/webapps folder.).
      Unix/Linux
    1. Stop tomcat (For How to Stop, refer)

      1. ubuntu@ip:dir/tomcat$./catalina.sh stop -force

    2. Navigate to webapps folder.
      1. Ex:

      2. ubuntu@ip:~$ cd dir/tomcat/webapps/

      3. List the content of the folder

        • ubuntu@ip:dir/tomcat/webapps$ ls -lart

        • -rwxrwxrwx 1 tomcat tomcat 49625845 Aug 5 09:52 eLink-CE-4.4.3.war

        • drwxrwxrwx 4 tomcat tomcat 4096 Aug 5 09:52 eLink-CE-4.4.3

      4. Take backup of the eLink-CE-4.4.3.war and eLink-CE-4.4.3 folder using the below command.

      5. ubuntu@ip-10-0-0-110:dir/tomcat/webapps$ cp -r dir/tomcat/webapps/eLink-CE-4.4.3/dir-to-backup

      6. Delete the war file and deployed folder of the war file using the below command. Example:

        • ubuntu@ip:dir/tomcat/webapps$rm -rf eLink-CE-4.4.3

        • ubuntu@ip:dir/tomcat/webapps$rm -rf eLink-CE-4.4.3.war

      7. Place new upgraded eLink - eLink-CE-version.war inside webapps folder (i.e- rootdir/tomcat/webapps).
        1. Transfer the new war file from local to unix/linux account.
        2. Then copy the war file to webapps folder.
        3. Ex:

        4. cp eLink-CE-latest-version root-dir/tomcat/webapps

  4. Verify if the new database file 'eLink.db' has been created inside 'tomcat-directory\eLinkDB\eLink-CE-7.6.0\eLink.db'.
  5. Once the file is created, we can access the configuration services from marketplace and do the required configurations for eLink as recommended.
  6. Once the configuration is saved, kindly restart the tomcat.
  7. Verify the port 8443 is still publicly open to the eLink server.
  8. Start Apache Tomcat.(For How to Start, refer)

Updating the configurations through Marketplace

  1. Login into Infor M3 Marketplace. Go to your My Account -> eLink Config.
  2. Select "eLink Name" for the version you are upgrading to. Verify Hostname and port.
  3. For Versions < 6.0,

    1. Click on Retrieve Configuration. Once default values are retrieved successfully, update settings for M3 database, M3 API & Mail and save configuration.

  4. For Versions >= 6.0,

    1. Click Save .This will attempt to connect to your eLink instance.

    2. Press Retrieve Configuration. Global Settings and Application Settings sections will appear. Update configuration data corresponding to your M3 environment in Global settings section.

  5. Restart Apache Tomcat.(To stop, refer and To start, refer)

Activating Licenses

  1. Go to your My Account -> My Licenses and click on "Activate Licenses in eLink" to reactivate all the active licenses in the upgraded eLink.

Common errors and instructions to troubleshoot

  1. Unable to start Tomcat with JAVA_HOME error

      • C:\eLink-CE-7.6.0_With_Tomcat\bin> startup.bat (or)

      • C:\eLink-CE-7.6.0_With_Tomcat\bin> catalina.bat

      • Neither the JAVA_HOME nor the JRE_HOME environment variable is defined.

      • Atleast one of those environment variable is needed to run this program.

    2. Solution:

      3. Setting up JAVA_HOME or JRE_HOME in the Windows environment variables should resolve the problem. Example can be found here. Remember to relaunch the command prompt after adding environment variables if you were using it to start the tomcat.

  2. Connection refused error
    1. Solution:

      2. The Port could be incorrect. Please verify that startup port is configured correctly in TOMCAT_HOME/conf/server.xml. Another common problem is that the Windows Firewall is blocking ports, so please ensure both company network firewall and the Windows Firewall on the server itself are not blocking the port. A common issue is that the port is open in the company firewall, but the Windows firewall on the server itself is blocking it.

  3. What if my tomcat is not restarting after upgradation without throwing any errors?
    1. After upgrading eLink, if there is some issue in starting Tomcat then clear your tomcat work directory and try starting Tomcat.
  4. How to clear the tomcat work directory.
    1. Stop the Apache Tomcat server. (For How to Stop, refer)
    2. Go to tomcat-directory\work\Catalina\localhost folder
    3. Important! Verify that you are in the tomcat-directory\work\Catalina\localhost folder and not the tomcat-directory\webapps folder.
    4. Delete eLink project folder.
    5. Restart the Apache Tomcat. (To stop, refer and To start, refer)
  5. What if the mobile app throws an error "Invalid Marketplace-ApiKey or Company Id"?
    1. There may be a problem in Active License Keys in eLink. Go to My Licenses and click Activate Licenses in eLink.

Please Note: LeanSwift does not store your eLink configuration. It is retrieved and updated securely through your Infor M3 Marketplace account, but never stored anywhere. The only thing stored in Marketplace is your eLink host and port.



If you have questions, please submit your query at Contact Us or email us at marketplace@leanswift.com