Document toolboxDocument toolbox

ServiceMobility 3.16.0 Installation - Linux

Linux Setup Notes

You must be logged into the Linux server as the user that the background services will eventually be running under. This ensures that files created during the setup process will have the correct permissions when running as a service.

General

  • This document describes the process of installing ServiceMobility on a new, clean system. For upgrading an existing ServiceMobility installation see: Upgrading ServiceMobility
  • Prior to installing ServiceMobility please ensure that all prerequisites have been met. See: ServiceMobility Hardware and Software Requirements
  • It is important to make sure the Java JDK is install and not the standard JRE. You can verify the JDK 1.8.0_45 or later is installed by running the following command

 

javac -version

 

Install Red Hat A-MQ

  1. Unpack the Red Hat A-MQ Distribution

    cd ~
    unzip jboss-a-mq-6.2.1.redhat-090.zip

Install Red Hat FUSE ESB

ServiceMobility 3.15.0 requires RedHat FUSE ESB version 6.2.0

  1. Unpack the Red Hat FUSE ESB Distribution

    cd ~
    unzip jboss-fuse-6.2.0.redhat-133

Install Node.js

ServiceMobility 3.15.0 requires Node.js 6.1.0+.

Follow the instructions on the Node.js web site (https://nodejs.org/en/download/) for downloading and installing Node.js

Install ServiceMobility

Unpacking

  1. Unpack the ServiceMobility.zip contents into the home directory of the user that the background Linux service will be running as. e.g.

    cd ~
    unzip ServiceMobility.zip

Creating the Initial Database

  1. Create a new SQL Server database named ServiceMobility
  2. Create a SQL logon used to access the ServiceMobility database
    1. (warning) The logon information will be required later in the setup process
  3. Execute the following scripts on the ServiceMobility database
    1. sql/ServiceMobility-SoR.sql to create the initial database structure
    2. sql/SeedData.sql to initialize the database with default values
    3. sql/SeedData-Templates.sql to initialize the databases default templates
  4. Create an initial Entity in the ServiceMobility Database
    1. Edit sql/USA.sql file and update the @EntityName variable with the desired entity name. Spaces are not allowed.
    2. Execute the sql/USA.sql script on the ServiceMobility database to create the new entity
    3. This new entity will have default logon of admin@EntityName (where EntityName is the value entered in step 1) with a default password of Password1!

Configure ServiceMobility

The ServiceMobility setup script can be executed at any time to make changes to a new or existing configuration. 

When the setup script first starts, it will verify the required directories and files exist. If any errors are reported verify the following:

  • Verify that ServiceMobility was extracted to the proper location
  • Verify you are running the setup script from the proper directory
  • Verify the currently logged user has access to the reported directory or file

 

  1. Execute the setup script

    cd ~/ServiceMobility
    node middlewares/up_auth/bin/setup.js
  2. Enter SQL Server connection properties
    1. After entering all of the properties the script will verify connectivity to SQL Server
      1. If the Script reports an Invalid Logon
        • Validate the ServiceMobility database has been created
        • Validate the entered credentials have proper access to the ServiceMobility database
        • Validate firewall settings to ensure the server has access to SQL Server over the entered port
      2. If the setup script reports an ETIMEOUT error
        • Validate the entered Server name
        • Try and ping the server
        • Validate the port number
        • Try and telnet to the server with the specified port
        • Validate firewall settings to ensure the server has access to SQL Server over the entered port
      3. If any error is reported you will have to option to re-enter the SQL Server properties or continue
  3. Enter SMTP Settings (optional but recommended)
    • ServiceMobility uses email to send alerts to administrators when there is a system error, sending Customer's PDF invoices, password reset notifications, etc.
  4. Amazon S3 Settings
    • Amazon S3 settings must be specified if you are planning to use the ServiceMobility photo capture functionality
  5. ActiveMQ Settings
    • For larger systems ActiveMQ and ESB can be installed on different servers. This setting identifies where the ActiveMQ server is located. 
  6. ServiceScheduling Settings (optional)
    • If ServiceMobility is integrated with ServiceScheduling then these settings are required
  7. Enter the user the ServiceMobility service should be run as
  8. After all of the properties have been entered the script will
    1. Save a copy of the entered settings in ServiceMobility-opts.json
    2. Update all of the appropriate configuration files
    3. Exit

Configure JBoss Fuse ESB to run as a Linux Service

  1. Start ESB Karaf Console

    cd ~/ServiceMobility/jboss-fuse/bin
    karaf
  2. Execute the following Karaf console commands

    karaf@root> features:install wrapper
    karaf@root> wrapper:install -s AUTO_START -n KARAF -d Karaf -D "Karaf Service"
    karaf@root> features:uninstall mq-fabric
    karaf@root> shutdown

    (warning) The shutdown process make take a couple of minutes - be patient

     

  3. Edit Karaf configuration file

    nano ~/ServiceMobility/jboss-fuse/etc/KARAF-wrapper.conf
  4. Locate the wrapper.java.maxmemory settings and set it to 2048

    	.
    	.
    # Maximum Java Heap Size (in MB)
    wrapper.java.maxmemory=2048
    	.
    	.
  5. Edit ~/ServiceMobility/jboss-fuse/bin/Karaf-service
  6. Locate the RUN_AS_USER parameter and set it to the user the service should be run as
  7. Execute the following shell commands

    cd ~/ServiceMobility/jboss-fuse/bin
    sudo ln -s $PWD/KARAF-service /etc/init.d/KARAF-service
    sudo chkconfig KARAF-service --add
    sudo chkconfig KARAF-service on
  8. Start the ESB service

    service KARAF-service start

Stopping the ESB Service

To stop the ESB service, execute the following command ( (warning) do not execute at this time)

service KARAF-service stop

Install ActiveMQ as a Service

ActiveMQ startup settings, including memory options are configured in /etc/default/activemq

  1. Execute the following commands

    cd ~/ServiceMobility/jboss-a-mq/bin
    sudo ln -s $PWD/env /etc/default/activemq
    sudo ln -s $PWD/activemq /etc/init.d/activemq
    sudo chkconfig --add activemq
    sudo chkconfig activemq on
  2. Start the ActiveMQ service

    service activemq start
  3. Stopping the ActiveMQ Service can be accomplished with the following command (warning) do not run it at this time

    service activemq stop

Configure Local TCP Forwarding Rules

For security reasons, Linux servers restrict binding to TCP ports below 1024 to services running as the root user. Running services as root it not a recommended practice. Therefore, to get around what appears to be a catch-22 problem is to simply create local port forwarding rules.

Node.js is expecting HTTP traffic on internal TCP port 3001 and secure HTTPS traffic on internal TCP port 3000. The following steps will guide you through setting up the TCP port forwarding rules.

  1. Edit /etc/rc.local

    sudo nano /etc/rc.local
  2. Add the following lines to the end of the file

    iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 443 -j REDIRECT --to-port 3000
    iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 80  -j REDIRECT --to-port 3001
  3. Save

Install Node.js as a Service

  1. Execute the following shell commands

    cd ~/ServiceMobility/middlewares/up_auth
    bin/installService.sh
  2. Add the following to /etc/init/env.conf file

    # /etc/init/env.conf
     env NODE_ENV=production

Verify Installation

In the URLs below, replace ${HOST} with the host name or IP address of the server that was just configured.

 

  • The ServiceMobility mobile application is accessed from the following URL

    https://${HOST}/mobility/index.htm

  • The ServiceMobility Management Application is accessed from the following URL

    https://${HOST}/nexus/index.html

  • The ServiceMobility REST APIs are accessed from the following URL

    https://${HOST}/seiapi/v3/...

Related Articles