This section describes in detail how to carry out the tasks in the installation workflows for the core components. If you are an existing customer upgrading from an earlier SPARCS N4 version, you can skip steps 6-8. If you are a new customer, you must perform all of the steps.
Install Steps for Core Components (SPARCS N4 and XPS):
1
Install Java Development Kit (JDK) (on page 46).This must be installed on every host server.
2
Install the SPARCS N4 Center node (on page 47).The SPARCS N4 install wizard has three paths: one for the Center node, one for the Standby Center node, and one for the Cluster nodes.
3
Install the Standby Center node (on page 57).Almost identical to installing the Center node, except for one step.
4
Install the SPARCS N4 cluster nodes (on page 60).The standard is to configure four nodes to serve as application servers in the cluster. This is based on the size of the terminal and the RAM capacity you have available. If the terminal is large, and you have more hosts available for the SPARCS N4 cluster, you can configure more nodes. See the SPARCS N4 2.4 Technical Requirements for more information.
5
Verify the SPARCS N4 node installation with a first startup (on page 62).Navis recommends a specific start-up procedure at this point in the installation for both new and upgrading customers.
6
Load initial reference data (on page 133).This is only necessary for new customers. If you are an exisitng customer, you do not need to do this step because SPARCS N4 reads this information from the database.
7
Set up a basic SPARCS N4 topology (on page 134).This is only necessary for new customers, or if you have changed your topology.
The topology codes you entered into the SPARCS N4 install wizards only populate the shared n4-settings.xml file. The SPARCS N4 install wizard does not create the topology in the database. However, you must use those same codes in creating the topology.
SPARCS N4: Installation Guide 2.4 45
8
Create a Yard Model and Configure the Yard (on page 141).This is only necessary for new customers.
For existing customers connecting to a 2.1 or above database, the database reads your existing yard into version 2.4 when it first starts up. (It gets this information from the database backup.)
9
Apply your license to SPARCS N4 (on page 140).This is essential if you are a new customer.
If you are upgrading from a previous version of SPARCS N4, SPARCS N4 reads your existing license from the database backup. However, with new versions, new features are enabled, and unless you perform this step, you do not have access to those new features. Further, if you have licensed additional features with this upgrade, you do not have access to those features until you apply your new license.
10
Install the XPS application and the Bridge daemon (on page 64).These two components install with the same install wizard, and run on the same host. Every yard has its own XPS/Bridge daemon host.
11
Install the XPS client on a desktop workstation (on page 70).The workstation must be on the same network with the staging system. You only need to install one XPS while you are initially installing. However, during testing and configuration, you can install as many as you need.
12
Start the system up to test the connections (on page 155).Follow the exact start-up sequence instructions or risk failure.
Install Java Development Kit (JDK)
The Java application bundle makes it possible for the SPARCS N4 application to be platform independent.
You install Java on the hosts for the SPARCS N4 application servers, the host for the Bridge daemon, and (if licensed), the hosts for N4 Billing and ECN4. SPARCS N4 2.4 requires JDK 1.6 (not JavaFX or JavaEE).
Go to http://www.oracle.com/technetwork/java/javase/downloads/index.html to download the latest 1.6 SE (Standard Edition, not JavaFX or JavaEE).
To install and configure Java:
1 Download the Java executable from the source site.
2 Put the file into a temporary directory.
3 Double-click the .exe. The install wizard opens and walks you through the process.
4 Accept the defaults.
5 Click Finish.
6 Repeat steps 1-5 on each of the host computers:
The host for the SPARCS N4 application servers
The host for the XPS/Bridge daemon
(Conditional) The host for ECN4Web
(Conditional) The host for ECN4
(Conditional) The host for N4 Billing
46 SPARCS N4: Installation Guide 2.4
Install the SPARCS N4 Center node
Install the SPARCS N4 application with a Center node, a Standby Center node, and pairs of Cluster nodes.
The installation wizard for the SPARCS N4 application servers, sparcsn4-install.exe, lets you choose which type of N4 node to install. Because all three of these node types require dedicated servers, for the production system, you will be running the N4 install wizard on at least four hosts:
The Center node host (see instructions below)
A Standby Center node host (see instructions (on page 57))
Pairs of SPARCS N4 cluster nodes; either four nodes (two dedicated SPARCS N4 hosts) or more (one dedicated SPARCS N4 host for every two nodes) (see instructions (on page 60))
Do not include underscores or dashes in your host names. There is a known issue with using this and other unregistered characters (including _!~'()*) in host machine names.
Before you proceed:
You must have already configured your SPARCS N4 database (on page 25) with an empty instance/schema, or have credentials for a backed-up database from a previous version (from apex.xml).
The installation user account must have administrative privileges.
You must have already installed the JDK on each of the SPARCS N4 application servers (on page 46).
If you are upgrading, you must have completed the pre-installation upgrade tasks (on page 13).
Collect the details and values the install wizard needs. See Worksheet of values necessary for installation (on page 10).
Quit all other programs before continuing with this installation.
Steps to install the SPARCS N4 2.4 Center node in a Windows environment:
1 Place a copy of the SPARCS N4 application install wizard (sparcsn4-install.exe) for version 2.4 on the host for the primary Center node.
2 Double-click to launch the install wizard. After you accept the User Account Control dialog and click Run, the InstallAnywhere progress bar unpacks the installer, which should take less than one minute.
When it is unpacked, the wizard opens. There is a progress list on the left side of the screen that indicates which step you are on in the process, and the steps that remain.
SPARCS N4: Installation Guide 2.4 47
The Introduction screen briefly describes the process. We recommend you have this guide available as you proceed through the instructions.
Click Next to proceed to the next screen.
3 The License Agreement screen prompts you to read the terms of the Navis software license. To move forward, accept the terms.
Click Next to proceed to the next screen.
4 On the Choose Install Set screen, choose an option:
First Install - Choose this option if you are installing SPARCS N4 2.4 for the first time.
48 SPARCS N4: Installation Guide 2.4
You must back up your system and fully uninstall any previous version of SPARCS N4 before installing SPARCS N4 2.4. See Pre-installation upgrade tasks (on page 13) for more information.
Upgrade - Choose this option if you are installing any release above SPARCS N4 2.4, including any point or patch releases of SPARCS N4 2.4 (for example, SPARCS N4 2.4.0.1, or 2.4.1).
Even if you are upgrading SPARCS N4 from another version such as SPARCS N4 2.0 or 2.3, do not choose the Upgrade option if you are installing the 2.4 version of SPARCS N4 for the first time. Instead make sure you have fully uninstalled any previous version of SPARCS N4, and then choose the First Install option in the installers.
Click Next to proceed to the next screen.
5 On the Host Type screen, select the Center Node button.
SPARCS N4: Installation Guide 2.4 49
When you select the Center Node, the instructions expand to show the Install Center Node
Configurations check box. The Install Center Node Configurations check box is selected by default.
Do not clear it unless you are installing the Standby Center node.
If the check box for Install Center Node Configurations is disabled, toggle the Cluster Node button and then re-select the Center Node button. This enables the Install Center Node Configurations check box.
Click Next to proceed to the next screen.
6 Choose Install Folders is the first of two screens with this same name. On this first Choose Install Folders screen, choose directories for the following installation components:
50 SPARCS N4: Installation Guide 2.4
Application Folder - Path to the application files. Default is C:\Program Files\Navis
Configuration Folder - Path to the individual SPARCS N4 node logs and node property files.
Default is C:\ProgramData\Navis\
To make sure that the ProgramData folder displays once it is installed, go to the Control Panel Appearance Folder Options View dialog and choose Display Hidden Files.
Shared Configuration Folder - Path to the configuration files such as n4-settings.xml and tangosol-coherence-override-prod.xml that are shared by all system components. There is no default. The value you enter here can either be an existing network path or a path to a new folder that the install wizard will create.
If you enter a path to a new folder that the install wizard will create, you must post-configure Windows to make the folder available on a network. See Windows Server 2008 R2
documentation on how to enable shared network folders.
Before you leave this screen, test whether the Center node host can get to the Shared Configuration Folder you just defined:
From the Windows task bar, right-click the Windows Explorer to Run as Administrator.
In the address bar, type the path to the Shared Configuration Folder. The Shared Configuration Folder should appear. If it does not appear, do not continue with the installation until you can access this folder from the Center node host.
Click Next to proceed to the next screen.
7 The second Choose Install Folders screen asks you to specify the Network Shared Folder. This is optional, but recommended. This value defines the persistentDir setting in the
n4-settings.xml file. The install wizard pre-fills this field with the value you entered for the Shared Configuration Folder on the previous screen.
SPARCS N4: Installation Guide 2.4 51
If the path you entered for the Shared Configuration Folder on the previous screen is a local path on the host for the N4 Center node, you must enter the full network path to the folder in the Network Shared Folder field. This is because all of the components use the path to reach the shared files.
Click Next to proceed to the next screen.
8 The Database: Settings screen is where you specify the type of database you are using, along with the database User ID, Password, and Database Host address. You also specify the database System User ID and the database System User Password. For the Database Host, enter the address to the
database. For Database Port, enter the appropriate port number for your database type. The defaults are as below, but you should check with your administrator to confirm this is being used at your site:
SQL Server - 1433
Oracle or Oracle RAC - 1521
MySQL - 3306
For Schema Name or SID, enter the database name. If you do not know these values, consult your database administrator. For more information, see Deploy the Database Performance Pack (on page 41).
a. (Conditional) If you are using Oracle RAC, you provide the address to the Oracle RAC database host(s) and the ONS port(s).
There are always two hosts with Oracle RAC. The ONS port is a required field.
b. (Conditional) If you are using MySQL, you browse to the supported MySQL driver. See the MySQL Configuration Checklist (on page 36) for more information.
52 SPARCS N4: Installation Guide 2.4
Click Next to proceed to the next screen.
9 On the Cluster Configuration-Center Nodes screen, enter the host name addresses of the primary Center node and the Standby Center node.
Click Next to proceed to the next screen.
10 On the Cluster Configuration-Coherence screen, enter parameters for the tangosol-coherence-override-prod.xml file:
Multicast Address of the Coherence Cache - This is the address the members of the Coherence cluster use to discover each other. It must be in the format, 224.Y.XXX.XXX where Y is a number between 0 and 4, and XXX is a number between 1 and 254.
SPARCS N4: Installation Guide 2.4 53
You simply define the address during installation, using the guidelines. This is not a value derived from your hardware environment.
To prevent data corruption, your staging and production environments must have unique multicast address values.
Multicast Time-To-Live (TTL) - Enter the lowest value integer possible, using the following guidelines:
TTL can represent the number of switches between two servers. On a simple switched backbone, this is usually "1".
However, on an advanced backbone with intelligent switching, you may require a value of "2"
or more.
If you set this value as >1, discuss possible latency issues with your Navis service representative.
Setting the value too high can use unnecessary bandwidth on other LAN segments, and can even cause the OS or network devices to disable multicast traffic.
Click Next to proceed to the next screen.
11 On the Cluster Configuration-Node Name screen, enter the name of the Center node. The install wizard defaults the name to [hostname]-center, but you can overwrite it. This name must not contain spaces. This name appears in the Cluster Services view in the SPARCS N4 ULC.
54 SPARCS N4: Installation Guide 2.4
Click Next to proceed to the next screen.
12 On the Cluster Configuration-XPS Host screen, enter the XPS host location (IP or machine name) and topology for the XPS host. Existing customers must enter the codes for their current topology. New customers determine these four codes with your Navis representative:
Operator code - Your Navis customer code.
Complex code - The United Nations (UN) location code for the city in (or nearby) which the complex is located. You can look this up at the UN website:
http://www.unece.org/cefact/locode/service/location.htm
Facility code - The natural name of the terminal, usually as a set of initials, or an acronym.
If you have more than one Facility, enter only the code for the main facility in your complex. After you have completed the installation with a separate XPS/Bridge installation for each facility/yard, you can post-configure your n4-settings.xml file for the additional facilities. See Post-configure for multiple facilities (on page 194).
SPARCS N4: Installation Guide 2.4 55
Yard code - The code used for the yard. It should be the same as the facility code.
Click Next to proceed to the next screen.
13 On the Pre-Installation Summary screen, review the configuration record.
a. Review the choices you made in the previous screens. If anything is incorrect, click Previous to go back to the relevant screen to change the input.
b. Check the disk space available on the host against the disk space required for installation. There must be enough disk space to install before you click Next.
The install wizard writes the configuration record on this screen to the
installvariables.properties file in the uninstall folder at C:\Program
Files\Navis\[component_name]\uninstall. See also the last step of this procedure for information about a similar file, installer.properties.
When everything is correct, click Install to apply the configuration and install the Center node.
14 The Installing SPARCS N4 screen shows progress during installation. The process should take less than five minutes. When it is complete, the installer displays a confirmation message. If there were errors, examine the time-stamped installation log at C:\Program
Files\Navis\sparcsn4\uninstall\logs\SparcsN4_Install_mm_dd_yyyy_hh_mm_ss.tx t for details. If you have errors during installation, it describes those errors. See Troubleshooting installation errors (on page 185).
Click Done to close the install wizard.
15 Verify that the wizard created the n4-settings.xml and tangosol-coherence-override-prod.xml files as expected in the Network Shared Folder. There should be two sub-folders in the Network Shared Folder: amq and conf. The conf folder should contain n4-settings.xml and tangosol-coherence-override-prod.xml. If not, review the installation record
(installer.properties) that the wizard writes to the folder from which you ran the install wizard.
56 SPARCS N4: Installation Guide 2.4
When you have completed installing the core components, you have the option to configure SPARCS N4 for unicast communication. See Configure unicast communication (on page 105).
16 Set the SPARCS N4 Center node service to run under a network domain user.
The default user for the SPARCS N4 Windows service is a local user who may not have sufficient privileges to access the shared drive.
a. From the Windows task bar on the Center node host, open the Server Manager . b. In the Server Manager, under Configuration in the left frame, select Services. The installed
services display in the right frame.
c. In the list of installed services, find the Navis N4 Center Node service, and right click. From the menu that appears, select Properties.
d. In the Log On tab, select This account: and enter a user account name.
e. Enter a Password and confirm the password.
f. Click OK. The Properties dialog closes.
17 Copy installer.properties from the folder from which you ran the sparcsn4-install.exe.
This file is an artifact of the installation. You can copy installer.properties to other SPARCS N4 hosts, and paste it into the folder with the install wizard for other SPARCS N4 application servers.
When installer.properties is present in the folder with the install wizard, the wizard reads these properties and pre-fills the corresponding fields in the install wizard with the same values. This is useful for accuracy in defining the database details, and the location of the Shared Configuration Folder across several hosts.
Next step: Install the Standby Center node (on page 57).
Install the SPARCS N4 Standby Center node
Install the SPARCS N4 Standby Center node on a dedicated host, apart from the Center node, the Cluster nodes, and XPS. It is the same process as installing the Center node, except for one step in the install wizard.
Once you install the Standby Center node, you start the service, and leave it running without further action. In this state, it is not fully initialized, and it does not appear in the Cluster Services view unless it becomes the Center node after the primary Center node goes down.
Before you proceed:
You must have already installed the Center node (on page 47).
You must have already installed the JDK (on page 46).
Verify that the host name does not contain an underscore.
Collect the details and values the install wizard needs. See Worksheet of values for installation (on page 10).
Quit all other programs before continuing with this installation.
Steps to install the SPARCS N4 2.4 Standby Center node in a Windows environment:
1 Place a copy of the SPARCS N4 application install wizard (sparcsn4-install.exe) for version 2.4 on the host for the Standby Center node.
2 Get the installer.properties file from the folder on the Center node host from which you ran SPARCS N4: Installation Guide 2.4 57
the install wizard for the Center node. Paste it into the same folder where you put the sparcsn4-install.exe.
This file is an artifact of the Center node installation. When it is present in the folder with the install wizard, the wizard reads the properties and pre-fills the corresponding fields in the Standby Center node path.
3 Test whether the Standby Center node host can get to the Shared Configuration Folder:
a. From the Windows task bar, open the Windows Explorer .
b. In the address bar, type the path to the Shared Configuration Folder that you defined when
b. In the address bar, type the path to the Shared Configuration Folder that you defined when