Knowledge Base

Back to support overview

Install Frontline Connector

This guide shows how to install Frontline Connector on Linux.

Prerequisites

  1. Download the .jar file of the Frontline Connector from our precompiled Connector Application with XLSX and CSV import.
  2. This .jar file needs to be uploaded to the server at the location: /var/opt/frontline/connector.jar

Wrapping the JAR

  1. Provide the .jar file as a service.
  2. Connector Service needs to be created manually. The path should be /etc/systemd/system/connector.service
[Unit]

   Description=frontline-connector
   After=mysql.service

[Service]

   Environment="UBIMAX_HOME=/var/data/frontline/"
   ExecStart=java -jar /var/opt/frontline/connector.jar
   SuccessExitStatus=143

[Install]

   WantedBy=multi-user.target

Configuring the Connector

1. Register the service with the command:

  systemctl enable connector.service

2. Start the service with the command:

  systemctl start connector.service

3. Show the status of the service with the command:

  systemctl status connector.service

Configuration files are created during the first launch of the service in the FRONTLINE_HOME directory.

4. Open the %FRONTLINE_HOME%/config/configuration/xservice.properties file .

5. Configure the "xserver.url" and "xserver.port" parameters of

server.port=${FC_PORT}
fcc.remote-address=${fcc.url}:${fcc.port}
fcc.api.key=${FCC_API_KEY}
fc.url=${FC_URL}:${FC_PORT}
server.servlet.context-path=/connector/

Example

service.port=8081 
fcc.remote-address=http://123.456.789.10:8080
fcc.api-key=687ae1dc4e40423c9d88b37b220a4328
fc.url=http://123.456.789.10:8081/connector
server.servlet.context-path=/connector/

Configure the API Key

In order to connect to the Frontline Command Center, an API key is required for authorization of the connector.

fcc.api-key=${api.key}

To get an API key,

  1. Log in to Frontline Command Center as sysadmin.
  2. Navigate to Configuration and then Users.
  3. In Users list, double-click on the user named "Frontline Connector".
  4. A detailed view opens with the key in the "User Info" section.

Note: Firewall configurations should allow access to the ports used in the settings.

5. Restart the service.

If the configurations were successful, the logs display lines like these:

25 Sep 2018 15:31:27,660 INFO  ServiceController - Registering EVENT-Service with xServer
[...]
25 Sep 2018 15:31:27,933 INFO  ServiceController - Registering TROUBLESHOOTER-Service with xServer
[...]
25 Sep 2018 15:31:27,957 INFO  ServiceController - Registering inspection-Service with xServer
[...]
25 Sep 2018 15:31:28,201 INFO  ServiceController - Registering PICKING-Service with xServer
[...]
25 Sep 2018 15:31:30,519 INFO  IntegrationService - Started IntegrationService in 8.665 seconds (JVM running for 10.55)

If the Frontline Connector has the web UI enabled, it can be accessed using the URL configured in the properties (e.g. http://123.456.789.10:8081).