This section describes in detail how to licensable options.
Install Step Notes
Install ECN4 for Equipment Control (on page 111)
Must be installed on a host separate from SPARCS N4 or XPS. See the SPARCS N4 2.4 Technical Requirements.
Install ECN4Web (on page 118)
With fewer than 100 RDTs/VMTs, you can install the ECN4Web server on the same host as ECN4.
Install a Radio server for Equipment Control (on page 120)
Follow these instructions only if you are using the Radio server for Equipment Control instead of licensing ECN4.
Set up an XPS client as the statistics server (on page 121)
Only for customers who have licensed Monitor and Analytics.
Install the N4 Billing application server (on page 122)
Must be installed on a separate host. See the SPARCS N4 2.4 Technical Requirements.
Install N4 Mobile (on
page 131) For customers who have licensed N4 Mobile.
Connect to CAP (Community Access Portal)
For customers who have licensed N4 CAP.
Install ECN4
This section describes how to install ECN4 in a Windows environment. You install ECN4 on a dedicated server as specified in the SPARCS N4 2.4 Technical Requirements.
You install one ECN4 application per yard. You only install multiple ECN4 applications if you have multiple yards in the complex.
SPARCS N4: Installation Guide 2.4 111
All but the smallest yards require a separate, server-room XPS decking client (known as the "client decker" or "XD") that handles decking requests from ECN4. XPS also handles decking requests if the client decker is not defined, or if ECN4 determines that the dispatch request has been sent from the client decker's IP address; in that case, ECN4 asks XPS to handle the decking request.
In versions 2.1 and above, you do not have to maintain ECN4 connection information (IP address and port number) on the XPS client or in the n4-settings.xml file that XPS reads. The ECN4 server publishes its location to the Bridge. The Bridge daemon reads this and sends a message to XPS with the location, which XPS then shares with any XPS client.
To support sites with multiple yards, the install wizard for ECN4 asks you for the XPS/Bridge daemon host name, so that it can write a file (ecn4_settings_prod.xml) to the Bridge daemon's directory. The ECN4 wizard also writes this same file to its own directory. The two instances of the ecn4_settings_prod.xml file must be kept in sync at all times.
On the Bridge daemon, the file is located at
C:\ProgramData\Navis\bridged\conf\ecn4_settings_prod.xml. You manage this path in the Startup tab of the Bridge daemon's Properties dialog (Right-click C:\Program
Files\Navis\bridged\bin\bridgedw.exe and Run as Administrator). The argument is '-f', and the default path is C:\ProgramData\Navis\bridged\conf\ecn4_settings_prod.xml On ECN4, the file is located at C:\ProgramData\Navis\ecn4\conf\ecn4_settings_prod.xml.
You manage this path in the Java tab of the Properties dialog (Right-click C:\Program Files\Navis\ecn4\bin\ecn4w.exe and Run as Administrator). The argument is '-Dcom.navis.ecn4.settings.file', and the default path is:
C:\ProgramData\Navis\ecn4\conf\ecn4_settings_prod.xml
Because these files are not read from the Shared Configuration Folder and exist on the local machine, if you rename or relocate the hosts without modifying these local copies, the Bridge daemon and ECN4 will not start.
Before you proceed:
You must have already,
Installed the SPARCS N4 application servers, including the Center node, the Standby Center node, and the Cluster nodes.
Installed the XPS server and the Bridge daemon.
Installed an XPS client workstation.
Installed the JDK (on page 46).
Verified that the host name does not contain an underscore.
Configured the yard. For instructions, see Set up and maintain the yard in the SPARCS N4 Administrator's Manual.
Collected 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.
To install the ECN4 application:
1 Place a copy of the ECN4 server installer (ecn4-install.exe) on the ECN4 application host.
2 Get the installer.properties file from the folder on the Center node host from which you ran 112 SPARCS N4: Installation Guide 2.4
the install wizard for the Center node. Paste it into the same folder where you put the ecn4-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 ECN4 install wizard.
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 installing the N4 Center node. 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 ECN4 host.
4 Launch ecn4-install.exe, accept the license, and in the Choose Install Set screen, choose the same option (First Install or Upgrade) that you chose for the N4 Center node.
Select the Upgrade option only if you are upgrading from a previous version of 2.4. If you are installing version 2.4 for the first time, select the First Install option.
Click Next to proceed to the next screen.
5 On the Choose Install Folders screen, choose directories for the following installation components. If you are using the installer.properties file (see step 2), the fields pre-fill with the correct information:
Application Folder - Path to the application files. Default is C:\Program Files\Navis
Configuration Folder - Path to the ECN4 logs and properties files. Default is C:\ProgramData\Navis
To make sure that the ProgramData folder displays once the install wizard creates it, go to the Control Panel Appearance Folder Options View dialog and choose Display Hidden Files.
Click Next to proceed to the next screen.
6 In the XPS Host screen, enter the IP address or machine name of the XPS application. Click Next to proceed to the next screen.
Using this value, the install wizard writes a file (ecn4_settings_prod.xml) to TWO locations:
The XPS/Bridge daemon host (C:\ProgramData\Navis\bridge\conf) and the ECN4 host (C:\ProgramData\Navis\ecn4\conf). You can see these paths in the Bridge daemon's properties Startup tab (bridgedw.exe) and in ECN4's properties Java tab (ecn4w.exe). So if you change the name of the XPS or the ECN4 host, or any of the settings it contains, you also need to change the values specified in both instances of ecn4_settings_prod.xml.
7 The Yard Topology screen has fields for the Operator, Complex, Facility, and Yard. These fields are case sensitive. You must enter them exactly as you set them up in SPARCS N4 or you will create a separate cache. See Set up a basic SPARCS N4 topology (on page 134) for more information. If you are using the installer.properties file (see step 2), the fields pre-fill with the correct information.
Click Next to proceed to the next screen.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
SPARCS N4: Installation Guide 2.4 113
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. The install wizard also writes the
configuration to a file called installer.properties to the same folder from where you ran the ecn4-install.exe. This file is similar, but with fewer details.
When everything is correct, click Install to apply the configuration and install the ECN4 application.
8 The Installing 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\ecn4\uninstall\logs\ECN4_Install_mm_dd_yyyy_hh_mm_ss.txt for details. If you have errors during installation, it describes those errors.
9 (Optional) If you would like ECN4 to log directly to the system's log facility life cycle events, you must make the following changes to the log4j.xml file in the ProgramData/Navis/ecn4/conf folder:
a. Change the appender class value from "org.apache.log4j.ConsoleAppender" to
"org.apache.log4j.nt.NTEventLogAppender".
b. Change the level value of the category element from OFF to ON.
10 Set the ECN4 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 ECN4 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 ECN4 Daemon 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.
11 Test whether the ECN4 installation is working:
a. Start the service for an N4 Cluster node, and then start a ULC against that node to view the service status in the Cluster Services view: Administration System Cluster Services Cluster Services view
b. Wait until the Cluster node is fully active.
You must refresh the Cluster Services view to see the current status of the services.
c. Start the SPARCS N4 Center node, the Bridge daemon, and XPS, in that order, waiting between each service to see in the ULC that each service becomes 'ACTIVE' in the Cluster Services view.
d. From the Server Manager on the ECN4 host, start the Navis ECN4 Daemon service.
e. Refresh in the Cluster Services view of the ULC to observe the ECN4 Daemon status. When it is active, move on to the next step.
114 SPARCS N4: Installation Guide 2.4
12 On the ECN4 server, install ECN4Web. See Install ECN4Web (on page 118) for instructions.
13 Set up your system for operations. See the ECN4 Setup chapter in the ECN4 Installation and Diagnostics Guide for instructions.
If you ever need to modify configuration elements for the ECN4 application, go to the
ecn4/bin/folder, and right-click ecn4w.exe. Then, from the menu that appears on right-click, choose Run as administrator. The User Account Control dialog opens, asking you to confirm the configuration. This launches the ECN4 configuration application. Click Yes.
The following table describes the file structure in the ECN4 installation folder.
File Structure in the ECN4 Installation Folder (ecn4_prod.zip)
Shaded rows represent default configuration files that come with every build. Copy and segregate them if you change a default configuration.
Directory File included File Description
//Program Files/Navis/ecn4 --no files at this level-- --
//Program Files/Navis/ecn4/bin ecn4.exe ECN4 application
ecn4w.exe Configuration Tool for ECN4
ecn4.bat Manual application launcher for Windows
installations
stopEcn4.bat Manual application stopper for Windows installations
ecn4.sh Manual application launcher for Linux
installations //Program
Files/Navis/ecn4/conf/ecn4store
various, plus queuestore and sparcs-amq-broker directories
Application files for developer use only.
//Program
Files/Navis/ecn4/conf_template
queries.list Default version of Internal configuration file*
ecn4-db.properties Default attributes of the in-memory database*
log4j.xml Default log configuration file*
ecn4_settings_prod.xml Default settings file for ECN4. Only necessary to review if rollback needed.
See //ProgramData//Navis/ecn4/conf //Program
Files/Navis/ecn4/conf_template/hsq l
ecn4.script Default script for creating in-memory db user*
//Program
Files/Navis/ecn4/conf_template/hyp eric
ecn4-plugin For monitoring the MuleESB and the Activemqbroker with Hyperic (a JMX tool).
SPARCS N4: Installation Guide 2.4 115
Directory File included File Description
//Program Files/Navis/ecn4/extras joblistFilters_en_US.properties Reference file containing the US English version of the XMLRDT messages ECN4 sends to ECN4Web related to JobList Filters.
joblistSorters_en_US.properties Reference file containing the US English version of the XMLRDT messages ECN4 sends to ECN4Web related to JobList Sorters.
xmlrdtMessages_en_US.properties Reference file containing the English version of the XMLRDT messages ECN4 sends to ECN4Web.
//Program Files/Navis/ecn4/lib multiple library files Application library*
//Program
Files/Navis/ecn4/uninstall
.com.zerog.registry Application file for developer use only.
InstallScript.iap_xml Application file for developer use only.
installvariables.properties Application file for developer use only.
Uninstall ECN4 Uninstall Wizard for ECN4
Do not uninstall ECN4 from this directory. Instead, use the Windows Control Panel Programs and Features tool. This enables beneficial Windows services registry features during uninstall.
Uninstall ECN4.lax Wizard application file for developer use only.
uninstaller Wizard application file for developer use only.
//Program
Files/Navis/ecn4/uninstall/Logs
ECN4_Install_mm_dd_yyyy_hh_mm _ss
Log of installation with install wizard.
//Program
Files/Navis/ecn4/uninstall/resource
iawin32.dll Wizard application file for developer use only.
iawin64_x64.dll Wizard application file for developer use only.
remove Wizard application file for developer use
only.
ZGWin32LaunchHelper Wizard application file for developer use only.
//ProgramData/Navis/ecn4/conf ecn4-db.properties Active attributes of the in-memory database*
log4j.xml Active log configuration file.
116 SPARCS N4: Installation Guide 2.4
Directory File included File Description
queries.list Active version of the internal configuration file*
ecn4_settings_prod.xml Active version of the ECN4 settings file.
The ECN4 install wizard creates two instances of this file that must be kept in sync. The other instance is located on the XPS/Bridged daemon host at
C:\ProgramData\Navis\bridged\co nf\
//ProgramData/Navis/ecn4/conf/hsq l
ecn4.script Active script for creating in-memory db user*
//ProgramData/Navis/ecn4/conf/hyp eric
ecn4-plugin For monitoring the MuleESB and the Activemqbroker with Hyperic (a JMX tool).
//ProgramData/Navis/ecn4/logs commons-daemon.yyyy-mm-dd.txt
ecn4-stderr.yyyy-mm-dd.txt Standard error stream for ECN4.
ecn4-stdout.yyyy-mm-dd.txt Standard output stream for ECN4.
navis-ecn4.txt Primary ECN4 log file template.
navis-ecn4.log.[1] Primary ECN4 log file. After reaching the size limit of 10,241 KB, ECN4 appends an integer and starts a new file.
navis-ecn4_axis.txt Internal file
navis-ecn4_che_[Handler ID].txt Log for VMT operations of each individual CHE.
navis-ecn4_data_issues.txt Internal file for developers only.
navis-ecn4_errors.txt Condensed version of the primary ECN4 log file, showing only errors.
*Indicates file(s) that do not need customer modification or configuration; however, they must exist in the directory structure.
SPARCS N4: Installation Guide 2.4 117
Install ECN4Web
ECN4Web is the interface through which you access ECN4. You do not need an additional host for the ECN4Web application unless you have >100 RDTs/VMTs in a yard. With <100 RDTs/VMTs, you can install the web server on the same host as ECN4. With >500 RDTs/VMTs in a single yard, you install an additional ECN4Web host.
Before you proceed:
You must have already,
Installed ECN4 (on page 111).
Collected 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.
To install ECN4Web:
1 Place a copy of the ECN4Web server installer (ecn4web-install.exe) on the ECN4Web application host.
2 Get the installer.properties file from the folder on the ECN4 host from which you ran the install wizard for ECN4. Paste it into the same folder where you put the ecn4web-install.exe.
This file is an artifact of the ECN4 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 ECN4Web install wizard.
If ECN4 and ECN4Web are on the same host (a common configuration), it is ok to put the ECN4Web install wizard in the same folder as the ECN4 install wizard, and just re-use the installer.properties file that is already there from the ECN4 installation.
3 Launch ecn4web-install.exe, accept the license, and in the Choose Install Set screen, choose the same option (First Install or Upgrade) that you chose for ECN4.
Select the Upgrade option only if you are upgrading from a previosu version of 2.4. If you are installing version 2.4 for the first time, select the First Install option.
Click Next to proceed to the next screen.
4 On the Choose Install Folders screen, choose directories for the following installation components. If you are using the installer.properties file (see step 2), the fields pre-fill with the correct information:
Application Folder - Path to the application files. Default is C:\Program Files\Navis
Configuration Folder - Path to the ECN4 property files and logs. Default is C:\ProgramData\Navis
Click Next to proceed to the next screen.
5 Enter the IP or name of the ECN4 host on ECN4 Server Address screen.
The default port for XMLRDT in ECN4 is 13101. It is controlled in the
ecn4_settings_prod.xml (located in the C:\ProgramData\Navis\ecn4\conf folder on the ECN4 host) by the ECN4 setting com.navis.ecn4.xmlrdt.PORT.
Click Next to proceed to the next screen.
6 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
118 SPARCS N4: Installation Guide 2.4
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. The install wizard also writes the
configuration to a file called installer.properties to the same folder from where you ran the ecn4web-install.exe. This file is similar, but with fewer details.
When everything is correct, click Next to apply the configuration and install the ECN4Web application.
7 The Installing 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\ECN4Web_Install_mm_dd_yyyy_hh_mm_ss.txt for details. If you have errors during installation, it describes those errors.
8 Set the ECN4Web 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
The default user for the SPARCS N4 Windows service is a local user who may not have sufficient