Installing on Linux

 

Several Linux distributions exhibit slow response as a result of the newly introduced FIPS TLS library. To prevent this issue, please see Installing haveged prior to installing MFT Server

 

To install using the RPM file, perform the following steps as a user with root privileges.

 

  1. Place the install.rpm file in a directory on the destination server.

     

  2. Install. Run the following command from the directory containing the RPM file you placed on your server:

     

    rpm -iv install.rpm

     

  3. Configure and initialize the MFT Server database.

     

    It is recommended that an ANSI compliant relational database such as MySQL, MSSQL, Oracle, or PostgreSQL be used. We also support relational database services, such as Amazon RDS and SQL Server Managed Instances in Azure. Before configuring the database, you must create it using the relational database of your choice. After doing so, you will reference the database during the configuration process.

     

    The JSCAPE MFT Server database user should be granted only the minimum necessary privileges. Avoid using administrative or root database accounts.

     

    Required Privileges — Work closely with your DBA to ensure the database and user are created with the access levels described below.

     

    • Schema Management: CREATE, ALTER, DROP (Required for initial installation)

    • Data Manipulation: INSERT, UPDATE, DELETE, SELECT (Required for normal operation)

    • Index Management: CREATE INDEX, DROP INDEX (Required for performance optimization)

     

    After the database is created, navigate to the MFT Server installation directory, which is /opt/mft_server.

     

    Next, to configure the relational database (created earlier, as described above), enter the following commands:

     

    ./js-database-configuration -configure -url <URL> -user <DB user> -password <DB Password> - For more details see js-database-configuration

     

    For example: ./js-database-configuration -configure -url jdbc:mysql://mftserverdb.d7movljn.us-west-2.rds.amazonaws.com:3306 /MFT_Server -user admin -password '***'

     

    Next, run the init command to initialize the database schema:

     

    ./js-database-configuration -init

     

    MFT Server ships with an embedded H2 database. It is NOT intended for production environments. It is used for evaluation purposes only.  If you are setting up an evaluation environment, you can use the embedded database (as opposed to a relational database) by issuing the 2 commands below. The H2 evaluation database will automatically be created for you.

     

    ./js-database-configuration -configure

     

    ./js-database-configuration -init

     

  4. Add an administrative user.  Go to the /opt/mft_server directory and run the following command.

     

    ./js-addadmin -db -username [username] -password [password] -sa

     

    For example

     

    ./js-addadmin -db -username admin -password secret -sa

     

  5. Configure Administration Service.  Go to the /opt/mft_server directory and run the following command:

     

    ./js-server-configuration -host [ip address] -port [port] -timeout [timeout in seconds]

     

    For example:

     

    ./js-server-configuration -host 0.0.0.0 -port 10880 -timeout 60

     

    This will configure your MFT Server Service, where [ip address] and [port] are the IP/port that you want the MFT Server Service to listen on, and [timeout in seconds] is the timeout value for this service. The defaults port for MFT Server Service  is 10880.

     

    The IP address 0.0.0.0 is a special address that instructs the service to listen on all available network interfaces.

     

    MFT Server Service host/IP and port identifies the default host/IP and port that the MFT Server Service listens on when users are programmatically accessing MFT Server using the Java Management API. If you do not plan on using Java API calls, you can disable the host and port (after the installation) by accessing the MFT Server Manager, then navigating to Settings > MANAGER SERVICE > Manager Service. Uncheck the Enable Manager Service checkbox.

     

  6. Configure the Web/REST settings. Go to the MFT Server installation directory, located in the mft_server directory relative to where the unzip command was executed, and run the following command:

     

    ./js-web-configuration -host [REST ip address] -port [REST port] -timeout [timeout in minutes]

     

    For example:

     

    ./js-web-configuration -host 0.0.0.0 -port 11880 -timeout 10

     

    Rest IP and port identify the default IP and port that MFT Server listens on when users connect to the web-based MFT Server Manager UI. MFT Server Manager is the interface used to manage all aspects of MFT Server, like creating services, Users, Trading Partners, and configuring settings. It is also the IP and port used to programmatically manage the MFT Server settings using management REST API calls.

     

  7. Configure the credentials used when invoking command line utilities. Go to the /opt/mft_server directory and run the following command:

     

    ./js-client-configuration -host [host] -port [port] -timeout [timeout in seconds] -user [username] -password [password]

     

    Make sure the user and password parameters match the username and password that were used earlier in the js-addadmin command.

     

    For example:

     

    ./js-client-configuration -host 0.0.0.0 -port 10880 -timeout 60 -user admin -password secret

     

  8. Generate a Server Key. Go to the /opt/mft_server directory and run the following command:

     

    ./js-add-server-key -rsa -size 4096 -alias example_rsa - Note, example_rsa is the name of the key. Feel free to name it whatever you would like. The recommended key size is 4096.

     

    The Server Key can also be created using the MFT Server Manager, after the installation.  See Keys > Server Keys > Generate > Generate Key.

     

  9. Copy the license key file to the etc directory that is relative to MFT Server's installation directory. This must be done before attempting to start the service. 

     

    The license key file is provided to each customer in a zip file. The MFT Server license is in the zip file's JSCAPE MFT Server folder. It is named license.lic.

     

  10. Startup Administration Service.  From the /opt/mft_server directory run the following command:

     

    ./start_service.sh

     

