SPARCS N4
Installation Guide
2.4
CONFIDENTIAL INFORMATION OF Navis LLC UNAUTHORIZED USE IS STRICTLY PROHIBITED. Navis SPARCS N4 is a trademark of Navis LLC. © Navis LLC 1988 - 2013. All rights reserved.
This document has been made available as part of the license that has been granted to an authorized user of Navis LLC software. Use of this documentation is subject to the terms and limitations of that license agreement. This documentation describes all functionality that can be licensed for this product. Not all functionality described in this documentation may be available to you depending on your license agreement. If you are not aware of the relevant terms of your license agreement, contact sales at Navis LLC. This document is protected by copyright and by the licensee’s agreement to maintain the
confidentiality of the content of this document as provided in the license agreement for the software. Liability Disclaimer
Navis LLC takes steps to ensure that its published documentation is correct; however, errors do occur. Navis LLC reserves the right to correct any such errors and disclaims liability resulting therefrom. Limitation of Liability
In no event shall Navis LLC or any of their licensors be liable to You for any of the following (collectively referred to as "Injuries"): injuries (including death) or damages to persons or to property, or damages of any other kind, direct, indirect, special, exemplary, incidental or consequential, including, but not limited to, loss of use, lost profits, lost revenues, loss of data, replacement costs, debt service or rental payments, or damages owing by You to others, whether arising out of contract, tort, strict liability or otherwise, arising from or relating to the design, use or operation of these online materials, the Software,
Documentation, Hardware, or from any Services provided by Navis LLC (whether or not Navis LLC or its licensors knew or should have known of the possibility of any such Injuries) even if a remedy set forth herein is found to have failed of its essential purpose.
Navis LLC
55 Harrison Street, Suite 600 Oakland CA 94607 USA www.navis.com
Tel: +1 510 267 5000 Fax: +1 510 267 5100
Contents
Overview: Installing SPARCS N4 2.4
7
Worksheet of values necessary for installation ... 10
1
Pre-installation upgrade tasks
13
Export database-backed variforms before backing up ... 14Migrate RoadCustomInitializer code to a SERVER_LIFECYCLE code extension type 15 Prepare conversion of LANE type logical blocks ... 15
Back up the database and import into a staging database ... 16
Preserve your existing configuration ... 19
Back up the N4 Billing database and server ... 21
Uninstall all Navis services ... 21
For patch upgrades only: Rolling Upgrade Test (RUT) ... 22
2
Install and configure a SPARCS N4 database
25
Oracle Configuration Checklist ... 26SQL Server Installation and Configuration Checklist ... 30
MySQL Configuration Checklist ... 34
Tips for installing MySQL for SPARCS N4 on Red Hat Linux ... 40
Create the database and an administrative user in MySQL... 40
Deploy the Database Performance Pack ... 41
Sample scripts for the separate system database user ... 42
3
Core component install steps
45
Install Java Development Kit (JDK) ... 46Install the SPARCS N4 Center node ... 47
Install the SPARCS N4 Standby Center node ... 57
Install the SPARCS N4 Cluster nodes ... 60
Verify the SPARCS N4 node installation with a first startup ... 62
Install the the XPS server and the Bridge daemon ... 64
Install an XPS client ... 70
Use the Notices window to identify any configuration issues ... 71
4
Post-installation upgrade tasks
73
Upgrade database-backed variforms ... 74Re-create database-backed variform customizations to platform-neutral forms 74 Convert .dtd variform overrides to .xml variform overrides ... 76
Remap some flex fields to standard fields ... 77
Configure the SPARCS settings.txt file ... 78
Tips for upgrading with the Yard Editor ... 78
Tips for setting up your existing yard ... 79
Tips for working with yard image maps ... 81
Handle duplicate bin names when upgrading ... 83
Sanity testing of the yard ... 84
Import an image map of your yard ... 84
Review automatic yard block conversions ... 86
View logical block conversion ... 87
Review straddle exchange lane block conversion ... 88
Resolve issues with LANE type logical block conversion... 90
Table of block type codes ... 91
Review Gate Lanes with converted straddle grid blocks ... 92
Revise the yard model ... 93
Exchange Areas, Transfer Zones, and Transfer Points ... 95
Prepare for proper conveyance of vessel berthing information to XPS... 97
Convert data from legacy SPARCS or test system for XPS ... 98
Start a solo XPS client using a backup data source ... 100
Retest Groovy Code Extensions ... 102
Configure unicast communication ... 105
Frequently asked questions for unicast mode ... 107
Import a gate configuration ... 108
Upload a License File in a cluster ... 109
5
Licensed option install steps and install wizards
111
Install ECN4 ... 111Install ECN4Web ... 118
Install a radio server for XPS ... 120
Set up an XPS client as the statistics server ... 121
Install N4 Billing ... 122
Uninstall N4 Billing from Windows ... 125
Start the N4 Billing client ... 126
Set up a N4 Billing topology... 127
Install N4 Mobile ... 131
Connect to CAP (Community Access Portal)... 132
6
Additional installation tasks for new customers
133
Load initial reference data ... 133Set up a basic SPARCS N4 topology ... 134
Scope levels ... 138
Apply your license to SPARCS N4 ... 140
Create a Yard Model and configure a placeholder yard ... 141
Create a placeholder Yard Model ... 142
Create a placeholder image map ... 145
Configure the placeholder yard ... 146
Apply Placeholder Yard Model to Active Yard ... 152
7
Sequence the start-up for the SPARCS N4 components
155
Start a SPARCS N4 application node ... 156Reduce the time it takes to load the cache ... 157
Start the SPARCS N4 client ... 157
Select a scope level ... 158 iv SPARCS N4: Installation Guide 2.4
Start the N4 Billing application server ... 159
Launch the Bento Server background job ... 159
Turn on the Purge/Archive Job ... 161
Start the Bridge daemon ... 161
Start XPS ... 162
Start ECN4... 163
Start the ECN4Web server ... 163
Start the XPS clients ... 164
8
Install a load balancer
167
Install an Apache load balancer ... 1689
Install Hyperic
175
Requirements for installing Hyperic ... 175Select and download a Hyperic installer ... 177
Steps to install the Hyperic server ... 177
JRE location for Hyperic ... 179
Steps to install the Navis Hyperic plug-in ... 179
Steps to install Hyperic agents ... 180
Verify the Hyperic installation ... 181
Get started monitoring SPARCS N4 with Hyperic ... 181
10
Troubleshooting installation errors
185
Review the navis-bridged.txt file ... 185Hyperic Known Issues ... 190
The n4-settings.xml file is empty ... 190
Appendix
191
Sample SPARCS N4 Installation Worksheet ... 191Post-configure for multiple facilities ... 194
Software and config file prerequisites for SPARCS N4 installation ... 195
JDBC drivers for SPARCS N4... 197
Scaling the number of SPARCS N4 application hosts by TEU ... 198
Manually configure the database connection ... 199
Sample apex.xml file from SQL Server ... 200
Sample apex.xml file from Oracle 11g ... 201
Sample apex.xml file from Oracle 11g RAC ... 203
Sample apex.xml file from MySQL ... 205
Add context information to Oracle database reports ... 206
Database troubleshooting with unreliable networks ... 208
Shut down or restart the SPARCS N4 system ... 209
Stop the Navis services ... 211
Cluster Services view information ... 211
Integrity Checker form ... 217
Model Directory Structure: SPARCS N4 hosts ... 219
Log Files on the SPARCS N4 nodes... 219
Verify the memory pool and garbage collection settings ... 220
Set up a solo workstation ... 220
Find instructions for setting privileges for the server-room XPS clients ... 221
Compile the yard source file ... 221
Create a test data folder ... 223
Activate the COMPYD privilege ... 223
Save the compiled yard file ... 225
Decompile a yard file ... 225
Version Rollbacks ... 226
How to gather information if there is a performance problem ... 227
Subscribe to a document in the Customer Support site ... 228
Subscribe to a 'Workspace' in the Customer Support site ... 229
Overview: Installing SPARCS N4 2.4
These instructions step you through the process of installing Navis SPARCS N4 version 2.4 in a staging environment with Microsoft Windows Server 2008 R2 with a Server class processor and a 2 x Quad-core Intel x86_64, AMD64 CPU.Though your environment may differ, these instructions describe how to use the Navis install wizards to install the SPARCS N4 application, along with XPS, Equipment Control, and N4 Billing. SPARCS N4 installs using unicast communication. Your network must be configured for unicast routing.
Preparation:
Determine your database environment. See Install and Configure a SPARCS N4 database (on page 25) for more information.
Verify that you have the prerequisite hardware or virtual environment. This includes identifying all necessary computers. See the SPARCS N4 2.4 Technical Requirements document.If you want to set up SPARCS N4 for low-volume demonstrations, such as for walking through specific workflows in the application, you can install only the SPARCS N4 Center node, XPS, and ECN4 on a single host. Follow the installation and start-up instructions in this manual, but leave out the additional SPARCS N4 nodes and hosts. Connect to the Center node with the ULC.
Verify that you have the required network features. See the Network Requirements in the Appendix.
Obtain the files required for installing your SPARCS N4 components. See Software and config file prerequisites for SPARCS N4 installation (on page 195) in the Appendix.
Set up your staging environment. Your staging environment must mirror your intended 2.4 production environment. You can follow a format similar to the Sample SPARCS N4 Installation Worksheet (on page 191) in the Appendix to record the necessary details.'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.
Once you have all prerequisite hardware, software, network environment, and files, complete the following preliminary steps:
Install a database: For upgrades from earlier SPARCS N4 versions: Back up your production database and run the
backup in a staging environment. See Upgrade tasks (on page 13) for more information.
For first-time Navis customers: Install and configure an empty instance/schema of the SPARCS N4 database (on page 25). The database you install is based on the specific size and operating needs at your terminal. SPARCS N4 2.4 supports SQL Server, Oracle 11g, Oracle 11g RAC, and for approved smaller terminals, MySQL. You install the database on a dedicated server.
Install Java on the staging servers. You install Java SDK (version 1.7, also known as Java 7) on the hosts for the SPARCS N4 application servers and the host for the XPS/Bridge daemon. If you have licensed ECN4 or N4 Billing, you also install it on those hosts. See Install Java (on page 46) for instructions.
For customers upgrading from earlier versions of SPARCS N4, preserve your existing configuration. See Pre-installation upgrade tasks (on page 13) for instructions.After re-creating or creating the database, installing Java, and (for upgrades) preserving your existing configuration and uninstalling versions below 2.4, follow the instructions for the install wizards. Then, test the installation connections for the core components. Once you know they are working, install a load balancer and (for upgrades) perform the post-installation upgrade tasks (on page 73).
In This Section
Worksheet of values necessary for installation ... 10
Worksheet of values necessary for installation
During the installation, you will be asked for the following information, so you should have it ready:
The hostnames and IP addresses of each of the hosts in the SPARCS N4 system. A useful format has the following columns and describes every system component. See the Sample SPARCS N4Installation Worksheet (on page 191) for an example of what this might look like for a medium-large sized system. The values that are already filled below are true for every installation. You can add rows as needed for your own environment.
Function Host Name1
IP Address Node Name(s) in Cluster Services2 RAM3 CPU4 Main or Standby? Intended Users SPARCS N4 Center Node MAIN NONE SPARCS N4 Standby Center Node 5 STANDBY NONE Pair of SPARCS N4 Cluster Nodes Pair of SPARCS N4 Cluster Nodes Shared Configuration Folder Path
N/A N/A N/A N/A
XPS and Bridge ECN4 and ECN4Web VPN Server Host
N/A N/A N/A N/A
Hyperic Host N/A N/A
Billing Host N/A `
1 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.
2 The node names for the SPARCS N4 Cluster Services view must not contain spaces. 3, 4 Check to see that these values conform to the SPARCS N4 Technical Requirements.
5 Appears only in Administration Debug Node Info Desk unless it takes over as the main Center
node.
Path to a shared network folder for the shared configuration files: _______________________________ (Do not use lettered drives in the path.)
The SPARCS N4 database type: SQL Server, Oracle, or MySQL
Database User ID: ___________________________________
Database Password: _________________________________
Database Host address: ______________________________
The SPARCS N4 database System User ID: _________________________
Database System User Password: ____________________________
The SPARCS N4 database Schema Name (SID):__________________________________
The SPARCS N4 database port. (The default values for each type are as below, but you should check with your system administrator to make sure those are the ones used at your terminal.) SQL Server - 1433
Oracle or Oracle RAC - 1521 MySQL - 3306
(Conditional) If you are using Oracle RAC, the Oracle RAC database host(s): _____________________
(Conditional) If you are using Oracle RAC, the ONS port(s): _____________________________
(Conditional) If you are using MySQL, the supported MySQL driver: _________________________ See the MySQL Configuration Checklist (on page 36) for more information.
The 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. 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.
The Multicast Time-To-Live (TTL) value: _______This is 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.
The individual node names for all SPARCS N4 components, as you want them to appear in the Cluster Services view. (Fill these values into a table, such as the template above.)See the Sample SPARCS N4 Installation Worksheet (on page 191) for a useful recording format.
The topology for the main XPS host, including any additional Facility codes. Existing customers can 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.)
Yard code: ____________________________ (The code used for the yard. It should be the same as the facility code.)
1 Pre-installation upgrade tasks
If you are upgrading to SPARCS N4 version 2.4 from version 2.3.x or below, you must back up your database and the SPARCS N4 application components as preparation for setting up a staging environment. Some of the tasks must be performed before the upgrade, and some are performed immediately after upgrading. Refer to the workflow diagrams to find out when to perform each step.
Before you upgrade, take a screen capture of your yard's Plan View in XPS. You can refer to it later when you are placing your yard blocks in the new Yard Editor in the SPARCS N4 client.
If you have developed code extensions or Groovy plug-ins using the Advanced Configuration, Customization, and Integration Module, Navis strongly recommends that you fully test these modifications in the upgrade version before running it in production. Navis only tests SPARCS N4 functionality defined by the product license(s); the customer is responsible for testing their
customized external code. For all of your external functionality, the best practice is to produce adequate documentation for testing, such as use cases and test cases. See Third-party Software Requirements in the Appendix for more information.
Pre-installation upgrade tasks:
1
Export database-backed variforms before backing up (on page 14).This task is only necessary for customers who have created database-backed variforms (variform overrides). With each release, Navis is converting some forms and tables to be platform neutral, and this step preserves a record of the customizations, so you can re-create them after the upgrade.
2
(Conditional) Migrate RoadCustomInitializer code to a SERVER_LIFECYCLE code extension (on page 15).Only necessary if you have Groovy code that uses the RoadCustomInitializer plug-in. This plug-in is deprecated in the SPARCS N4 2.4 release.
3
Prepare conversion of LANE type logical blocks (on page 15).Only necessary for upgrading customers who have LANE logical blocks configured in their yard files.
4
Back up the database and import into a staging database (on page 16). Follow the instructions for your specific database:SQL Server - Back up a SQL Server database and import the information to a staging database (on page 16)
Oracle - Back up an Oracle database and import the information to a staging database (on page 17) MySQL - Back up a MySQL database and import the information to a staging database (on page 18)
5
Preserve your existing configuration (on page 19).This is part of efficiently migrating SPARCS N4 components from one version to another.
6
Back up the N4 Billing database and server (on page 21).7
Unistall all Navis services (on page 21).8
For patch upgrades only: Rolling Upgrade Test (RUT) (on page 22).This is a test you can run to determine whether or not it is advisable to implement a rolling upgrade for mini-releases ('patch mini-releases', for example '2.4.5') to the SPARCS N4 application servers. Note that this information does not apply to first-time installations of version 2.4. (A rolling upgrade in this context is defined as upgrading each single SPARCS N4 application server while the other SPARCS N4 hosts are running, thus incurring no down time.)
Export database-backed variforms before backing up
With each release, Navis is converting selected forms and tables in SPARCS N4 to be platform neutral. This requires a change to the XML for that form. Therefore, when Navis makes a form or table platform-neutral, any existing database-backed variform override to that form or table must also be converted to the new platform-neutral state. To maintain any previous variform customizations during an upgrade to a SPARCS N4 version that contains platform-neutral forms, it is essential to export your existing variform overrides to a temporary location. This may already be part of your administrative best practices. Further, after exporting to a temporary location, for any form or table that Navis has converted to be platform neutral, you must delete your previous variform override from SPARCS N4. The Post-installation upgrade tasks section of this manual contains instructions for re-creating the variform overrides in
converted platform-neutral forms (on page 74).
To identify platform-neutral forms in a release, export database-backed variforms, and delete previous variform overrides:
1 Before upgrading to a new version, check for any platform-neutral forms that may be listed under the New Configuration section of all release notes for each release between your current production version and the version you are upgrading to. The New Configuration section is sorted alphabetically by type. Search for the type 'Platform-Neutral Form'. Make a list of these forms with the original and current variform IDs, which are available in the release note for these issues.
2 To see which database-backed variform overrides you have made, in SPARCS N4, open the Database Backed Variforms view (Administration Settings Database Backed Variforms Database Backed Variforms view). Display the Variform ID column by right-clicking a column for a list of available columns.
3 Compare the list of converted platform-neutral forms from the release notes to your overrides in the Database Backed Variforms view. For each converted platform-neutral form for which you have an override, do the following:
a. Export each override individually from the Edit Variform File Definition form (Administration Settings Database Backed Variforms Database Backed Variforms view Variform File Definition form) using Export File. Back up the exported files to a temp folder.
b. In the Database Backed Variforms view, right-click each override you have exported and select Delete. This deletes your overriden variform(s) from the database.
c. Again in the Database Backed Variforms view, select Actions Reload All Variforms. A dialog box opens, asking if you want to update only the local node, or all nodes. Choose Propagate change to all nodes.
The variform overrides that you have created are now protected from being overwritten during the upgrade. For instructions for how to re-create each deleted database-backed variform after the
upgrade, see Re-create database-backed variform customizations to platform-neutral forms (on page 74), in the Post installation upgrade tasks.
Migrate RoadCustomInitializer code to a
SERVER_LIFECYCLE code extension type
If you have Groovy code that uses the RoadCustomInitialzer Groovy Plug-in, then you must migrate this code to a SERVER_LIFECYCLE code extension type and delete the RoadCustomInitialzer plug-in. The RoadCustomInitializer plug-in was deprecated in SPARCS N4 version 2.4. Navis
recommends that you migrate your code over as early as possible, before you upgrade to any release 2.4. Once you have migrated your code, you must restart SPARCS N4 for these changes to take effect.
However, if you are upgrading from 2.1 to 2.4, since the SERVER_LIFECYCLE code extension type is not supported in 2.1, you cannot migrate your code until after you upgrade. After upgrading to 2.4, Groovy code associated with the RoadCustomInitializer plug-in is still available but does not execute. You must migrate this code over as soon as possible.
Prepare conversion of LANE type logical blocks
This task is only necessary for upgrading customers from 2.1 or below who have LANE logical blocks configured in their yard files.
LANE logical blocks modeled as straddle exchange lanes in the SPARCS Settings.txt file in XPS have been deprecated in SPARCS N4 2.2 in favor of using Straddle Grid block types (equivalent to block type code 'G' in XPS). Straddle Grid blocks are configured as general type stack blocks using the SPARCS N4 Yard Editor tool. (In SPARCS N4, there are two general block types: stack and non-stack. All block types fall into one of these two general categories.)
When upgrading to version 2.4 from an older version, SPARCS N4 automatically converts logical blocks of type LANE previously specified in a SPARCS Settings.txt file to G type stack blocks. However, this automatic conversion becomes a problem if you have more than one LANE type logical block that start with the same character defined.
This is why: SPARCS N4 applies the naming format B1C2 to all stack bins of the GRID block. For example, if there are two logical blocks called PARK1 and PARK2, SPARCS N4 would name the stack bins of both blocks P01, P02, and so on. This leads to duplicate stack bin names, which SPARCS N4 does not allow. See
also Handle duplicate bin names when upgrading (on page 83).
Another issue that might occur is related to the graphic representation of exchange lane blocks in the yard plan view in XPS. Because the SPARCS N4 conversion process assumes a very small fixed length for the GRID block polygon, it can easily go unnoticed in the XPS yard plan view. Because by default SPARCS N4 displays GRID block polygons in the bottom left corner of the yard, they often overlap with other yard blocks. To move them, you can use the SPARCS N4 Yard Editor or adjust the #BPOINTS in the yard file. You can prevent these issues by making changes prior to upgrading, or you can fix them after the upgrade (on page 90).
To prepare the conversion of LANE type logical blocks prior to upgrading: 1 To resolve the naming issue, do one of the following:
Change the names of the respective LANE type logical blocks in the SPARCS settings.txt file. Manually create GRID type blocks with new names and remove the LANE type logical block from
the SPARCS settings.txt file. 2 To resolve the display issue:
a. Manually define the GRID block in the yard with valid BPOINTS. Make sure the block is big enough to see in the yard plan view.
b. Remove the logical blocks from the SPARCS settings.txt file.
Back up the database and import into a staging database
The instructions for how to back up your database vary, depending on whether you are running a SQL Server, Oracle, or MySQL database.
SQL Server
Backups can be full or partial ('diffs'). These instructions describe how to create a full backup of the Navis-recommended versions of SQL Server 2005 and SQL Server 2008.
In production environments, always consult with the database administrator (DBA) for your operation to develop the best back-up strategy for your environment.
If you have created database-backed variforms for SPARCS N4, it is best practice to separately export the individual form files from the Edit Variform File Definition form (Administration Settings Database Backed Variforms Database Backed Variforms view Variform File Definition form) and save to a common location. With each release, Navis is converting some forms to be platform-neutral, and for those forms, you must re-apply any customizations. See Export database-backed variforms before backing up (on page 14) and Re-create database-backed variform customizations to platform-neutral forms (on page 74).
To back up a SQL Server database and import the information to a staging database: 1 On the host for the production database, run the backup command to create a backup file:
use [master]
BACKUP DATABASE [sparcs-n4-CLIENT-test]
TO DISK = 'D:\MSSQL\sparcs-n4-CLIENT-test.bak'
WITH init,
STATS = 5
If the database is large, specify output to multiple files: BACKUP DATABASE [sparcs-n4-CLIENT-test]
TO DISK = 'D:\MSSQL\sparcs-n4-CLIENT-test_BAK01.bak',
DISK = 'D:\MSSQL\sparcs-n4-CLIENT-test_BAK02.bak',
DISK = 'D:\MSSQL\sparcs-n4-CLIENT-test_BAK03.bak'
WITH init,
STATS = 5
2 While still on the database, zip the file(s) up.
3 Transfer the zip file to another computer, and check to make sure that you can unzip it there. This proves the file transfer was successful.
4 On the host for the staging database,
a. Figure out what the data file and log file names are to prepare the command below. (Right-click the production database, and from the SQL Server Management tool, choose Properties Files)
b. Place the .bak file(s) on the local drive.
c. Run the restore command to import the data: use [database name]
RESTORE FILELISTONLY
FROM DISK = 'C:\PS_temp\[DATABASE_NAME]Backup\apex.bak'
d. Use the output of the above for the next command: use [master]
RESTORE DATABASE [ps-apex-[DATABASE_NAME]]
FROM DISK = 'C:\PS_temp\[DATABASE_NAME]Backup\apex.bak'
WITH REPLACE, MOVE 'apex' TO 'C:\MSSQL\Data\ps-apex-[DATABASE_NAME].mdf',
MOVE 'apex_log' TO 'C:\MSSQL\Logs\ps-apex-[DATABASE_NAME]_log.ldf'
The system confirms the completed import, or reports failure. If there are errors, check the log files.
Oracle
Backups can be full or partial ('diffs'). These instructions describe how to create a full backup of the Navis-recommended versions of Oracle.
In production environments, always consult with the database administrator (DBA) for your operation to develop the best back-up strategy for your environment.
If you have created database-backed variforms for SPARCS N4, it is best practice to separately export the individual form files from the Edit Variform File Definition form (Administration Settings Database Backed Variforms Database Backed Variforms view Variform File Definition form) and save to a common location. With each release, Navis is converting some forms to be platform-neutral, and for those forms, you must re-apply any customizations. See Export database-backed variforms before backing up (on page 14) and Re-create database-backed variform customizations to platform-neutral forms (on page 74).
To back up an Oracle database and import the information to a staging database:
1 On the host for the production database, run the data dump command to create a backup file: expdp system/password@ORACLE_SID directory=DATA_DUMP_DIR
dumpfile=client_apex.dmp schemas=client_apex logfile=client_apex.log
2 While still on the database, zip the files up.
3 Transfer the zip file to another computer, and check to make sure that you can unzip it there. This proves the file transfer was successful.
4 On the host for the staging database:
a. Figure out what the data file and log file names are to prepare the command below.
b. Place the Oracle dump file(s) onto the load directory.
c. Run the import command (impdp) to import the data:
impdp system/password@NONU directory=DATA_LOAD_DIR schemas=spe2epbt dumpfile=spe2epbt.dmp REMAP_SCHEMA=spe2epbt:dpwpbt_apex1
REMAP_TABLESPACE=PBT_DATA:DPWPBT_APEX1_DATA logfile=spe2epbt_impdp.log
The system confirms the completed import, or reports failure. If there are errors, check the log file, spe2epbt_impdp.log.
MySQL
Backups can be full or partial ('diffs'). These instructions describe how to create a full backup of the Navis-recommended versions of MySQL.
Important: Always consult with the MySQL supplier or database administrator (DBA) for your operation to be advised of the latest backup and restore options to use for your environment.
If you have created database-backed variforms for SPARCS N4, it is best practice to separately export the individual form files from the Edit Variform File Definition form (Administration Settings Database Backed Variforms Database Backed Variforms view Variform File Definition form) and save to a common location. With each release, Navis is converting some forms to be platform-neutral, and for those forms, you must re-apply any customizations. See Export database-backed variforms before backing up (on page 14) and Re-create database-backed variform customizations to platform-neutral forms (on page 74).
To back up a MySQL database and import the information to a staging database: 1 On the host for the production database, run the backup command to create a backup file:
mysqldump -u USER -pPASSWORD DATABASE > filename.sql
2 While still on the database, zip the file up.
3 Transfer the zip file to another computer, and check to make sure that you can unzip it there. This proves the file transfer was successful.
4 On the host for the staging database,
a. Use the MySQL command line option to place the .sql files on the local drive.
b. Run the delete database command to prepare the database for loading: delete a database
mysql> drop database [DATABASE_NAME]
c. Run the create command to create an empty database: create a database
mysql> create database [DATABASE_NAME]
mysql> GRANT ALL PRIVILEGES ON *.* to mnr@localhost IDENTIFIED BY 'mnrpass';
mysql> GRANT ALL PRIVILEGES ON *.* to mnr@"%"IDENTIFIED BY 'mnrpass';
5 Run the import command to load the data:
mysql -u USER -pPASSWORD DBNAME < dump.sql
Any errors will be reported back to the MySQL command prompt. Otherwise, the successful completion is indicated by the command completing with no messages.
Preserve your existing configuration
Preserving your existing configuration is part of efficiently migrating SPARCS N4 components from one version to another.
You cannot re-use configuration files, such as n4-settings.xml, n4-settings-prod.xml, or ecn4-settings.xml from previous installations. It is important to save these files from previous installations as backup and as a configuration record only. The 2.4 install wizards create the configuration files with every installation.
To preserve your existing SPARCS N4 configuration:
1 On an XPS client logged in with Administrative privileges, select File Back-up Files. This action saves data to the Private data folder for the client. You can use this later to import XPS-owned reference data (such as allocation ranges, CHE names, and User names) into your upgraded system. For more information, see Convert data from legacy SPARCS or test system for XPS (on page 98).
Select Help About Navis SPARCS. The path to the Private folder appears in the splash screen.
2 Shut down all ECN4Web and N4 Billing client workstations. 3 Shut down the XPS clients, including any server-room clients.
4 Shut down all Navis services (as licensed) and in this order:
a. N4 Billing
b. ECN4Web
c. ECN4
d. XPS
For instructions, see Stop the Navis services (on page 211).
5 Verify that SPARCS N4 has processed all updates from XPS before you completely shut the system down:
a. Log in to SPARCS N4.
b. In the Cluster Services view (Administration System Cluster Services Cluster Services view) locate the journal queue size:
In versions 2.1 and below, this is in the list of statistics in the Current Status block (upper left portion of the view).
c. In versions 2.2 and above, this information is located in the Info column for the the rows for the N4CacheMaster row.
6 Shut down the Bridge daemon service.
7 Stop (or restart) all SPARCS N4 application servers. 8 Preserve your existing configuration:
a. Create back-up folders in safe places on each host.
b. On each of the SPARCS N4 hosts, back up the configuration files by copying the apex.xml file from ProgramData\Navis\NodeN\conf\Catalina\localhost
($NAVIS_HOME\tomcat\instances in versions 2.1 and below), and pasting it into the back-up folder you created above.
c. On the XPS host, back up the configuration by copying the following file and folders and pasting them into the back-up folder you created above.
C:\ProgramData\Navis\xps\settings.xml ($NAVIS_HOME\xps\settings.xml in versions 2.1 and below)
C:\ProgramData\Navis\xps\data ($NAVIS_HOME\xps\data in versions 2.1 and below) C:\ProgramData\Navis\xps\database ($NAVIS_HOME\xps\database in versions 2.1
and below)
d. (Conditional, if you are using ECN4) On the ECN4 host, back up the configuration by copying the following folder and pasting it into the back-up folder you created above.
C:\ProgramData\Navis\ecn4\conf ($NAVIS_HOME\ecn4\conf in versions 2.1 and below)
e. On each of the SPARCS N4 hosts, open the configuration application for each node. For example, for the first node on the first host, right-click C:\Program
Files\Navis\sparcsn4\bin\n4node1w.exe ($NAVIS_HOME\tomcat\bin\tomcat1w.exe in releases 2.1 and below)
f. From the menu that appears on right-click, choose Run as administrator. The User Account Control dialog opens, asking you to confirm the configuration.
g. Click Yes. The SPARCS N4 configuration dialog opens.
The User Account Control dialog is part of the Microsoft Windows Server 2008 R2 security regime.
h. Open the Java tab. Scroll through the Java Options field to make note of the values of the following properties, which you need to complete the SPARCS N4 install wizard:
tangosol.coherence.multicast tangosol.coherence.ttl
environment.container.identity
i. Repeat for the remaining SPARCS N4 application server nodes on each host.
9 On each respective host, zip up the following directory folders, and place in a safe location. ProgramData\Navis\NodeN\conf\Catalina\localhost ($NAVIS_HOME\tomcat in
versions 2.1 and below)
C:\ProgramData\Navis\bridged ($NAVIS_HOME\bridged in versions 2.1 and below) C:\ProgramData\Navis\xps ($NAVIS_HOME\xps in versions 2.1 and below)
C:\ProgramData\Navis\ecn4 ($NAVIS_HOME\ecn4 in versions 2.1 and below)
C:\ProgramData\Navis\ecn4web ($NAVIS_HOME\ecn4web in versions 2.1 and below) The shared configuration folder.
It is not necessary to preserve storage daemon configuration information when upgrading to SPARCS N4 versions 2.4 and above.
Back up the N4 Billing database and server
Back up the N4 Billing database using the instructions for backing up the SPARCS N4 database, depending on the database type.
To back up the N4 Billing application server, save the NAVIS_HOME directory to a zip file, and place it on the N4 Billing application staging server. The most important file in this group is billing.xml, which contains database and configuration values.
Uninstall all Navis services
These instructions describe how to uninstall Navis services from a Windows 2008 R2 staging
environment. There are two sets of instructions to account for whether you are uninstalling 2.1 (or below) services or 2.2 (and above) services. This is because there are no install wizards in versions 2.1 and below, and you must uninstall manually. You uninstall versions 2.2 and above using the install wizards.
Procedure: Uninstall 2.1 (and below) Navis Windows services
To uninstall Windows services for SPARCS N4 releases 2.1 and below:
1 On the desktop for each of the hosts, unpack the archive, windows-install-scripts.zip, from the earlier version's release package.
2 Right-click the uninstall-services.bat script. From the menu that appears on right-click, choose Run as administrator. The User Account Control dialog opens, asking you to confirm the
configuration.
3 Click Yes. The script runs and removes the service(s) on the host. 4 On each respective host, delete the following directory folders:
This instruction assumes that you have already made backups of these configuration files to support any upgrade. If you do not have copies of these files, copy them and save to a safe location before you delete them
$NAVIS_HOME\tomcat $NAVIS_HOME\bridged $NAVIS_HOME\xps
$NAVIS_HOME\storaged (This folder is on each server that is a member of the Coherence cluster.)
$NAVIS_HOME\ecn4
5 On the XPS client workstations for the staging environment, delete the XPS folders.
Procedure: Uninstall 2.2 (and above) Navis Windows services
To uninstall Windows services for SPARCS N4 versions 2.2 and above:
1 Back up your system by saving the following folders and files from the XPS server in a secure location:
C:\ProgramData\Navis\xps\data C:\ProgramData\Navis\xps\database C:\ProgramData\Navis\xps\settings.xml
2 (Conditional) If you have licensed ECN4 and customized the ECN4Web interface, save the custom context to a secure location. It is located on the ECN4 server, in the webapps folder, at this location: C:\Program Files\Navis\ecn4web\webapps\[name_of_custom_context]
3 On the desktop for each of the hosts, click Start Control Panel Programs and Features. The Programs and Features window opens, displaying a list of all services installed on the host.
a. Find the relevant Navis services, and right-click. Select Uninstall/Change from the menu that appears. The uninstall wizard opens, and steps through the process automatically, displaying progress as it goes.
b. The wizard confirms whether the uninstall was successful. It reports a list of any files it is unable to delete. You may still proceed if there are files that could not be removed.
c. Delete any folders or files under C:\Program Files\Navis and C:\ProgramData\Navis that were not automatically deleted. (See above for folders and files you need to save to a separate location.)
4 On the XPS client workstations, save the ...\Sparcs N4 Client\Private\SPARCS
Banner.nbn and the ...\Sparcs N4 Client\SPARCS\SPARCS BORG Prefs x.x files to an archive location, and delete the rest of the SPARCS N4 Client folders and files.
The SPARCS BORG Prefs x.x file specifies the current printer and other local data.
For patch upgrades only: Rolling Upgrade Test (RUT)
This section describes a test you can run to determine whether or not it is advisable to implement a rolling upgrade for mini-releases ('patch releases', for example '2.4.5') to the SPARCS N4 application servers. Note 22 SPARCS N4: Installation Guide 2.4
that this information does not apply to first-time installations of version 2.4. (A rolling upgrade in this context is defined as upgrading each single SPARCS N4 application server while the other SPARCS N4 hosts are running, thus incurring no down time.)
The rolling upgrade test (RUT) lets you take snapshots of shared classes in the second-level cache and in the objects that are shared between XPS and SPARCS N4, which can change across minor releases. By comparing the snapshot of the SPARCS N4 release running on the production servers to the snapshot of the SPARCS N4 release running on the staging servers, you can verify whether there are differences in: Second-level cache
Other framework classes XPS/Bridge shared class usages Shared cache entities
Then you compare the two snapshot files. There are two outcomes:
If there are differences, the RUT has failed. Performing a rolling upgrade would be very risky; Navis advises against performing a rolling upgrade.
If there are no differences, the RUT passes, and you can proceed with a rolling upgrade of the SPARCS N4 application servers.
The RUT provides an incremental level of confidence, but not a guarantee, that a rolling upgrade will proceed smoothly. Keep in mind that issues can still occur during a rolling upgrade.
Steps to perform the RUT:
1 Take a snapshot of the shared cache entities for the release running on the production servers:
a. From a SPARCS N4 client, go to Administration Debug Node Info Desk. The Node Info Desk view opens.
b. Select the node that is serving your instance of the SPARCS N4 client. (It is in the row that displays a black dot in the Local column.)
c. In the Node Info Desk view, select Actions Node Attributes. The Diagnostics view for the node opens.
d. In the Diagnostics view, expand the cacheDiagnosticsMbean folder, and select
cachedClassVersions attribute. The right pane displays a list of UUIDs of all cached classes.
e. Save this list to a file by clicking the file save button in the bottom left corner of the Diagnostics view.
2 Repeat step 1 on the upgraded release running on the staging servers. 3 Compare the UUIDs for the two files using external tools (Eg. Hyperic,
http://www.quickdiff.com/, etc.)
Important:
Navis recommends you schedule the necessary down time to upgrade XPS and other system components in your next maintenance window.
There is no need to restart XPS or other system components as a result of the rolling upgrade.
You can perform a rolling upgrade to the SPARCS N4 application servers using the SPARCS N4 install wizard (sparcsn4-installer.exe). The order is:
a. Stop the service for the Standby Center node.
b. Upgrade the Standby Center node.
c. Start the Standby Center node.
d. Stop the service for the main Center node. The Standby Center node takes over as the Center node.
e. On the main Center node host, upgrade the main Center node.
f. Start the main Center node. When it is started, it is visible in the "Initializing" state in the Administration Debug Node Info Desk view.
g. Stop the service for the Standby Center node (which was running as the Center node).
h. Verify that the main Center node again takes over as the Center node by looking in the Administration System Cluster Services Cluster Services view.
i. Start the service for the Standby Center node. Verify that it is in the "Initializing" state in the Node Info Desk view.
j. Upgrade each SPARCS N4 Cluster node one at a time.
To upgrade XPS and the Bridge daemon, ECN4, and ECN4Web, you must:
a. Stop the services (in this order) for ECN4Web, ECN4, XPS, and the Bridge.
b. Run the respective install wizards in the upgrade mode.
c. Start the service for the Bridge daemon. Observe it coming up in the Cluster Services view.
d. Start XPS, ECN4, and ECN4Web.
Provided the results of the test indicate that there would be no potential problems with a rolling upgrade, and provided the rolling upgrades to the SPARCS N4 servers proceed without incident, the SPARCS N4 application servers can run in the upgraded mode simultaneously with other system components that have not yet been upgraded.
2 Install and configure a SPARCS N4
database
The purpose of this section is to help you configure your database so that you can install the SPARCS N4 application servers. You install the database on a dedicated host computer.
SPARCS N4 is compatible with Oracle, Oracle RAC, Microsoft SQL Server, and MySQL. However, each of these is only appropriate for certain production environments. The customer is responsible for working with a database administrator and a database vendor to choose a database and install and configure it on its own host. The table below recommends basic environment attributes, based on your database choice.
Navis Recommendations for Database Configurations
SQL Server MySQL Oracle Oracle RAC
Operating System 64-bit Microsoft Windows 64-bit Linux Database Name for SPARCS N4 sparcsn4 User and Password
The user you create should be able to add/modify/delete in the database.
Create an administrator-level user and password, and write down the Oracle System ID (SID) of the database instance in a secure location.
Navis provides the following installation checklists for installing the supported databases: Oracle/Oracle RAC (on page 26)
SQL Server (on page 30) MySQL
For information about the hardware capacity recommended for the database server, see Database server size based on annual TEU.
Important Considerations
Your SPARCS N4 database may run on any operating system regardless of the operating system on which you are running the application.
Regardless of OS or database type, Navis highly recommends a 64-bit system for the database server for all customers. If you do not use a 64-bit system, you may experience slow or unacceptable performance.
Current performance and scalability tests, as well as the associated hardware/TEU volume
recommendations, assume that the database for the N4 Billing application runs on a separate database host. It is up to the customer to ensure that performance is adequate for their specific operational profile if they wish to maintain the SPARCS N4 and N4 Billing databases on the same host. A MySQL database is only suited to terminals with volumes of less than 100 thousand TEUs per
annum. At higher volumes, there are serious concerns about indexing performance and the robustness of local support for what is a mission-critical database. If you have more than 100,000 TEU/annum, and are considering MySQL, we require prior consultation and certification from the engineering
department.
Oracle Configuration Checklist
This checklist is intended for your database administrator to use while installing and configuring an Oracle database for SPARCS N4. It is only a checklist, and not intended to replace comprehensive instructions. If your database administrator is unclear about any of the items, contact your Navis Professional Services representative for more information.
Supported Oracle Database Versions: 11g or 11g RAC.
Supported Platforms: Linux, Unix, or Microsoft Windows Server 2008 R2 Licensing Recommendations for your Oracle database:
Recommended for all customers - Diagnostic Package. The advantages are: Automatic Workload Repository Reports, Automatic Database Diagnostic Monitoring.
Recommended for terminals with greater than 750 Million Annual TEU (Large and Extra-Large sites as defined in Database server size based on annual TEU): Enterprise Edition The advantages are: No CPU limit (the standard edition is limited by 4 sockets), and access to the following features: Oracle Parallel Query, Data Guard or Advanced Replication, Online Index Rebuild.
Hardware Recommendations: We highly recommend using a dedicated 64-bit Linux system and at least 4 CPUs for the database server for all customers. If you do not use such system, you may experience slow or unacceptable performance. If you are using a database reporting application, it should use a separate database server.
Running any other applications on the Oracle database server may create a significant load on the database, and the SPARCS N4 application performance will suffer.
The N4 and N4 Billing install wizards do not support SCAN (Single Client Access Name) addressing that provides a single name for clients to access Oracle databases in a cluster. The wizards only generate the older general format when configuring an Oracle RAC database connection. The older general format continues to work with 11gR2, so you can continue to use Oracle RAC with the older general format.
Oracle Configuration Checklist
Apply all recommended patches and updates before proceeding.
Review the SPARCS N4 2.4 Technical Requirements document.
Use only the driver shipped with your SPARCS N4 installation package. 26 SPARCS N4: Installation Guide 2.4The shipped version may not be the latest version commercially available.
Verify that the database character set is AL32UTF8. (AL32UTF8 is the database character set that supports the latest version (5.0 in Oracle 11.1) of the Unicode standard.) Contact your Navis representative for more information.
Verify that you have the connection pooling configured correctly by reviewing the application descriptor file, apex.xml. It should look similar to the sample provided in this document for configuring the database connection: Sample apex.xml file from Oracle 11g (on page 201) Sample apex.xml file from Oracle 11g RAC (on page 203)
If you have more than one connection pool, make sure all 'cache names' are unique.
Configure a second data source. Refer to the sample files provided in Configure the database connection (on page 199), which all contain segments for a system data source, and Sample scripts for the second database user (on page 42).Activating the Database Performance Pack and configuring a second data source provide you with additional diagnostic information for identifying performance problems and verifying the database configuration. See Deploy the Database Performance Pack (on page 41) for more information.
(Optional) Verify that Fast Connection Failover (FCF) is configured. FCF is an advanced feature of Oracle RAC, which provides high availability of the system. Contact your Navis representative for more information.
Create tablespace(s). To do this, you verify that the segment space management (ASSM) is set to automatic. Contact your Navis representative for more information. In Oracle 10g RAC, ASSM defaults to "manual". In Oracle 10g, ASSM defaults to "auto" for all permanent tablespaces.
Create application user and schema. Verify in the dba_role_privs and dba_sys_privs tables that the SPARCS N4 application user has only two privileges: CONNECT and RESOURCE. Contact your Navis representative for more information. Verify in the dba_ts_quotas that the SPARCS N4 application user has sufficient quota.Do not grant more than the two privileges listed above. If you grant more than CONNECT and RESOURCE, you risk data loss or corruption. For example, granting the 'dba' privilege, could result in upgrade failures that require you to recover your last production database snapshot from the previous release, then restart the upgrade.
If one of the necessary privileges is missing, you must issue an appropriate "grant" command for the application to operate.
You can issue an appropriate "revoke" command to remove non-required privileges.
Oracle 11 expires passwords by default. Make sure the PASSWORD_LIFE_TIME value for SPARCS N4 application users is set to UNLIMITED.
Use the command below to check to see if the database is configured to use the "DEFAULT profile SPARCS N4: Installation Guide 2.4 27
when deciding to expire passwords:
select resource_name, limit from dba_profiles where profile='DEFAULT' and RESOURCE_TYPE='PASSWORD';
If so, to prevent the password from expiring in Oracle 11, use the following statement: ALTER PROFILE DEFAULT LIMIT
FAILED_LOGIN_ATTEMPTS UNLIMITED
PASSWORD_LIFE_TIME UNLIMITED;
Verify that the database Server Parameters file is configured by locating the spfile parameter, and making sure it is pointing to an appropriate spfile. Contact your Navis representative for more information.
Schedule an interval for gathering schema statistics. As a default, we recommend you initially set this for twice a week and adjust to be more or less frequent as needed for your terminal. Schedule it for off-peak hours. Contact your Navis representative for more information.Navis also highly recommends gathering system statistics in addition to schema statistics.
Navis highly recommends gathering system statistics during normal (peak) activity and during most idle times. Contact your Navis representative for more information.Analyzing the SYS schema might downgrade performance. Avoid gathering statistics for the entire database.
If you do not gather both types of statistics, the Oracle Optimizer might use non-optimal execution plans, and it will adversely affect application performance.
You must have Oracle interMedia installed for SPARCS N4 2.2 and later versions. Typically this is part of the standard Oracle installation. The interMedia installation includes Oracle Locator, which is required for SPARCS N4 to support geometry objects in an Oracle database. If DDL statements involving geometry columns are failing, please check to see if Oracle interMedia is installed. The link below to the Oracle interMedia User's Guide gives instructions for verifying whether interMedia is installed and how to install it if it is missing:http://download.oracle.com/docs/cd/B19306_01/appdev.102/b14302/ap_instl_up grd.htm
Verify the database memory parameters are sufficient. The following table describes *required* values for the key memory allocation parameter, depending on the size of the database:Parameter Name Small Database (50-399K Annual TEU) Medium Database (400-700K Annual TEU) Large Database (701K-1.99M Annual TEU) Extra-Large Database (2.0M+ Annual TEU)
MEMORY_TARGET 6 Gb 12 Gb at least 16 Gb at least 32 Gb
K=Thousand M=Million Set SGA_TARGET and PGA_AGGREGATED_TARGET parameters to = 0. Oracle then distributes
memory based on actual load. If a memory parameter is a positive number, the values act as minimum value. To review memory settings, use the "show parameter target" command or 28 SPARCS N4: Installation Guide 2.4
"select from v$parameters where ...." statement.
We recommend reviewing Automated Workload Repository (AWR) Reports periodically for advice about how to alter these parameters as necessary.
Verify that PROCESSES, SESSIONS, and OPEN_CURSORS parameters are sufficient. The following table describes the values for these parameters, depending on the size of the database:Parameter Name Small Database (50-399K Annual TEU) Medium Database (400-700K Annual TEU) Large Database (701K-1.99M Annual TEU) Extra-Large Database (2.0M+ Annual TEU)
PROCESSES 300 500 at least 500 at least 500
SESSIONS 350 550 at least 550 at least 550
OPEN_CURSORS 300 500 at least 500 at least 500
K = Thousands M = Millions
(Conditional) For multi-byte encoding systems, we recommend setting the NLS_LENGTH_SEMANTICS parameter to CHAR (the default is BYTE).
(Optional) Configure data storage. Navis provides a simple and robust schema deployment script which is created to have minimal complexity for customers. Only one tablespace is needed to deploy the entire schema.However, Navis recommends you follow Oracle's guidelines for best practices when it comes to database instance and schema configuration, and maintenance.
Navis can provide advice or prepare a configuration/data migration plan on a time and material basis through Navis Professional Services.
The following suggestions are only recommendations, and should be applied only if they suit the needs and fit your environment.
Use ASM (Automated Storage Management). In most cases this will yield better performance and configuration flexibility.
Distribute objects into different tablespaces. This may not bring any performance gains (unless multiple storage devices are utilized), but in general is considered a good practice. Here are some things to keep in mind:
An example of groups of objects can be: LARGE TABLES, INDEXES OF THE LARGE TABLES, OTHER TABLES, INDEXES OF THE OTHER TABLES, LOBs.
In cases when multiple storage devices are utilized by a database, it could be beneficial to distribute tablespace storage over those devices in a way which would balance the IO. It may be beneficial to:
Create separate tablespaces for read-only tables. Keep small, referenced tables in memory. Keep redo log files on separate disks.
Deliberately map different tables and index structures to tablespaces of different sizes.
This allocation is based on the average row length of the data within the table, as well as access patterns within the whole database.
Oracle lets you choose between 2K, 4K, 16K, and 32K sizes of data block tablespaces.
Use appropriate STORAGE parameters on an object level and EXTENT parameters on tablespace level.
For example, use AUTO segmentspace management, and LOCAL extent management. Additionally, if a tablespace contains only large objects, it may be advantageous to use large
uniformly-sized extents.
Use an appropriate number of INI_TRANS object level parameters depending on a number of concurrent updates.
All options are dependent upon database size and hardware configuration.
(Conditional) If you are using Oracle RAC, the Interconnect protocol setup is important because User Data Protocol (UDP) settings define the amount of send and receive buffer space for sending and receiving datagrams over an IP network. These settings affect cluster interconnect transmissions. If the buffers set by these parameters are too small, the incoming UDP datagrams can drop due to insufficient space. Then they require send-side transmission, which can result in poor cluster performance. Contact your Navis representative for more information.
Alter the connection parameters to avoid connections from being severed due to a firewall timeout. SPARCS N4 can hang if you have set up a firewall timeout for idle connections. To do this, set the three parameters below. Set the InactivityTimeout value (seconds) on the connection cache to be shorter than the firewall idle timeout value. For example:
connectionCacheProperties="{MinLimit=6, InitialLimit=6, MaxLimit=50, MaxStatementsLimit=50, InactivityTimeout=120,
ConnectionWaitTimeout=120}"
Set maxInactiveInterval parameter for Tomcat to the same value. For example: maxInactiveInterval="120"
Enable Oracle Net DCD (Dead Client Detection) by setting SQLNET.EXPIRE_TIME=1 in the sqlnet.ora file on the server-side.
You can also review other suggestion from Oracle at:
http://download.oracle.com/docs/cd/B28359_01/java.111/b31224/apxtblsh.htm#C HDBBDDA
For more information, see the SPARCS N4 Administrator's Guide. It contains instructions for collecting performance statistics and a procedure for gathering information in case there is a performance problem.SQL Server Installation and Configuration Checklist
This checklist is intended for your database administrator to use while installing and configuring a Microsoft SQL ServerTM database for Navis SPARCS N4. It is only a checklist for configuring SQL Server
for SPARCS N4; it is not possible to replace comprehensive Oracle installation instructions with this list. If your database administrator is unclear about any of the items, contact your Navis Professional Services representative for more information.
Supported SQLServer Database Versions: Microsoft SQL Server Enterprise 2008 R2 Edition (US English) or, if fewer than 100K annual TEU, Microsoft SQL Server Standard 2008 R2 Edition (US English).
Supported Platforms: Microsoft Windows Server 2008 R2 or Windows Server 2003 (64-bit - see below) Licensing Recommendations: Enterprise Edition
Microsoft SQL Server Enterprise editions have the following advantages over SQL Server Standard: No limitation on the number of CPUs
Full scalability vs. limited scalability High availability
Ability to create and rebuild indexes online Superior performance and diagnostic tools
Hardware Recommendations: SPARCS N4 requires a 64-bit system and at least 4 CPUs for the database server for all customers. If you do not use such system, you may experience slow or unacceptable
performance.
SQL Server Installation and Configuration Checklist
Apply all recommended patches and updates before proceeding.
Microsoft SQL Server 2008 requires an installation of Internet Information Services (IIS). Therefore, before installing Microsoft SQL Server 2008, make sure your machine includes an IIS installation. It is a Windows component you can add from the Control Panel.
Install the following components in the SQL Server setup wizard: SQL Server Database Services (optional, only required if you use Analytics) Analysis Services (optional, only required if you use Analytics) Integration Services
Workstation components
Books Online development tools
(optional) Choose the options to start SQL Server Agent and SQL Browser services after setup (as well as any other services you may have installed).
(optional) Choose Mixed Mode for the Authentication Mode.
You can check to see if they are installed using Start All Programs MS SQL Server 2008 Configuration Tools SQL Server Configuration Manager SQL Server Services. If they are not present, reinstall the database software, and select the components above.
After you walk through the installation wizard, the install processing could take 30 minutes or longer.
Review the following additional recommendations before you complete installation: Navis recommends against installing Reporting Services and Notification Services unless you have separate plans to run reports and use notification services. SPARCS N4 does not use either of