To verify that MFT Server is running, enter: ps aux | grep mft_server

 

If MFT Server is not running, navigate to the MFT Server log file: /opt/mft_server/var/log

 

Enter: cat server0.log

 

See also

 

Accessing the user interface - MFT Server Manager - This is the web-based application used to configure and manage MFT Server.

 

MFT Server Manager Navigation

 

Auto-start using SysVinit scripts

 

If you intend to run MFT Server on Java 9 or Java 10 read Running on Java 9 or above

 

 

Several Linux distributions exhibit slow response as a result of the newly introduced FIPS TLS library. To prevent this issue, please see Installing haveged prior to installing MFT Server

 

  1. Place the install.zip file in a directory on the destination server.

     

  2. Install. Run the following command from the directory containing the ZIP file you placed on your server:

     

    unzip install.zip

     

  3. Configure and initialize the MFT Server database.

     

    It is recommended that an ANSI compliant relational database such as MySQL, MSSQL, Oracle, or PostgreSQL be used. We also support relational database services, such as Amazon RDS and SQL Server Managed Instances in Azure. Before configuring the database, you must create it using the relational database of your choice. After doing so, you will reference the database during the configuration process.

     

    The JSCAPE MFT Server database user should be granted only the minimum necessary privileges. Avoid using administrative or root database accounts.

     

    Required Privileges — Work closely with your DBA to ensure the database and user are created with the access levels described below.

     

    • Schema Management: CREATE, ALTER, DROP (Required for initial installation)

    • Data Manipulation: INSERT, UPDATE, DELETE, SELECT (Required for normal operation)

    • Index Management: CREATE INDEX, DROP INDEX (Required for performance optimization)

     

    After the database has been created (as described above), navigate to the MFT Server installation directory, located in the mft_server directory relative to where the unzip command was executed.

     

    Next, to configure the relational database, enter the following commands:

     

    ./js-database-configuration -configure -url <URL> -user <DB user> -password <DB Password> - For more details see js-database-configuration

     

    For example: ./js-database-configuration -configure -url jdbc:mysql://mftserverdb.d7movljn.us-west-2.rds.amazonaws.com:3306 /MFT_Server -user admin -password '***'

     

    Next, run the init command to initialize the database schema:

     

    ./js-database-configuration -init

     

    MFT Server ships with an embedded H2 database. It is NOT intended for production environments. It is used for evaluation purposes only.  If you are setting up an evaluation environment, you can use the embedded database (as opposed to the relational database) by issuing the 2 commands below. The H2 evaluation database will automatically be created for you.

     

    ./js-database-configuration -configure

     

    ./js-database-configuration -init

     

  4. Add an administrative user. Go to the MFT Server installation directory, located in the mft_server directory relative to where the unzip command was executed, and run the following command:

     

    ./js-addadmin -db -username [username] -password [password] -sa

     

    For example:

     

    ./js-addadmin -db -username admin -password secret -sa

     

  5. Configure Administration Service.  Go to the /opt/mft_server directory and run the following command:

     

    ./js-server-configuration -host [ip address] -port [port] -timeout [timeout in seconds]

     

    For example:

     

    ./js-server-configuration -host 0.0.0.0 -port 10880 -timeout 60

     

    This will configure your MFT Server Service , where [ip address] and [port] are the IP/port that you want the MFT Server Service to listen on, and [timeout in seconds] is the timeout value for this service. The defaults port for MFT Server Service  is 10880.

     

    The IP address 0.0.0.0 is a special address that instructs the service to listen on all available network interfaces.

     

    MFT Server Service host/IP and port identifies the default host/IP and port that the MFT Server Service listens on when users are programmatically accessing MFT Server using the Java Management API. If you do not plan on using Java API calls, you can disable the host and port (after the installation) by accessing the MFT Server Manager, then navigating to Settings > MANAGER SERVICE > Manager Service. Uncheck the Enable Manager Service checkbox.

     

  6. Configure the Web/REST settings. Go to the MFT Server installation directory, located in the mft_server directory relative to where the unzip command was executed, and run the following command:

     

    ./js-web-configuration -host [REST ip address] -port [REST port] -timeout [timeout in minutes]

     

    For example:

     

    ./js-web-configuration -host 0.0.0.0 -port 11880 -timeout 10

     

    Rest IP and port identify the default IP and port that MFT Server listens on when users connect to the web-based MFT Server Manager UI. MFT Server Manager is the interface used to manage all aspects of MFT Server, like creating services, Users, Trading Partners, and configuring settings. It is also the IP and port used to programmatically manage the MFT Server settings using management REST API calls.

     

  7. Configure the credentials used when invoking command line utilities. Go to the /opt/mft_server directory and run the following command:

     

    ./js-client-configuration -host [host] -port [port] -timeout [timeout in seconds] -user [username] -password [password]

     

    Make sure the user and password parameters match the username and password that were used earlier in the js-addadmin command.

     

    For example:

     

    ./js-client-configuration -host 0.0.0.0 -port 10880 -timeout 60 -user admin -password secret

     

  8. Generate a Server Key. Go to the /opt/mft_server directory and run the following command:

     

    ./js-add-server-key -rsa -size 4096 -alias example_rsa - Note, example_rsa is the name of the key. Feel free to name it whatever you would like. The recommended key size is 4096.

     

    The Server Key can also be created using the MFT Server Manager, after the installation.  See Keys > Server Keys > Generate > Generate Key.

     

  9. Copy the license key file to the etc directory that is relative to MFT Server's installation directory. This must be done before attempting to start the service.

     

    The license key file is provided to each customer in a zip file. The MFT Server license is in the zip file's JSCAPE MFT Server folder. It is named license.lic.

     

  10. Startup Administration Service.  From the /opt/mft_server directory run the following command:

     

    ./start_service.sh

 

To verify that MFT Server is running, enter: ps aux | grep mft_server

 

If MFT Server is not running, navigate to the MFT Server log file: /opt/mft_server/var/log

 

Enter: cat server0.log

 

See also

 

Accessing the user interface - MFT Server Manager - This is the web-based application used to configure and manage MFT Server.

 

MFT Server Manager Navigation

 

Auto-start using SysVinit scripts

 

If you intend to run MFT Server on Java 9 or Java 10 read Running on Java 9 or above

 

Select the installation instructions based on the filename you downloaded from the JSCAPE website.

 

 

See also

 

Redwood University - JSCAPE On-premise MFT Installation. Select Installing JSCAPE MFT Server.

 

A login is required to access Redwood University.