Navis N4

Monitoring and Reporting

Guide
3.8.20
CONFIDENTIAL INFORMATION OF Navis LLC

UNAUTHORIZED USE IS STRICTLY PROHIBITED.

N4 is a trademark of Navis LLC.

© Navis LLC 1988 - 2021. All rights reserved.

This help 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.

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

Contents
Part 1 Reports Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.1 Setting up Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.1.1 Adding General Notice Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.2 Adding Report Designs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.1.3 Adding Report Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Part 2 Reports Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2.1 Reporting Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.1.1 Report Designs view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.1.1.1 Report Design form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.1.2 Media Assets view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.1.2.1 Media Asset form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.1.3 Report Definitions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.1.3.1 Report Definition form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.1.3.2 Run a report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.1.3.3 Duplicate a report definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.1.4 Reporting Entities view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.1.4.1 Reporting Entity form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.2 Reporting Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

2.2.1 Bill of Lading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.2.2 Bill of Lading - Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.2.3 Cargo Lot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
2.2.4 EDI Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
2.2.5 Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
2.2.6 Reefer Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.2.7 Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.2.8 Unit - Complex Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
2.2.9 Unit - Damages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
2.2.10 Unit - Hazards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
2.2.11 Unit - Hazards and Train Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
2.2.12 Unit - Holds/Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
2.2.13 Unit Move Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
2.2.14 Vessel Exchange Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
2.2.15 Che Move Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
2.2.16 CHE Trip Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
2.2.17 Equipment Block Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
2.2.18 Yard Block Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
2.2.19 Booking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 3
Confidential -- Proprietary
 Contents

2.2.20 Booking Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

2.2.21 Equipment Loadout Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
2.2.22 Equipment Delivery Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
2.2.23 Rail Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
2.2.24 Service Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
2.2.25 Service Order Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
2.2.26 Service Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
2.2.27 Item Service Type Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
2.2.28 Carrier Visit Service Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
2.2.29 Carrier Visit Service Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
2.2.30 Railcar Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
2.2.31 Train Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
2.2.32 UFV Arrived on Railcar Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
2.2.33 UFV on Railcar Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
2.2.34 Appointments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
2.2.35 Truck Transaction Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
2.2.36 Truck Visit Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
2.2.37 Truck Visit Stage and Transaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
2.2.38 Truck Visit Stages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
2.2.39 Truck Visit Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
2.2.40 Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
2.2.41 Line DischargeList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
2.2.42 Line LoadList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
2.2.43 Vessel Crane Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
2.2.44 Vessel Crane Statistics - Delays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
2.2.45 Vessel Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

2.3 Monitoring and Reporting Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

2.3.1 Monitoring and Reporting Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.3.1.1 Media Assets Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.3.1.2 Monitor Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.3.1.3 Report Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
2.3.1.4 Terminal Monitor Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
2.3.2 Monitor and Analytics configuration settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR006 (BREAK_BULK_CRANE_ACTIVITY_ID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR007 (HATCH_LID_CRANE_ACTIVITY_ID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR008 (TWIST_LOCK_CRANE_ACTIVITY_ID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
ARGOMONITOR009 (EGEAR_CRANE_ACTIVITY_ID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
ARGOMONITOR010 (MENSA_SERVER_SOCKET_TIMEOUT)'. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
FRMCARINA033 (GADGET_REFRESH_PERIOD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 4
Confidential -- Proprietary
 Contents

MENCHEMETRICS001 (CHE_METRICS_FOR_MINUTES_AGO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

MENDASHBOARD001 (AUTO_CREATE_DASHBOARD_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . 465
MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
MENDASHBOARD003 (AUTO_CREATE_DASHBOARD_ROLE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENDASHBOARD005 (VSL_SHOW_ALL_CRANES). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENDATAMART001 (MONITOR_MOVES_EXTRACT_LATENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENJOBS001 (VESSEL_STATISTICS_JOB_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENJOBS002 (CHE_STATISTICS_JOB_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENJOBS003 (EC_EVENT_IMPORTER_JOB_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
MENJOBS004 (EC_EVENT_IMPORTER_FILE_PATH). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
MENJOBS005 (EC_EVENT_IMPORTER_PROCESSED_FILE_PATH). . . . . . . . . . . . . . . . . . . . . . . . . 467
MENSPARCS003 (SPARCS_STATISTICS_SERVER_HARVEST_FREQ). . . . . . . . . . . . . . . . . . . . . . . 467
MENSPARCS004 (SPARCS_STATISTICS_SERVER_REQUEST_DELAY). . . . . . . . . . . . . . . . . . . . . . 467
ROADMONITOR001 (MONITOR_REFRESH). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
ROADMONITOR002 (YARD_SERVICE_TIME). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
2.3.3 Reporting job settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
ARGOREPORTING001 (REPORTING_TEMP_FILE_FOLDER). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ARGOREPORTING002 (REPORTING_FROM_EMAIL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ARGOREPORTING003 (REPORTING_REPLY_TO_EMAIL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ARGOREPORTING004 (REPORTING_NULL_PARAM_VALUE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ARGOREPORTING005 (REPORTING_SQL_TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
ARGOREPORTING006 (REPORTING_SQL_ROWS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
ARGOREPORTING007 (REPORTING_SQL_FETCH_SIZE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
ARGOREPORTING008 (REPORTING_CLEANUP_TIME_MILLIS). . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
ARGOREPORTING009 (REPORTING VIEW VESSEL VISIT CLOSED). . . . . . . . . . . . . . . . . . . . . . . . 470
MENCHEMETRICS001 (CHE_METRICS_FOR_MINUTES_AGO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
MENJOBS001 (VESSEL_STATISTICS_JOB_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
MENJOBS002 (CHE_STATISTICS_JOB_FREQUENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
SRVNOTICE001 (NOTICE_RETURN_EMAIL_ADDRESS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

Part 3 Business Intelligence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

3.1 Configuring the Business Intelligence Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
3.1.1 Setting up a Navis N4 XPS client as the statistics server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
3.1.2 Configuring settings for the XPS statistics server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
3.1.3 Initializing standard report designs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
3.1.4 Starting BI-related background jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
3.1.5 Editing gadget-related settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

3.2 Enabling the Dashboards menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

3.2.1 Manage Dashboards view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
3.2.2 Setting up the automatic creation of vessel/crane dashboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
3.2.3 Adding or editing a dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 5
Confidential -- Proprietary
 Contents

3.3 <Dashboard> tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

3.3.1 Displaying gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
3.3.1.1 About data availability in Crane gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
3.3.1.2 About gadget titles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
3.3.1.3 Configuring settings for vessel and crane gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
3.3.2 Adding gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
3.3.2.1 AGV Average moves per hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
3.3.2.2 AGV Travel Distance gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
3.3.2.3 AGV Idle Time By AGV Pool gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
3.3.2.4 AGV Moves Per Hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
3.3.2.5 AGV Wait at QC gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
3.3.2.6 AGV Wait At Parallel Buffer gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
3.3.2.7 AGV Wait In ASC TZ gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
3.3.2.8 ASC Driving Time gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
3.3.2.9 ASC Idle Time by Yard Block gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
3.3.2.10 ASC Moves by Move Kind gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
3.3.2.11 ASC Moves last hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
3.3.2.12 ASC Productivity gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
3.3.2.13 ASC Red Time For Date Range gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
3.3.2.14 ASC Red Time Current Day Range gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
3.3.2.15 ASC Summary gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
3.3.2.16 ASC Travel Distance gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
3.3.2.17 Average ASC Cycle Time by ASC gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
3.3.2.18 Block Fullness for ASC yard blocks gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
3.3.2.19 Crane KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
3.3.2.20 Crane Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
3.3.2.21 Crane Rhythm gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
3.3.2.22 Crane Worked Last Hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
3.3.2.23 Facility TEU gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
3.3.2.24 Fixed CHE Details gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
3.3.2.25 Moves per Day gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
3.3.2.26 Moving CHE Details gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
3.3.2.27 Quay Cranes Moves By Hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
3.3.2.28 Quay Cranes Moves by Lift Mode for selected Quay gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . 498
3.3.2.29 Quay Cranes Moves by Lift Mode gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
3.3.2.30 Quay Cranes Net Moves By Hour gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
3.3.2.31 Truck KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
3.3.2.32 Truck Turn Time gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
3.3.2.33 Trucks in Yard gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
3.3.2.34 Unit Dwell Time gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
3.3.2.35 Units in Yard gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
3.3.2.36 Vessel KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 6
Confidential -- Proprietary
 Contents

3.3.2.37 Vessel Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

3.3.2.38 Vessels Alongside gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
3.3.2.39 Yard Utilization gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
3.3.3 Moving gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
3.3.4 Editing the parameter settings of gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
3.3.4.1 AGV Average moves per hour form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
3.3.4.2 AGV Idle Time By AGV Pool form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
3.3.4.3 AGV Moves Per Hours form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
3.3.4.4 AGV Travel Distance form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
3.3.4.5 AGV Wait at QC form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
3.3.4.6 AGV Wait At Parallel Buffer form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
3.3.4.7 AGV Wait In ASC TZ form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
3.3.4.8 ASC Driving Time form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
3.3.4.9 ASC Idle Time by Yard Block form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
3.3.4.10 ASC Moves by Move Kind form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
3.3.4.11 ASC Moves last hour form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
3.3.4.12 ASC Productivity form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
3.3.4.13 ASC Red Time For Date Range form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
3.3.4.14 ASC Red Time Current Day Range form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
3.3.4.15 ASC Summary form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
3.3.4.16 ASC Travel Distance form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
3.3.4.17 Average ASC Cycle Time By ASC form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
3.3.4.18 Changing a gadget type's default parameter settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
3.3.4.19 Crane KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
3.3.4.20 Crane Metrics form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
3.3.4.21 Crane Rhythm form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
3.3.4.22 Fixed CHE Details form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
3.3.4.23 Moves per Day form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
3.3.4.24 Moving CHE Details form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
3.3.4.25 Quay Cranes Moves by Lift Mode for selected Quay form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
3.3.4.26 Quay Cranes Net Moves By Hour form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
3.3.4.27 Truck KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
3.3.4.28 Trucks in Yard form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
3.3.4.29 Vessels Alongside form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
3.3.4.30 Vessel KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
3.3.4.31 Vessel Metrics form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
3.3.4.32 Yard Utilization form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
3.3.5 Editing the display properties of table gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
3.3.6 Hiding gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
3.3.7 Creating a PCPH gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 7
Confidential -- Proprietary
 Contents

3.4 BI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

3.4.1 Understanding the Plan Deviation gauge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
3.4.1.1 Good plan deviation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
3.4.1.2 Poor plan deviation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
3.4.1.3 Reasonable negative plan deviation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
3.4.1.4 Reasonable positive plan deviation (Vessel KPIs gadget). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
3.4.2 Determining which quay crane made a vessel move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
3.4.3 Crane/Vessel Forward-Looking metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
3.4.3.1 Data Element Definition for Crane/Vessel Forward-Looking metrics. . . . . . . . . . . . . . . . . . . . . . 533
3.4.3.2 Projection scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
3.4.3.3 Definition of Crane/Vessel Forward-Looking Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
3.4.3.4 Example scenarios for Crane/Vessel Forward-Looking Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . 536
3.4.4 Crane/Vessel Crane Activity metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
3.4.4.1 Crane/vessel crane activity terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
3.4.4.2 Definition of Crane/Vessel Crane Activity metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
3.4.4.3 Relevant XPS configuration settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
3.4.4.4 Operation guidelines for gathering decision support data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
3.4.4.5 Activity categories and codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
3.4.4.6 Example scenarios for Crane/Vessel Crane Activity Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
3.4.5 CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
3.4.5.1 CHE terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
3.4.5.2 Moving CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
3.4.5.3 Fixed CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
3.4.5.4 Which CHE are credited with a move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
3.4.6 ASC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
3.4.6.1 Data Element Definition for ASC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
3.4.6.2 Definition of ASC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
3.4.6.3 ASC EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
3.4.7 AGV metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
3.4.7.1 Data Element Definition for AGV metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
3.4.7.2 Definition of AGV metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
3.4.7.3 AGV/AHT EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
3.4.8 Quay crane metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
3.4.8.1 Data element definition for QC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
3.4.8.2 Definition of QC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
3.4.8.3 QC EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
3.4.9 RTG/RMG metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
3.4.9.1 Definition of RTG/RMG metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
3.4.10 Yard metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
3.4.10.1 Data Element Definition for Yard metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
3.4.10.2 Definition of Yard metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 8
Confidential -- Proprietary
 Contents

3.4.10.3 Edge cases and restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573

3.4.11 Gate metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
3.4.11.1 Data Element Definition for Gate metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
3.4.11.2 Definition of Gate metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
3.4.12 Move count per facility visit metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
3.4.12.1 Unit facility visit move count metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
3.4.13 Equipment block visit (EBV) count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
3.4.14 Internal and External trucks wait time metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
3.4.14.1 Internal trucks wait time metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
3.4.14.2 External trucks wait time metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
3.4.15 Sample reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
3.4.15.1 Moving CHE Productivity Analysis report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
3.4.15.2 Move Count by POW by CHE report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
3.4.15.3 Straddle Productivity report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
3.4.15.4 Truck Turn Time Analysis report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
3.4.15.5 Clerk Activity report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
3.4.15.6 Yard Rehandle by Equipment Operator report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
3.4.15.7 Stack Block Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
3.4.15.8 Reefer Plug Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
3.4.15.9 Average Daily Yard Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
3.4.15.10 UFV Move Count report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
3.4.15.11 Internal Prime Movers report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
3.4.15.12 External Trucks report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
3.4.15.13 ASC Move Count by Move Type report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
3.4.15.14 ASC Move Count Summary report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
3.4.15.15 ASC Productivity report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
3.4.15.16 ASC Productivity Report By Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
3.4.15.17 RTG/RMG Productivity report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
3.4.15.18 AGV Productivity Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
3.4.15.19 QC Productivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
3.4.16 Operation scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
3.4.16.1 Loading a container to a vessel (RTG/RMG). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
3.4.16.2 Discharging a container from a vessel (RTG/RMG). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
3.4.16.3 Moving a container from one yard block to another (RTG/RMG). . . . . . . . . . . . . . . . . . . . . . . . 619
3.4.16.4 Moving a container without a truck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
3.4.16.5 Moving containers with moving CHEs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
3.4.16.6 Moving containers with straddle carriers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
3.4.16.7 Moving a container to/from an ASC stack. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
3.4.17 Reporting a Monitor metric issue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639

3.5 Validating BI data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640

3.5.1 Validate the Vessels Alongside gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 9
Confidential -- Proprietary
 Contents

3.5.2 Validate the Vessel Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642

3.5.3 Validate the Vessel KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
3.5.4 Validate the Crane KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
3.5.5 Validate the Crane Rhythm gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
3.5.6 Validate the Crane Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
3.5.7 Validate the Fixed and Moving CHE Details gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
3.5.8 Validate the Yard Utilization gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
3.5.8.1 Validate reefer plug data in the Yard Utilization gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
3.5.9 Validate dynamic gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
3.5.10 Validate the Moves per Day gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
3.5.11 Validate the Trucks in Yard gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
3.5.12 Validate the Truck KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
3.5.13 Validate the Vessel Crane Metrics view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
3.5.14 Validate the Move Count By POW By CHE report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
3.5.15 Validate the Moving CHE Productivity Analysis report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
3.5.15.1 Verification of time-related fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
3.5.15.2 Example: Validation of load moves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
3.5.16 Validate the Yard Rehandle Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
3.5.17 Validate the Reefer Plug Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
3.5.18 Validate the Average Daily Yard Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
3.5.18.1 Percentage of total yard utilization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
3.5.18.2 Percentage of total reefer utilization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
3.5.18.3 Percentage of utilization by area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679

Part 4 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682

4.1 Troubleshooting Statistics and Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
4.1.1 Mensa statistics server role disconnects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
4.1.2 XPS client as statistics server (Mensa client) does not populate the database tables mns_yard_block
and mns_yard_block_statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
4.1.3 AGV Wait at Parallel Buffer gadget does not display the AGV waiting time. . . . . . . . . . . . . . . . . . . . . 684
4.1.4 AGV Wait in ASC TZ gadget displays zero values in the X and Y axis. . . . . . . . . . . . . . . . . . . . . . . . 684
4.1.5 Vessel Metrics gadget displays null values in the eGMPH, eGGH, eNGH, eNMP columns. . . . . . . . . 685

4.2 Reporting How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686

4.2.1 Add a new SQL Query report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
4.2.2 Change the logo that appears on reports in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
4.2.3 Sort a report by a computed field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
4.2.4 Set up multiple notice requests for a single combination of Entity and Event. . . . . . . . . . . . . . . . . . . . 689
4.2.5 Create a filter for General Notices that applies to Advised units only. . . . . . . . . . . . . . . . . . . . . . . . . . 690

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 10
Confidential -- Proprietary
Part 1
Reports Process Flows
In this Section:

Setting up Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 11
Confidential -- Proprietary
1.1 Setting up Reports

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 12
Confidential -- Proprietary
1.1.1 Adding General Notice Requests

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 13
Confidential -- Proprietary
1.1.2 Adding Report Designs

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 14
Confidential -- Proprietary
1.1.3 Adding Report Definitions

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 15
Confidential -- Proprietary
Part 2
Reports Configuration
In this Section:

Reporting Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Reporting Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Monitoring and Reporting Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 16
Confidential -- Proprietary
2.1 Reporting Views
This section contains the reporting views that you need to configure reporting.

Report Designs view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Media Assets view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Report Definitions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Reporting Entities view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 17
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Report Designs view

2.1.1 Report Designs view

Operations Reports Report Designs Report Designs view

Prerequisites
• To access the Report Designs view, you need to assign the Report Designs - Add privilege to your user role.

The Report Designs view displays the report designs that exist at the current scope level. A report design includes
information about the type of report, the entity on which the report is based, the scope at which the report is run, and
the physical layout of the data in a report. A report design is further enhanced and configured using report definitions
(on page 28).

You can add, edit, and delete report designs from this view.

When creating a report design, in addition to the N4 data, you can add information such as the date and time of
creation or your company logo. To add:

• The date of creation to a report design, see the built-in functions in iReport.
• The logo to a report design, see the Media Assets view (on page 26).
• Multi-language support to reports, please contact your Navis Professional Services representative.
If you are using iReport, ensure that you set the default language to Java. To change the default language, right-click a
report in the iReport interface, select Properties in the Report Structure tab, and change the default language to
Java.

In addition, you can use the Actions Export SNX File option to export the selected report designs as an XML file
using the snx.xsd format.

To add the standard set of report designs, see Set-up Database view.

N4 allows you to create two types of reports, Reportable Entity and SQL Query.

• Reportable Entity
The Reportable Entity reports are based on the reporting entities defined in N4. These reports have certain
limitations. For example, you cannot generate reports for entities that do not have a direct relationship (a parent-
child relationship).
• SQL Query
The SQL Query reports are more configurable as they use a database query instead of the reporting entities to
retrieve data. When using the reports, you can include entities that may or may not have a direct relationship. The
SQL Query reports in N4 support all the database fields and are specific to the database that you use for your site.
You can use the iReport tool to design the report layout and to define a SQL query to retrieve the data for your
report.
N4 allows you to set up reporting jobs for both report types, Reportable Entity and SQL Query. However, you can
include a SQL Query report in a reporting job only if the SQL Query report does not accept any parameters as user
input.

For both, Reportable Entity and SQL Query reports, you can add a database field (Metafield) to a report design, even
if it does not have an External Tag defined in the reporting entity. For example, instead of adding BookingNbr to a
report, which is the External Tag for the Booking Number, you can add the internal Metafield ID, eqboNbr, of the
Booking Number to the report design. Make sure the Metafield ID is correct; otherwise, the report fails.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 18
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Designs view

To add a new record:

Click .

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

Report Designs Columns

Short Label Long Label In Filter? Sorting?
Broadest Scope Broadest
Reportable Scope
Changed Record Changed X X
Date
Changer Record Changed X X
User
Created Record Create X X
Date
Creator Record Create X X
User
Description Description X X
Entity Reporting Entity X X
Name Report Design X X
Name
Narrowest Scope Narrowest
Reportable Scope
Report Type Report Type X X
Scope Visible Scope X X

2.1.1.1 Report Design form

Operations Reports Report Designs Report Designs view Report Design form

The Report Design form enables you to add and edit reporting formats used as a basis of the report definitions that
you create in the Report Definition form (on page 30).

N4 provides a standard set of report designs (on page 21) that are created using XML files. You can use any open
source XML editor to modify existing report designs and to create new report designs.

The standard set of report designs that are provided in N4 are based on a tool called JasperReports (http://
jasperreports.sourceforge.net/). The structure of the report design XML files must follow the XSD format
provided by JasperReports. Navis recommends using a tool called iReport (http://
ireport.sourceforge.net/) to create and edit the report design XML files. For more information on N4 and

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 19
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Report Designs view

JasperReports compatibility, see the N4 and JasperReports Compatibility Matrix (on page 25). If you are using
iReport, ensure that you set the default language to Java. To change the default language, right-click a report in the
iReport interface, select Properties in the Report Structure tab, and change the default language to Java.

To add or edit a report design:

1. Create or edit a report design XML file using any open source XML editor and save the file using an .xml file
extension.
You can use report design parameters (on page 24) and reporting entity tags (on page 48) to create the report
design XML file.
2. In the Report Design Name field, enter a name that uniquely identifies the report design in N4.
If you are editing a standard report design, you should change the name of the edited report design so that N4 does
not overwrite it with a standard report design when you update the standard set of report designs using the Set-up
Database view.
3. From the Report Type drop-down list, select the type as:
▪ Reportable Entity: To add a report design based on the existing N4 reporting entities or custom reporting entities.
▪ SQL Query: To add a report design based on a SQL Query.
If you are upgrading from a version prior to N4 2.4, N4 assumes that all the existing report designs are of the type,
Reportable Entity, and uses an upgrade action to set the Report Type for all the existing report designs as
Reportable Entity.
4. From the Reporting Entity drop-down list, select the business entity type for which you want to add the report
design.
The business entity type selected in this step determines the valid fields for you to use in the report design XML file.
5. Optionally, in the Description field, enter a description of the purpose of the report design.
6. From the Visible Scope drop-down list, select the scope level, such as Operator, Facility, or Yard, at which the
report design is visible in N4.
A report design is visible at the scope level that you select in this step and at all lower scope levels.
For example, if you select Complex in this step, the report design is visible at the Complex, Facility, and Yard scope
levels.
7. From the Broadest Reportable Scope drop-down list, select the highest scope level at which a user may log in and
be able to use the report design.

The reportable scope is the scope level at which a report design can be used to create a report definition.
The Broadest Reportable Scope must be equal to or lower than the Visible Scope selected in step 6 above.
8. From the Narrowest Reportable Scope drop-down list, select the lowest scope level at which a user may log in
and be able to use the report design.
This must be equal to or lower than the Broadest Reportable Scope selected in step 7 above.
9. In the XML Design field, click Import File to import the saved report design XML file.
For the SQL Query report type, when you import a .jrxml for the report design, N4 parses the embedded SQL
and searches for the database table for a reporting entity. If it cannot find the database table name, N4 displays an
error message and informs the user that a table name is expected and without that, the report data cannot be
scoped.
10. Optionally, in the Filter Criteria area, create a filter to restrict the data included in a report based on this report
design. For example, you can create a filter that includes only export units when creating an "Export Units" report.
Use the report design filter to ensure that the data used for reporting is accurate and valid.
If you selected the Report Type as SQL Query in step 3, N4 disables the Filter Criteria area.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 20
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Report Designs view

11. Click Save.

The report design file defines the format and content of a report. You must edit the design file to implement any
customization to a report, such as adding flex fields.

To modify an existing report design XML file:

1. In the Report Designs view (on page 18), select the report design you want to modify and click .
2. Click Export File to export the report design XML file.
In the Export XML Configuration, save the report design XML file with a name and .xml file extension.
3. Edit the report design XML file using any open source XML editor.

One reason we recommend the iReport tool is that it verifies that the XML file meets the XSD standard.

4. In the Report Design form, click Import File to import the modified report design XML file.
5. Make any other required changes to the report design.
6. Click Save.
Use the modified report design XML file to create a new report design or overwrite an existing report design.

To remove a loaded file report design XML file, click Clear.

Standard report designs

N4 provides a set of standard or out-of-box report designs that you can initialize and define to create your own custom
reports.

The following table lists the out-of-box report designs, the associated report entity, and a description.

To view the designs and definitions for the BI reports, and to run the BI reports, your user role must include the
RUN_ADVANCED_REPORT privilege. For more information, see Report Privileges (on page 462).

Report Design Report Entity Description

ADVISED CONTAINERS Unit Units advised to the facility
(grouped by inbound mode)
Average Daily Yard Utilization YardBlockStatistics Average daily yard and reefer
Report plug utilization for the last 7
days
CLERK ACTIVITY TruckTransactionStage Number of truck visits and gate
moves by clerk
DELAYS FOR VESSEL VesselCraneStatisticDelays All delays of the cranes that
EXCHANGE worked on a specified vessel
DELIVERED UNITS Unit Departed units (grouped by line
operator)
ECN FOR EXPORTS Unit ECN info for export and
transship containers that are
advised or active for which the
port of discharge is not in the
US (grouped by OB carrier)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 21
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Designs view

Report Design Report Entity Description

ECN OUTSTANDING FOR Unit Export and transship containers
EXPORTS for which port of discharge is
not in the US that have no ECN
defined (grouped by OB carrier)
EVENTS RECORDED FOR Event Recorded events grouped by
TARGETS target
EXPORT DEMURRAGE Unit Dwell days and demurrage days
for export units (grouped by OB
carrier, line operator, and
length)
External Trucks Report TruckTransactionStage Wait time metrics for trucks at
the exchange area based on the
Queue Time and Wait Time
HAZARDOUS CARGO FOR UnitHazard Hazardous cargo that came in
VESSEL on or will leave on a vessel
(grouped by length)
HAZARDOUS CARGO YARD UnitHazard Hazardous cargo currently in
LIST the yard
IMPORT DEMURRAGE Unit Delivered import units with
outstanding demurrage
(grouped by payee)
Internal Prime Movers Report CheMoveStatistics Wait time for a truck/straddle at
the quay area and at a yard
block based on the move kind
LINE OPERATOR IMPORT Unit Import units that arrived on a
LIST vessel (grouped by inbound
carrier and line operators)
MOVE COUNT BY POW BY CheMoveStatistics Details and summary of move
CHE counts by CHE and POW
MOVING CHE PRODUCTIVITY CheTripStatistics Detailed productivity analysis,
ANALYSIS such as number of moves and
trips, average travel and wait
times, and totals, grouped by
CHE
RECEIVAL LOAD LIST Unit Units received that will be
loaded or were loaded on
departure vessel (grouped by
outbound vessel)
RECORDED EVENTS Event All recorded events
RECORDED EVENTS FOR Event Recorded events grouped by
EVENT TYPE event type
REEFER POSITION IN YARD Unit Reefers units in the yard
including the slot position
REEFER RECEIVAL Unit Powered reefer containers
HANDOVER REPORT received for signing off (grouped
by outbound carrier and line
operator)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 22
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Designs view

Report Design Report Entity Description

REEFER UNITS Unit Filtered for reefer containers
(grouped by line operator)
REEFER IN YARD Unit Reefer containers in the yard
REEFERS ON POWER Unit Powered reefer containers in
CHARGES yard or departed showing
amount of days in yard
(grouped by line operator)
ROAD & RAIL DELIVERY Unit Road and rail departed units
(grouped by line operator)
ROAD & RAIL RECEIVAL Unit Receival containers in the yard
or already on the vessel that
came to the terminal by truck or
train (grouped by OB carrier and
line operator)
STORAGE UNITS IN YARD Unit Empty import and storage units
in the yard
STRADDLE PRODUCTIVITY CheMoveStatistics Detailed and summary
productivity report grouped by
straddle carrier
TRUCK TURN TIME ANALYSIS TruckVisitStageTransaction Detailed truck turn time report
by BAT number
UFV Move Count Report Unit Moves for a unit during its
facility visit
UNDELIVERED IMPORTS Unit Undelivered import units in the
yard showing stops (grouped by
arrival vessel and line operator)
UNIT STORAGE CHARGES Unit Active storage units or storage
units departed in billing period
showing amount of days in yard
depending on entered billing
start and end dates (grouped by
line operator and equipment
type)
UNITS IN YARD Unit All units currently in the yard
(created for shipping
companies)
UNITS IN YARD - SUMMARY Unit Summary of all active units in
the yard (by vessel - OB carrier
for export containers, IB carrier
for all other categories,
category, and size)
UNITS WITH STOPS Unit Units that are in the yard or
already delivered showing stops
(grouped by arrival carrier and
line operator)
VESSEL EXCHANGE VesselCraneStatistics Crane Move Summary for the
STATISTICS work on a specified vessel

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 23
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Designs view

Report Design Report Entity Description

VESSEL REEFER Unit Reefer units discharged or
DISCHARGES coming off from a vessel
VESSEL REEFER LOADS Unit Advised or active reefer units
planned for or already loaded
on a vessel (no through
containers)
VESSEL WORK DETAILS UnitMoveEvent Detailed report of the work on a
specified vessel showing loads,
discharges, restows, and shifts
(grouped by line operator, move
type, category, freight kind, and
size)
VESSEL WORK SUMMARY UnitMoveEvent Summary report of the work on
a specified vessel showing
loads, discharges, restows, and
shifts (grouped by move type,
category, freight kind, and size)
YARD REHANDLE UnitMoveEvent Yard rehandles for vessel loads
grouped by equipment operator
Yard Reefer Plug Utilization YardBlockStatistics Detailed reefer plug utilization
grouped by yard block
Yard Stack Block Utilization YardBlockStatistics Slot utilization grouped by area
code

Report design parameters

In addition to the reporting entity tags (on page 48) that represent the data for the report content, you can use report
design parameters to display additional general information in a report. You do this by including the report design
parameters in the report design XML file.

The structure of the report design XML files must follow the DTD (Document Type Definition) of JasperReports. We
recommend using a tool called iReport (http://ireport.sourceforge.net/) to create and edit the report design
XML files. For more information on N4 and JasperReports compatibility, see the N4 and JasperReports Compatibility
Matrix (on page 25).

The following table lists the name, data type, and description of the available report design parameters:

Name Data Type Description

Date Date Displays the date when the report
was created.
The date is localized for the time zone
of the user who created the report.
NavisLogo String Displays the Navis N4 logo in reports.
Operator String Displays the operator in the scope
level at which the user who runs the
report is logged in.
ReportParams String Displays the report parameter labels

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 24
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Designs view

Name Data Type Description

and the values entered when a report
is run.
The report parameters are the filter
parameters that you define as part of
the report design and report definition
filters.

If you do not specify a value

for a report parameter at
runtime, the report parameter
label and value pair is
ignored when the report is
run.

TimeZone String Displays the time zone of the user

running the report.
Title String Displays the report title as specified in
the Report Display Title field in the
Report Definition form (on page 30).

If the Report Display Title is

not specified, N4 displays null
value in the report.

UserId String Displays the ID of the user who

created the report.
UserScope String Displays the login scope of the user
who created the report.

When creating the report design XML file, you must type the name of a report design parameter exactly as
specified in the above table.

N4 and JasperReports Compatibility Matrix

The following table displays the N4 versions and the corresponding compatible version of the third-party components.

N4 Release JasperReports Release iReports Release

2.4 4.1.3 4.1.3

2.5 4.1.3 4.1.3

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 25
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Media Assets view

N4 Release JasperReports Release iReports Release

2.6 5.1.0 5.1.0

A key change in the latest
version is that each element
in the report design has its
own unique UUID.
Since there is no change to
the structure of the .jrxml,
except for the addition of
new elements, all reports in
N4 release 2.4 and above
will work as expected when
you upgrade JasperReports
to 5.1.0.
Navis recommends that you
use iReport 5.1.0 instead of
iReport 4.1.3 with N4 release
2.6.
3.1 and later 5.5.x 5.5.x
iReport/Jaspersoft Studio
has announced that as of
version 5.5.0, Jaspersoft
Studio will be the official
design client for
JasperReports. iReport will
remain as a supported
product in maintenance-only
mode until December 31,
2015.

To use iReport for N4, you must configure it to be compatible with the JasperReports version by navigating (in iReport)
to Tools Options iReport Compatibility. On the Compatibility screen, you can select the JasperReports
version you need as the compatibility model that the iReport version you are using should use when operating.

2.1.2 Media Assets view

Operations Reports Media Assets Media Assets view

Prerequisites
• To access the Media Assets view, you need to assign the Media Assets - View privilege to your user role.

The Media Assets view displays all the media files that exist at the current scope level. You can add new media files,
such as images and logos to N4, and edit or delete existing media files using this view. After you add the image files to
N4, you can use them in report designs (on page 18) and place them in the main N4 frame. This is useful, for example,
if you want to include a logo in a report.

To add an image file to a report design:

1. Add the image file (on page 27) to N4.
2. In iReport, define a parameter (on page 28) to reference the image file stored in N4.
For more information on using iReport, go to http://ireport.sourceforge.net/.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 26
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Media Assets view

To add a new record:

Click .

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

Media Assets Columns

Short Label Long Label In Filter? Sorting?
Id Id X X
Short Desc Short Description X X

2.1.2.1 Media Asset form

Operations Reports Media Assets Media Assets view Media Asset form

The Media Asset form enables you to add media files to N4. You can use the Media Asset form to import new media
files and export existing media files. After you add a media file, such as an image or a company logo to N4, you can
use the image file in report designs (on page 18).

To add a media asset to N4:

1. In the Id field, enter an ID that uniquely identifies the media file.
The ID for a media asset:
▪ Is used as the parameter name in iReport
For more information on iReport, go to http://ireport.sourceforge.net/.
▪ May be alphanumeric
▪ Must not contain any spaces
▪ Can only have underscore (_) special character
2. In the Short Description field, enter a short description of the media file.
3. To import the media file into N4, click Import File.
4. Use the file dialog box to browse the folders and select the media file.
You can only select one of the following types of media files: Joint Photographic Experts Group (JPEG/JPG),
Portable Network Graphics (PNG), or Graphics Interchange Format (GIF).
5. Click Open.
This also closes the Import XML Configuration dialog box.
In the Media Asset form, the Media File field displays --loaded-- to indicate that a media file is associated with the
selected media asset.
6. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 27
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Report Definitions view

After you save an image file in N4, you can use the ID of the image file, as defined in step 1 above, as a parameter in
iReport and add the associated image file to various report designs. For more information on defining the parameter,
see Media Asset parameter in iReport (on page 28).

To remove a loaded file, click Clear.

Media Asset parameter in iReport

N4 enables you to add media files, such as images and company logos to report designs that you create using iReport.
You can use the Add/modify parameter form in iReport to define a new parameter. For more information on iReport, go
to http://ireport.sourceforge.net/.

To define the media asset parameter in iReport:

1. Add a parameter with the same name as the ID of the media asset in N4.
For more information on adding a media asset to N4, see Media Asset form (on page 27).
2. From the Parameter Class Type field, select the java.awt.Image class for the media asset parameter.
If the class is not listed in the drop-down list, enter the class name as shown above.
3. Place an Image object in the report design where you want the media asset to display.
4. Double-click the Image object.
5. On the Image, in the Image Expression field, enter the parameter name.
$P{<parameter name>}
The <parameter name> in the above line of code must be the same as the ID of the media asset that you define
in the Media Asset form in N4.
6. From the Image Expression Class list, select the java.awt.Image class.
Close the properties dialog box.

2.1.3 Report Definitions view

Operations Reports Report Definitions Report Definitions view

Prerequisites
• To access the Report Definitions view, you need to assign the Report Definitions - Add privilege to your user
role.

The Report Definitions view displays the report definitions that exist at the current scope level. You can add, edit, and
delete report definitions from this view.

You cannot delete a report definition that is used in a reporting job. For more information, see Reporting Jobs view.

In addition, you can use the following options in the Actions menu to:

• Export SNX File: Export the selected report definitions as an XML file using the snx.xsd format.
• Run Report (on page 42): Run a report using the selected report definition.
• Report Analyzer: Run the Report Analyzer to return the count of synthetic fields, database-backed fields, and
metafield IDs along with the report query and report output type in a separate window to identify whether the report

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 28
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

hydrates data. This option helps you tweak the report to receive better performance trade-offs. You can use the
Report Analyzer action only for reports that do not accept any user input (parameters).
• Duplicate Report Def (on page 43): Duplicate the selected report definition to create another report definition. Click
to view the changes made by the Duplicate Report Def action.

Selecting multiple report definitions disables the options in the Actions menu.

To add a new record:

Click .

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

Report Definitions Columns

Short Label Long Label In Filter? Sorting?
Changed Record Changed X X
Date
Changer Record Changed X X
User
Created Record Create X X
Date
Creator Record Create X X
User
Description Description X X
Design Entity Report Design X X
Reporting Entity
Design Name Report Design X X
Report Design
name
Name Report Definition X X
Name
Output Output Type X X
Report Type Report Type X X
Sort 1 Sort Field 1 X X
Sort 2 Sort Field 2 X X
Sort 3 Sort Field 3 X X
SortOrd 1 Sort Order Field 1 X X
SortOrd 2 Sort Order Field 2 X X

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 29
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

Short Label Long Label In Filter? Sorting?

SortOrd 3 Sort Order Field 3 X X
Title Report Display X X
Title

2.1.3.1 Report Definition form

Operations Reports Report Definitions Report Definitions view Report Definition form

The Report Definition form enables you to add and edit a report definition. A report definition contains the data and
format information required to create a report document. Each report definition is based on a report design (on page
18).

To add or edit a report definition:

1. In the Report Definition Name field, enter a name that uniquely identifies the report definition.
2. Optionally, in the Description field, enter a description of the purpose of the report definition.
3. Optionally, in the Report Display Title field, enter a title that will be used in the report document.

If you do not specify a report title, the ID of the associated report design will be used in the report document.

4. From the Reporting Entity drop-down list, select the business entity type for the report definition.
5. From the Report Design drop-down list, select the report design to use as a base for the report definition.

The available report designs are determined by the business entity type selected in step 4 above.

6. From the Output Type drop-down list, select the default output type for the report document.
You can select one of the following available output types:
▪ PDF (Portable Document Format)
▪ CSV (comma-separated Value file)
▪ TSV (Tab Separated Value file)
▪ RTF (Rich Text Format)
▪ XLS (Excel Worksheet Format)

You can still select a different output type every time you run the report (on page 42).

7. Optionally, in the Role field, you can associate a role with each report definition. For more information on the rules
for associating a role with a report definition, see Associate a role with a report definition (on page 31).
8. Optionally, in the Sort Fields area, select up to three sort fields and the sort order (Ascending/Descending) for each
field.
The sort order will determine the order of the records displayed in the report document.
Computed reporting fields are not database fields and are therefore not available for sorting in N4. However,
you can sort a report by a computed field when setting up the report using iReport. For more information, see
the topic How do I sort a report by a computed field? (on page 689)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 30
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Report Definitions view

9. Optionally, in the Filter Criteria area, create a filter to restrict the information included in the report.
For example, you can create a filter that displays containers for a specific line operator. For more information on
editing, moving, or copying filter criteria, see Editing a filter or a mapping rule.
It is recommended that you parameterize filter criteria created for report definitions (see Add a parameter to a filter
criterion).
If you you modify the name of a parameter in the report definition filter, you must modify the report design
accordingly.

10. Click Save to save the report definition, or click Run Report to run the report definition without saving it.
If you save a report definition, it is displayed in the Report Definitions view (on page 28) and you can use it to
generate reports any number of times. You can also duplicate a saved report definition (on page 43) if you want to
add a similar report with minor differences.
The Run Report button is available only when you are editing an existing report definition. If you are adding
a new report definition, you must save the report definition before you run it. N4 displays an error message
and does not allow you to download the reports if the report contains empty records

Output file types

On your workstation, you must associate each output file type with an application that can open it. For example, you
might associate the RTF file type with Microsoft Word, CSV file type with Microsoft Excel, and the PDF file type with
Adobe Acrobat Reader. When a report document is created, it opens in the associated application from which you can
save or print it.

See your operating system documentation for information about associating a file type with an application.

Associate a role with a report definition

In the Report Definition form (on page 30), associate roles with a report definition to restrict the availability of the
report definition for various users. The roles that a user can associate with a report definition are listed in the Excluded
list. When a role is associated with a report definition, it is moved to the Included list.

The following rules are implemented when associating a role with a report definition:

1. In the Report Definitions view (on page 28), a super user (a user with the Administrator role) can see all report
definitions that are associated with one or more roles. All other users can see only the report definitions associated
with their roles.
2. All users can associate any available role with a report definition.
3. A super user can see all the roles defined in the system and associate any available role with the report definition.
4. Other users can see only the roles that they belong to and can associate any of the available roles with the report
definition.
The Excluded list displays all the roles available to a user.
5. All users can create new report definitions that are not associated with any of the available roles. These report
definitions are treated as private and are available only to the user who creates them. A private report is not
available even to the super user.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 31
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

Standard report definitions

N4 provides a set of standard or out-of-box report definitions based on various standard report designs (on page 21).
For more information on the BI reports, see Sample reports (on page 577).

The following table lists the standard or out-of-box report definitions and the associated reporting entity.

To view the designs and definitions for the BI reports, and to run the BI reports, your user role must include the
RUN_ADVANCED_REPORT privilege. For more information, see Report Privileges (on page 462).

Report Definition Report Design Entity

Asc Move Count By Move Type Chemovestatistics
Asc Move Count Summary Chemovestatistics
Asc Productivity Chemovestatistics
Asc Productivity by Block Chemovestatistics
Agv Productivity Chemovestatistics
Average Daily Yard Utilization Yardblockstatistics
Clerk Activity Trucktransactionstage
External Trucks Trucktransactionstage
Internal Prime Movers Chemovestatistics
Move Count By Pow By Che Chemovestatistics
Moving Che Productivity Analysis Chetripstatistics
QC Productivity Chemovestatistics
Rtg/rmg Productivity Chemovestatistics
Straddle Productivity Chemovestatistics
Truck Turn Time Analysis Truckvisitstagetransaction
Ufv Move Count Unit
Yard Reefer Plug Utilization Yardblockstatistics
Yard Rehandle Unitmoveevent
Yard Stack Block Utilization YardBlockStatistics

SQL Query Reports

The SQL Query reports use a database query to retrieve data. When using SQL Query reports, you can include
entities that may or may not have a direct relationship. Since they use a database query, the SQL Query reports are
specific to the database that you use for your site.

The SQL Query reports in N4 support all the database fields.

You can use the iReport tool to design the report layout and to define a SQL query to retrieve the data for your report.

When adding a SQL Query report, you can use the XML Design field in the Report Design form (on page 19) to
upload the .jrxml file that contains the SQL query and the report layout. The uploaded SQL query is not scoped. To
enable scoping for the report, you must select a Reporting Entity in the Report Design form. N4 uses the reporting
entity to get the entity scope and appends the same to the SQL query when generating the report.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 32
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

When adding a report definition (on page 30), you must select the Report Type and the Reporting Entity to get the list
of available report designs.

N4 allows you to set up reporting jobs for both report types, Reportable Entity and SQL Query. However, you
can include a SQL Query report in a reporting job only if the SQL Query report does not accept any
parameters as user input.
When you include parameters in a SQL Query report, you must append these with a colon (:). The reporting
mechanism parses the SQL query to find the parameter names and displays the same in the Enter Filter Parameter
Values form.

In addition, the following settings are added to N4 to minimize the impact on performance and stability when running
SQL reports:

• ARGOREPORTING005 (REPORTING_SQL_TIMEOUT) (on page 468)

• ARGOREPORTING006 (REPORTING_SQL_ROWS) (on page 469)
• ARGOREPORTING007 (REPORTING_SQL_FETCH_SIZE) (on page 469)
The SQL Query reports must meet the following conditions in order to be executed by the reporting mechanism in N4:

• The SQL query for the report must contain the Reporting Entity in the From condition; otherwise, N4 displays an
error message when you run the report.
For example, if the Reporting Entity for a report design is Unit, the SQL query for the report must contain the
inv_unit_fcy_visit table in the From clause.
• To provide instance security, N4 scopes the SQL Query at runtime. Since SQL is free form and adding conditions at
random places is not desirable, it is required that you specify the Reporting Entity selected for the report between
the FROM and the WHERE clauses (preferably in the outer most loop).
• If you want the SQL query to request user input, you can add parameters to the query. However, each parameter in
the query must be named, uniquely.
To include a parameter in the SQL query, you must use the ‘$P{ UserParameterNameHere } tag. For example, to
prompt the user to enter the Facility for which to run the report, you can include the following in your SQL query:
select … FROM ... WHERE ufv.fcy_gkey = $P{Facility} …
When you run the report, N4 displays Facility as a field in the Enter Filter Parameter Values form.
• You must configure ARGOREPORTING005, ARGOREPORTING006, and ARGOREPORTING007 to ensure the
stability of the N4 installation.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 33
Confidential -- Proprietary
Guidelines for Designing SQL Query Reports
This section describes the guidelines for designing SQL Query reports.

Although N4 enables you to use free form SQL to design the queries for a report, it is important to understand that
applying instance security (scoping) to the data depends entirely on how you structure the SQL query. For example, if
you place the table name required for scoping inside the SQL query where the new criteria does not affect the rows
fetched, it makes scoping ineffective.

Supported Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
SQL Design Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Examples of Valid SQL Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Examples of Invalid SQL Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Example of a SQL Query with the UNION clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Advanced SQL Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Other SQL Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 34
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

Supported Entities
The following table represents the Reporting Entities that are available in N4, by default and you can use any of these
to add or update a SQL Report design. When you use a Reporting Entity in a SQL Report design, the SQL query must
contain the table name for the entity as listed in the table below.

The entities Booking, BookingItem, and TruckVisitDetails cause exception errors at runtime because the
associated tables have columns whose values are derived using formulas. To avoid these exception errors, use
these entities as the secondary entities in conjunction with the other entities when you design the SQL Report.

Entity Name Display Base Entity Is Built-In Is Enabled Table

Name Required*
BillOfLading Bill Of Lading BillOfLading true true crg_bills_of_
lading
BlItem Bill Of Lading- BlItem true true crg_bl_item
Items
Booking Booking Booking true true inv_eq_base_
order_ item
BookingItem Booking Item EquipmentOrde true true ord_equipment
rItem _ order_items
CargoLot Cargo Lot CargoLot true true crg_lots
CarrierVisitServ Carrier Visit CarrierVisitServ true true ord_service_or
iceOrder Service Order iceOrder der
CarrierVisitServ Carrier Visit CarrierVisitServ true true ord_carrier_visi
iceType Service Type iceType t_ service_type
CheMoveStatis Che Move CheMoveStatis true true table _block
tics Statistics tics
CheTripStatistic Che Trip CheTripStatistic true true mns_che_trip_
s Statistics s statistics
EdiSession Edi Session EdiSession true true edi_session
Equipment Equipment EquipmentStat true true inv_eq_state
e
EquipmentBloc Equipment EquipmentBloc true true mns_equipmen
kVisit block Visit kVisit t_ block_visit
EquipmentDeliv Equipment EquipmentDeliv true true inv_eq_base_
eryOrder Delivery Order eryOrder order_item
EquipmentLoad Equipment EquipmentLoad true true inv_eq_base_
outOrder Loadout Order outOrder order_item

Event Event Event true true srv_event

GateAppointme Appointments GateAppointme true true road_gate_
nt nt appointment
ItemServiceTyp Service Types ItemServiceTyp true true ord_item_
e e service_type
ItemServiceTyp Item Service ItemServiceTyp true true ord_item_
eUnit Type Unit eUnit service_unit
LineDischargeL Line LineDischargeL true true vsl_line_
ist DischargeList ist discharge_list

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 35
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

Entity Name Display Base Entity Is Built-In Is Enabled Table

Name Required*
LineLoadList Line LoadList LineLoadList true true vsl_line_loadlist
RailcarVisit Rail Car Visit RailcarVisit true true rail_car_visits
RailOrder Rail Order RailOrder true true inv_eq_base_
order_item
ReeferRecord ReeferRecord ReeferRecord true true inv_unit_
reefer_records
ServiceOrder Service Order ServiceOrder true true ord_service_or
der
ServiceOrderIte Service Order ServiceOrderIte true true ord_service_
m Item m order_item
TrainVisitDetail Train Visit TrainVisitDetail true true rail_train_
s s visit_details
TruckTransacti Truck TruckTransacti true true road_truck_
onStage Transaction onStage transaction_
Stage stages
TruckVisitDetail Truck Visit TruckVisitDetail true true road_truck_
s Details s transactions
TruckVisitStage Truck Visit TruckVisitStage true true road_truck_visit
Stages _ stages
TruckVisitStage Truck Visit TruckVisitStage true true road_truck_visit
Transaction Stage and _ stages
Transaction
TruckVisitStats Truck Visit TruckVisitStats true true road_truck_visit
Statistics _ stages
UfvArrivedOn Ufv Arrived UfvArrivedOn true true Not Supported
RailcarVisit On RailcarVisit
RailcarVisit
UfvOnRailcarV Ufv On UfvOnRailcarV true true Not Supported
isit RailCarVisit isit
Unit Unit UnitFacilityVisit true true inv_unit_fcy_vi
sit
UnitComplexVi UnitComplexVi Unit true true inv_unit
sit sit
UnitDamage Unit - Damages UnitFacilityVisit true true inv_unit_fcy_vi
sit
UnitEquipmen DEPRECATED UnitEquipmen true true inv_unit_equi
t - Unit - t p
Equipment

UnitFlag Unit - Holds/ UnitFlag true true Not supported

Permissions

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 36
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

Entity Name Display Base Entity Is Built-In Is Enabled Table

Name Required*
UnitHazard Unit - Hazards UnitFacilityVisit true true inv_unit_fcy_vi
sit

UnitHazardTrai UnitHazards UnitFacilityVisit true true inv_unit_fcy_vi

nVisitRailcar and Trainvisit sit

UnitMoveEvent Unit Move MoveEvent true true inv_move_even

Event t

VesselCraneSt Vessel Crane VesselStatistics true true vsl_crane_

atisticDelays Statistics - ByCrane statistics
Delays

VesselCraneSt Vessel Crane VesselStatistics true true vsl_crane_

atistics Statistics ByCrane statistics

VesselVisitDeta Vessel Visit VesselVisitDeta true true vsl_vessel_visit

ils ils _ details

WorkInstructi DEPRECATED WorkInstructi true true _qual

ons - Vessel on
Exchange
Instructions
YardBlockStatis Yard Block YardBlockStatis true true mns_yard_bloc
tics Statistics tics k_ statistics

SQL Design Guidelines

Although you can design the report using free form SQL, you must meet the following conditions:

• The SQL query must have at least one from and where clause (group, and order clauses are optional).

If you want to create a SQL query without the WHERE clause, you must include an empty WHERE clause,
such as WHERE 1=1, in the query.

• The SQL query must contain the table name (corresponding to the Reporting Entity for the report) in the FROM
clause.
The FROM keyword for this clause must be represented in the uppercase. If you want to add a WHERE clause
here, it must be in uppercase too.
• It is recommended that you place the table name for the Reporting Entity as the first table in the FROM clause.
• If you add Parameters to accept user input, the parameter names within the SQL query must be unique.
• If the SQL query contains UNION, INTERSECT, and MINUS clauses that require the query to be scoped multiple
times, you can use the FROM clause (in uppercase) multiple times.
• The tables used in the FROM clause must be unique and not aliases.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 37
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

• Do not use Database aliases.

• If you use the srv_event table as the primary entity in a query, define the query as given below because the
srv_event table is a composite table consisting of srv_event, inv_event, and edi_event:
srv_event srve
left outer join inv_move_event invm
on srve.gkey=invm.mve_gkey
left outer join edi_event edie
on srve.gkey=edie.edievent_gkey
In addition, N4 allows you to use parameters defined in an SQL report design and place them anywhere. N4 displays
these parameters based on the order defined in the report design in the form Enter Filter Parameter Values when you
run a report.

Examples of Valid SQL Queries

SQL Query with the WHERE clause

The following code sample shows a SQL Query with the correct use of the FROM and WHERE clauses.

select id,
visit_state,
category,
freight_kind,
(select id from argo_complex where gkey= inv_unit.complex_gkey) complex,
seal_nbr1,
trucking_company,
remark FROM inv_unit WHERE id is not null;

SQL Query without the WHERE clause

The following code sample shows a SQL Query with the correct use of the FROM clause without a WHERE clause.

select id,
visit_state,
category,
freight_kind,
(select id from argo_complex where gkey= inv_unit.complex_gkey) complex,
seal_nbr1,
trucking_company,
remark FROM inv_unit
WHERE 1=1;

SQL Query with the WHERE clause and a Parameter

The following code sample shows a SQL Query with the correct use of the WHERE clause and Parameters for
accepting user input.

select unit.id as UnitId,

unit.line_op as Line,
ufv.time_in as FcyTimeIn,
ufv.time_out as FcyTimeOut,
unit.remark as Notes,
gds.bl_nbr as BlNbr,
gnte.gnte_invoice_status as InvoiceStatus,
gnte.invoice_draft_nbr as InvoiceDraftNbr,
gnte.guarantee_amount as GnteAmount,
ibcv.gkey as IbCvId,
gnte.quantity as GnteQty,

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 38
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

gnte.created as GnteTime,
gnte.guarantee_type as GnteType,
gnte.payment_type as PayeeType,
gnte.creator as UserId,
gnte.notes as GnteNotes,
5 as DemurrageAmt,
6 as VacisAmt,
7 as AQIAmt,
8 as OtherAmt,
cue.payee_customer_id as CustId,
"eventId" as EventId
FROM
inv_unit_fcy_visit ufv
LEFT OUTER JOIN inv_unit unit on ufv.gkey = unit.active_ufv
LEFT OUTER JOIN inv_goods gds on unit.goods = gds.gkey
LEFT OUTER JOIN argo_carrier_visit ibcv on ufv.actual_ib_cv =
ibcv.gkey,argo_chargeable_unit_events cue
LEFT OUTER JOIN argo_guarantees gnte on cue.gkey = gnte.applied_to_gkey
WHERE
ufv.fcy_gkey = $P{Facility} and
unit.gkey = cue.unit_gkey
and ufv.gkey = cue.ufv_gkey
and gnte.applied_to_class = 'INV'
and ufv.transit_state in ('S10_ADVISED','S40_YARD')
and gnte.gkey
in (select gnte.gkey from inv_unit_fcy_visit ufv
LEFT OUTER JOIN inv_unit unit on ufv.gkey = unit.active_ufv,
argo_chargeable_unit_events cue
LEFT OUTER JOIN argo_guarantees gnte on cue.gkey = gnte.applied_to_gkey
where unit.gkey = cue.unit_gkey
and ufv.gkey = cue.ufv_gkey
and gnte.applied_to_class = 'INV'
and ufv.transit_state in ('S10_ADVISED','S40_YARD') );
Examples of Invalid SQL Queries

SQL Query with multiple FROM (uppercase) clauses

The following code sample shows a SQL Query with multiple uppercase FROM and WHERE clauses. Each query must
have only one FROM and WHERE clause in uppercase.

select id,
visit_state,
category,
freight_kind,
(select id FROM argo_complex WHERE gkey= inv_unit.complex_gkey) complex,
seal_nbr1,
trucking_company,
remark FROM inv_unit WHERE id is not null;

SQL Query with an uppercase FROM clause with a lowercase where clause
The following code sample shows a SQL Query with an uppercase FROM clause with a lowercase where clause.

select id,
visit_state,
category,
freight_kind,

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 39
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

(select id from argo_complex where gkey= inv_unit.complex_gkey) complex,

seal_nbr1,
trucking_company,
remark FROM inv_unit where id is not null;

SQL Query with a lowercase FROM clause

The following code sample shows a SQL Query with a lowercase from clause in the outer most condition. Therefore,
the Reportable Entity table is not available.

select id,
visit_state,
category,
freight_kind,
(select id from argo_complex where gkey= inv_unit.complex_gkey) complex,
seal_nbr1,
trucking_company,
remark from inv_unit where id is not null;

SQL Query with non-unique table names in the FROM clause

The following code sample shows a SQL Query where the table names are not unique as multiple aliases for the same
table are used in the FROM clause.

select unit1.id,
unit1.visit_state,
unit1.category,
unit1.freight_kind,
(select id from argo_complex where gkey= unit1.complex_gkey) complex,
unit2.seal_nbr1,
unit1.trucking_company,
remark FROM inv_unit unit1, inv_unit unit2 WHERE unit1.id is not null
and uni1.id = unit2.id
and unit2.trucking_company =25;

SQL Query with table name alias in the FROM clause

The following code sample shows a SQL Query where an alias is used in place of the table name in the FROM clause.

select id,
visit_state,
category,
freight_kind,
(select id from argo_complex where gkey= inv_unit.complex_gkey) complex,
seal_nbr1,
trucking_company,
remark FROM N4.inv_unit WHERE id is not null;
Example of a SQL Query with the UNION clause
You can use the FROM (uppercase) clause multiple times in a query with UNION, INTERSECT, or MINUS keywords.
In this case the blocks above and below the keyword are considered as separate queries.

The following SQL query is for the Unit entity and must be scoped twice. In this case, you can use the FROM
(uppercase) clause twice.

SELECT count(distinct hh.id)as TRAIN_COUNT,count(c.id) as RECEIVAL_COUNT,0 as

DELIVERY_COUNT
FROM inv_unit_fcy_visit a
LEFT JOIN inv_unit c

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 40
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

ON c.gkey = a.unit_gkey
LEFT JOIN argo_carrier_visit hh
ON hh.gkey = a.actual_ob_cv
WHERE a.fcy_gkey=189 AND hh.carrier_mode = 'TRAIN'
AND hh.ATD >= TO_TIMESTAMP('2012-05-01','YYYY-MM-DD')
AND hh.ATD < TO_TIMESTAMP('2012-05-17','YYYY-MM-DD')
AND c.CATEGORY ='IMPRT'
AND a.VISIT_STATE != '4RETIRED'
AND hh.phase != '80CANCELED'
UNION
SELECT count(distinct hh.id)as TRAIN_COUNT,0 as RECEIVAL_COUNT,count(c.id) as
DELIVERY_COUNT
FROM inv_unit_fcy_visit a
LEFT JOIN inv_unit c
ON c.gkey = a.unit_gkey
LEFT JOIN argo_carrier_visit hh
ON hh.gkey = a.actual_ib_cv
WHERE hh.carrier_mode = 'TRAIN'
AND hh.ATD >= TO_TIMESTAMP('2012-05-01','YYYY-MM-DD')
AND hh.ATD < TO_TIMESTAMP('2012-05-17','YYYY-MM-DD')
AND c.CATEGORY ='EXPRT'
AND a.VISIT_STATE != '4RETIRED'
AND hh.phase != '80CANCELED'
Advanced SQL Definition
You can use any of the following advanced SQL constraints as long as these constraints are supported by the
database that you are using for your site.

SQL INTERSECT
When you use SQL INTERSECT, you need to use the uppercase FROM and WHERE clauses only once because that
is enough to impose the instance security. While the UNION acts as an OR operator, selecting a value if it appears in
either the first or the second statement, the INTERSECT acts as an AND operator, selecting a value only of it appears
in both the statements.

[select statement1] -- here the FROM and WHERE clause are in caps
INTERSECT
[select statement2]

The INTERSECT keyword can be used with multiple uppercase FROM clauses.

SQL MINUS
The MINUS also operates on two SQL statements. It takes all the results from the first SQL statement and then
removes the ones that are also present in the second SQL statement to get the final result. It ignores any results that
are present in the second SQL statement but not in the first statement.

With the MINUS keyword it is recommended to use the uppercase FROM and WHERE clauses with both the
statements.

[select statement1] -- here the FROM and WHERE clause are in caps
INTERSECT
[select statement2] -- here the FROM and WHERE clause are in caps

If you do not use the uppercase FROM and WHERE clauses with both the statements, instance security me be
applied to only a part of the query and you may get some unexpected results.
Other SQL Conditions

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 41
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Report Definitions view

You can use any of the following SQL conditions in your query. Since these conditions do not affect the query as a
whole, you can use them according to your requirements.

• SQL LIMIT
• SQL TOP
• SQL EXISTS
• SQL CASE
• SQL DECODE
• SQL NULL
• SQL ISNULL
• SQL IFNULL
• SQL NVL
• SQL COALESCE
• SQL NULLIF

Depending on the database that you are using, all of the above functions may not be available to you.

2.1.3.2 Run a report

Operations Reports Report Definitions Report Definitions view Actions Run Report

You can use the Run Report action in the Report Definitions view (on page 28) to generate a report using the
selected report definition.

To generate a report:
1. In the Report Definitions view, select the report definition that defines the data and the layout of the report.
2. Select Actions Run Report.
You can also right-click a report definition and select the Run Report option from the shortcut menu. This opens the
Enter Filter Parameter Values form.
3. Optionally, in the Sort Fields area, you can select up to three Sort fields and the sort order (Ascending/Descending)
for each field.
N4 uses the sort order to determine the order of the records displayed in the report.
If available, N4 automatically fills in values from the report definition. However, any sort values selected here
override the sort values specified in the report definition.
When you run a SQL Query report, N4 does not display the Sort Fields area.

In addition, if you run the report from within the Report Definition form (on page 30), N4 does not display the
Sort Fields area. It uses the sort values specified in the report definition.

4. If the selected report definition or the associated report design has filter parameters, enter or select those values.
5. Optionally, from the Report Output drop-down list, select a different report output format.
The Report Output drop-down list displays the default Output Type (on page 30) selected for the report definition.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 42
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Views
Reporting Entities view

6. Click OK.
N4 generates the report and displays it in the selected Report Output format.

To cancel a report while it is generating, first click OK to close the Report Information form and then, in the
Enter Filter Parameter Values form, click Cancel.
If the report does not return any rows, N4 creates and displays an empty report.

2.1.3.3 Duplicate a report definition

Operations Reports Report Definitions Report Definitions view Actions Duplicate Report Def

You can use the Duplicate Report Def action in the Report Definitions view (on page 28) to duplicate an existing
report definition.

For example, you want to create a new report definition that uses the same report design and filter as an existing report
definition but differs in the sort order. Instead of creating a new report definition, you can quickly duplicate the existing
report definition and change the sort order.

To duplicate a report definition:

1. In the Report Definitions view, select the report definition you want to duplicate.
2. Select Actions Duplicate Report Def.

3. Click to view the duplicate report definition.

▪ The duplicate report definition is named by appending the words "Copy n", where 'n' is a numerical digit
representing the number of the copy, to the name of the original report definition.
▪ To rename the duplicate report definition, double-click the duplicate report definition in the list view.

You can also select the duplicate report definition and click .

2.1.4 Reporting Entities view

Configuration Reports Reporting Entities Reporting Entities view

Prerequisites
• Some built-in reporting entities are only available with Monitor and Analytics license.

The Reporting Entities view displays all built-in and custom reporting entities that exist in the system

When creating report designs (on page 18) and report definitions (on page 28), you specify which reporting entity you
want to use. The reporting entity determines which fields you can use in the report design and which fields appear in
the sort and filter lists of the report definition.

If none of the existing reporting entities provides the right combination of fields you would like to use in your report
design or definition, you can create a new reporting entity, or you can edit an existing reporting entity by adding custom
fields.

Reporting entities also support dynamic entities and dynamic fields, enabling you to create a report that includes
dynamic fields or is based on a dynamic entity.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 43
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Reporting Entities view

From this view, you can:

• View built-in reporting entities.

• Add custom fields to built-in reporting entities.
• Create and edit custom reporting entities.
• Delete custom reporting entities
You cannot delete built-in reporting entities. You also cannot delete custom reporting entities that are used in at least
one report design.
In addition, you can:

• Use the Actions menu to:

▪ Export SNX File: Export reporting entities as an SNX file.
▪ Publish Reporting Entities: Publish reporting entities to make your changes take effect. This is how they
become available in report designs and report definitions. Propagate the changes to one or all nodes.
N4 prompts you to select whether to apply the changes to the current node or all nodes. Select Only update
local node (default) if you want to test the changes locally before propagating the changes to all nodes. Select
Propagate changes to all nodes if you are ready to distribute the changes to all nodes in the cluster.
• Right-click an entity and select Show Diagnostics. This opens a view-only form that lists all reporting fields for the
selected entity.
The Reporting Entities (on page 48) section also provides detailed information on all available built-in entities.
The following table clarifies which privileges you need for this view and the available actions.

Task Required Privilege

Open the Reporting Entities view Configurable Reporting Entities - View
Publish Reporting Entities Configurable Reporting Entities - Add
Configurable Reporting Entities - Edit
Configurable Reporting Entities - Delete
Show Diagnostics Configurable Reporting Entities - View

To add a new record:

Click .

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

Reporting Entities columns

Short Label Long Label In Filter? Sorting?
Base Entity Query Base Entity X X

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 44
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Reporting Entities view

Short Label Long Label In Filter? Sorting?

Changed Changed Date X X
Changer Changed User X X
Created Created Date X X
Creator Created User X X
Display Name Display Name X X
Entity Desc Entity Description X X
Entity Name Entity Name X X
Is BuiltIn Is BuiltIn X X
Is Enabled Is Enabled X X
Joined Entity Joined Entity X X
Joined Entity Path Joined Entity Path X X
Joined Entity Prefix Joined Entity Prefix X X

2.1.4.1 Reporting Entity form

Configuration Reports Reporting Entities Reporting Entities view Reporting Entity form

The Reporting Entity form lets you add a new reporting entity, edit the properties of an existing custom reporting
entity, and add or edit fields. You can also join the query base entity with another database table, provided the base
entity references the joined entity.

In this form:

• The Configured Fields tab lists the reporting fields of built-in reporting entities. This tab is view-only. You cannot
edit these fields.
• The Custom Fields tab lists any custom fields added to a reporting entity. You use this tab to add, edit, or delete a
custom field.
The following table clarifies which privileges you need for this form.

Task Required Privilege

View the properties of a built-in reporting entity Configurable Reporting Entities - Add
Add a new reporting entity Configurable Reporting Entities - Add
Edit the properties of a custom reporting entity Configurable Reporting Entities - Edit
Delete a custom reporting entity Configurable Reporting Entities - Delete

To add or edit the properties of a reporting entity:

1. From the Query Base Entity lookup field, select the N4 database table on which you want to base this reporting
entity.
2. In the Entity Name lookup field, enter a unique name for the reporting entity. Green font indicates that the name is
unique and valid. Red indicates that the name is invalid; in this case, pick a different name.
3. In the Display Name field, enter a unique label for the reporting entity.
4. If you do not want this reporting entity to appear in the Reporting Entity drop-down list in the Report Design (on

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 45
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Reporting Entities view

page 19) and Report Definition (on page 30) forms, clear the Is Enabled check box. By default, this check box is
selected.
5. To join the query base entity with another database table, from the Joined Entity Fields tree, select a database
table. To expand a node (folder icon), double-click it, and then select a table (page icon).
Selecting a field automatically fills in the Joined Entity, Joined Entity Prefix, and Joined Entity Path information.
6. In the Entity Description field, enter a concise description of the entity.
7. Click Save to save the new reporting entity and enable the Configured Fields (on page 46) and Custom Fields (on
page 46) tabs.
8. On the Custom Fields tab, add fields. (on page 46)

Notes
• You can change, but not save, the query base entity of an existing reporting entity if this entity already includes
custom fields. You need to delete the custom fields before you can save the reporting entity with an updated Query
Base Entity field.
• Both entity names and display names must be unique. Otherwise, N4 displays an error message.

Configured Fields tab

Configuration Reports Reporting Entities Reporting Entities view Reporting Entity form Configured Fields tab

The Configured Fields tab lists the reporting fields of built-in reporting entities. This tab is view-only. You cannot edit
these fields. When you select a configured field and click , the Edit Reporting Config Fields form opens in view-
only mode.

However, you can refresh the data on this tab and perform quick search.

Reporting Config Fields form

Configuration Reports Reporting Entities Reporting Entities view Reporting Entity form Configured Fields tab Reporting
Config Fields form

The Reporting Config Fields form displays the properties of the configured field you selected. Configured fields are
built-in fields that you cannot edit. This form is view-only.

Custom Fields tab

Configuration Reports Reporting Entities Reporting Entities view Reporting Entity form Custom Fields tab

The Custom Fields tab lists any custom fields added to a reporting entity. You use this tab to add, edit, or delete a
custom field.

To add a new record:

Click .

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 46
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Views
Reporting Entities view

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

Reporting Custom Fields form

Configuration Reports Reporting Entities Reporting Entities view Reporting Entity form Custom Fields tab Reporting
Custom Fields form

You use the Reporting Custom Fields form to add a new field to the reporting entity or to edit an existing custom field.

A field is based on a metafield, which can be a database-backed field or a synthetic (calculated) field. N4 makes all
metafields that are database fields available for sorting.

A metafield must be unique within a reporting entity. You cannot use it for more than one field for the same reporting
entity.

To add or edit a custom field:

1. In the External Tag field, enter a unique name for the field.
2. From the Fields tree at the bottom, select a field. To expand a node (folder icon), double-click it, and then select a
field (page icon). N4 only lists fields still available for this reporting entity. Each field is labeled as either database-
backed or synthetic (calculated).
Selecting a field automatically fills in the Metafield Id field at the top of the form and finds and persists the class
type, provided the field is valid. You can view class type information in the Class Type column on the Custom
Fields tab (on page 46).
3. Select or clear any of the following check boxes, as required:
▪ Can Use In Design: Select to be able to use this field in the report design.
▪ Use Descriptive Version: Select to display the description of Enum.
Generally, reports display the Enum code, such as I, instead of the description, such as Import, for the IMPORT
category Enum.
▪ Is Enabled: Select to be able to use this field for sorting and filtering in the respective report design and definition.
By default, this check box is selected.
4. In the Field Description field, enter a concise description of the field.
5. Click Save to save your changes and close the form.

Notes
• Expandable nodes are reference entities, not metafields.
• If you select a field in the tree but overwrite the string in the Metafield Id field, N4 displays an error when you try to
save the field.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 47
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Reporting Entities view

2.2 Reporting Entities

The reporting entities represent the entities in N4 that you can use for reporting. Each reporting entity has a set of fields that you can use in report designs to
display appropriate data.

Each field in a reporting entity is associated with an External Tag that you can use in a report design to display data. In a report design, you must type the
External Tag exactly as displayed in this online help.

The various reportable entities in N4 are categorized as follows based on the module that they refer to:

• Cargo
▪ Bill of Lading (on page 50)
▪ Bill of Lading - Item (on page 59)
▪ Cargo Lot (on page 66)
• EDI
▪ EDI Session (on page 83)
• Inventory (Unit)
▪ Equipment (on page 84)
▪ Reefer Record (on page 88)
▪ Unit (on page 89)
▪ Unit - Complex Visit (on page 123)
▪ Unit - Damages (on page 153)
▪ Unit - Hazards (on page 183)
▪ Unit - Hazards and Train Visit (on page 215)
▪ Unit - Holds/Permissions (on page 219)
▪ Unit - Move Event (on page 222)
▪ Vessel Exchange Instructions (on page 258)
• Monitor
▪ CHE Move Statistics (on page 273)
▪ CHE Trip Statistics (on page 281)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 48
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Reporting Entities view

▪ Equipment Block Visit (on page 283)

▪ Yard Block Statistics (on page 284)
• Orders (Booking/EDO/ELO)
▪ Booking (on page 286)
▪ Booking Item (on page 291)
▪ Empty Loadout Order (ELO) (on page 300)
▪ Equipment Delivery Order (EDO) (on page 302)
▪ Rail Order (on page 304)
▪ Service Order (on page 307)
▪ Service Order Item (on page 309)
▪ Service Types (on page 310)
▪ Item Service Type Unit (on page 311)
▪ Carrier Visit Service Order (on page 313)
▪ Carrier Visit Service Type (on page 314)
• Rail
▪ Railcar Visit (on page 314)
▪ Train Visit (on page 323)
▪ UFV Arrived on Railcar Visit (on page 327)
▪ UFV on Railcar Visit (on page 335)
• Road (Gate)
▪ Appointments (on page 344)
▪ Truck Transaction Stage (on page 351)
▪ Truck Visit Details (on page 376)
▪ Truck Visit Stage and Transaction (on page 380)
▪ Truck Visit Stages (on page 405)
▪ Truck Visit Statistics (on page 410)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 49
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Bill of Lading

• Services
▪ Event (on page 413)
• Vessel
▪ Line DischargeList (on page 416)
▪ Line LoadList (on page 425)
▪ Vessel Crane Statistics (on page 434)
▪ Vessel Crane Statistics - Delays (on page 442)
▪ Vessel Visit (on page 450)

2.2.1 Bill of Lading

The Bill of Lading reporting entity includes information about the bills of lading associated with the units in N4. You can use this reporting entity to generate
reports with Bill of Lading information.

External Tag Long Label Short Label Description Type In Design In Sort
BlBondedDestination Bonded Destination Bond Dest The bonded java.lang.String Yes Yes
Id destination of the
cargo
BlCategory BL Category BL Category Legal category of java.lang.String Yes Yes
shipment: Import,
Export, Transship,
Domestic, Storage,
Through
BlChanged Record Changed Changed The date the Bill of java.util.Date Yes Yes
Date Lading was last
changed
BlChanger Record Changed Changer The user who last java.lang.String Yes Yes
User changed the Bill of
Lading
BlCommodityDescrip Commodity Short Cmdy Short Name description for the java.lang.String Yes No
tion Name commodity
BlCommodityId Commodity ID Id The unique identifier java.lang.String Yes Yes
of commodity

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 50
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlComplexId Complex Complex Complex Id java.lang.String Yes Yes
BlComplexName Complex Name Cpx Name Complex Name java.lang.String Yes Yes
BlConsigneeId Id Id Party Id that will java.lang.String Yes Yes
receive the cargo
BlConsigneeName Name Name Party Name that will java.lang.String Yes Yes
receive the cargo
BlContainerIsoGroup ISO Group ISO Grp The iso group of the java.lang.String Yes Yes
container defined in
the appointment (e.g.
'General purpose
container without
ventilation', 'Self-
powered
refrigerated/heated',
'Dry bulk container,
pressurized', etc..
BlCreated Record Create Date Created The date the Bill of java.util.Date Yes Yes
Lading was created
BlCreator Record Create User Creator The user who java.lang.String Yes Yes
created the Bill of
Lading
BlDeclaredIbCarrierI Visit Ref Visit The declared/ java.lang.String Yes Yes
d documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
BlDeclaredObCarrier Visit Ref Visit The declared java.lang.String Yes Yes
Id outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
BlDestination Destination Dest The final destination java.lang.String Yes Yes
of the cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 51
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlEquipmentTypeHei Height Height The equipment java.lang.Long Yes Yes
ghtMm height in millimeters
BlEquipmentTypeId ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
BlEquipmentTypeLe Length Length The equipment java.lang.Long Yes Yes
ngthMm length in millimeters
BlEquipmentTypeWi Width Width The equipment width java.lang.Long Yes Yes
dthMm in millimeters
BlFlexDate01 BLFlexDate01 BLFlexDate01 The flex field of the java.util.Date Yes Yes
Bl with name:
BlFlexDate01.
BlFlexDate02 BLFlexDate02 BLFlexDate02 The flex field of the java.util.Date Yes Yes
Bl with name:
BlFlexDate02.
BlFlexDate03 BLFlexDate03 BLFlexDate03 The flex field of the java.util.Date Yes Yes
Bl with name:
BlFlexDate03.
BlFlexDate04 BLFlexDate04 BLFlexDate04 The flex field of the java.util.Date Yes Yes
Bl with name:
BlFlexDate04.
BlFlexDate05 BLFlexDate05 BLFlexDate05 The flex field of the java.util.Date Yes Yes
Bl with name:
BlFlexDate05.
BlFlexDouble01 BLFlexDouble01 BLFlexDouble01 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble01.
BlFlexDouble02 BLFlexDouble02 BLFlexDouble02 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble02.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 52
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlFlexDouble03 BLFlexDouble03 BLFlexDouble03 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble03.
BlFlexDouble04 BLFlexDouble04 BLFlexDouble04 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble04.
BlFlexDouble05 BLFlexDouble05 BLFlexDouble05 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble05.
BlFlexDouble06 BLFlexDouble06 BLFlexDouble06 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble06.
BlFlexDouble07 BLFlexDouble07 BLFlexDouble07 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble07.
BlFlexDouble08 BLFlexDouble08 BLFlexDouble08 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble08.
BlFlexDouble09 BLFlexDouble09 BLFlexDouble09 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble09.
BlFlexDouble10 BLFlexDouble10 BLFlexDouble10 The flex field of the java.lang.Double Yes Yes
bl with name:
BlFlexDouble10.
BlFlexLong01 BLFlexLong01 BLFlexLong01 The flex field of the java.lang.Long Yes Yes
bl with name:
BlFlexLong01.
BlFlexLong02 BLFlexLong02 BLFlexLong02 The flex field of the java.lang.Long Yes Yes
bl with name:
BlFlexLong02.
BlFlexLong03 BLFlexLong03 BLFlexLong03 The flex field of the java.lang.Long Yes Yes
bl with name:
BlFlexLong03.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 53
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlFlexLong04 BLFlexLong04 BLFlexLong04 The flex field of the java.lang.Long Yes Yes
bl with name:
BlFlexLong04.
BlFlexLong05 BLFlexLong05 BLFlexLong05 The flex field of the java.lang.Long Yes Yes
bl with name:
BlFlexLong05.
BlFlexString01 BLFlexString01 BLFlexString01 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString01.
BlFlexString02 BLFlexString02 BLFlexString02 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString02.
BlFlexString03 BLFlexString03 BLFlexString03 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString03.
BlFlexString04 BLFlexString04 BLFlexString04 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString04.
BlFlexString05 BLFlexString05 BLFlexString05 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString05.
BlFlexString06 BLFlexString06 BLFlexString06 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString06.
BlFlexString07 BLFlexString07 BLFlexString07 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString07.
BlFlexString08 BLFlexString08 BLFlexString08 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString08.
BlFlexString09 BLFlexString09 BLFlexString09 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString09.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 54
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlFlexString10 BLFlexString10 BLFlexString10 The flex field of the java.lang.String Yes Yes
bl with name:
BlFlexString10.
BlFreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
BlGrossWeightKgVal Gross Weight Weight The gross weight of java.lang.Double Yes Yes
ue the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
BlIsUnitDamaged Is Unit Damaged java.lang.Boolean Yes No
BlItemCommodityDe description for the java.lang.String Yes No
sc commodity in BL
items
BlLineOperatorId Id Id The line operator java.lang.String Yes Yes
Id(shipping line)
responsible for this
Bill of Lading
BlLineOperatorName Name Name The line operator java.lang.String Yes Yes
Name(shipping line)
responsible for this
Bill of Lading
BlManifestedQty Manifested Quantity Manifested The total number of java.lang.Double Yes Yes
packages manifested
(according to
CUSTOMS)
BlNbr BL Number BL Nbr Bill of Lading number java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 55
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlNotes Notes Notes Miscellaneous notes java.lang.String Yes Yes
about the cargo
BlOrigin Origin Origin Inland location where java.lang.String Yes Yes
cargo originated
BlPod1Id Point ID ID The first port of java.lang.String Yes Yes
discharge Id
BlPod2Id Point ID ID The second port of java.lang.String Yes Yes
discharge Id
BlPolId Point ID ID The port Id at which java.lang.String Yes Yes
the cargo will be
loaded to the vessel
BlShipperId Id Id Party Id that shipped java.lang.String Yes Yes
the cargo
BlShipperName Name Name Party Name that java.lang.String Yes Yes
shipped the cargo
BlTruckingCompanyI Id Id The trucking java.lang.String Yes Yes
d company Id
responsible for this
Bill of Lading
BlTruckingCompany Name Name The line operator java.lang.String Yes Yes
Name Name(shipping line)
responsible for this
Bill of Lading
BlUnitActiveImpedim Active Holds and java.lang.String Yes No
ents Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 56
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlUnitArrivalPosition Position Position The complete name java.lang.String Yes Yes
Full of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
BlUnitArrivalPosition Location Id LocId The arrival location java.lang.String Yes Yes
LocId ID: Carrier visit ID.
BlUnitArrivalPosition Position Type Type The arrival location java.lang.String Yes Yes
LocType type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
BlUnitArrivalPosition Slot Slot The arrival slot java.lang.String Yes Yes
Slot position ID.
BlUnitHoldsAndPerm Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
issions Permissions granted permissions
attached to the unit.
BlUnitId Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.
BlUnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 57
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading

External Tag Long Label Short Label Description Type In Design In Sort
BlUnitNonActiveImpe Released Holds and java.lang.String Yes No
diments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By , Applied On
Date, Updated by
and Updated On
BlUnitPositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
BlUnitPositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
BlUnitPositionLocTyp Position Type Type The last registered java.lang.String Yes Yes
e location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
BlUnitPositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
BlUnitServiceEventT return all service java.lang.String Yes No
ype event type used in
unit Separated with
comma.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 58
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlUnitServiceRuleNa return all service rule java.lang.String Yes No
me name used in unit
Separated with
comma.
BlUnitTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
BlUnitVisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
BlVesselId Visit Ref Visit Vessel voyage call java.lang.String Yes Yes
for this Bill of Lading
-Id
BlVesselName Carrier Name Carrier Name Vessel voyage call java.lang.String Yes No
for this Bill of Lading
-Name
blAgentId Id Id Agent id java.lang.String Yes Yes

2.2.2 Bill of Lading - Item

The Bill of Lading - Item reporting entity includes information about the bill of lading items associated with a bill of lading. You can use this reporting entity to
generate reports with Bill of Lading Item information.

External Tag Long Label Short Label Description Type In Design In Sort
BlItemBlAgentName Name Name Agent Name java.lang.String Yes Yes
BlItemBlBondedDesti Bonded Destination Bond Dest The bonded java.lang.String Yes Yes
nation destination of the
cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 59
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemBlCategory BL Category BL Category Legal category of java.lang.String Yes Yes
shipment: Import,
Export, Transship,
Domestic, Storage,
Through
BlItemBlComplexId Complex Complex Complex Id java.lang.String Yes Yes
BlItemBlComplexNa Complex Name Cpx Name Complex Name java.lang.String Yes Yes
me
BlItemBlConsigneeId Id Id Party Id that will java.lang.String Yes Yes
receive the cargo
BlItemBlConsigneeN Name Name Party Name that will java.lang.String Yes Yes
ame receive the cargo
BlItemBlDestination Destination Dest The final destination java.lang.String Yes Yes
of the cargo
BlItemBlLineOperato Id Id The line operator java.lang.String Yes Yes
rId Id(shipping line)
responsible for the
Bill of Lading
BlItemBlLineOperato Name Name The line operator java.lang.String Yes Yes
rName Name(shipping line)
responsible for the
Bill of Lading
BlItemBlNbr BL Number BL Nbr Bill of Lading number java.lang.String Yes Yes
BlItemBlOrigin Origin Origin Inland location where java.lang.String Yes Yes
cargo originated
BlItemBlPod1 Point ID ID The first port of java.lang.String Yes Yes
discharge Id
BlItemBlPod2 Point ID ID The second port of java.lang.String Yes Yes
discharge Id
BlItemBlPol Point ID ID The port Id at which java.lang.String Yes Yes
the cargo will be
loaded to the vessel
BlItemBlShipperId Id Id Party Id that shipped java.lang.String Yes Yes
the cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 60
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemBlShipperNam Name Name Party Name that java.lang.String Yes Yes
e shipped the cargo
BlItemBlVesselId Visit Ref Visit Vessel voyage call java.lang.String Yes Yes
for this Bill of Lading
-Id
BlItemBlVesselName Carrier Name Carrier Name Vessel voyage call java.lang.String Yes No
for this Bill of Lading
-Name
BlItemBulkUnit Bulk Units Units The bulk units of java.lang.String Yes Yes
measure(e.g. tons)
BlItemChanged Record Changed Changed The date the item java.util.Date Yes Yes
Date was last changed
BlItemChanger Record Changed Changer The user who last java.lang.String Yes Yes
User changed the item
BlItemCommodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
BlItemCommodityDe Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
scription Name description for the
contents of a unit.
BlItemCreated Record Create Date Created The date the item java.util.Date Yes Yes
was created
BlItemCreator Record Create User Creator The user who java.lang.String Yes Yes
created the item
BlItemFlexDate01 FlexDate-01 FlexDate-01 The flex field of the java.util.Date Yes Yes
Bl Item with name:
BlItemFlexDate01.
BlItemFlexDate02 FlexDate-02 FlexDate-02 The flex field of the java.util.Date Yes Yes
Bl Item with name:
BlItemFlexDate02.
BlItemFlexDate03 FlexDate-03 FlexDate-03 The flex field of the java.util.Date Yes Yes
Bl Item with name:
BlItemFlexDate03.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 61
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemFlexDate04 FlexDate-04 FlexDate-04 The flex field of the java.util.Date Yes Yes
Bl Item with name:
BlItemFlexDate04.
BlItemFlexDate05 FlexDate-05 FlexDate-05 The flex field of the java.util.Date Yes Yes
Bl Item with name:
BlItemFlexDate05.
BlItemFlexDouble01 FlexDouble-01 FlexDouble-01 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble01.
BlItemFlexDouble02 FlexDouble-02 FlexDouble-02 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble02.
BlItemFlexDouble03 FlexDouble-03 FlexDouble-03 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble03.
BlItemFlexDouble04 FlexDouble-04 FlexDouble-04 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble04.
BlItemFlexDouble05 FlexDouble-05 FlexDouble-05 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble05.
BlItemFlexDouble06 FlexDouble-06 FlexDouble-06 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble06.
BlItemFlexDouble07 FlexDouble-07 FlexDouble-07 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble07.
BlItemFlexDouble08 FlexDouble-08 FlexDouble-08 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble08.
BlItemFlexDouble09 FlexDouble-09 FlexDouble-09 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble09.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 62
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemFlexDouble10 FlexDouble-10 FlexDouble-10 The flex field of the java.lang.Double Yes Yes
Bl Item with name:
BlitemFlexDouble10.
BlItemFlexLong01 FlexLong-01 FlexLong-01 The flex field of the java.lang.Long Yes Yes
Bl Item with name:
BlitemFlexLong01.
BlItemFlexLong02 FlexLong-02 FlexLong-02 The flex field of the java.lang.Long Yes Yes
Bl Item with name:
BlitemFlexLong02.
BlItemFlexLong03 FlexLong-03 FlexLong-03 The flex field of the java.lang.Long Yes Yes
Bl Item with name:
BlitemFlexLong03.
BlItemFlexLong04 FlexLong-04 FlexLong-04 The flex field of the java.lang.Long Yes Yes
Bl Item with name:
BlitemFlexLong04.
BlItemFlexLong05 FlexLong-05 FlexLong-05 The flex field of the java.lang.Long Yes Yes
Bl Item with name:
BlitemFlexLong05.
BlItemFlexString01 FlexString-01 FlexString-01 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString01.
BlItemFlexString02 FlexString-02 FlexString-02 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString02.
BlItemFlexString03 FlexString-03 FlexString-03 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString03.
BlItemFlexString04 FlexString-04 FlexString-04 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString04.
BlItemFlexString05 FlexString-05 FlexString-05 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 63
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemFlexString06 FlexString-06 FlexString-06 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString06.
BlItemFlexString07 FlexString-07 FlexString-07 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString07.
BlItemFlexString08 FlexString-08 FlexString-08 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString08.
BlItemFlexString09 FlexString-09 FlexString-09 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString09.
BlItemFlexString10 FlexString-10 FlexString-10 The flex field of the java.lang.String Yes Yes
Bl Item with name:
BlitemFlexString10.
BlItemIsBulk Bulk Bulk Item is BULK cargo java.lang.Boolean Yes Yes
(i.e. tracked by
measurement)
BlItemNbr Item Number Item Nbr Bill of Lading Item java.lang.String Yes Yes
number
BlItemPackageHeigh Package Height Package Height The height of each java.lang.Double Yes Yes
tCm package in
centimeters
BlItemPackageLengt Package Length Package Length The length of each java.lang.Double Yes Yes
hCm package in
centimeters
BlItemPackageWeig Package Weight Package Weight The Weight of each java.lang.Double Yes Yes
htKg package in kilograms
BlItemPackageWidth Package Width Package Width The width of each java.lang.Double Yes Yes
Cm package in
centimeters
BlItemPackagetype Id Id A code identifying java.lang.String Yes Yes
the package type

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 64
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Bill of Lading - Item

External Tag Long Label Short Label Description Type In Design In Sort
BlItemPackagetypeD Description Desc Description of the java.lang.String Yes Yes
esc package type
BlItemPackagetypeU UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
ccCode standard package
type encoding
(0=carton,
1=pallet,etc.)
BlItemPieceBulkUnit Piece Bulk Units Units The bulk units of java.lang.String Yes Yes
measure(e.g. tons)
inside each package
BlItemPieceHeightC Piece Height Piece Height The Height of each java.lang.Double Yes Yes
m piece in a package in
centimeters
BlItemPieceIsBulk Bulk Package Bulk Package Item is BULK cargo java.lang.Boolean Yes Yes
inside each package
BlItemPieceLengthC Piece Length Piece Length The length of each java.lang.Double Yes Yes
m piece in a package in
centimeters
BlItemPiecePackage Id Id The type of java.lang.String Yes Yes
type packages (e.g.
pallets) for pieces in
a package
BlItemPiecePackage Description Desc Description of the java.lang.String Yes Yes
typeDesc package type for
pieces in a package
BlItemPiecePackage UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
typeUccCode standard package
type encoding
(0=carton,
1=pallet,etc.) for
pieces in a package

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 65
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
BlItemPieceQuantity Piece Quantity Piece Qty The number of java.lang.Double Yes Yes
pieces inside each
packages or bulk
units or
measurement.
BlItemPieceWeightK Piece Weight Piece Weight The Weight of each java.lang.Double Yes Yes
g piece inside the
package in kilograms
BlItemPieceWidthCm Piece Width Piece Width The width of each java.lang.Double Yes Yes
piece in a package in
centimeters
BlItemQuantity Item Quantity Item Qty The number of java.lang.Double Yes Yes
packages or bulk
units or
measurement
BlItemblAgentId Id Id Agent id java.lang.String Yes Yes

2.2.3 Cargo Lot

The Cargo Lot reporting entity includes information about the cargo lots and the associated bill of ladings and BL Items.

External Tag Long Label Short Label Description Type In Design In Sort
LotBrand Brand Brand Brand name of the java.lang.String Yes Yes
lot
LotChanged Record Changed Changed The date the lot was java.util.Date Yes Yes
Date last changed
LotChanger Record Changed Changer The user who last java.lang.String Yes Yes
User changed the lot
LotColor Color Color Color of the lot java.lang.String Yes Yes
LotCreated Record Create Date Created The date the lot was java.util.Date Yes Yes
created
LotCreator Record Create User Creator The user who java.lang.String Yes Yes
created the lot

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 66
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotDamageSeverity Lot Damage Severity Damage Severity Cargo Lot Damage java.lang.String Yes Yes
Severity
LotExportReleaseAli Export Release Alias Export Release Alias Export Release java.lang.String Yes Yes
asId Id Id identifier - additional
information to
identify the release
information
LotExportReleaseNb Export Release Nbr Export Rel Nbr Export Release java.lang.String Yes Yes
r Number
LotFlexDate01 FlexDate-01 FlexDate-01 The flex field of the java.util.Date Yes Yes
Cargo Lot with
name:
LotFlexDate01.
LotFlexDate02 FlexDate-02 FlexDate-02 The flex field of the java.util.Date Yes Yes
Cargo Lot with
name:
LotFlexDate02.
LotFlexDate03 FlexDate-03 FlexDate-03 The flex field of the java.util.Date Yes Yes
Cargo Lot with
name:
LotFlexDate03.
LotFlexDate04 FlexDate-04 FlexDate-04 The flex field of the java.util.Date Yes Yes
Cargo Lot with
name:
LotFlexDate04.
LotFlexDate05 FlexDate-05 FlexDate-05 The flex field of the java.util.Date Yes Yes
Cargo Lot with
name:
LotFlexDate05.
LotFlexDouble01 FlexDouble-01 FlexDouble-01 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble01.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 67
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotFlexDouble02 FlexDouble-02 FlexDouble-02 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble02.
LotFlexDouble03 FlexDouble-03 FlexDouble-03 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble03.
LotFlexDouble04 FlexDouble-04 FlexDouble-04 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble04.
LotFlexDouble05 FlexDouble-05 FlexDouble-05 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble05.
LotFlexDouble06 FlexDouble-06 FlexDouble-06 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble06.
LotFlexDouble07 FlexDouble-07 FlexDouble-07 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble07.
LotFlexDouble08 FlexDouble-08 FlexDouble-08 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble08.
LotFlexDouble09 FlexDouble-09 FlexDouble-09 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble09.
LotFlexDouble10 FlexDouble-10 FlexDouble-10 The flex field of the java.lang.Double Yes Yes
Cargo Lot with
name:
LotFlexDouble10.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 68
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotFlexLong01 FlexLong-01 FlexLong-01 The flex field of the java.lang.Long Yes Yes
Cargo Lot with
name:
LotFlexLong01.
LotFlexLong02 FlexLong-02 FlexLong-02 The flex field of the java.lang.Long Yes Yes
Cargo Lot with
name:
LotFlexLong02.
LotFlexLong03 FlexLong-03 FlexLong-03 The flex field of the java.lang.Long Yes Yes
Cargo Lot with
name:
LotFlexLong03.
LotFlexLong04 FlexLong-04 FlexLong-04 The flex field of the java.lang.Long Yes Yes
Cargo Lot with
name:
LotFlexLong04.
LotFlexLong05 FlexLong-05 FlexLong-05 The flex field of the java.lang.Long Yes Yes
Cargo Lot with
name:
LotFlexLong05.
LotFlexString01 FlexString-01 FlexString-01 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString01.
LotFlexString02 FlexString-02 FlexString-02 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString02.
LotFlexString03 FlexString-03 FlexString-03 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString03.
LotFlexString04 FlexString-04 FlexString-04 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 69
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotFlexString05 FlexString-05 FlexString-05 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString05.
LotFlexString06 FlexString-06 FlexString-06 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString06.
LotFlexString07 FlexString-07 FlexString-07 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString07.
LotFlexString08 FlexString-08 FlexString-08 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString08.
LotFlexString09 FlexString-09 FlexString-09 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString09.
LotFlexString10 FlexString-10 FlexString-10 The flex field of the java.lang.String Yes Yes
Cargo Lot with
name:
LotFlexString10.
LotGoodsUnitNbr Unit Nbr Unit Nbr Goods Unit Number java.lang.String Yes Yes
LotGoodsUnitPositio Position Position The complete name java.lang.String Yes Yes
nFull of the position,
'(Type)-(Carrier or
Yard)- (Slot)'.
LotGoodsUnitPositio Location Id LocId The goods unit java.lang.String Yes Yes
nLocId location ID: Carrier
visit ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 70
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotGoodsUnitPositio Position Type Type The goods unit java.lang.String Yes Yes
nLocType location type: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
LotGoodsUnitPositio Slot Slot The goods unit slot java.lang.String Yes Yes
nSlot position ID.
LotId Cargo Lot Id Id Identifier for this java.lang.String Yes Yes
piece of cargo
LotInboundBlItemBlA Name Name Agent Name java.lang.String Yes Yes
gentName
LotInboundBlItemBlB Bonded Destination Bond Dest The bonded java.lang.String Yes Yes
ondedDestination destination of the
cargo
LotInboundBlItemBlC BL Category BL Category Legal category of java.lang.String Yes Yes
ategory shipment: Import,
Export, Transship,
Domestic, Storage,
Through
LotInboundBlItemBlC Complex Complex Complex Id java.lang.String Yes Yes
omplexId
LotInboundBlItemBlC Complex Name Cpx Name Complex Name java.lang.String Yes Yes
omplexName
LotInboundBlItemBlC Id Id Party Id that will java.lang.String Yes Yes
onsigneeId receive the cargo
LotInboundBlItemBlC Name Name Party Name that will java.lang.String Yes Yes
onsigneeName receive the cargo
LotInboundBlItemBlD Destination Dest The final destination java.lang.String Yes Yes
estination of the cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 71
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotInboundBlItemBlL Id Id The line operator java.lang.String Yes Yes
ineOperatorId Id(shipping line)
responsible for the
Bill of Lading
LotInboundBlItemBlL Name Name The line operator java.lang.String Yes Yes
ineOperatorName Name(shipping line)
responsible for the
Bill of Lading
LotInboundBlItemBlN BL Number BL Nbr Bill of Lading number java.lang.String Yes Yes
br
LotInboundBlItemBl Origin Origin Inland location where java.lang.String Yes Yes
Origin cargo originated
LotInboundBlItemBlP Point ID ID The first port of java.lang.String Yes Yes
od1 discharge Id
LotInboundBlItemBlP Point ID ID The second port of java.lang.String Yes Yes
od2 discharge Id
LotInboundBlItemBlP Point ID ID The port Id at which java.lang.String Yes Yes
ol the cargo will be
loaded to the vessel
LotInboundBlItemBlS Id Id Party Id that shipped java.lang.String Yes Yes
hipperId the cargo
LotInboundBlItemBlS Name Name Party Name that java.lang.String Yes Yes
hipperName shipped the cargo
LotInboundBlItemBlV Visit Ref Visit Vessel voyage call java.lang.String Yes Yes
esselId for this Bill of Lading
-Id
LotInboundBlItemBlV Carrier Name Carrier Name Vessel voyage call java.lang.String Yes No
esselName for this Bill of Lading
-Name
LotInboundBlItemBul Bulk Units Units The bulk units of java.lang.String Yes Yes
kUnit measure(e.g. tons)
LotInboundBlItemCh Record Changed Changed The date the item java.util.Date Yes Yes
anged Date was last changed

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 72
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotInboundBlItemCh Record Changed Changer The user who last java.lang.String Yes Yes
anger User changed the item
LotInboundBlItemCo Commodity ID Id The commodity ID java.lang.String Yes Yes
mmodity for the contents of a
unit.
LotInboundBlItemCo Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
mmodityDescription Name description for the
contents of a unit.
LotInboundBlItemCre Record Create Date Created The date the item java.util.Date Yes Yes
ated was created
LotInboundBlItemCre Record Create User Creator The user who java.lang.String Yes Yes
ator created the item
LotInboundBlItemCu Customer Order Cust. Ord. Nbr. BL Item customer java.lang.String Yes Yes
stomerOrderNbr Number order number
LotInboundBlItemCu Customer Product Cust. Prod. Nbr. BL Item customer java.lang.String Yes Yes
stomerProductNbr Number product number
LotInboundBlItemIsB Bulk Bulk Item is BULK cargo java.lang.Boolean Yes Yes
ulk (i.e. tracked by
measurement)
LotInboundBlItemMa Marks and Numbers Marks Marks and Numbers java.lang.String Yes Yes
rksAndNumbers stenciled on each
package
LotInboundBlItemNbr Item Number Item Nbr Bill of Lading Item java.lang.String Yes Yes
number
LotInboundBlItemNot Notes Notes BL Item notes java.lang.String Yes Yes
es
LotInboundBlItemPa Package Height Package Height The height of each java.lang.Double Yes Yes
ckageHeightCm package in
centimeters
LotInboundBlItemPa Package Length Package Length The length of each java.lang.Double Yes Yes
ckageLengthCm package in
centimeters
LotInboundBlItemPa Value Value Item package value java.lang.Double Yes Yes
ckageValue

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 73
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotInboundBlItemPa Currency Currency Item package value java.lang.String Yes Yes
ckageValueCurrency currency
LotInboundBlItemPa Package Weight Package Weight The Weight of each java.lang.Double Yes Yes
ckageWeightKg package in kilograms
LotInboundBlItemPa Package Width Package Width The width of each java.lang.Double Yes Yes
ckageWidthCm package in
centimeters
LotInboundBlItemPa Id Id A code identifying java.lang.String Yes Yes
ckagetype the package type
LotInboundBlItemPa Description Desc Description of the java.lang.String Yes Yes
ckagetypeDesc package type
LotInboundBlItemPa UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
ckagetypeUccCode standard package
type encoding
(0=carton,
1=pallet,etc.)
LotInboundBlItemPie Piece Bulk Units Units The bulk units of java.lang.String Yes Yes
ceBulkUnit measure(e.g. tons)
inside each package
LotInboundBlItemPie Piece Height Piece Height The Height of each java.lang.Double Yes Yes
ceHeightCm piece in a package in
centimeters
LotInboundBlItemPie Bulk Package Bulk Package Item is BULK cargo java.lang.Boolean Yes Yes
ceIsBulk inside each package
LotInboundBlItemPie Piece Length Piece Length The length of each java.lang.Double Yes Yes
ceLengthCm piece in a package in
centimeters
LotInboundBlItemPie Id Id The type of java.lang.String Yes Yes
cePackagetype packages (e.g.
pallets) for pieces in
a package
LotInboundBlItemPie Description Desc Description of the java.lang.String Yes Yes
cePackagetypeDesc package type for
pieces in a package

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 74
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotInboundBlItemPie UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
cePackagetypeUccC standard package
ode type encoding
(0=carton,
1=pallet,etc.) for
pieces in a package
LotInboundBlItemPie Piece Quantity Piece Qty The number of java.lang.Double Yes Yes
ceQuantity pieces inside each
packages or bulk
units or
measurement.
LotInboundBlItemPie Piece Weight Piece Weight The Weight of each java.lang.Double Yes Yes
ceWeightKg piece inside the
package in kilograms
LotInboundBlItemPie Piece Width Piece Width The width of each java.lang.Double Yes Yes
ceWidthCm piece in a package in
centimeters
LotInboundBlItemPro Id Id A code identifying java.lang.String Yes Yes
ductType the product type
LotInboundBlItemQu Item Quantity Item Qty The number of java.lang.Double Yes Yes
antity packages or bulk
units or
measurement
LotInboundBlItemRe CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
quiredCO2Percentag required (%).
e
LotInboundBlItemRe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
quiredHumidityPerce required (%).
ntage
LotInboundBlItemRe Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
quiredMaxTempC temperature allowed
(degrees
Centigrade).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 75
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotInboundBlItemRe Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
quiredMinTempC temperature allowed
(degrees
Centigrade).
LotInboundBlItemRe O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
quiredO2Percentage required (%).
LotInboundBlItemRe Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
quiredTempC required temperature
(degrees
Centigrade).
LotInboundBlItemRe Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
quiredVent required. The
measurement unit is
defined in separate
field
RequiredVentUnit.
LotInboundBlItemRe Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
quiredVentUnit unit for the
RequiredVent field.
LotInboundBlItemSe Sequence Number Sequence BL Item sequence java.lang.Long Yes Yes
q
LotInboundBlItemWe Item Total Weight Total Weight Total weight of cargo java.lang.Double Yes Yes
ightTotalKg
LotInboundBlItemblA Id Id Agent id java.lang.String Yes Yes
gentId
LotIsDefault Default Lot Default Default Lot created java.lang.Boolean Yes Yes
automatically
LotMnftCargoSeqNo Manifest Seq Mnft Seq Nbr Sequence number java.lang.String Yes Yes
Number received from
manifest
LotModel Model Model Model name of the java.lang.String Yes Yes
lot
LotOutboundBlItemB Name Name Agent Name java.lang.String Yes Yes
lAgentName

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 76
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemB Bonded Destination Bond Dest The bonded java.lang.String Yes Yes
lBondedDestination destination of the
cargo
LotOutboundBlItemB BL Category BL Category Legal category of java.lang.String Yes Yes
lCategory shipment: Import,
Export, Transship,
Domestic, Storage,
Through
LotOutboundBlItemB Complex Complex Complex Id java.lang.String Yes Yes
lComplexId
LotOutboundBlItemB Complex Name Cpx Name Complex Name java.lang.String Yes Yes
lComplexName
LotOutboundBlItemB Id Id Party Id that will java.lang.String Yes Yes
lConsigneeId receive the cargo
LotOutboundBlItemB Name Name Party Name that will java.lang.String Yes Yes
lConsigneeName receive the cargo
LotOutboundBlItemB Destination Dest The final destination java.lang.String Yes Yes
lDestination of the cargo
LotOutboundBlItemB Id Id The line operator java.lang.String Yes Yes
lLineOperatorId Id(shipping line)
responsible for the
Bill of Lading
LotOutboundBlItemB Name Name The line operator java.lang.String Yes Yes
lLineOperatorName Name(shipping line)
responsible for the
Bill of Lading
LotOutboundBlItemB BL Number BL Nbr Bill of Lading number java.lang.String Yes Yes
lNbr
LotOutboundBlItemB Origin Origin Inland location where java.lang.String Yes Yes
lOrigin cargo originated
LotOutboundBlItemB Point ID ID The first port of java.lang.String Yes Yes
lPod1 discharge Id
LotOutboundBlItemB Point ID ID The second port of java.lang.String Yes Yes
lPod2 discharge Id

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 77
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemB Point ID ID The port Id at which java.lang.String Yes Yes
lPol the cargo will be
loaded to the vessel
LotOutboundBlItemB Id Id Party Id that shipped java.lang.String Yes Yes
lShipperId the cargo
LotOutboundBlItemB Name Name Party Name that java.lang.String Yes Yes
lShipperName shipped the cargo
LotOutboundBlItemB Visit Ref Visit Vessel voyage call java.lang.String Yes Yes
lVesselId for this Bill of Lading
-Id
LotOutboundBlItemB Carrier Name Carrier Name Vessel voyage call java.lang.String Yes No
lVesselName for this Bill of Lading
-Name
LotOutboundBlItemB Bulk Units Units The bulk units of java.lang.String Yes Yes
ulkUnit measure(e.g. tons)
LotOutboundBlItemC Record Changed Changed The date the item java.util.Date Yes Yes
hanged Date was last changed
LotOutboundBlItemC Record Changed Changer The user who last java.lang.String Yes Yes
hanger User changed the item
LotOutboundBlItemC Commodity ID Id The commodity ID java.lang.String Yes Yes
ommodity for the contents of a
unit.
LotOutboundBlItemC Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
ommodityDescription Name description for the
contents of a unit.
LotOutboundBlItemC Record Create Date Created The date the item java.util.Date Yes Yes
reated was created
LotOutboundBlItemC Record Create User Creator The user who java.lang.String Yes Yes
reator created the item
LotOutboundBlItemC Customer Order Cust. Ord. Nbr. BL Item customer java.lang.String Yes Yes
ustomerOrderNbr Number order number
LotOutboundBlItemC Customer Product Cust. Prod. Nbr. BL Item customer java.lang.String Yes Yes
ustomerProductNbr Number product number

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 78
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemIs Bulk Bulk Item is BULK cargo java.lang.Boolean Yes Yes
Bulk (i.e. tracked by
measurement)
LotOutboundBlItemM Marks and Numbers Marks Marks and Numbers java.lang.String Yes Yes
arksAndNumbers stenciled on each
package
LotOutboundBlItemN Item Number Item Nbr Bill of Lading Item java.lang.String Yes Yes
br number
LotOutboundBlItemN Notes Notes BL Item notes java.lang.String Yes Yes
otes
LotOutboundBlItemP Package Height Package Height The height of each java.lang.Double Yes Yes
ackageHeightCm package in
centimeters
LotOutboundBlItemP Package Length Package Length The length of each java.lang.Double Yes Yes
ackageLengthCm package in
centimeters
LotOutboundBlItemP Value Value Item package value java.lang.Double Yes Yes
ackageValue
LotOutboundBlItemP Currency Currency Item package value java.lang.String Yes Yes
ackageValueCurrenc currency
y
LotOutboundBlItemP Package Weight Package Weight The Weight of each java.lang.Double Yes Yes
ackageWeightKg package in kilograms
LotOutboundBlItemP Package Width Package Width The width of each java.lang.Double Yes Yes
ackageWidthCm package in
centimeters
LotOutboundBlItemP Id Id A code identifying java.lang.String Yes Yes
ackagetype the package type
LotOutboundBlItemP Description Desc Description of the java.lang.String Yes Yes
ackagetypeDesc package type

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 79
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemP UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
ackagetypeUccCode standard package
type encoding
(0=carton,
1=pallet,etc.)
LotOutboundBlItemP Piece Bulk Units Units The bulk units of java.lang.String Yes Yes
ieceBulkUnit measure(e.g. tons)
inside each package
LotOutboundBlItemP Piece Height Piece Height The Height of each java.lang.Double Yes Yes
ieceHeightCm piece in a package in
centimeters
LotOutboundBlItemP Bulk Package Bulk Package Item is BULK cargo java.lang.Boolean Yes Yes
ieceIsBulk inside each package
LotOutboundBlItemP Piece Length Piece Length The length of each java.lang.Double Yes Yes
ieceLengthCm piece in a package in
centimeters
LotOutboundBlItemP Id Id The type of java.lang.String Yes Yes
iecePackagetype packages (e.g.
pallets) for pieces in
a package
LotOutboundBlItemP Description Desc Description of the java.lang.String Yes Yes
iecePackagetypeDes package type for
c pieces in a package
LotOutboundBlItemP UCC/EAN-128 Code Code UCC/EAN-128 java.lang.String Yes Yes
iecePackagetypeUcc standard package
Code type encoding
(0=carton,
1=pallet,etc.) for
pieces in a package
LotOutboundBlItemP Piece Quantity Piece Qty The number of java.lang.Double Yes Yes
ieceQuantity pieces inside each
packages or bulk
units or
measurement.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 80
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemP Piece Weight Piece Weight The Weight of each java.lang.Double Yes Yes
ieceWeightKg piece inside the
package in kilograms
LotOutboundBlItemP Piece Width Piece Width The width of each java.lang.Double Yes Yes
ieceWidthCm piece in a package in
centimeters
LotOutboundBlItemP Id Id A code identifying java.lang.String Yes Yes
roductType the product type
LotOutboundBlItemR CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
equiredCO2Percenta required (%).
ge
LotOutboundBlItemR Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
equiredHumidityPerc required (%).
entage
LotOutboundBlItemR Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
equiredMaxTempC temperature allowed
(degrees
Centigrade).
LotOutboundBlItemR Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
equiredMinTempC temperature allowed
(degrees
Centigrade).
LotOutboundBlItemR O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
equiredO2Percentag required (%).
e
LotOutboundBlItemR Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
equiredTempC required temperature
(degrees
Centigrade).
LotOutboundBlItemR Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
equiredVent required. The
measurement unit is
defined in separate
field
RequiredVentUnit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 81
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Cargo Lot

External Tag Long Label Short Label Description Type In Design In Sort
LotOutboundBlItemR Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
equiredVentUnit unit for the
RequiredVent field.
LotOutboundBlItemS Sequence Number Sequence BL Item sequence java.lang.Long Yes Yes
eq
LotOutboundBlItem Item Total Weight Total Weight Total weight of cargo java.lang.Double Yes Yes
WeightTotalKg
LotOutboundBlItembl Id Id Agent id java.lang.String Yes Yes
AgentId
LotPositionFull Position Position The complete name java.lang.String Yes Yes
of the position,
'(Type)-(Carrier or
Yard)-(Slot)'.
LotPositionLocId Location Id LocId The location ID: java.lang.String Yes Yes
Carrier visit ID.
LotPositionLocType Position Type Type The location type: Y java.lang.String Yes Yes
for 'Yard', V for
'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
LotPositionSlot Slot Slot The slot position ID. java.lang.String Yes Yes
LotQuantity Quantity Qty Quantity currently at java.lang.Double Yes Yes
a location
LotQuantityDiscrepe Discrepancy Discrepancy Quantity missing (-) java.lang.Double Yes Yes
ncy or overage (+) at a
location
LotQuantityManifiest Quantity Manifested Manifested Quantity originally java.lang.Double Yes Yes
ed declared at a
location
LotSeqNbr Seq Number Seq Sequence number of java.lang.Integer Yes Yes
lot among all lots for
BL Item

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 82
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
EDI Session

External Tag Long Label Short Label Description Type In Design In Sort
LotWeightTotalKg Lot Total Weight Lot Total Weight The total weight of java.lang.Double Yes Yes
Cargo Lot in
kilograms

2.2.4 EDI Session

The EDI Session reporting entity includes information about the EDI session and also represents the EDI session details such as the EDI mail box and the
batch.

External Tag Long Label Short Label Description Type In Design In Sort
EdisessChanged Changed Changed The date and time java.util.Date Yes Yes
when it has been
latest changed.
EdisessChanger Changer Changer The user who last java.lang.String Yes Yes
changed the session
EdisessCreated Created Created The date and time java.util.Date Yes Yes
when the session is
created.
EdisessCreator Creator Creator The user who java.lang.String Yes Yes
created the session
EdisessDelimeter Delimiter Delimiter Delimiter of the edi java.lang.String Yes Yes
file used in this EDI
Session.
EdisessDesc Description Description A short description of java.lang.String Yes Yes
the EDI session.
EdisessFileExt File Extension File Extension The file extension to java.lang.String Yes Yes
associate with the
EDI session.
EdisessLastRunTime Last Run Time Time The date the EDI java.util.Date Yes Yes
stamp session last ran.
EdisessName Name Name A short name for the java.lang.String Yes Yes
EDI session.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 83
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Equipment

External Tag Long Label Short Label Description Type In Design In Sort
EdisessTranCntlNbr Last Control Number Control Number Last EDI Transaction java.lang.Long Yes Yes
Control Number
used in this EDI
Session.

2.2.5 Equipment
The Equipment reporting entity is used to track the state of the equipment.

External Tag Long Label Short Label Description Type In Design In Sort
DamageSeverity Damage Damage Damage Severity java.lang.String Yes No
EquipmentArcheTyp ISO Id ISO Id Equipment type ID java.lang.String Yes Yes
eId
EquipmentBuildDate Build Date Built Equipment Build java.util.Date Yes Yes
Date
EquipmentChanged Record Changed Changed The date and time java.util.Date Yes Yes
Date the equipment was
last changed
EquipmentChanger Record Changed Changer The user who last java.lang.String Yes Yes
User changed the
equipment
EquipmentClass Equipment Class Class Equipment Class java.lang.String Yes Yes
EquipmentCreated Record Create Date Created The date and time java.util.Date Yes Yes
the equipment was
created
EquipmentCreator Record Create User Creator The user who java.lang.String Yes Yes
created the
equipment
EquipmentDamages Damages Owner Dmgs Owner Entity Equipment Damages java.lang.String Yes No
OwnerName Entity Name Name Owner Name
EquipmentDataSour Data Source DataSrc Equipment Data java.lang.String Yes Yes
ce Source

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 84
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Equipment

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentGradeDes Description Description Equipment Grade java.lang.String Yes Yes
cription Description
EquipmentHasWheel Has Wheels Has Wheels Equipment has java.lang.Boolean Yes Yes
s wheels
EquipmentHeightMm Height Height Equipment Height java.lang.Long Yes Yes
millimeters
EquipmentIdCheckDi Check Digit Check Digit Equipment Id Check java.lang.String Yes Yes
git Digit
EquipmentIdFull Equipment Number Equip Nbr Equipment Id Full java.lang.String Yes Yes
EquipmentIdNbrOnly Equip Nbr Digits Digits Equipment Id java.lang.String Yes Yes
Number Only
EquipmentIdNoChec Equip Nbr w/o Check Nbr No Check Digit Equipment Id No java.lang.String Yes Yes
kDigit Digit Check Digit
EquipmentIdPrefix Prefix Prefix EquipmentIdPrefix java.lang.String Yes Yes
EquipmentIsInsulate Is Insulated Insulated Equipment is java.lang.Boolean Yes Yes
d insulated
EquipmentIsOpen Is IMDG ''open'' IMDG Open Equipment is open java.lang.Boolean Yes Yes
EquipmentIsPOS Is POS Is POS Equipment is pos java.lang.Boolean Yes Yes
EquipmentIsTempera Is Temperature Temp Cntrld Equipment is java.lang.Boolean Yes Yes
tureControlled Controlled temperature
controlled
EquipmentIsUnseala Cannot Be Sealed No Seals Equipment is java.lang.Boolean Yes Yes
ble unsealable
EquipmentIsoGroup ISO Group ISO Grp Equipment Iso Group java.lang.String Yes Yes
EquipmentLastFacilit Complex Name Cpx Name Equipment Last java.lang.String Yes Yes
yComplexName Facility Complex
Name
EquipmentLastFacilit Life Cycle State Life Cycle Equipment Last java.lang.String Yes Yes
yLifeCycleState Facility Life Cycle
State
EquipmentLastFacilit Facility Name Facility Name Equipment Last java.lang.String Yes Yes
yName Facility Name

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 85
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Equipment

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentLastFacilit Point ID ID Equipment Last java.lang.String Yes Yes
yRoutingPointId Facility Routing Point
Id
EquipmentLastFacilit Terminal Terminal Equipment Last java.lang.String Yes Yes
yRoutingPointTermin Facility Routing Point
al Terminal
EquipmentLastFacilit TEU Capacity TEUs 'Green' Equipment Last java.lang.Long Yes Yes
yTeuGreen 'Green' Facility Teu Green
EquipmentLastFacilit TEU Capacity 'Red' TEUs 'Red' Equipment Last java.lang.Long Yes Yes
yTeuRed Facility Teu Red
EquipmentLastFacilit TEU Capacity TEUs 'Yellow' Equipment Last java.lang.Long Yes Yes
yTeuYellow 'Yellow' Facility Teu Yellow
EquipmentLeaseExpi Lease Expiration Lease Expires Equipment Lease java.util.Date Yes Yes
ration Expiration
EquipmentLengthM Length Length Equipment Length java.lang.Long Yes Yes
m millimeters
EquipmentLifeCycle Life Cycle State Life Cycle State Equipment life cycle java.lang.String Yes Yes
State state
EquipmentMaterial Material Material Equipment material java.lang.String Yes Yes
EquipmentMustStow Above Deck Only Above Deck Only Equipment must java.lang.Boolean Yes Yes
AboveDeck stow above deck
EquipmentMustStow Below Deck Only Below Deck Only Equipment must java.lang.Boolean Yes Yes
BelowDeck stow below deck
EquipmentNoStowO No Overstow If No Overstow Mty Equipment don't java.lang.Boolean Yes Yes
nTopIfEmpty Empty stow on top if empty
EquipmentNoStowO No Stow If Laden No Overstow Laden Equipment don't java.lang.Boolean Yes Yes
nTopIfLaden stow on top if laden
EquipmentObsolete Name Name Equipment obsolete java.lang.String Yes Yes
Operator operator
EquipmentObsolete Name Name Equipment obsolete java.lang.String Yes Yes
Owner owner
EquipmentObsoleteP Name Name Equipment obsolete java.lang.String Yes Yes
reviousOperator previous operator

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 86
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Equipment

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOogOk Can be Out-Of- OOG-OK Equipment oog ok java.lang.Boolean Yes Yes
Gauge
EquipmentOperator Id Id Equipment Operator java.lang.String Yes Yes
Id
EquipmentOperatorN Name Name Equipment Operator java.lang.String Yes Yes
ame Name
EquipmentOwner Id Id Equipment Owner Id java.lang.String Yes Yes
EquipmentOwnerNa Name Name Equipment Owner java.lang.String Yes Yes
me Name
EquipmentPreviousO Id Id Equipment Previous java.lang.String Yes Yes
perator Operator Id
EquipmentPreviousO Name Name Equipment Previous java.lang.String Yes Yes
peratorName Operator Name
EquipmentSafeWeig Safe Weight Safe Wt Equipment Safe java.lang.Double Yes Yes
htKg Weight kilograms
EquipmentStrengthC Strength Code Strength Equipment strength java.lang.String Yes Yes
ode code
EquipmentTareWeig Tare Weight Tare Wt Equipment Tare java.lang.Double Yes Yes
htKg Weight kilograms
EquipmentTimeTran Transponder Install TrnspTime Equipment time java.util.Date Yes Yes
sponderInstall Time transponder install
EquipmentTranspon Transponder ID TrnspId Equipment java.lang.String Yes Yes
derId transponder ID
EquipmentTranspon Transponder Type TrnspTyp Equipment java.lang.String Yes Yes
derType transponder type
EquipmentTypeId ISO Id ISO Id Equipment type ID java.lang.String Yes Yes
EquipmentUseMode Use Mode Use Mode Equipment Use java.lang.String Yes Yes
Mode
EquipmentUsesAcce Uses Accessories Accss OK Equipment uses java.lang.Boolean Yes Yes
ssories accessories
EquipmentWidthMm Width Width Equipment Width java.lang.Long Yes Yes
millimeters

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 87
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Reefer Record

External Tag Long Label Short Label Description Type In Design In Sort
FlexString01 eqsFlexString01 eqsFlexString01 Flex String 01 java.lang.String Yes Yes
FlexString02 eqsFlexString02 eqsFlexString02 Flex String 02 java.lang.String Yes Yes
FlexString03 eqsFlexString03 eqsFlexString03 Flex String 03 java.lang.String Yes Yes
LastPositionLocation Location Type Loc Type Last Position java.lang.String Yes Yes
Type Location Type
LastPositionName Location Location Last Position Name java.lang.String Yes Yes
OperatorName Operator Name Opr Name Operator Name java.lang.String Yes Yes
ReturnToLocation Off-Hire Location Off-Hire Return To Location java.lang.String Yes Yes
TimeLastMove Time Last Move Last Move Last Time Move java.util.Date Yes Yes

2.2.6 Reefer Record

The Reefer Record reporting entity represents a single reefer recording.

External Tag Long Label Short Label Description Type In Design In Sort
AreDrainsOpen Drains Open Drains AreDrainsOpen java.lang.Boolean Yes Yes
CarbonDioxide Carbon Dioxide CO2% CarbonDioxide java.lang.Double Yes Yes
ComputerId Reefer Record ComputerId ComputerId java.lang.String Yes Yes
Computer Id
CreationRefId Unique Creation Creation Reference CreationRefId java.lang.String Yes Yes
Reference
DataSource Reefer Record Data Data Source DataSource java.lang.String Yes Yes
Source
DefrostIntervalHours Defrost Interval Defrost DefrostIntervalHours java.lang.Double Yes Yes
DefrostTemp Defrost Temperature Defrost Tmp DefrostTemp java.lang.Double Yes Yes
FanSetting Fan Setting Fan FanSetting java.lang.String Yes Yes
FaultCode Reefer Record Fault Fault Code FaultCode java.lang.String Yes Yes
Code
FuelLevel Fuel Level, % Fuel% FuelLevel java.lang.Double Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 88
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
HasMalfunction Reefer Record Has Malfunction HasMalfunction java.lang.Boolean Yes Yes
Malfunction
Humidity Humidity Humidity% Humidity java.lang.Double Yes Yes
IsBulbOn Bulb On Bulb On IsBulbOn java.lang.Boolean Yes Yes
IsPowered On Power On Power IsPowered java.lang.Boolean Yes Yes
MaximumMonitorTe Max Monitored Max Tmp MaximumMonitorTe java.lang.Double Yes Yes
mp Temperature mp
MinimumMonitorTem Min Monitored Min Tmp MinimumMonitorTem java.lang.Double Yes Yes
p Temperature p
Oxygen Oxygen Level O2% Oxygen java.lang.Double Yes Yes
Remark Remark Remark Remark java.lang.String Yes Yes
ReturnTmp Return Temperature Tmp ReturnTmp java.lang.Double Yes Yes
SetPointTemp Temperature Set Set Point SetPointTemp java.lang.Double Yes Yes
Point
SupplyTemp Supply Temperature Supply Tmp SupplyTemp java.lang.Double Yes Yes
TaskId Reefer Record Task TaskId TaskId java.lang.String Yes Yes
Id
Time Time of recording Time Time java.util.Date Yes Yes
Unit Unit Nbr Unit Nbr Unit java.lang.String Yes Yes
VentSetting Ventilation Setting Vent Set VentSetting java.lang.Double Yes Yes
VentUnit Ventilation Unit Vent Unit VentUnit java.lang.String Yes Yes

2.2.7 Unit
The Unit is the central object in N4, representing a moveable entity consisting of cargo and its packaging. The Unit reporting entity corresponds to the
information you see in the Units view in N4. The view displays units in all visit states ignoring whether the unit is currently in the yard, Advised, or Departed.
All equipment information such as size, type, height, and so on refer to the primary equipment of the unit.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalCarrierVehicle The arrival carrier java.lang.String Yes No
Seq Railcar Sequence.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 89
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalCarrierVehicle The arrival carrier java.lang.String Yes No
Type type, '(in case of
Railcar it is Railcar
template type)' .
ArrivalOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (ELO) for
receivals.
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: Y for 'Yard', V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
AttachedPayloadUnit The Equipment IDs java.lang.String Yes No
s of attached payload
units separated by a
';'.
AttachedUnits Attached Attached The Equipment IDs java.lang.String Yes No
Equipments Equipments of attached units
separated by a ';'.
Bundle Unit is a Bundle Bundle True if the unit is a java.lang.Boolean Yes Yes
Bundle.
CargoQuantity Cargo Quantity Cargo Quantity Unit cargo quantity. java.lang.Double Yes Yes
CargoQuantityUnit Cargo Qty Unit Cargo Qty Unit Unit cargo quantity java.lang.String Yes Yes
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 90
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
CargoWeight Cargo Weight Cargo Wt Cargo weight of the java.lang.Double Yes No
unit (gross weight
minus tare weight).
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).
Commodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
CommodityDescripti Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
on Name description for the
contents of a unit.
CurrentlyAttachedAc Currently Attached Currently Attached java.lang.String Yes No
cessoriesIds Accessories Accessories
CurrentlyAttachedCh Chassis Equip Nbr Chassis Equip Nbr java.lang.String Yes No
assisId
CurrentlyAttachedUn Currently Attached Currently Attached The Equipment IDs java.lang.String Yes No
its Equipments Equipments of currently attached
units separated by a
';'.
DateOfGateProcessi EC-In Time EC-In Time The time the unit java.util.Date Yes Yes
ng was processed at the
gate.
DateOfLastHandling Time of Last Move Last Move The last recorded java.util.Date Yes Yes
time the unit was
moved.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 91
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
DeckRequirements Deck Stowage Deck Req The stowage java.lang.String Yes Yes
Requirements requirement for the
unit: A for 'Above
Deck Only', B for
'Below Deck Only', or
E for 'Don't Care'.
DeclaredIbCarrierId Visit Ref Visit The declared/ java.lang.String Yes Yes
documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
DeclaredObCarrierId Visit Ref Visit The declared java.lang.String Yes Yes
outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
DemurragePayee Payee Payee The payee defined to java.lang.String Yes No
pay for demurrage
charges.
DepartureOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (booking,
EDO, ELO) for
deliveries or
receivals.
DesignatedTrucking Id Id The ID of the java.lang.String Yes No
Company designated trucking
company to which
the unit will be
delivered.
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 92
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
DrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit: F for
'Forward to Loading
Point', R for 'Return
to shipper', O for
'Dray Out and Back',
I for 'Dray In', or T for
'Transfer to other
Facility'.
DwellDays Dwell Days Dwell The number of days java.lang.Long Yes No
the unit has been in
the yard.
ECN Export Control ECN The ECN clearing java.lang.String Yes No
Number this unit by customs.
EquipmentArcheTyp ISO Id ISO Id The arche type for java.lang.String Yes Yes
eId the primary
equipment type code
(ISO or other). For
information about
ISO codes, see the
documents section at
http:www.smdg.org.
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
equipment was
built/put in service.
EquipmentDamage Damage Severity Damage Severity The equipment java.lang.String Yes Yes
damage level: '-' for
Repaired, None,
Minor, or Major.
EquipmentDataSour Data Source DataSrc Equipment Data java.lang.String Yes Yes
ce Source
EquipmentGradeId ID ID The equipment java.lang.String Yes Yes
grade ID.
EquipmentHeightMm Height Height The overall java.lang.Long Yes Yes
equipment height in
millimeters.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 93
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentIsFolded Is Folded Is Folded True if the equipment java.lang.Boolean Yes Yes
is folded such as a
folded flat-rack.
EquipmentIsOutOfSe Is POS Is POS True if the equipment java.lang.Boolean Yes Yes
rvice is permanently out of
service.
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration for the primary
equipment expires,
blank if no lease
applies.
EquipmentLengthM Length Length The overall java.lang.Long Yes Yes
m equipment length in
millimeters.
EquipmentMaterial Material Material The material of the java.lang.String Yes Yes
primary equipment:
Unknown, Aluminum,
or Steel.
EquipmentOffHireLo Off-Hire Location Off-Hire The location the java.lang.String Yes Yes
cation equipment will be
returned after it
comes off the lease.
EquipmentOperator Id Id The line operator java.lang.String Yes Yes
(shipping line)
currently registered
as the equipment
operator (lessee or
owner).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 94
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).
EquipmentOwner Id Id The line operator java.lang.String Yes Yes
(shipping line) that
owns the primary
equipment.
EquipmentPreviousO Id Id The line operator java.lang.String Yes Yes
perator (shipping line) that
was the previous
operator for the
primary equipment.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.
EquipmentSafeWeig Safe Weight Safe Wt The equipment safe java.lang.Double Yes Yes
htKg weight in kilograms.
The safe weight is
the maximum
permissible weight of
the equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 95
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 96
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
EquipmentWidthMm Width Width The overall java.lang.Long Yes Yes
equipment width in
millimeters.
FirstReeferRecordDa The date of the first java.util.Date Yes No
teAfterInTime reefer reading after
the unit came into
the yard (first reading
after in time).
FirstReeferRecordTe The temperature java.lang.Double Yes No
mpAfterInTime recorded at the first
reefer reading after
the unit came into
the yard (first reading
after in time).
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
the unit.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GoodsBlNbr BL Number BL Nbr Simple Bill of Lading java.lang.String Yes Yes
Id.
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsConsigneeNa Name Name The specified java.lang.String Yes Yes
me consignee for the
goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 97
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
GoodsShipperName Name Name The name of the java.lang.String Yes Yes
specified shipper for
the goods.
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: The gross
weight of the
equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
GrossWeightKgAdvis Gross Weight - Gross Wt. - Adv. The gross weight of java.lang.Double Yes Yes
ed Advised the equipment in
kilograms.Goods and
Container weight in
Kgs (gross weight)
when the container
was booked/advised.
GrossWeightKgGate Scale Weight - Gate Scale Wt. - Gate The gross weight of java.lang.Double Yes Yes
Measured the equipment in
kilograms. Goods
and Container weight
in Kgs (gross weight)
as recorded by gate
scales.
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms.The gross
weight is the
combined weight of
the equipment and
the goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 98
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeightKgYard Scale Weight - Yard Scale Wt. - Yard The gross weight of java.lang.Double Yes Yes
Measured the equipment in
kilograms.Goods and
Container weight in
Kgs (gross weight)
as recorded by CHE
in yard.
HandlingReason Handling Reason Hndl Reason Reason for last java.lang.String Yes Yes
handling: C for
'Container Operator
Request', L for 'Line
Operator Request', T
for 'Terminal
Convenience', or U
for 'Customs
Request'.
HasPlannedMove There is a planned java.lang.Boolean Yes No
move for this unit.
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
entered the facility.
Same as the
discharge time if the
unit was discharged
from a vessel.
InboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the inbound
carrier.
InboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierCount Country Name Cntry Name The country of the java.lang.String Yes No
ry inbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 99
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierDocu Documentation Doc Nbr The documentation java.lang.String Yes No
mentationNbr Number number of the
inbound carrier. For
the vessel this is the
Coast Guard
Document Number.
InboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
inbound carrier.
InboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the trucking
company.
InboundCarrierInVoy Inbound carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes).
InboundCarrierInVoy Inbound carrier: For java.lang.String Yes No
ageNbr vessels it is the
inbound voyage
number, and for
trains it is the train
ID.
InboundCarrierName Carrier Name Carrier Name The inbound carrier java.lang.String Yes No
name such as Vessel
Name, Truck License
Number, or Train ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 100
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torId operator ID such as
the line operator
(shipping line) or the
Trucking Company.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torName operator name such
as the line operator
(shipping line), or the
trucking company.
InboundCarrierOutVo Inbound carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes).
InboundCarrierOutVo Inbound carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', or N for
'Train'.
InboundCarrierVisitP Visit Phase Phase Inbound carrier's visit java.lang.String Yes No
hase phase, C for
CREATED, I for
INBOUND, A for
ARRIVED, W for
WORKING, T for
COMPLETE, D for
DEPARTED, S for
CLOSED, Z for
CANCELLED, X for
ARCHIVED

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 101
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
InboundVesselInVoy Inbound Voyage I/B Vyg null null No Yes
ageNbrRef
InboundVesselLloyds I/B Vessel Lloyds Id I/B Vessel Lloyds Id A unique identifier for java.lang.String Yes No
Id the hull of the unit
inbound vessel. A
Lloyd's ID is issued
by the insurance
company, Lloyd's of
London
InboundVesselName Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
InboundCarrierName
instead.
InboundVesselRadio I/B Vessel Radio Call I/B Vessel Radio Call The call sign java.lang.String Yes No
CallSign Sign Sign assigned by the
national licensing
authority for the
country of origin. A
call sign is a unique
designation for a
transmitting station
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector.
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes No
contains hazardous
cargo.
IsOOG Is OOG Is OOG True if the unit is out- java.lang.Boolean Yes Yes
of-gauge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 102
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
IsOnPower On Power On Power True if the unit is java.lang.Boolean Yes Yes
connected to
electrical supply, or
forced air exchange,
in case of porthole
reefer.
IsReefer Requires Power Reqs Power True if the unit java.lang.Boolean Yes Yes
requires power (is an
active reefer).
IsYardPositionVerifie Verified Yard Ver Yard Pos True if the SPARCS java.lang.Boolean Yes Yes
d Position user has verified the
yard position of the
unit.
LastFreeDay Last Free Day Last Free Day The last day (as java.lang.String Yes No
string) the unit can
stay in the facility
without charges. If
the date has a
preceding '!', the
date has been
manually overridden
and is not calculated
using the storage
rules.
LastFreeDayDate The last day the unit java.util.Date Yes No
can stay in the
facility without
charges.
LastReeferRecordDa The date of the last java.util.Date Yes No
te reefer reading.
LastReeferRecordTe Last Temperature Last Temp Read The temperature java.lang.Double Yes No
mp Monitored recorded during the
last reefer reading.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 103
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
LineStorageDaysOw Line Storage Days Line Storage Days Number of Line java.lang.Long Yes No
ed Owed Owed Storage Days Owed
LineStorageDaysTot Storage Days Total Storage Days Total The number of line java.lang.Long Yes No
al storage days total.
LineStorageIsPaid True if line storage is java.lang.Boolean Yes No
paid.
LineStorageRuleEnd LINE_STORAGE java.util.Date Yes No
Time rule end time as per
rule definition
LineStorageRuleStar LINE_STORAGE java.util.Date Yes No
tTime rule start time as per
rule definition
MainHazardCodes Main Hazard Codes Hzd Codes All the applicable java.lang.String Yes No
hazard codes
separated by a ','.
MainHazardUNNum The UN Numbers of java.lang.String Yes No
bers the three most
severe hazards
registered as cargo,
separated by ','.
OOG A code to display the java.lang.String Yes No
OOG dimensions of
a unit 'H W L' for
Height, Width, and
Length. A '-' is
displayed if one of
the dimensions is not
OOG. For example,
'H - -' means that
only the Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 104
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
side (centimeters).
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
side (centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original port of java.lang.String Yes Yes
load (the
International port of
load, if the cargo was
relayed through
domestic ports of
load).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig The specified origin java.lang.String Yes Yes
of the goods.
OutTime Time Facility-Out Time Out The time the unit java.util.Date Yes Yes
exited the facility.
Same as the carrier
departure time.
OutboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
of the outbound
carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 105
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure of the
outbound carrier.
OutboundCarrierCou Country Name Cntry Name The country of the java.lang.String Yes No
ntry outbound carrier.
OutboundCarrierDO DOT Hazardous Haz CCN The DOT certificate java.lang.String Yes Yes
TCertNbr Material CCN number for the
outbound carrier.
OutboundCarrierDoc Documentation Doc Nbr The documentation java.lang.String Yes No
umentationNbr Number number of the
outbound carrier. For
the vessel this is the
Coast Guard
Document Number.
OutboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival of the
outbound carrier.
OutboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure of the
outbound carrier.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
train ID for train, or
license number for
truck.
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the
OutboundCarrierId,
but for trucks it also
includes the Trucking
Company.
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 106
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierInVo Inbound voyage java.lang.String Yes No
yageNbr number for the
Outbound Vessel
(undefined for other
carrier modes).
OutboundCarrierNa Carrier Name Carrier Name The name of the java.lang.String Yes No
me outbound carrier
(e.g. vessel name,
truck license number,
train ID).
OutboundCarrierOpe The operator ID of java.lang.String Yes No
ratorId the outbound carrier
such as the line
operator (shipping
line) or the trucking
company.
OutboundCarrierOpe The operator name java.lang.String Yes No
ratorName of the outbound
carrier such as the
line operator
(shipping line) or the
trucking company.
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes).
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageNbr For vessels it is the
outbound voyage
number, for trains it
is the train ID.
OutboundCarrierSer ID ID The service ID java.lang.String Yes Yes
viceId (rotation) of the
outbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 107
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
OutboundCarrierVisit Visit Phase Phase Outbound carrier's java.lang.String Yes No
Phase visit phase, C for
CREATED, I for
INBOUND, A for
ARRIVED, W for
WORKING, T for
COMPLETE, D for
DEPARTED, S for
CLOSED, Z for
CANCELLED, X for
ARCHIVED
OutboundCarrierlInV Inbound voyage java.lang.String Yes No
oyageNbr number for the
Outbound Vessel
(undefined for other
carrier modes).
OutboundIntendedC Visit Ref Visit Intended Departure java.lang.String Yes Yes
arrierId carrier: Vessel ID for
vessel, train ID for
train, or license
number for truck.
OutboundVesselLab Labor On Board LaborOnBoard The time the labor java.util.Date Yes Yes
orOnBoard went on board to
work the outbound
vessel (undefined for
other carrier modes).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 108
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundVesselLloy O/B Vessel Lloyds Id O/B Vessel Lloyds Id A unique identifier for java.lang.String Yes No
dsId the hull of the unit
outbound vessel. A
Lloyd's ID is issued
by the insurance
company, Lloyd's of
London
OutboundVesselNam Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
e OutboundCarrierNa
me instead.
OutboundVesselRadi O/B Vessel Radio O/B Vessel Radio The call sign java.lang.String Yes No
oCallSign Call Sign Call Sign assigned by the
national licensing
authority for the
country of origin. A
call sign is a unique
designation for a
transmitting station
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
OwedStorageDays Storage Days Owed Storage Days Owed The number of days java.lang.Long Yes No
storage was charged
for the unit.
PIN PIN Number PIN The Container java.lang.String Yes Yes
Release Number or
Container PIN.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 109
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
POD2Cntry Country Code Code The country code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code The country code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded on a
vessel.
POLCntry Country Code Code The country code of java.lang.String Yes Yes
the port of load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.
PlacardsMismatched Placards Mismatch Placards Mismatch False if Unit's Hazard java.lang.Boolean Yes Yes
placards and
observed placards
match, True
otherwise

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 110
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.
PositionPlanned Planned Position Planned Position Planned position of java.lang.String Yes No
the LOAD work
instruction.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
PowerDaysTotal Power Days/Hours Power Days/Hours The number of java.lang.Long Yes No
Total Total power days total.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 111
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
PowerOffRequested Requested Off- Requested Off- The date and time java.util.Date Yes Yes
Time Power Time Power the unit needs
should be taken off
power.
PowerOnLatestTime Must be On-Power Must be On-Power The latest date and java.util.Date Yes Yes
Time time the unit needs
to be on power.
PowerRuleEndTime POWER rule end java.util.Date Yes No
time as per rule
definition
PowerRuleStartTime POWER rule start java.util.Date Yes No
time as per rule
definition

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 112
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
RailLoadStop Stop-Rail Stop-Rail True if rail load is java.lang.Boolean Yes Yes
disallowed.
RequiredCO2Percen CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
tage required (%).
RequiredHumidityPe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
rcentage required (%).
RequiredMaxTempC Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredMinTempC Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredO2Percenta O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
ge required (%).
RequiredTempC Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
required temperature
(degrees
Centigrade).
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required. The
measurement unit is
defined in separate
field
RequiredVentUnit.
RequiredVentPercen Ventilation Required Vent Req DEPRECATED - use java.lang.Double Yes Yes
tage the RequiredVent
field instead. The
measurement unit is
defined as a
separate field,
RequiredVentUnit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 113
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the
RequiredVent field.
RequiresPower Requires Power Reqs Power True if the unit needs java.lang.Boolean Yes Yes
power for its reefer
unit, or forced air, in
case of porthole
reefer.
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', or H for
'Shift move'.
RoadDeliveryStop Stop-Road Stop-Road True if road delivery java.lang.Boolean Yes Yes
is disallowed.
RoutingGroup Group ID Grp ID The routing group ID. java.lang.String Yes Yes
SealNbr1 Seal Number 1 Seal Nbr1 Seal number 1. java.lang.String Yes Yes
SealNbr2 Seal Number 2 Seal Nbr2 Seal number 2. java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 Seal number 3. java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 Seal number 4. java.lang.String Yes Yes
SpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID.
SpecialStow2 ID ID The special stow 2 java.lang.String Yes Yes
requirement ID.
SpecialStow3 ID ID The special stow 3 java.lang.String Yes Yes
requirement ID.
StorageDaysTotal Storage Days Total Storage Days Total The number of java.lang.Long Yes No
storage days total.
StorageIsPaid Is Storage Paid Is Storage Paid True if storage is java.lang.Boolean Yes No
paid.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 114
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
StorageRuleEndTim STORAGE rule end java.util.Date Yes No
e time as per rule
definition
StorageRuleStartTim STORAGE rule start java.util.Date Yes No
e time as per rule
definition
TempRequiredInC Temp Req. in C Temp Req. in C The preferred/ java.lang.Double Yes No
required temperature
(degrees
Centigrade).
TempRequiredInF Temp Req. in F Temp Req. in F The preferred/ java.lang.Double Yes No
required temperature
(degrees
Fahrenheit).
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
outbound carrier,
empty if not yet
loaded.
TransitState Transit State T-State Describes the UFV's java.lang.String Yes No
transit through the
Facility.
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 115
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 116
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString05.
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString10.
UfvInboundCvClassif Inbound Visit IB Classification The inbound carrier java.lang.Object Yes No
ication Classification visit classification
UfvMoveCount Move Count Move Count No. of moves done java.lang.Long Yes Yes
for a unit during its
unit facility visit.
UfvOutboundCvClas Outbound Visit OB Classification The outbound carrier java.lang.Object Yes No
sification Classification visit classification
UfvSparcsNotes Sparcs Notes Sparcs Notes Unit Facility Visit java.lang.String Yes No
Sparcs Notes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 117
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UnitActiveImpedimen Active Holds and java.lang.String Yes No
ts Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On
UnitAgent1 Id Id Agent1 Information. java.lang.String Yes No
UnitAgent2 Id Id Agent2 Information. java.lang.String Yes No
UnitCreatedDate Time Created Time Created The date and time java.util.Date Yes Yes
when the unit is
created.
UnitEquipDmgsItmN Miscellaneous notes java.lang.String Yes No
otes for the damage Item
UnitExportReleaseD Export Release Date Export Release Dt. Unit Export Release java.util.Date Yes No
ate Date
UnitExportReleaseN Export Release Export Release Nbr. Unit Export Release java.lang.String Yes No
br Number Number
UnitFacility Facility Facility The Facility of the java.lang.String Yes Yes
Unit
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 118
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 119
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitHoldPermAppled Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
On AppliedOn AppliedOn active holds and
granted/canceled
permissions applied
to the unit
UnitHoldPermUpdate Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
dOn UpdatedOn UpdatedOn released holds and
granted/canceled
permissions updated
to the unit
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
sions Permissions granted permissions
attached to the unit.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm The IDs of active java.lang.String Yes No
sionsView Permissions Groups Groups Holds and
Permissions View on
the Unit
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.
UnitIsStowplanPoste Is Stowplan Posted Stowplan Posted Is there Stowplan java.lang.Boolean Yes Yes
d EDI containing the
particular Unit
UnitLastFreeDateRe Last Free Date >Last Free Date Last user who java.lang.String Yes No
cordedBy Recorded By Recorded By updated the free
date override
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 120
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
UnitNonActiveImpedi Released Holds and java.lang.String Yes No
ments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By ,Applied On Date,
Updated by and
Updated On
UnitStripServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STRIP
event for the
selected unit
UnitStuffServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STUFF
event for the
selected empty unit
UnitWayBillDate Waybill Date Waybill Date Way Bill date for java.util.Date Yes No
Unit.
UnitWayBillNbr Waybill Nbr Waybill Nbr Way bill number for java.lang.String Yes No
Unit.
VGMEntityVerifier VGM Verifier VGM Verifier Verifier of the Gross java.lang.String Yes Yes
Mass Ex: Load port,
Shipper.
VGMWeightKgValue VGM Weight VGM Weight The VGM weight of java.lang.Double Yes Yes
the equipment in
kilograms. The VGM
weight of the
container is
determined at the
terminal.
VesselLoadStop Stop-Vessel Stop-Vsl True if vessel load is java.lang.Boolean Yes Yes
disallowed.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 121
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit

External Tag Long Label Short Label Description Type In Design In Sort
VgmVerifiedDate VGM Updated Date VGM Updated Date The VGM Verified java.util.Date Yes No
Date for the
container.
VisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised',
'Active','Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
YardPositionVerified Verified Yard Ver Yard Pos True if the yard java.lang.Boolean Yes Yes
Position position has been
verified, otherwise
false.
YardStowageType Yard Stowage Type Yard Stow Type Type of yard java.lang.String Yes Yes
stowage required: W
for 'Must be kept on
wheels', G for 'Must
be kept on ground',
or E for 'Does not
matter'.
unitFlag1ReferenceI Export Control ECN The reference ID of java.lang.String Yes No
d Number the last hold/
permission defined
by setting
INVSERVICESFLAG
001 applied to the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 122
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
unitFlag2ReferenceI Payee Payee The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
002 applied to the
unit.
unitFlag3ReferenceI Unit Flag 3 Ref Id Unit Flag 3 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
003 applied to the
unit.
unitFlag4ReferenceI Unit Flag 4 Ref Id Unit Flag 4 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
004 applied to the
unit.
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

2.2.8 Unit - Complex Visit

The Unit - Complex Visit reporting entity corresponds to the attributes of the Unit entity from the perspective of a complex.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (ERO) for
receivals.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 123
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: Y for 'Yard', V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
AttachedPayloadUnit The Equipment IDs java.lang.String Yes No
s of attached payload
units separated by a
';'.
AttachedUnits Attached Attached The Equipment IDs java.lang.String Yes No
Equipments Equipments of attached units
separated by a ';'.
Bundle Unit is a Bundle Bundle True if the unit is a java.lang.Boolean Yes Yes
Bundle.
CargoWeight Cargo Weight Cargo Wt Cargo weight of the java.lang.Double Yes No
unit (gross weight
minus tare weight).
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 124
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
Commodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
CommodityDescripti Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
on Name description for the
contents of a unit.
DateOfGateProcessi EC-In Time EC-In Time The time the unit java.util.Date Yes Yes
ng was processed at the
gate.
DateOfLastHandling Time of Last Move Last Move The last recorded java.util.Date Yes Yes
time the unit was
moved.
DeckRequirements Deck Stowage Deck Req The stowage java.lang.String Yes Yes
Requirements requirement for the
unit: A for 'Above
Deck Only', B for
'Below Deck Only', or
E for 'Don't Care'.
DeclaredIbCarrierId Visit Ref Visit The declared/ java.lang.String Yes Yes
documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
DeclaredObCarrierId Visit Ref Visit The declared java.lang.String Yes Yes
outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
DemurragePayee Payee Payee The payee defined to java.lang.String Yes No
pay for demurrage
charges.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 125
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
DepartureOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (booking,
EDO, ELO) for
deliveries or
receivals.
DesignatedTrucking Id Id The ID of the java.lang.String Yes No
Company designated trucking
company to which
the unit will be
delivered.
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.
DrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit: F for
'Forward to Loading
Point', R for 'Return
to shipper', O for
'Dray Out and Back',
I for 'Dray In', or T for
'Transfer to other
Facility'.
DwellDays Dwell Days Dwell The number of days java.lang.Long Yes No
the unit has been in
the yard.
ECN Export Control ECN The ECN clearing java.lang.String Yes No
Number this unit by customs.
EquipmentArcheTyp ISO Id ISO Id The arche type for java.lang.String Yes Yes
eId the primary
equipment type code
(ISO or other). For
information about
ISO codes, see the
documents section at
http:www.smdg.org.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 126
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
equipment was
built/put in service.
EquipmentDamage Damage Severity Damage Severity The equipment java.lang.String Yes Yes
damage level: '-' for
Repaired, None,
Minor, or Major.
EquipmentGradeId ID ID The equipment java.lang.String Yes Yes
grade ID.
EquipmentHeightMm Height Height The overall java.lang.Long Yes Yes
equipment height in
millimeters.
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentIsFolded Is Folded Is Folded True if the equipment java.lang.Boolean Yes Yes
is folded such as a
folded flat-rack.
EquipmentIsOutOfSe Is POS Is POS True if the equipment java.lang.Boolean Yes Yes
rvice is permanently out of
service.
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration for the primary
equipment expires,
blank if no lease
applies.
EquipmentLengthM Length Length The overall java.lang.Long Yes Yes
m equipment length in
millimeters.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 127
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentMaterial Material Material The material of the java.lang.String Yes Yes
primary equipment:
Unknown, Aluminum,
or Steel.
EquipmentOffHireLo Off-Hire Location Off-Hire The location the java.lang.String Yes Yes
cation equipment will be
returned after it
comes off the lease.
EquipmentOperator Id Id The line operator java.lang.String Yes Yes
(shipping line)
currently registered
as the equipment
operator (lessee or
owner).
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).
EquipmentOwner Id Id The line operator java.lang.String Yes Yes
(shipping line) that
owns the primary
equipment.
EquipmentPreviousO Id Id The line operator java.lang.String Yes Yes
perator (shipping line) that
was the previous
operator for the
primary equipment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 128
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.
EquipmentSafeWeig Safe Weight Safe Wt The equipment safe java.lang.Double Yes Yes
htKg weight in kilograms.
The safe weight is
the maximum
permissible weight of
the equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code.
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 129
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
EquipmentWidthMm Width Width The overall java.lang.Long Yes Yes
equipment width in
millimeters.
FirstReeferRecordDa The date of the first java.util.Date Yes No
teAfterInTime reefer reading after
the unit came into
the yard (first reading
after in time).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 130
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
FirstReeferRecordTe The temperature java.lang.Double Yes No
mpAfterInTime recorded at the first
reefer reading after
the unit came into
the yard (first reading
after in time).
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
the unit.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GoodsBlNbr BL Number BL Nbr Simple Bill of Lading java.lang.String Yes Yes
Id.
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsConsigneeNa Consignee ID Consignee ID The specified java.lang.String Yes No
me consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
GoodsShipperName Shipper ID Shipper ID The name of the java.lang.String Yes No
specified shipper for
the goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 131
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: The gross
weight of the
equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
HandlingReason Handling Reason Hndl Reason Reason for last java.lang.String Yes Yes
handling: C for
'Container Operator
Request', L for 'Line
Operator Request', T
for 'Terminal
Convenience', or U
for 'Customs
Request'.
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
entered the facility.
Same as the
discharge time if the
unit was discharged
from a vessel.
InboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the inbound
carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 132
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierCount Country Name Cntry Name The country of the java.lang.String Yes No
ry inbound carrier.
InboundCarrierDocu Documentation Doc Nbr The documentation java.lang.String Yes No
mentationNbr Number number of the
inbound carrier. For
the vessel this is the
Coast Guard
Document Number.
InboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
inbound carrier.
InboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the trucking
company.
InboundCarrierInVoy Inbound carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes).
InboundCarrierInVoy Inbound carrier: For java.lang.String Yes No
ageNbr vessels it is the
inbound voyage
number, and for
trains it is the train
ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 133
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierName Carrier Name Carrier Name The inbound carrier java.lang.String Yes No
name such as Vessel
Name, Truck License
Number, or Train ID.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torId operator ID such as
the line operator
(shipping line) or the
Trucking Company.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torName operator name such
as the line operator
(shipping line), or the
trucking company.
InboundCarrierOutVo Inbound carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes).
InboundCarrierOutVo Inbound carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', or N for
'Train'.
InboundVesselInVoy Inbound Voyage I/B Vyg null null No Yes
ageNbrRef

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 134
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes No
contains hazardous
cargo.
IsOOG Is OOG Is OOG True if the unit is out- java.lang.Boolean Yes Yes
of-gauge.
IsOnPower On Power On Power True if the unit is java.lang.Boolean Yes Yes
connected to
electrical supply, or
forced air exchange,
in case of porthole
reefer.
IsReefer Requires Power Reqs Power True if the unit java.lang.Boolean Yes Yes
requires power (is an
active reefer).
IsYardPositionVerifie Verified Yard Ver Yard Pos True if the SPARCS java.lang.Boolean Yes Yes
d Position user has verified the
yard position of the
unit.
LastFreeDay Last Free Day Last Free Day The last day (as java.lang.String Yes No
string) the unit can
stay in the facility
without charges. If
the date has a
preceding '!', the
date has been
manually overridden
and is not calculated
using the storage
rules.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 135
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
LastFreeDayDate The last day the unit java.util.Date Yes No
can stay in the
facility without
charges.
LastReeferRecordDa The date of the last java.util.Date Yes No
te reefer reading.
LastReeferRecordTe Last Temperature Last Temp Read The temperature java.lang.Double Yes No
mp Monitored recorded during the
last reefer reading.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
MainHazardCodes Main Hazard Codes Hzd Codes All the applicable java.lang.String Yes No
hazard codes
separated by a ','.
MainHazardUNNum The UN Numbers of java.lang.String Yes No
bers the three most
severe hazards
registered as cargo,
separated by ','.
OOG A code to display the java.lang.String Yes No
OOG dimensions of
a unit 'H W L' for
Height, Width, and
Length. A '-' is
displayed if one of
the dimensions is not
OOG. For example,
'H - -' means that
only the Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 136
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
side (centimeters).
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
side (centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original port of java.lang.String Yes Yes
load (the
International port of
load, if the cargo was
relayed through
domestic ports of
load).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig The specified origin java.lang.String Yes Yes
of the goods.
OutTime Time Facility-Out Time Out The time the unit java.util.Date Yes Yes
exited the facility.
Same as the carrier
departure time.
OutboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the outbound
carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 137
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierCou Country Name Cntry Name The country of the java.lang.String Yes No
ntry outbound carrier.
OutboundCarrierDO DOT Hazardous Haz CCN The DOT certificate java.lang.String Yes Yes
TCertNbr Material CCN number for the
outbound carrier.
OutboundCarrierDoc Documentation Doc Nbr The documentation java.lang.String Yes No
umentationNbr Number number of the
outbound carrier. For
the vessel this is the
Coast Guard
Document Number.
OutboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
outbound carrier.
OutboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
train ID for train, or
license number for
truck.
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the
OutboundCarrierId,
but for trucks it also
includes the Trucking
Company.
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 138
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierInVo Inbound voyage java.lang.String Yes No
yageNbr number for the
Outbound Vessel
(undefined for other
carrier modes).
OutboundCarrierNa Carrier Name Carrier Name The name of the java.lang.String Yes No
me outbound carrier
(e.g. vessel name,
truck license number,
train ID).
OutboundCarrierOpe The operator ID of java.lang.String Yes No
ratorId the outbound carrier
such as the line
operator (shipping
line) or the trucking
company.
OutboundCarrierOpe The operator name java.lang.String Yes No
ratorName of the outbound
carrier such as the
line operator
(shipping line) or the
trucking company.
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes).
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageNbr For vessels it is the
outbound voyage
number, for trains it
is the train ID.
OutboundCarrierSer ID ID The service ID java.lang.String Yes Yes
viceId (rotation) of the
outbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 139
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
OutboundCarrierlInV Inbound voyage java.lang.String Yes No
oyageNbr number for the
Outbound Vessel
(undefined for other
carrier modes).
OutboundIntendedC Visit Ref Visit Intended Departure java.lang.String Yes Yes
arrierId carrier: Vessel ID for
vessel, train ID for
train, or license
number for truck.
OutboundVesselLab Labor On Board LaborOnBoard The time the labor java.util.Date Yes Yes
orOnBoard went on board to
work the outbound
vessel (undefined for
other carrier modes).
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
OwedStorageDays Storage Days Owed Storage Days Owed The number of days java.lang.Long Yes No
storage was charged
for the unit.
PIN PIN Number PIN The Container java.lang.String Yes Yes
Release Number or
Container PIN.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 140
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POD2Cntry Country Code Code The country code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code The country code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
vessel.
POLCntry Country Code Code The country code of java.lang.String Yes Yes
the port of load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 141
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
PlacardsMismatched Placards Mismatch Placards Mismatch False if Unit's Hazard java.lang.Boolean Yes Yes
placards and
observed placards
match, True
otherwise
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionPlanned Planned Position Planned Position Planned position of java.lang.String Yes No
the LOAD work
instruction.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 142
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
PowerOffRequested Requested Off- Requested Off- The date and time java.util.Date Yes Yes
Time Power Time Power the unit needs
should be taken off
power.
PowerOnLatestTime Must be On-Power Must be On-Power The latest date and java.util.Date Yes Yes
Time time the unit needs
to be on power.
RailLoadStop Stop-Rail Stop-Rail True if rail load is java.lang.Boolean Yes Yes
disallowed.
RequiredCO2Percen CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
tage required (%).
RequiredHumidityPe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
rcentage required (%).
RequiredMaxTempC Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 143
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
RequiredMinTempC Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredO2Percenta O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
ge required (%).
RequiredTempC Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
required temperature
(degrees
Centigrade).
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required. The
measurement unit is
defined in separate
field
RequiredVentUnit.
RequiredVentPercen Ventilation Required Vent Req DEPRECATED - Use java.lang.Double Yes Yes
tage the RequiredVent
field instead. The
measurement unit is
defined as a
separate field,
RequiredVentUnit.
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the
RequiredVent field.
RequiresPower Requires Power Reqs Power True if the unit needs java.lang.Boolean Yes Yes
power for its reefer
unit, or forced air, in
case of porthole
reefer.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 144
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', or H for
'Shift move'.
RoadDeliveryStop Stop-Road Stop-Road True if road delivery java.lang.Boolean Yes Yes
is disallowed.
RoutingGroup Group ID Grp ID The routing group ID. java.lang.String Yes Yes
SealNbr1 Seal Number 1 Seal Nbr1 Seal number 1. java.lang.String Yes Yes
SealNbr2 Seal Number 2 Seal Nbr2 Seal number 2. java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 Seal number 3. java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 Seal number 4. java.lang.String Yes Yes
SpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID.
SpecialStow2 ID ID The special stow 2 java.lang.String Yes Yes
requirement ID.
SpecialStow3 ID ID The special stow 3 java.lang.String Yes Yes
requirement ID.
StorageIsPaid Is Storage Paid Is Storage Paid True if storage is java.lang.Boolean Yes No
paid.
TempRequiredInC Temp Req. in C Temp Req. in C The preferred/ java.lang.Double Yes No
required temperature
(degrees
Centigrade).
TempRequiredInF Temp Req. in F Temp Req. in F The preferred/ java.lang.Double Yes No
required temperature
(degrees
Fahrenheit).
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
outbound carrier,
empty if not yet
loaded.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 145
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 146
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString05.
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString10.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 147
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvMoveCount Move Count Move Count No. of moves done java.lang.Long Yes Yes
for a unit during its
unit facility visit.
UfvSparcsNotes Sparcs Notes Sparcs Notes Unit Facility Visit java.lang.String Yes No
Sparcs Notes
UnitActiveImpedimen Active Holds and java.lang.String Yes No
ts Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On
UnitCreatedDate Time Created Time Created The date and time java.util.Date Yes Yes
when the unit is
created.
UnitEquipDmgsItmN Miscellaneous notes java.lang.String Yes No
otes for the damage Item
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 148
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
sions Permissions granted permissions
attached to the unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 149
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.
UnitNonActiveImpedi Released Holds and java.lang.String Yes No
ments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By ,Applied On Date,
Updated by and
Updated On
UnitStripServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STRIP
event for the
selected unit
UnitStuffServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STUFF
event for the
selected empty unit
VGMEntityVerifier VGM Verifier VGM Verifier Verifier of the Gross java.lang.String Yes Yes
Mass Ex: Load port,
Shipper.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 150
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
VGMWeightKgValue VGM Weight VGM Weight The VGM weight of java.lang.Double Yes Yes
the equipment in
kilograms. The VGM
weight of the
container is
determined at the
terminal.
VesselLoadStop Stop-Vessel Stop-Vsl True if vessel load is java.lang.Boolean Yes Yes
disallowed.
VgmVerifiedDate VGM Updated Date VGM Updated Date The VGM Verified java.util.Date Yes No
Date for the
container.
VisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
YardPositionVerified Verified Yard Ver Yard Pos True if the yard java.lang.Boolean Yes Yes
Position position has been
verified, false
otherwise.
YardStowageType Yard Stowage Type Yard Stow Type Type of yard java.lang.String Yes Yes
stowage required: W
for 'Must be kept on
wheels', G for 'Must
be kept on ground,
or E for 'Does not
matter'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 151
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Complex Visit

External Tag Long Label Short Label Description Type In Design In Sort
unitFlag1ReferenceI Export Control ECN The reference ID of java.lang.String Yes No
d Number the last hold/
permission defined
by setting
INVSERVICESFLAG
001 applied to the
unit.
unitFlag2ReferenceI Payee Payee The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
002 applied to the
unit.
unitFlag3ReferenceI Unit Flag 3 Ref Id Unit Flag 3 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
003 applied to the
unit.
unitFlag4ReferenceI Unit Flag 4 Ref Id Unit Flag 4 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
004 applied to the
unit.
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 152
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit - Damages

2.2.9 Unit - Damages

The Unit - Damages reporting entity emphasizes on the damages to the primary equipment in the unit. The Unit is the central object in N4, representing a
moveable entity consisting of cargo and its packaging.

A unit with two damage items appears in the report as two separate result rows.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (ERO) for
receivals.
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
AttachedPayloadUnit The Equipment IDs java.lang.String Yes No
s of attached payload
units separated by a
';'.
AttachedUnits Attached Attached The Equipment IDs java.lang.String Yes No
Equipments Equipments of attached units
separated by a ';'.
Bundle Unit is a Bundle Bundle True if the unit is a java.lang.Boolean Yes Yes
Bundle.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 153
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
CargoWeight Cargo Weight Cargo Wt Cargo weight of the java.lang.Double Yes No
unit (gross weight
minus tare weight).
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).
Commodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
CommodityDescripti Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
on Name description for the
contents of a unit.
DamageComponent Component ID ID The equipment java.lang.String Yes Yes
component that is
damaged (door, floor,
etc.).
DamageComponent Eq Class Eq Class Equipment class for java.lang.String Yes Yes
Class the damage
component:
'Container',
'Chassis',
'Semitrailer' , 'Mafi',
'Accessory'.
DamageComponent Eq Class Eq Class Equipment class for java.lang.String Yes No
ClassShort the damage
component: CTR for
'Container' , CHS for
'Chassis', STR for
'Semitrailer', MFI for
'Mafi', or ACC for
'Accessory'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 154
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
DamageComponent Description Description A description of the java.lang.String Yes Yes
Description equipment damage
component
DamageDepthCm Depth Depth The depth of the java.lang.Double Yes Yes
damaged area.
DamageDescription Notes Notes Description of the java.lang.String Yes No
damage.
DamageLengthCm Length Length The length of the java.lang.Double Yes Yes
damaged area.
DamageLocation Location Location The location of the java.lang.String Yes Yes
equipment damage.
DamageQuantity Quantity Quantity The damage quantity java.lang.Long Yes Yes
such as the number
of holes, dents, etc.
DamageSeverity Severity Severity Damage level: '-' for java.lang.String Yes Yes
none, Minor, or
Major.
DamageType ID ID Damage type ID. java.lang.String Yes Yes
DamageTypeClass Equipment Class Equip Class Equipment class for java.lang.String Yes Yes
the damage type:
'Container',
'Chassis',
'Semitrailer', 'Mafi',
'Accessory'.
DamageTypeClassS Equipment Class Equip Class Equipment class for java.lang.String Yes No
hort the damage type:
CTR for 'Container',
CHS for 'Chassis',
STR for 'Semitrailer',
MFI for 'Mafi', or
ACC for 'Accessory'.
DamageTypeDescrip Description Description A description of the java.lang.String Yes Yes
tion equipment damage
type

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 155
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
DamageWidthCm Width Width The width of the java.lang.Double Yes Yes
damaged area.
DateDamageRepaire Repaired On Repaired The date the java.util.Date Yes Yes
d damage was
repaired.
DateDamageReporte Reported On Reported The date the java.util.Date Yes Yes
d damage was
reported.
DateOfGateProcessi EC-In Time EC-In Time The time the unit java.util.Date Yes Yes
ng was processed at the
gate.
DateOfLastHandling Time of Last Move Last Move The last recorded java.util.Date Yes Yes
time the unit was
moved.
DeckRequirements Deck Stowage Deck Req The stowage java.lang.String Yes Yes
Requirements requirement for the
unit: A for 'Above
Deck Only', B for
'Below Deck Only', or
E for 'Don't Care'.
DeclaredIbCarrierId Visit Ref Visit The declared/ java.lang.String Yes Yes
documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
DeclaredObCarrierId Visit Ref Visit The declared java.lang.String Yes Yes
outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
DemurragePayee Payee Payee The payee defined to java.lang.String Yes No
pay for demurrage
charges.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 156
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
DepartureOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (booking,
EDO, ELO) for
deliveries or
receivals.
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.
DrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit: F for
'Forward to Loading
Point', R for 'Return
to shipper', O for
'Dray Out and Back',
I for 'Dray In', or T for
'Transfer to other
Facility'.
DwellDays Dwell Days Dwell The number of days java.lang.Long Yes No
the unit has been in
the yard.
ECN Export Control ECN The ECN clearing java.lang.String Yes No
Number this unit by customs.
EquipmentArcheTyp ISO Id ISO Id The arche type for java.lang.String Yes Yes
eId the primary
equipment type code
(ISO or other). For
information about
ISO codes, see the
documents section at
http:www.smdg.org.
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
equipment was
built/put in service.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 157
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentDamage Damage Severity Damage Severity The equipment java.lang.String Yes Yes
damage level: '-' for
Repaired, None,
Minor, or Major.
EquipmentGradeId ID ID The equipment java.lang.String Yes Yes
grade ID.
EquipmentHeightMm Height Height The overall java.lang.Long Yes Yes
equipment height in
millimeters.
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentIsFolded Is Folded Is Folded True if the equipment java.lang.Boolean Yes Yes
is folded such as a
folded flat-rack.
EquipmentIsOutOfSe Is POS Is POS True if the equipment java.lang.Boolean Yes Yes
rvice is permanently out of
service.
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration for the primary
equipment expires,
blank if no lease
applies.
EquipmentLengthM Length Length The overall java.lang.Long Yes Yes
m equipment length in
millimeters.
EquipmentMaterial Material Material The material of the java.lang.String Yes Yes
primary equipment:
Unknown, Aluminum,
or Steel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 158
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOffHireLo Off-Hire Location Off-Hire The location the java.lang.String Yes Yes
cation equipment will be
returned after it
comes off the lease.
EquipmentOperator Id Id The line operator java.lang.String Yes Yes
(shipping line)
currently registered
as the equipment
operator (lessee or
owner).
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).
EquipmentOwner Id Id The line operator java.lang.String Yes Yes
(shipping line) that
owns the primary
equipment.
EquipmentPreviousO Id Id The line operator java.lang.String Yes Yes
perator (shipping line) that
was the previous
operator for the
primary equipment.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 159
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentSafeWeig Safe Weight Safe Wt The equipment safe java.lang.Double Yes Yes
htKg weight in kilograms.
The safe weight is
the maximum
permissible weight of
the equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 160
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
EquipmentWidthMm Width Width The overall java.lang.Long Yes Yes
equipment width in
millimeters.
FirstReeferRecordDa The date of the first java.util.Date Yes No
teAfterInTime reefer reading after
the unit came into
the yard (first reading
after in time).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 161
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
FirstReeferRecordTe The temperature java.lang.Double Yes No
mpAfterInTime recorded at the first
reefer reading after
the unit came into
the yard (first reading
after in time).
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
the unit.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GoodsBlNbr BL Number BL Nbr Simple Bill of Lading java.lang.String Yes Yes
Id.
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsConsigneeNa Name Name The specified java.lang.String Yes Yes
me consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
GoodsShipperName Name Name The name of the java.lang.String Yes Yes
specified shipper for
the goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 162
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: The gross
weight of the
equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
HandlingReason Handling Reason Hndl Reason Reason for last java.lang.String Yes Yes
handling: C for
'Container Operator
Request', L for 'Line
Operator Request', T
for 'Terminal
Convenience', or U
for 'Customs
Request'.
HasPlannedMove True if there is a java.lang.Boolean Yes No
planned move for
this unit.
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
entered the facility.
Same as the
discharge time if the
unit was discharged
from a vessel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 163
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the inbound
carrier.
InboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierCount Country Name Cntry Name The country of the java.lang.String Yes No
ry inbound carrier.
InboundCarrierDocu Documentation Doc Nbr The documentation java.lang.String Yes No
mentationNbr Number number of the
inbound carrier. For
the vessel this is the
Coast Guard
Document Number.
InboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
inbound carrier.
InboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the trucking
company.
InboundCarrierInVoy Inbound carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 164
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierInVoy Inbound carrier: For java.lang.String Yes No
ageNbr vessels it is the
inbound voyage
number, and for
trains it is the train
ID.
InboundCarrierName Carrier Name Carrier Name The inbound carrier java.lang.String Yes No
name such as Vessel
Name, Truck License
Number, or Train ID.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torId operator ID such as
the line operator
(shipping line) or the
Trucking Company.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torName operator name such
as the line operator
(shipping line), or the
trucking company.
InboundCarrierOutVo Inbound carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes).
InboundCarrierOutVo Inbound carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 165
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
InboundVesselName Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
InboundCarrierName
instead.
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes No
contains hazardous
cargo.
IsOOG Is OOG Is OOG True if the unit is out- java.lang.Boolean Yes Yes
of-gauge.
IsOnPower On Power On Power True if the unit is java.lang.Boolean Yes Yes
connected to
electrical supply, or
forced air exchange,
in case of porthole
reefer.
IsReefer Requires Power Reqs Power True if the unit java.lang.Boolean Yes Yes
requires power (is an
active reefer).
IsYardPositionVerifie Verified Yard Ver Yard Pos True if the SPARCS java.lang.Boolean Yes Yes
d Position user has verified the
yard position of the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 166
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
LastFreeDay Last Free Day Last Free Day The last day (as java.lang.String Yes No
string) the unit can
stay in the facility
without charges. If
the date has a
preceding '!', the
date has been
manually overridden
and is not calculated
using the storage
rules.
LastFreeDayDate The last day the unit java.util.Date Yes No
can stay in the
facility without
charges (date
object).
LastReeferRecordDa The date of the last java.util.Date Yes No
te reefer reading.
LastReeferRecordTe Last Temperature Last Temp Read The temperature java.lang.Double Yes No
mp Monitored recorded during the
last reefer reading.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
MainHazardCodes Main Hazard Codes Hzd Codes All the applicable java.lang.String Yes No
hazard codes
separated by a ','.
MainHazardUNNum The UN Numbers of java.lang.String Yes No
bers the three most
severe hazards
registered as cargo,
separated by ','.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 167
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
OOG A code to display the java.lang.String Yes No
OOG dimensions of
a unit 'H W L' for
Height, Width, and
Length. A '-' is
displayed if one of
the dimensions is not
OOG. For example,
'H - -' means that
only the Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
side (centimeters).
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
side (centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original port of java.lang.String Yes Yes
load (the
International port of
load, if the cargo was
relayed through
domestic ports of
load).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 168
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig The specified origin java.lang.String Yes Yes
of the goods.
OutTime Time Facility-Out Time Out The time the unit java.util.Date Yes Yes
exited the facility.
Same as the carrier
departure time.
OutboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the outbound
carrier.
OutboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierCou Country Name Cntry Name The country of the java.lang.String Yes No
ntry outbound carrier.
OutboundCarrierDO DOT Hazardous Haz CCN The DOT certificate java.lang.String Yes Yes
TCertNbr Material CCN number for the
outbound carrier.
OutboundCarrierDoc Documentation Doc Nbr The documentation java.lang.String Yes No
umentationNbr Number number of the
outbound carrier. For
the vessel this is the
Coast Guard
Document Number.
OutboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
outbound carrier.
OutboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
outbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 169
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
train ID for train, or
license number for
truck.
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the InboundCarrierId,
but for trucks it also
includes the Trucking
Company.
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes).
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundCarrierNa Carrier Name Carrier Name The name of the java.lang.String Yes No
me outbound carrier
(e.g. vessel name,
truck license number,
train ID).
OutboundCarrierOpe The operator ID of java.lang.String Yes No
ratorId the outbound carrier
such as the line
operator (shipping
line) or the trucking
company.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 170
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierOpe The operator name java.lang.String Yes No
ratorName of the outbound
carrier such as the
line operator
(shipping line) or the
trucking company.
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes).
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageNbr For vessels it is the
outbound voyage
number, for trains it
is the train ID.
OutboundCarrierSer ID ID The service ID java.lang.String Yes Yes
viceId (rotation) of the
outbound carrier.
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
OutboundCarrierlInV Departure carrier: java.lang.String Yes No
oyageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundVesselNam Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
e OutboundCarrierNa
me instead.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 171
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
OwedStorageDays Storage Days Owed Storage Days Owed The number of days java.lang.Long Yes No
storage was charged
for the unit.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POD2Cntry Country Code Code The country code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code The country code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 172
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
vessel.
POLCntry Country Code Code The country code of java.lang.String Yes Yes
the port of load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 173
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
PositionPlanned Planned Position Planned Position Planned position of java.lang.String Yes No
the LOAD work
instruction.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
PowerOffRequested Requested Off- Requested Off- The date and time java.util.Date Yes Yes
Time Power Time Power the unit needs
should be taken off
power.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 174
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
PowerOnLatestTime Must be On-Power Must be On-Power The latest date and java.util.Date Yes Yes
Time time the unit needs
to be on power.
RailLoadStop Stop-Rail Stop-Rail True if rail load is java.lang.Boolean Yes Yes
disallowed.
RequiredCO2Percen CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
tage required (%).
RequiredHumidityPe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
rcentage required (%).
RequiredMaxTempC Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredMinTempC Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredO2Percenta O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
ge required (%).
RequiredTempC Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
required temperature
(degrees
Centigrade).
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required. The
measurement unit is
defined in separate
field
RequiredVentUnit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 175
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
RequiredVentPercen Ventilation Required Vent Req DEPRECATED - Use java.lang.Double Yes Yes
tage the RequiredVent
field instead. The
measurement unit is
defined as a
separate field,
RequiredVentUnit.
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the
RequiredVent field.
RequiresPower Requires Power Reqs Power True if the unit needs java.lang.Boolean Yes Yes
power for its reefer
unit, or forced air, in
case of porthole
reefer.
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', or H for
'Shift move'.
RoadDeliveryStop Stop-Road Stop-Road True if road delivery java.lang.Boolean Yes Yes
is disallowed.
RoutingGroup Group ID Grp ID The routing group ID. java.lang.String Yes Yes
SealNbr1 Seal Number 1 Seal Nbr1 Seal number 1. java.lang.String Yes Yes
SealNbr2 Seal Number 2 Seal Nbr2 Seal number 2. java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 Seal number 3. java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 Seal number 4. java.lang.String Yes Yes
SpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID.
SpecialStow2 ID ID The special stow 2 java.lang.String Yes Yes
requirement ID.
SpecialStow3 ID ID The special stow 3 java.lang.String Yes Yes
requirement ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 176
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
StorageIsPaid Is Storage Paid Is Storage Paid True if storage is java.lang.Boolean Yes No
paid.
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
outbound carrier,
empty if not yet
loaded.
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 177
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString05.
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString08.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 178
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString10.
UfvSparcsNotes Sparcs Notes Sparcs Notes Unit Facility Visit java.lang.String Yes No
Sparcs Notes
UnitActiveImpedimen Active Holds and java.lang.String Yes No
ts Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On
UnitEquipDmgsItmN Miscellaneous notes java.lang.String Yes No
otes for the damage Item
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 179
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 180
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
sions Permissions granted permissions
attached to the unit.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm The IDs of active java.lang.String Yes No
sionsView Permissions Groups Groups Holds and
Permissions View on
the Unit
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.
UnitNonActiveImpedi Released Holds and java.lang.String Yes No
ments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By ,Applied On Date,
Updated by and
Updated On
UnitRemark Unit Notes Unit Notes Unit Notes java.lang.String Yes No
UnitStripServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STRIP
event for the
selected unit
UnitStuffServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STUFF
event for the
selected empty unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 181
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Damages

External Tag Long Label Short Label Description Type In Design In Sort
VesselLoadStop Stop-Vessel Stop-Vsl True if vessel load is java.lang.Boolean Yes Yes
disallowed.
VisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
YardPositionVerified Verified Yard Ver Yard Pos True if the yard java.lang.Boolean Yes Yes
Position position has been
verified, false
otherwise.
YardStowageType Yard Stowage Type Yard Stow Type Type of yard java.lang.String Yes Yes
stowage required: W
for 'Must be kept on
wheels', G for 'Must
be kept on ground,
or E for 'Does not
matter'.
unitFlag1ReferenceI Export Control ECN The reference ID of java.lang.String Yes No
d Number the last hold/
permission defined
by setting
INVSERVICESFLAG
001 applied to the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 182
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
unitFlag2ReferenceI Payee Payee The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
002 applied to the
unit.
unitFlag3ReferenceI Unit Flag 3 Ref Id Unit Flag 3 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
003 applied to the
unit.
unitFlag4ReferenceI Unit Flag 4 Ref Id Unit Flag 4 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
004 applied to the
unit.
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

2.2.10 Unit - Hazards

The Unit - Hazards reporting entity emphasizes on the hazardous content of a unit. The Unit is the central object in N4, representing a moveable entity
consisting of cargo and its packaging.

A unit with two hazard items appears in the report as two separate result rows.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 183
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
AttachedPayloadUnit The Equipment IDs java.lang.String Yes No
s of attached payload
units separated by a
';'.
AttachedUnits Attached Attached The Equipment IDs java.lang.String Yes No
Equipments Equipments of attached units
separated by a ';'.
Bundle Unit is a Bundle Bundle True if the unit is a java.lang.Boolean Yes Yes
Bundle.
CargoWeight Cargo Weight Cargo Wt Cargo weight of the java.lang.Double Yes No
unit (gross weight
minus tare weight).
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 184
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
Commodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
CommodityDescripti Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
on Name description for the
contents of a unit.
DateOfGateProcessi EC-In Time EC-In Time The time the unit java.util.Date Yes Yes
ng was processed at the
gate.
DateOfLastHandling Time of Last Move Last Move The last recorded java.util.Date Yes Yes
time the unit was
moved.
DeckRequirements Deck Stowage Deck Req The stowage java.lang.String Yes Yes
Requirements requirement for the
unit: A for 'Above
Deck Only', B for
'Below Deck Only', or
E for 'Don't Care'.
DeclaredIbCarrierId Visit Ref Visit The declared/ java.lang.String Yes Yes
documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
DeclaredObCarrierId Visit Ref Visit The declared java.lang.String Yes Yes
outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
DemurragePayee Payee Payee The payee defined to java.lang.String Yes No
pay for demurrage
charges.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 185
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
DepartureOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (booking,
EDO, ELO) for
deliveries or
receivals.
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.
DrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit: F for
'Forward to Loading
Point', R for 'Return
to shipper', O for
'Dray Out and Back',
I for 'Dray In', or T for
'Transfer to other
Facility'.
DwellDays Dwell Days Dwell The number of days java.lang.Long Yes No
the unit has been in
the yard.
ECN Export Control ECN The ECN clearing java.lang.String Yes No
Number this unit by customs.
EquipmentArcheTyp ISO Id ISO Id The arche type for java.lang.String Yes Yes
eId the primary
equipment type code
(ISO or other). For
information about
ISO codes, see the
documents section at
http:www.smdg.org.
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
equipment was
built/put in service.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 186
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentDamage Damage Severity Damage Severity The equipment java.lang.String Yes Yes
damage level: '-' for
Repaired, None,
Minor, or Major.
EquipmentGradeId ID ID The equipment java.lang.String Yes Yes
grade ID.
EquipmentHeightMm Height Height The overall java.lang.Long Yes Yes
equipment height in
millimeters.
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentIsFolded Is Folded Is Folded True if the equipment java.lang.Boolean Yes Yes
is folded such as a
folded flat-rack.
EquipmentIsOutOfSe Is POS Is POS True if the equipment java.lang.Boolean Yes Yes
rvice is permanently out of
service.
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration for the primary
equipment expires,
blank if no lease
applies.
EquipmentLengthM Length Length The overall java.lang.Long Yes Yes
m equipment length in
millimeters.
EquipmentMaterial Material Material The material of the java.lang.String Yes Yes
primary equipment:
Unknown, Aluminum,
or Steel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 187
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOffHireLo Off-Hire Location Off-Hire The location the java.lang.String Yes Yes
cation equipment will be
returned after it
comes off the lease.
EquipmentOperator Id Id The line operator java.lang.String Yes Yes
(shipping line)
currently registered
as the equipment
operator (lessee or
owner).
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).
EquipmentOwner Id Id The line operator java.lang.String Yes Yes
(shipping line) that
owns the primary
equipment.
EquipmentPreviousO Id Id The line operator java.lang.String Yes Yes
perator (shipping line) that
was the previous
operator for the
primary equipment.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 188
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentSafeWeig Safe Weight Safe Wt The equipment safe java.lang.Double Yes Yes
htKg weight in kilograms.
The safe weight is
the maximum
permissible weight of
the equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 189
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
EquipmentWidthMm Width Width The overall java.lang.Long Yes Yes
equipment width in
millimeters.
FirstReeferRecordDa The date of the first java.util.Date Yes No
teAfterInTime reefer reading after
the unit came into
the yard (first reading
after in time).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 190
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
FirstReeferRecordTe The temperature java.lang.Double Yes No
mpAfterInTime recorded at the first
reefer reading after
the unit came into
the yard (first reading
after in time).
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
the unit.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GoodsBlNbr BL Number BL Nbr Simple Bill of Lading java.lang.String Yes Yes
Id.
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsConsigneeNa Name Name The specified java.lang.String Yes Yes
me consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
GoodsShipperName Name Name The name of the java.lang.String Yes Yes
specified shipper for
the goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 191
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: The gross
weight of the
equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
HandlingReason Handling Reason Hndl Reason Reason for last java.lang.String Yes Yes
handling: C for
'Container Operator
Request', L for 'Line
Operator Request', T
for 'Terminal
Convenience', or U
for 'Customs
Request'.
HasPlannedMove There is a planned java.lang.Boolean Yes No
move for this unit.
HazardItemDcLgRef DcLgRef DcLgRef DANCARG DC-lg- java.lang.String Yes Yes
refno.
HazardItemDeckRes Deck Restrictions Deck Restr A DANCARG deck java.lang.String Yes Yes
trictions restriction.
HazardItemDescripti The Hazard Item java.lang.String Yes No
on Description.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 192
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
HazardItemEMSNum EMS EMS The emergency java.lang.String Yes Yes
ber schedule number of
the hazard item.
HazardItemEmergen Emergency contact Emrg. Tel. The emergency java.lang.String Yes Yes
cyTelephone telephone number of
the hazard item.
HazardItemExplosive Explosive Class Expl.Class The explosive class java.lang.String Yes Yes
Class (A, B, etc.).
HazardItemFireCode Id Id The fire code for this java.lang.String Yes Yes
hazard item.
HazardItemFlashPoi Flash Point Flash The temperature in java.lang.Double Yes Yes
nt Centigrade at which
the hazardous
material will
spontaneously
combust.
HazardItemHazIdUp Hazard Id, Upper Haz Id, upper part Hazard Identification java.lang.String Yes Yes
per part number, upper part.
HazardItemImdgClas IMDG Class IMDG Class The standard IMDG java.lang.String Yes Yes
s class code to identify
the hazardous
material.
HazardItemInhalatio InhalationZone Inh.Zone DANCARG java.lang.String Yes Yes
nZone inhalation zone.
HazardItemLimitedQt Limited Quantity Ltd Qty True if the quantity is java.lang.Boolean Yes Yes
y too small to require
segregation or
special handling.
HazardItemMFAG MFAG MFAG The medical first aid java.lang.String Yes Yes
guide number of the
hazard item.
HazardItemMarinePo Marine Pollutants Marine Pollutants The marine java.lang.Boolean Yes Yes
llutants pollutants of the
hazard item.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 193
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
HazardItemMoveMet Move Method Move Meth The method by java.lang.String Yes Yes
hod which the cargo is to
be moved (fork, etc).
HazardItemNumberT Hazard Number Hazard Number The number type for java.lang.String Yes Yes
ype Type Type the hazard entry.
HazardItemPackage PackageType Pkg.Type A description of the java.lang.String Yes Yes
Type package type.
HazardItemPacking Packing Group Pack Gr The type of java.lang.String Yes Yes
Group packaging an
explosive is in.
HazardItemPageNu IMDG Page Number IMDG Page The page number in java.lang.String Yes Yes
mber the IMDG book
(English version)
where the hazard is
described in detail.
HazardItemPlacards Hazard Item Hazard Item A string representing java.lang.String Yes No
String Placards Placards the placards
associated with the
hazard item.
HazardItemPlannerR Planner Reference Planner Ref DG-reference java.lang.String Yes Yes
ef Number number as allocated
by the central
planner.
HazardItemProperNa Proper Name Prop.Name The legal name of java.lang.String Yes Yes
me the hazardous
commodity for a
hazardous shipment.
HazardItemQuantity Quantity Qty Quantity of items java.lang.Long Yes Yes
such as barrels or
boxes for this hazard
type.
HazardItemRemarks Notes Notes The remarks java.lang.String Yes Yes
associated with the
hazard item.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 194
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
HazardItemRespons Emergency ERG Nbr The response guide java.lang.String Yes Yes
eGuideNbr Response Guide Nbr number of the
hazard item.
HazardItemSecondar IMO1 IMO1 The standard IMDG java.lang.String Yes Yes
yIMO1 class code to identify
the Secondary IMO1.
HazardItemSecondar IMO2 IMO2 The standard IMDG java.lang.String Yes Yes
yIMO2 class code to identify
the Secondary IMO2.
HazardItemSequenc Sequence Number Seq Nbr The Sequence java.lang.Long Yes Yes
e number for the
hazard entry.
HazardItemSubstanc Substance Id, Lower Subst Id, Lower Part Substance java.lang.String Yes Yes
eLower Part Identification
number, lower part.
HazardItemTechNam Technical Name Tech.Name The technical name java.lang.String Yes Yes
e of the hazardous
cargo.
HazardItemUNNumb UN/NA Number UN/NA The UN number for java.lang.String Yes Yes
er the hazard entry.
HazardItemWeight Weight Wt The net weight in java.lang.Double Yes Yes
kilograms of the
hazardous material.
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
entered the facility.
Same as the
discharge time if the
unit was discharged
from a vessel.
InboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the inbound
carrier.
InboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
inbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 195
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierCount Country Name Cntry Name The country of the java.lang.String Yes No
ry inbound carrier.
InboundCarrierDOT DOT Hazardous Haz CCN The DOT certificate java.lang.String Yes Yes
CertNbr Material CCN number for the
inbound carrier.
InboundCarrierDocu Documentation Doc Nbr The documentation java.lang.String Yes No
mentationNbr Number number of the
inbound carrier. For
the vessel this is the
Coast Guard
Document Number.
InboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
inbound carrier.
InboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the trucking
company.
InboundCarrierInVoy Inbound carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes).
InboundCarrierInVoy Inbound carrier: For java.lang.String Yes No
ageNbr vessels it is the
inbound voyage
number, and for
trains it is the train
ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 196
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierName Carrier Name Carrier Name The inbound carrier java.lang.String Yes No
name such as Vessel
Name, Truck License
Number, or Train ID.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torId operator ID such as
the line operator
(shipping line) or the
Trucking Company.
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torName operator name such
as the line operator
(shipping line), or the
trucking company.
InboundCarrierOutVo Inbound carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes).
InboundCarrierOutVo Inbound carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', or N for
'Train'.
InboundVesselInVoy Inbound Voyage I/B Vyg null null No Yes
ageNbrRef
InboundVesselName Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
InboundCarrierName
instead.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 197
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes No
contains hazardous
cargo.
IsOOG Is OOG Is OOG True if the unit is out- java.lang.Boolean Yes Yes
of-gauge.
IsOnPower On Power On Power True if the unit is java.lang.Boolean Yes Yes
connected to
electrical supply, or
forced air exchange,
in case of porthole
reefer.
IsReefer Requires Power Reqs Power True if the unit java.lang.Boolean Yes Yes
requires power (is an
active reefer).
IsYardPositionVerifie Verified Yard Ver Yard Pos True if the SPARCS java.lang.Boolean Yes Yes
d Position user has verified the
yard position of the
unit.
LastFreeDay Last Free Day Last Free Day The last day (as java.lang.String Yes No
string) the unit can
stay in the facility
without charges. If
the date has a
preceding '!', the
date has been
manually overridden
and is not calculated
using the storage
rules.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 198
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
LastFreeDayDate The last day the unit java.util.Date Yes No
can stay in the
facility without
charges (date
object).
LastReeferRecordDa The date of the last java.util.Date Yes No
te reefer reading.
LastReeferRecordTe Last Temperature Last Temp Read The temperature java.lang.Double Yes No
mp Monitored recorded during the
last reefer reading.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
MainHazardCodes Main Hazard Codes Hzd Codes All the applicable java.lang.String Yes No
hazard codes
separated by a ','.
MainHazardUNNum The UN Numbers of java.lang.String Yes No
bers the three most
severe hazards
registered as cargo,
separated by ','.
OOG A code to display the java.lang.String Yes No
OOG dimensions of
a unit 'H W L' for
Height, Width, and
Length. A '-' is
displayed if one of
the dimensions is not
OOG. For example,
'H - -' means that
only the Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 199
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
side (centimeters).
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
side (centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original port of java.lang.String Yes Yes
load (the
International port of
load, if the cargo was
relayed through
domestic ports of
load).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig The specified origin java.lang.String Yes Yes
of the goods.
OutTime Time Facility-Out Time Out The time the unit java.util.Date Yes Yes
exited the facility.
Same as the carrier
departure time.
OutboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the outbound
carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 200
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierCou Country Name Cntry Name The country of the java.lang.String Yes No
ntry outbound carrier.
OutboundCarrierDO DOT Hazardous Haz CCN The DOT certificate java.lang.String Yes Yes
TCertNbr Material CCN number for the
outbound carrier.
OutboundCarrierDoc Documentation Doc Nbr The documentation java.lang.String Yes No
umentationNbr Number number of the
outbound carrier. For
the vessel this is the
Coast Guard
Document Number.
OutboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
outbound carrier.
OutboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
train ID for train, or
license number for
truck.
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the
OutboundCarrierId,
but for trucks it also
includes the Trucking
Company.
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 201
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundCarrierNa Carrier Name Carrier Name The name of the java.lang.String Yes No
me outbound carrier
(e.g. vessel name,
truck license number,
train ID).
OutboundCarrierOpe The operator ID of java.lang.String Yes No
ratorId the outbound carrier
such as the line
operator (shipping
line) or the trucking
company.
OutboundCarrierOpe The operator name java.lang.String Yes No
ratorName of the outbound
carrier such as the
line operator
(shipping line) or the
trucking company.
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes).
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageNbr For vessels it is the
outbound voyage
number, for trains it
is the train ID.
OutboundCarrierSer ID ID The service ID java.lang.String Yes Yes
viceId (rotation) of the
outbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 202
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
OutboundCarrierlInV Departure carrier: java.lang.String Yes No
oyageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundVesselNam Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
e OutboundCarrierNa
me instead.
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
OwedStorageDays Storage Days Owed Storage Days Owed The number of days java.lang.Long Yes No
storage was charged
for the unit.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POD2Cntry Country Code Code The country code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 203
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code The country code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
vessel.
POLCntry Country Code Code The country code of java.lang.String Yes Yes
the port of load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.
PlacardsMismatched Placards Mismatch Placards Mismatch False if Unit's Hazard java.lang.Boolean Yes Yes
placards and
observed placards
match, True
otherwise
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 204
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.
PositionPlanned Planned Position Planned Position Planned position of java.lang.String Yes No
the LOAD work
instruction.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 205
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
PowerOffRequested Requested Off- Requested Off- The date and time java.util.Date Yes Yes
Time Power Time Power the unit needs
should be taken off
power.
PowerOnLatestTime Must be On-Power Must be On-Power The latest date and java.util.Date Yes Yes
Time time the unit needs
to be on power.
RailLoadStop Stop-Rail Stop-Rail True if rail load is java.lang.Boolean Yes Yes
disallowed.
RequiredCO2Percen CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
tage required (%).
RequiredHumidityPe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
rcentage required (%).
RequiredMaxTempC Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredMinTempC Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 206
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
RequiredO2Percenta O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
ge required (%).
RequiredTempC Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
required temperature
(degrees
Centigrade).
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required. The
measurement unit is
defined in separate
field
RequiredVentUnit.
RequiredVentPercen Ventilation Required Vent Req DEPRECATED - Use java.lang.Double Yes Yes
tage the RequiredVent
field instead. The
measurement unit is
defined as a
separate field,
RequiredVentUnit.
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the
RequiredVent field.
RequiresPower Requires Power Reqs Power True if the unit needs java.lang.Boolean Yes Yes
power for its reefer
unit, or forced air, in
case of porthole
reefer.
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', or H for
'Shift move'.
RoadDeliveryStop Stop-Road Stop-Road True if road delivery java.lang.Boolean Yes Yes
is disallowed.
RoutingGroup Group ID Grp ID The routing group ID. java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 207
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
SealNbr1 Seal Number 1 Seal Nbr1 Seal number 1. java.lang.String Yes Yes
SealNbr2 Seal Number 2 Seal Nbr2 Seal number 2. java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 Seal number 3. java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 Seal number 4. java.lang.String Yes Yes
SpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID.
SpecialStow2 ID ID The special stow 2 java.lang.String Yes Yes
requirement ID.
SpecialStow3 ID ID The special stow 3 java.lang.String Yes Yes
requirement ID.
StorageIsPaid Is Storage Paid Is Storage Paid True if storage is java.lang.Boolean Yes No
paid.
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
outbound carrier,
empty if not yet
loaded.
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 208
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 209
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString10.
UfvSparcsNotes Sparcs Notes Sparcs Notes Unit Facility Visit java.lang.String Yes No
Sparcs Notes
UnitActiveImpedimen Active Holds and java.lang.String Yes No
ts Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On
UnitCreatedDate Time Created Time Created The date and time java.util.Date Yes Yes
when the unit is
created.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 210
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
UnitEquipDmgsItmN Miscellaneous notes java.lang.String Yes No
otes for the damage Item
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 211
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitHoldPermAppled Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
On AppliedOn AppliedOn active holds and
granted/canceled
permissions applied
to the unit
UnitHoldPermUpdate Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
dOn UpdatedOn UpdatedOn released holds and
granted/canceled
permissions updated
to the unit
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
sions Permissions granted permissions
attached to the unit.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm The IDs of active java.lang.String Yes No
sionsView Permissions Groups Groups Holds and
Permissions View on
the Unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 212
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.
UnitNonActiveImpedi Released Holds and java.lang.String Yes No
ments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By ,Applied On Date,
Updated by and
Updated On
UnitRemark Unit Notes Unit Notes Unit Notes java.lang.String Yes No
UnitStripServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STRIP
event for the
selected unit
UnitStuffServiceNote Notes recorded with java.lang.String Yes No
s the UNIT_STUFF
event for the
selected empty unit
VesselLoadStop Stop-Vessel Stop-Vsl True if vessel load is java.lang.Boolean Yes Yes
disallowed.
VisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 213
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards

External Tag Long Label Short Label Description Type In Design In Sort
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
YardPositionVerified Verified Yard Ver Yard Pos True if the yard java.lang.Boolean Yes Yes
Position position has been
verified, false
otherwise.
YardStowageType Yard Stowage Type Yard Stow Type Type of yard java.lang.String Yes Yes
stowage required: W
for 'Must be kept on
wheels', G for 'Must
be kept on ground,
or E for 'Does not
matter'.
unitFlag1ReferenceI Export Control ECN The reference ID of java.lang.String Yes No
d Number the last hold/
permission defined
by setting
INVSERVICESFLAG
001 applied to the
unit.
unitFlag2ReferenceI Payee Payee The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
002 applied to the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 214
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit - Hazards and Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
unitFlag3ReferenceI Unit Flag 3 Ref Id Unit Flag 3 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
003 applied to the
unit.
unitFlag4ReferenceI Unit Flag 4 Ref Id Unit Flag 4 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
004 applied to the
unit.
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

2.2.11 Unit - Hazards and Train Visit

The Unit - Hazards and Train Visit reporting entity represents the hazards, train visit, and railcar visit information associated with a unit. The Unit is the central
object in N4, representing a moveable entity consisting of cargo and its packaging.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalCarrierCreated The arrival carrier java.util.Date Yes No
train visit created
time.
ArrivalCarrierCreator The arrival carrier java.lang.String Yes No
train visit creator.
ArrivalCarrierDirectio The arrival carrier java.lang.String Yes No
n train visit direction.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 215
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards and Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalCarrierLastMo The arrival carrier java.util.Date Yes No
veTime train visit(inbound
OR outbound) Last
move time.
ArrivalCarrierVehicle The arrival carrier java.lang.String Yes No
Destination Railcar Destination.
ArrivalCarrierVehicle The arrival carrier java.lang.String Yes No
FlatCarType Railcar Flatcar type.
ArrivalCarrierVehicle The arrival carrier java.lang.String Yes No
Seq Railcar Sequence.
ArrivalCarrierVisitAT Act. Time of Depart. ATD Actual Time of java.util.Date Yes Yes
D Departure of the
inbound Carrier Visit.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
CarrierVisitId Visit Ref Visit Id of the inbound java.lang.String Yes Yes
carrier visit.
CarrierVisitOperator Id Id Operator of the java.lang.String Yes Yes
inbound carrier visit.
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).
Consignee Id Id The current java.lang.String Yes Yes
consignee of the
unit.
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 216
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards and Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
HazardItemSecondar IMO1 IMO1 The standard IMDG java.lang.String Yes Yes
yIMO1 class code to identify
the Secondary IMO1.
HazardItemSecondar IMO2 IMO2 The standard IMDG java.lang.String Yes Yes
yIMO2 class code to identify
the Secondary IMO2.
HazardItemTechNam Technical Name Tech.Name The technical name java.lang.String Yes Yes
e of the hazardous
cargo.
HazardItemUNNumb UN/NA Number UN/NA The UN number for java.lang.String Yes Yes
er the hazard entry.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 217
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Hazards and Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', or N for
'Train'.
InboundCarrierVisitP Visit Phase Phase Inbound carrier's visit java.lang.String Yes No
hase phase, C for
CREATED, I for
INBOUND, A for
ARRIVED, W for
WORKING, T for
COMPLETE, D for
DEPARTED, S for
CLOSED, Z for
CANCELLED, X for
ARCHIVED
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes Yes
contains hazardous
cargo.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
LineOperatorName Name Name The current operator java.lang.String Yes Yes
name (shipping line)
of the unit.
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded on a
vessel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 218
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit - Holds/Permissions

External Tag Long Label Short Label Description Type In Design In Sort
UnitCreatedDate Time Created Time Created The date and time java.util.Date Yes Yes
when the unit is
created.
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.

2.2.12 Unit - Holds/Permissions

The Unit - Holds/Permissions reporting entity represents the holds/permissions associated with a unit. The Unit is the central object in N4, representing a
moveable entity consisting of cargo and its packaging.

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOperator Equipment Operator Eq Operator The id of the line java.lang.String Yes Yes
operator (shipping
line) currently
registered as the
equipment operator
EquipmentOperatorN Equipment Operator Eq Operator Name The name of the line java.lang.String Yes Yes
ame Name operator (shipping
line) currently
registered as the
equipment operator
EquipmentOwner Equipment Owner Eq Owner The line operator java.lang.String Yes Yes
id(shipping line) that
owns the primary
equipment
EquipmentOwnerNa Equipment Owner Eq Owner Name The line operator java.lang.String Yes Yes
me Name name(shipping line)
that owns the
primary equipment
HoldOrPerm Flag Flag Purpose: HOLD or java.lang.String Yes Yes
PERMISSION

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 219
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Holds/Permissions

External Tag Long Label Short Label Description Type In Design In Sort
HoldPermAction Action Action The action that must java.lang.String Yes No
be completed for the
selected hold or
permission to be
released or granted
HoldPermAppledBy Applied By Applied By The user who java.lang.String Yes Yes
applied the Hold/
Permission
HoldPermAppledTo Applied To Appled To The unit id to which java.lang.String Yes Yes
this Hold/Permission
was applied
HoldPermAppliedDat Applied Date Applied Date The Date the Hold/ java.util.Date Yes Yes
e Permission was
applied
HoldPermChangedB Changer Changer The user who java.lang.String Yes Yes
y updated the Hold/
Permission
HoldPermChangedD Changed Changed The date and time java.util.Date Yes Yes
ate the Hold/Permission
was updated
HoldPermCovert Covert Flag Type Covert Flag Type Covert Flag Type java.lang.Boolean Yes Yes
HoldPermCreatedBy Creator Creator The user who java.lang.String Yes Yes
created the Hold/
Permission
HoldPermCreatedDa Created Created The date and time java.util.Date Yes Yes
te the Hold/Permission
was created
HoldPermId Flag Id Flag Id Id of the Hold/ java.lang.String Yes Yes
Permission
HoldPermNote Note Note Note recorded with java.lang.String Yes Yes
this unit's Hold/
Permission

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 220
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit - Holds/Permissions

External Tag Long Label Short Label Description Type In Design In Sort
HoldPermRefId Reference Id Ref Id Reference java.lang.String Yes Yes
information recorded
with this Unit's Hold/
Permission
HoldPermStatus Status Status The status of Hold/ java.lang.String Yes No
Permission
HoldPermUnitId Unit Nbr Unit Nbr The unit id to which java.lang.String Yes Yes
this Hold/Permission
was applied
HoldPermUnitIsStow Is Stowplan Posted Stowplan Posted Is there Stowplan java.lang.Boolean Yes Yes
planPosted EDI containing the
particular Unit
HoldPermUpdatedBy Updated By Upd By The user who java.lang.String Yes No
released/canceled
the hold/permission
HoldPermUpdatedD Updated On Upd On The date on which java.util.Date Yes No
ate the hold/permission
was released/
canceled
HoldPermUpdatedN Update Note Upd Note A short note about java.lang.String Yes No
ote the release/
cancelation of the
hold/permission
HoldPermUpdatedR Updated Reference Upd Ref ID The update java.lang.String Yes No
efId ID reference ID used
when releasing/
canceling the hold/
permission
HoldPermView Hold/Perm View Id Hold/Perm View Id A unique identifier for java.lang.String Yes Yes
the hold or
permission view
IBCarrierMode IB Carrier Mode IB Mode The inbound carrier java.lang.String Yes Yes
type: 'Vessel',
'Railcar', 'Truck' or
'Train'

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 221
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
IBCarrierVisitOperat IB Carrier Operator IB Operator The Inbound carrier java.lang.String Yes Yes
or visit operator Id
IBCarrierVisitOperat IB Carrier Operator IB Operator Name The Inbound carrier java.lang.String Yes Yes
orName Name visit operator Name
IBDeclaredCarrierId Visit Ref Visit Inbound declared java.lang.String Yes Yes
carrier: Visit ID for
vessel, Train ID for
train, or License
Number for truck
OBCarrierMode OB Carrier Mode OB Mode The outbound carrier java.lang.String Yes Yes
type: 'Vessel',
'Railcar', 'Truck' or
'Train'
OBCarrierVisitOperat OB Carrier Operator OB Operator The outbound carrier java.lang.String Yes Yes
or visit operator Id
OBCarrierVisitOperat OB Carrier Operator OB Operator Name The outbound carrier java.lang.String Yes Yes
orName Name visit operator name
OBDeclaredCarrierId Visit Ref Visit Outbound declared java.lang.String Yes Yes
carrier: Visit ID for
vessel, Train ID for
train, or License
Number for truck

2.2.13 Unit Move Event

The Unit - Move Event reporting entity describes all moves that a unit underwent during its stay at a facility. Some of the fields describe the unit data at the
moment of the move, for which the external tags are postfixed by the word 'SnapShot'. The MoveCarrier fields describe the arrival carrier depending on the
move kind: e.g. for a Discharge, the carrier is the inbound vessel, for a Load the carrier is the outbound vessel. All reports dealing with working a vessel
(loading, discharge, restow) should use this reporting entity.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (ERO) for
receivals.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 222
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
AttachedPayloadUnit The Equipment IDs java.lang.String Yes No
s of attached payload
units separated by a
';'.
AttachedUnits Attached Attached The Equipment IDs java.lang.String Yes No
Equipments Equipments of attached units
separated by a ';'.
Bundle Unit is a Bundle Bundle True if the unit is a java.lang.Boolean Yes Yes
Bundle.
CargoWeight Cargo Weight Cargo Wt Cargo weight of the java.lang.Double Yes No
unit (gross weight
minus tare weight).
CarryChe CHE Name CHE Name The crane that java.lang.String Yes Yes
executed the 'carry'
phase of the move.
CarryCheLoginName Carry CHE Login Carry CHE Login Login Name of the java.lang.String Yes Yes
Name Name CHE User that
executed the 'carry'
phase of the move.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 223
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).
Commodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit.
CommodityDescripti Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
on Name description for the
contents of a unit.
DateOfGateProcessi EC-In Time EC-In Time The time the unit java.util.Date Yes Yes
ng was processed at the
gate.
DateOfLastHandling Time of Last Move Last Move The last recorded java.util.Date Yes Yes
time the unit was
moved.
DeckRequirements Deck Stowage Deck Req The stowage java.lang.String Yes Yes
Requirements requirement for the
unit: A for 'Above
Deck Only', B for
'Below Deck Only', or
E for 'Don't Care'.
DemurragePayee Payee Payee The payee defined to java.lang.String Yes No
pay for demurrage
charges.
DepartureOrderNo Number Number Associated Order java.lang.String Yes Yes
Number (booking,
EDO, ELO) for
deliveries or
receivals.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 224
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
Destination Destination Dest The specified java.lang.String Yes Yes
destination for the
goods.
DistanceCarried Distance of Carry Dist.Carry Distance prime java.lang.Long Yes Yes
mover traveled in
carry phase
(meters).
DistanceToStart Distance To Start Dist.Start Distance prime java.lang.Long Yes Yes
mover traveled in
fetch phase (meters).
DrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit: F for
'Forward to Loading
Point', R for 'Return
to shipper', O for
'Dray Out and Back',
I for 'Dray In', or T for
'Transfer to other
Facility'.
DwellDays Dwell Days Dwell The number of days java.lang.Long Yes No
the unit has been in
the yard.
ECN Export Control ECN The ECN clearing java.lang.String Yes No
Number this unit by customs.
EquipmentArcheTyp ISO Id ISO Id The arche type for java.lang.String Yes Yes
eId the primary
equipment type code
(ISO or other). For
information about
ISO codes, see the
documents section at
http:www.smdg.org.
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
equipment was
built/put in service.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 225
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentDamage Damage Severity Damage Severity The equipment java.lang.String Yes Yes
damage level: '-' for
Repaired, None,
Minor, or Major.
EquipmentGradeId ID ID The equipment java.lang.String Yes Yes
grade ID.
EquipmentHeightMm Height Height The overall java.lang.Long Yes Yes
equipment height in
millimeters.
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentIsFolded Is Folded Is Folded True if the equipment java.lang.Boolean Yes Yes
is folded such as a
folded flat-rack.
EquipmentIsOutOfSe Is POS Is POS True if the equipment java.lang.Boolean Yes Yes
rvice is permanently out of
service.
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration for the primary
equipment expires,
blank if no lease
applies.
EquipmentLengthM Length Length The overall java.lang.Long Yes Yes
m equipment length in
millimeters.
EquipmentMaterial Material Material The material of the java.lang.String Yes Yes
primary equipment:
Unknown, Aluminum,
or Steel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 226
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOffHireLo Off-Hire Location Off-Hire The location the java.lang.String Yes Yes
cation equipment will be
returned after it
comes off the lease.
EquipmentOperator Id Id The line operator java.lang.String Yes Yes
(shipping line)
currently registered
as the equipment
operator (lessee or
owner).
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).
EquipmentOwner Id Id The line operator java.lang.String Yes Yes
(shipping line) that
owns the primary
equipment.
EquipmentPreviousO Id Id The line operator java.lang.String Yes Yes
perator (shipping line) that
was the previous
operator for the
primary equipment.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 227
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentSafeWeig Safe Weight Safe Wt The equipment safe java.lang.Double Yes Yes
htKg weight in kilograms.
The safe weight is
the maximum
permissible weight of
the equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 228
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
EquipmentWidthMm Width Width The overall java.lang.Long Yes Yes
equipment width in
millimeters.
FetchChe CHE Name CHE Name The crane that java.lang.String Yes Yes
executed the 'fetch'
phase of the move.
FetchCheLoginName Fetch CHE Login Fetch CHE Login Login Name of the java.lang.String Yes Yes
Name Name CHE User that
executed the 'fetch'
phase of the move.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 229
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
FirstReeferRecordDa The date of the first java.util.Date Yes No
teAfterInTime reefer reading after
the unit came into
the yard (first reading
after in time).
FirstReeferRecordTe The temperature java.lang.Double Yes No
mpAfterInTime recorded at the first
reefer reading after
the unit came into
the yard (first reading
after in time).
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
the unit.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GoodsBlNbr BL Number BL Nbr Simple Bill of Lading java.lang.String Yes Yes
Id.
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 230
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: The gross
weight of the
equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
HandlingReason Handling Reason Hndl Reason Reason for last java.lang.String Yes Yes
handling: C for
'Container Operator
Request', L for 'Line
Operator Request', T
for 'Terminal
Convenience', or U
for 'Customs
Request'.
HasPlannedMove True if there is a java.lang.Boolean Yes No
planned move for
this unit.
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
entered the facility.
Same as the
discharge time if the
unit was discharged
from a vessel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 231
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the inbound
carrier.
InboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
inbound carrier.
InboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
inbound carrier.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the trucking
company.
InboundCarrierInVoy Inbound carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes).
InboundCarrierInVoy Inbound carrier: For java.lang.String Yes No
ageNbr vessels it is the
inbound voyage
number, and for
trains it is the train
ID.
InboundCarrierName Carrier Name Carrier Name The inbound carrier java.lang.String Yes No
name such as Vessel
Name, Truck License
Number, or Train ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 232
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierOpera The inbound carrier java.lang.String Yes No
torId operator ID such as
the line operator
(shipping line) or the
Trucking Company.
InboundCarrierOpera null java.lang.String Yes No
torName
InboundCarrierOutVo Inbound carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes).
InboundCarrierOutVo Inbound carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
InboundCarrierType Carrier Mode Mode The inbound carrier java.lang.String Yes Yes
type: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
InboundVesselInVoy Inbound Voyage I/B Vyg null null No Yes
ageNbrRef
InboundVesselName Carrier Name Carrier Name DEPRECATED - Use java.lang.String Yes No
InboundCarrierName
instead.
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 233
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
IsHazardous Hazardous? Hazardous? True if the unit java.lang.Boolean Yes No
contains hazardous
cargo.
IsOOG Is OOG Is OOG True if the unit is out- java.lang.Boolean Yes Yes
of-gauge.
IsOnPower On Power On Power True if the unit is java.lang.Boolean Yes Yes
connected to
electrical supply, or
forced air exchange,
in case of porthole
reefer.
IsReefer Requires Power Reqs Power True if the unit java.lang.Boolean Yes Yes
requires power (is an
active reefer).
IsYardPositionVerifie Verified Yard Ver Yard Pos True if the SPARCS java.lang.Boolean Yes Yes
d Position user has verified the
yard position of the
unit.
LastFreeDay Last Free Day Last Free Day The last day (as java.lang.String Yes No
string) the unit can
stay in the facility
without charges. If
the date has a
preceding '!', the
date has been
manually overridden
and is not calculated
using the storage
rules.
LastFreeDayDate The last day the unit java.util.Date Yes No
can stay in the
facility without
charges (date
object).
LastReeferRecordDa The date of the last java.util.Date Yes No
te reefer reading.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 234
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
LastReeferRecordTe Last Temperature Last Temp Read The temperature java.lang.Double Yes No
mp Monitored recorded during the
last reefer reading.
LineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
LineOpertorSnapSho Id Id The line operator java.lang.String Yes Yes
t (shipping line)
operating the unit at
the moment the
move was recorded.
MainHazardCodes Main Hazard Codes Hzd Codes All the applicable java.lang.String Yes No
hazard codes
separated by a ','.
MainHazardUNNum The UN Numbers of java.lang.String Yes No
bers the three most
severe hazards
registered as cargo,
separated by ','.
MoveCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the involved
carrier if the move
was to or from a
carrier visit, else null.
MoveCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
involved carrier if the
move was to or from
a carrier visit, else
null.
MoveCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
involved carrier if the
move was to or from
a carrier visit, else
null.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 235
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
involved carrier if the
move was to or from
a carrier visit, else
null.
MoveCarrierId Visit Ref Visit The CarrierVisit, if java.lang.String Yes Yes
the move was to or
from a carrier visit,
else null.
MoveCarrierInVoyag Involved carrier: java.lang.String Yes No
eCall Inbound call number
for vessels
(undefined for other
carrier modes).
MoveCarrierInVoyag Involved carrier: For java.lang.String Yes No
eNbr vessel it is the
inbound voyage
number, for trains it
is the train ID.
MoveCarrierInVoyag Inbound Voyage I/B Vyg null null No Yes
eNbrRef
MoveCarrierName Carrier Name Carrier Name The name of the java.lang.String Yes No
involved carrier
(vessel name, truck
license number, train
ID) if the move was
to or from a carrier
visit, else null.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 236
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveCarrierOperator The ID of the java.lang.String Yes No
Id involved carrier
operator such as the
line operator
(shipping line), or the
trucking company if
the move was to or
from a carrier visit,
else null.
MoveCarrierOperator The name of the java.lang.String Yes No
Name involved carrier
operator such as the
line operator
(shipping line), or the
trucking company if
the move was to or
from a carrier visit,
else null.
MoveCarrierOutVoya Involved carrier: java.lang.String Yes No
geCall Outbound call
number for vessels
(undefined for other
carrier modes).
MoveCarrierOutVoya Involved carrier: For java.lang.String Yes No
geNbr vessel it is the
outbound voyage
number, for trains it
is the train ID.
MoveCarrierServiceI ID ID The service ID java.lang.String Yes Yes
d (rotation) of the
involved carrier if the
move was to or from
a carrier visit, else
null.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 237
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveCarrierType Carrier Mode Mode The type of the java.lang.String Yes Yes
involved carrier if the
move was to or from
a carrier visit, else
null: V for 'Vessel', R
for 'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
MoveComplex Complex Complex The complex at java.lang.String Yes Yes
which the move
event was recorded.
MoveEventCreated Created Date Created The date and time java.util.Date Yes Yes
the move event was
created
MoveEventCreator Creator Creator The user who java.lang.String Yes Yes
created the move
event
MoveEventType Id Id The event type of java.lang.String Yes Yes
this move event
recording - in general
use MoveType
instead.
MoveEventTypeBilla Billable Billable True if the event type java.lang.Boolean Yes Yes
ble of this move event
recording is billable.
MoveEventTypeNotifi Notifiable Notifiable True if the event type java.lang.Boolean Yes Yes
able of this move event
recording can trigger
notifications.
MoveEventTypeTarg Applies To Applies To The target entity type java.lang.String Yes Yes
etEntity of this move event
recording: Container,
Goods, Vessel,
Booking, etc.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 238
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveExcludedFrom Exclude from Exclude True if this move java.lang.Boolean Yes Yes
Report Reports event should not
show in reports. This
should always be
part of the filter for
reporting on Unit
Move Events.
MoveFacility Facility Facility The facility at which java.lang.String Yes Yes
the move event was
recorded.
MoveFromPositionF Position Position The complete name, java.lang.String Yes Yes
ull '(Type)-(Carrier or
Yard)-(Slot)' of the
location from which
the unit was moved.
MoveFromPositionLo Location Id LocId The ID of the java.lang.String Yes Yes
cId location from which
the unit was moved
such as the Yard
code or the carrier
ID.
MoveFromPositionLo Position Type Type The type of the java.lang.String Yes Yes
cType location from which
the unit was moved: :
Y for 'Yard', V for
'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
MoveFromPositionSl Slot Slot The slot position ID java.lang.String Yes Yes
ot of the location from
which the unit was
moved.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 239
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveNote Note Note A note defined when java.lang.String Yes Yes
this move event was
recorded.
MoveOperator Operator Operator The operator site at java.lang.String Yes Yes
which the move
event was recorded.
MoveRecordingTime Apply Date Apply Date The date and time at java.util.Date Yes Yes
which the move
event has been
recorded.
MoveToPositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
location to which the
unit was moved.
MoveToPositionLocI Location Id LocId The ID of the java.lang.String Yes Yes
d location to which the
unit was moved such
as the Yard code or
the carrier ID.
MoveToPositionLocT Position Type Type The type of the java.lang.String Yes Yes
ype location to which the
unit was moved: Y
for 'Yard', V for
'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
MoveToPositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the location to
which the unit was
moved.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 240
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
MoveType Move Kind Move Kind The type of move in java.lang.String Yes Yes
the move event:
Receival, Delivery,
Discharge, Load,
Rail Load, Rail
Disch, Shift O.B.,
Yard Move, Yard
Shift, or Other.
MoveUser Applied By Applied By The username under java.lang.String Yes Yes
which the move
event has been
recorded.
MoveYard Yard Yard The yard at which java.lang.String Yes Yes
the move event was
recorded.
OOG A code to display the java.lang.String Yes No
OOG dimensions of
a unit 'H W L' for
Height, Width, and
Length. A '-' is
displayed if one of
the dimensions is not
OOG. For example,
'H - -' means that
only the Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
side (centimeters).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 241
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
side (centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original port of java.lang.String Yes Yes
load (the
International port of
load, if the cargo was
relayed through
domestic ports of
load).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig The specified origin java.lang.String Yes Yes
of the goods.
OutTime Time Facility-Out Time Out The time the unit java.util.Date Yes Yes
exited the facility.
Same as the carrier
departure time.
OutboundCarrierATA Act. Time of Arrival ATA Actual time of arrival java.util.Date Yes Yes
for the outbound
carrier.
OutboundCarrierATD Act. Time of Depart. ATD Actual time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierETA Est. Time of Arrival ETA Expected time of java.util.Date Yes Yes
arrival for the
outbound carrier.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 242
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierETD Est. Time of Depart. ETD Expected time of java.util.Date Yes Yes
departure for the
outbound carrier.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
train ID for train, or
license number for
truck.
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the InboundCarrierId,
but for trucks it also
includes the Trucking
Company.
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes).
OutboundCarrierInVo Departure carrier: java.lang.String Yes No
yageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundCarrierNa Carrier Name Carrier Name The name of the java.lang.String Yes No
me outbound carrier
(e.g. vessel name,
truck license number,
train ID).
OutboundCarrierOpe The operator ID of java.lang.String Yes No
ratorId the outbound carrier
such as the line
operator (shipping
line) or the trucking
company.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 243
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierOpe The operator name java.lang.String Yes No
ratorName of the outbound
carrier such as the
line operator
(shipping line) or the
trucking company.
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes).
OutboundCarrierOut Departure carrier: java.lang.String Yes No
VoyageNbr For vessels it is the
outbound voyage
number, for trains it
is the train ID.
OutboundCarrierSer ID ID The service ID java.lang.String Yes Yes
viceId (rotation) of the
outbound carrier.
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
or U for 'Unknown'.
OutboundCarrierlInV Departure carrier: java.lang.String Yes No
oyageNbr Inbound voyage
number for outbound
vessels (undefined
for other carrier
modes).
OutboundVesselLab Labor On Board LaborOnBoard null java.util.Date Yes Yes
orOnBoard

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 244
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
OwedStorageDays Storage Days Owed Storage Days Owed The number of days java.lang.Long Yes No
storage was charged
for the unit.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POD2Cntry Country Code Code The country code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code The country code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 245
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
vessel.
POLCntry Country Code Code The country code of java.lang.String Yes Yes
the port of load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 246
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
PowerOffRequested Requested Off- Requested Off- The date and time java.util.Date Yes Yes
Time Power Time Power the unit needs
should be taken off
power.
PowerOnLatestTime Must be On-Power Must be On-Power The latest date and java.util.Date Yes Yes
Time time the unit needs
to be on power.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 247
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
PutChe CHE Name CHE Name The crane that java.lang.String Yes Yes
executed the 'put'
phase of the move.
PutCheLoginName Put CHE Login Put CHE Login Login Name of the java.lang.String Yes Yes
Name Name CHE User that
executed the 'put'
phase of the move.
QayChe CHE Name CHE Name The quay crane that java.lang.String Yes Yes
did the move (will
also be the fetch or
put CHE, depending
on the move type).
RailLoadStop Stop-Rail Stop-Rail True if rail load is java.lang.Boolean Yes Yes
disallowed.
RehandleCount Rehandle Count Rehandle Count Number of rehandles java.lang.Long Yes Yes
required to perform
the move.
RequiredCO2Percen CO2 required, % CO2 Req.% The CO2 value java.lang.Double Yes Yes
tage required (%).
RequiredHumidityPe Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
rcentage required (%).
RequiredMaxTempC Temp. Max Temp. Max The maximum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredMinTempC Temp. Min Temp. Min The minimum java.lang.Double Yes Yes
temperature allowed
(degrees
Centigrade).
RequiredO2Percenta O2 required, % O2 Req.% The O2 value java.lang.Double Yes Yes
ge required (%).
RequiredTempC Temp. Required Temp Required The preferred/ java.lang.Double Yes Yes
required temperature
(degrees
Centigrade).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 248
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required. The
measurement unit is
defined in separate
field
RequiredVentUnit.
RequiredVentPercen Ventilation Required Vent Req DEPRECATED - Use java.lang.Double Yes Yes
tage the RequiredVent
field instead. The
measurement unit is
defined as a
separate field,
RequiredVentUnit.
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the
RequiredVent field.
RequiresPower Requires Power Reqs Power True if the unit needs java.lang.Boolean Yes Yes
power for its reefer
unit, or forced air, in
case of porthole
reefer.
RestowAccount Restow Account Restow Account The account against java.lang.String Yes Yes
which the restow
cost is charged.
RestowReason Restow Reason Restow Reason Reason for restow. java.lang.String Yes Yes
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', or H for
'Shift move'.
RoadDeliveryStop Stop-Road Stop-Road True if road delivery java.lang.Boolean Yes Yes
is disallowed.
RoutingGroup Group ID Grp ID The routing group ID. java.lang.String Yes Yes
SealNbr1 Seal Number 1 Seal Nbr1 Seal number 1. java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 249
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
SealNbr2 Seal Number 2 Seal Nbr2 Seal number 2. java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 Seal number 3. java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 Seal number 4. java.lang.String Yes Yes
ServiceOrder Service Order Service Order The service order java.lang.String Yes Yes
against which the
move is to be
charged.
SpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID.
SpecialStow2 ID ID The special stow 2 java.lang.String Yes Yes
requirement ID.
SpecialStow3 ID ID The special stow 3 java.lang.String Yes Yes
requirement ID.
StorageIsPaid Is Storage Paid Is Storage Paid True if storage is java.lang.Boolean Yes No
paid.
TimeCarryCheDispat Time Carry Che Time Carry Che Time at which the java.util.Date Yes Yes
ch Dispatch Dispatch carry CHE was
dispatched.
TimeCarryCheFetch Time Carry Che Time Carry Che Time at which the java.util.Date Yes Yes
Ready Ready Ready carry CHE was ready
to fetch.
TimeCarryChePutRe Time Put Che Ready Time Put Che Ready Time at which the java.util.Date Yes Yes
ady carry CHE was ready
to put.
TimeCarryComplete Time Carry Complete Time Carry Complete Time at which carry java.util.Date Yes Yes
phase was
completed.
TimeDischarge Time of Discharge Time of Discharge Time at which java.util.Date Yes Yes
discharge phase was
completed
TimeDispatch Time of Dispatch Time of Dispatch Time at which move java.util.Date Yes Yes
was dispatched.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 250
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
TimeFetch Time of Fetch Time of Fetch Time at which fetch java.util.Date Yes Yes
phase was
completed.
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
outbound carrier,
empty if not yet
loaded.
TimePut Time Completed Time Completed Time at which put java.util.Date Yes Yes
phase was
completed.
TwinCarry Twin Carry Twin Carry True if the carry java.lang.Boolean Yes Yes
phase was a twin
move.
TwinFetch Twin Fetch Twin Fetch True if the fetch java.lang.Boolean Yes Yes
phase was a twin
move.
TwinPut Twin Put Twin Put True if the put phase java.lang.Boolean Yes Yes
was a twin move.
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 251
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 252
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString10.
UnitActiveImpedimen Active Holds and java.lang.String Yes No
ts Required
Permissions
preventing an event
for this unit. Display
flag id suffixed with
HP view Id,status,
Applied By , Applied
On Date, Updated by
and Updated On
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 253
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 254
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitHoldPermAppled Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
On AppliedOn AppliedOn active holds and
granted/canceled
permissions applied
to the unit
UnitHoldPermUpdate Unit Holds/Perm Unit Holds/Perm Date and time the java.util.Date Yes No
dOn UpdatedOn UpdatedOn released holds and
granted/canceled
permissions updated
to the unit
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active holds and java.lang.String Yes No
sions Permissions granted permissions
attached to the unit.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm The IDs of active java.lang.String Yes No
sionsView Permissions Groups Groups Holds and
Permissions View on
the Unit
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 255
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
UnitNonActiveImpedi Released Holds and java.lang.String Yes No
ments Granted/Canceled
Permissions an
event for this unit.
Display flag id
suffixed with HP view
Id,status, Applied
By ,Applied On Date,
Updated by and
Updated On
VesselLoadStop Stop-Vessel Stop-Vsl True if vessel load is java.lang.Boolean Yes Yes
disallowed.
VisitsState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.
WiBerth Berthing Berth Work Instruction's java.lang.String Yes Yes
Berthing.
WiPOW Work Instruction WI POW Work Instruction's java.lang.String Yes Yes
Point of Work POW.
YardPositionVerified Verified Yard Ver Yard Pos True if the yard java.lang.Boolean Yes Yes
Position position has been
verified, false
otherwise.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 256
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Unit Move Event

External Tag Long Label Short Label Description Type In Design In Sort
YardStowageType Yard Stowage Type Yard Stow Type Type of yard java.lang.String Yes Yes
stowage required: W
for 'Must be kept on
wheels', G for 'Must
be kept on ground,
or E for 'Does not
matter'.
unitFlag1ReferenceI Export Control ECN The reference ID of java.lang.String Yes No
d Number the last hold/
permission defined
by setting
INVSERVICESFLAG
001 applied to the
unit.
unitFlag2ReferenceI Payee Payee The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
002 applied to the
unit.
unitFlag3ReferenceI Unit Flag 3 Ref Id Unit Flag 3 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
003 applied to the
unit.
unitFlag4ReferenceI Unit Flag 4 Ref Id Unit Flag 4 Ref Id The reference ID of java.lang.String Yes No
d the last hold/
permission defined
by setting
INVSERVICESFLAG
004 applied to the
unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 257
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

2.2.14 Vessel Exchange Instructions

DEPRECATED! Use Unit - Move Event (on page 222) instead.

The Vessel Exchange Instructions reporting entity describes all registered moves (by Work Instructions) that a unit underwent during its stay at a facility.

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalOrderNo Number Number null java.lang.String Yes Yes
ArrivalPositionFull Position Position complete name of java.lang.String Yes Yes
the arrival position as
in (type)-(carrier or
yard)-(slot)
ArrivalPositionLocId Location Id LocId The ID of the arrival java.lang.String Yes Yes
location: Carrier visit
ID.
ArrivalPositionLocTy Position Type Type The type of the java.lang.String Yes Yes
pe arrival location for
this visit: V for
'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
U for 'Unknown'.
ArrivalPositionSlot Slot Slot The identification of java.lang.String Yes Yes
the arrival slot
position
AttachedPayloadUnit Equipment ids of java.lang.String Yes No
s attached payload
Units separated by ';'

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 258
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
AttachedUnits Attached Attached Equipment ids of java.lang.String Yes No
Equipments Equipments attached Units
separated by ';'
Category Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', R for
'Through' (includes
Restow).
Commodity Commodity ID Id null java.lang.String Yes Yes
CommodityDescripti Commodity Short Cmdy Short Name null java.lang.String Yes No
on Name
DateOfGateProcessi EC-In Time EC-In Time null java.util.Date Yes Yes
ng
DateOfLastHandling Time of Last Move Last Move null java.util.Date Yes Yes
DemurragePayee Payee Payee The payee who is java.lang.String Yes No
defined to pay for
demurrage charges
DepartureOrderNo Number Number null java.lang.String Yes Yes
Destination Destination Dest null java.lang.String Yes Yes
DrayStatus Dray Status Dray Status Dray Status of Unit: java.lang.String Yes Yes
F for 'Forward to
Loading Point', R for
'Return to shipper', O
for 'Dray Out and
Back', I for 'Dray In',
or T for 'Transfer to
other Facility'.
DwellDays Dwell Days Dwell null java.lang.Long Yes No
ECN Export Control ECN null java.lang.String Yes No
Number

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 259
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentBuildDate Build Date Built The date the primary java.util.Date Yes Yes
Equipment was built/
put in service.
EquipmentDamage Damage Severity Damage Severity Damage level: java.lang.String Yes Yes
REPAIRED/NONE/
MINOR/MAJOR
EquipmentGradeId ID ID null java.lang.String Yes Yes
EquipmentHeightMm Height Height null java.lang.Long Yes Yes
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code. For
information about
ISO codes, see
http:www.smdg.org/
documents.
EquipmentIsFolded Is Folded Is Folded null java.lang.Boolean Yes Yes
EquipmentIsOutOfSe Is POS Is POS null java.lang.Boolean Yes Yes
rvice
EquipmentLeaseExpi Lease Expiration Lease Expires The date the lease java.util.Date Yes Yes
ration expires for the
primary equipment,
blank if no lease
applies.
EquipmentLengthM Length Length null java.lang.Long Yes Yes
m
EquipmentMaterial Material Material null java.lang.String Yes Yes
EquipmentOperator Id Id null java.lang.String Yes Yes
EquipmentOperatorN Name Name The name of the line java.lang.String Yes Yes
ame operator (shipping
line) currently
registered as the
equipment operator
(lessee or owner).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 260
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentOwner Id Id The primary java.lang.String Yes Yes
equipment's owning
line.
EquipmentPreviousO Id Id The primary java.lang.String Yes Yes
perator equipment's owning
line.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of this primary
container. NOTE:
that field can only be
used if report data is
filter for 'Equipment
Class = Container'
EquipmentSafeWeig Safe Weight Safe Wt The safe weight in java.lang.Double Yes Yes
htKg kilograms. The safe
weight is the
maximum allowable
weight of the
equipment and
cargo.
EquipmentStrengthC Strength Code Strength The equipment java.lang.String Yes Yes
ode strength code
EquipmentTareWeig Tare Weight Tare Wt The tare weight in java.lang.Double Yes Yes
htKg kilograms. The tare
weight is the empty
weight of the
equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type ISO
code. For information
about ISO codes,
see
http:www.smdg.org/
documents.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 261
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeBasic Basic Length Basic Length Primary equipment java.lang.String Yes Yes
Length basic length: 20 or
40
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of this primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
P for 'Porthole
(forced-air)'
EquipmentTypeNomi Nominal Height Height Primary equipment java.lang.String Yes Yes
nalHeight nominal height: 40',
43', 80', 86', etc.
EquipmentTypeNomi Nominal Length Length Primary equipment java.lang.String Yes Yes
nalLength nominal length: 20,
24, 30, 40, 45, 53
EquipmentWidthMm Width Width null java.lang.Long Yes Yes
FreeDaysAllowed Allowed Free Days Allowed Free Days Allowed free days for java.lang.Long Yes No
this unit.
FreightKind Freight Kind Frght Kind Unit's fill status: E for java.lang.String Yes Yes
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', B
for 'Breakbulk'
GoodsConsignee Id Id null java.lang.String Yes Yes
GoodsShipper Id Id null java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 262
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
GrossWeight Gross Weight Gross Weight DEPRECATED - Use java.lang.Long Yes No
GrossWeightKgValue
instead: Combined
Goods and
Container weight in
Kgs (gross weight)
GrossWeightKgValue Gross Weight Weight The gross weight of java.lang.Double Yes Yes
the equipment in
kilograms. The gross
weight is the
combined weight of
the equipment and
the goods.
HandlingReason Handling Reason Hndl Reason null java.lang.String Yes Yes
InTime Time Facility-In Time In The time the unit java.util.Date Yes Yes
came into the facility
- equals to discharge
time if unit came off
a vessel.
InboundCarrierATA Act. Time of Arrival ATA null java.util.Date Yes Yes
InboundCarrierATD Act. Time of Depart. ATD null java.util.Date Yes Yes
InboundCarrierETA Est. Time of Arrival ETA null java.util.Date Yes Yes
InboundCarrierETD Est. Time of Depart. ETD null java.util.Date Yes Yes
InboundCarrierId Visit Ref Visit null java.lang.String Yes Yes
InboundCarrierIdAnd This is the same as java.lang.String Yes No
TruckingCompany the InboundCarrierId,
but for trucks it also
includes the Trucking
company.
InboundCarrierInVoy Inbound Carrier: java.lang.String Yes No
ageCall Inbound call number
for vessels
(undefined for other
carrier modes)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 263
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
InboundCarrierInVoy Inbound Carrier: For java.lang.String Yes No
ageNbr vessel it is the
inbound voyage
number, for trains it
is the train ID
InboundCarrierOpera The ID of the java.lang.String Yes No
torId Inbound Carrier
Operator (Shipping
Line, Trucking
Company,...)
InboundCarrierOpera null java.lang.String Yes No
torName
InboundCarrierOutVo Inbound Carrier: java.lang.String Yes No
yageCall Outbound call
number for vessels
(undefined for other
carrier modes)
InboundCarrierOutVo Inbound Carrier: For java.lang.String Yes No
yageNbr vessel it is the
outbound voyage
number, for trains it
is the train ID
InboundCarrierType Carrier Mode Mode null java.lang.String Yes Yes
InboundVesselInVoy Inbound Voyage I/B Vyg null null No Yes
ageNbrRef
InboundVesselName Carrier Name Carrier Name The name of the java.lang.String Yes No
inbound carrier
vessel (only usable
for inbound carrier of
type vessel)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 264
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
InboundVesselServic ID ID The service ID java.lang.String Yes Yes
eId (rotation) of the
inbound carrier as
displayed in the
Inbound area on the
Routing tab in the
Unit Inspector
IsHazardous Hazardous? Hazardous? null java.lang.Boolean Yes No
IsOOG Is OOG Is OOG True if this unit is java.lang.Boolean Yes Yes
out-of-gauge.
IsOnPower On Power On Power True if unit is java.lang.Boolean Yes Yes
connected to
electrical supply or,
in case of porthole
reefer, forced air
exchange
IsReefer Requires Power Reqs Power null java.lang.Boolean Yes Yes
IsYardPositionVerifie Verified Yard Ver Yard Pos null java.lang.Boolean Yes Yes
d Position
LastFreeDay Last Free Day Last Free Day null java.lang.String Yes No
LastFreeDayDate null java.util.Date Yes No
LineOperator Id Id This Units Line java.lang.String Yes Yes
Operator.
MainHazardCodes Main Hazard Codes Hzd Codes null java.lang.String Yes No
MainHazardUNNum null java.lang.String Yes No
bers

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 265
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
MoveStage Move Stage Stage The stage of the java.lang.String Yes Yes
workinstruction's
move: None,
Planned, Fetch
Underway, Carry
Ready, Carry
Underway, Carry
Complete, Put
Underway, Complete
MoveType Move Kind Kind The type of move of java.lang.String Yes Yes
this workinstruction:
Receival, Delivery,
Discharge, Load,
Rail Load, Rail
Disch, Shift O.B.,
Yard Move, Yard
Shift, Other
OOG Showing over java.lang.String Yes No
dimensions of the
unit like 'H W L' (for
Height, Width and
Length). If one of
these dimension is
not OOG then a '-' is
displayed: e.g. 'H - -'
means only Height is
OOG.
OOGBack Overlong Back OL-B The unit is out-of- java.lang.Long Yes No
gauge at the back
(centimeters).
OOGFront Overlong Front OL-F The unit is out-of- java.lang.Long Yes No
gauge in the front
(centimeters).
OOGLeft Overwide Left OW-L The unit is out-of- java.lang.Long Yes No
gauge on the left
(centimeters).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 266
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
OOGRight Overwide Right OW-R The unit is out-of- java.lang.Long Yes No
gauge on the right
(centimeters).
OOGTop Overheight OH The unit is out-of- java.lang.Long Yes No
gauge at the top
(centimeters).
OPL Point ID ID The original load port java.lang.String Yes Yes
(International port if
cargo relayed
through domestic
load port).
OPLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the original port of
load.
OPLPlaceName Place Name Place Name The place code of java.lang.String Yes Yes
the original port of
load.
Origin Origin Orig null java.lang.String Yes Yes
OutTime Time Facility-Out Time Out null java.util.Date Yes Yes
OutboundCarrierATA Act. Time of Arrival ATA null java.util.Date Yes Yes
OutboundCarrierATD Act. Time of Depart. ATD null java.util.Date Yes Yes
OutboundCarrierETA Est. Time of Arrival ETA null java.util.Date Yes Yes
OutboundCarrierETD Est. Time of Depart. ETD null java.util.Date Yes Yes
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
Visit ID for vessel,
Train Id for Train,
License Number for
Truck
OutboundCarrierIdA This is the same as java.lang.String Yes No
ndTruckingCompany the InboundCarrierId,
but for trucks it also
includes the Trucking
company.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 267
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierInVo Departure Carrier: java.lang.String Yes No
yageCall Inbound call number
for vessels
(undefined for other
carrier modes)
OutboundCarrierInVo Departure Carrier: java.lang.String Yes No
yageNbr Inbound call number
for vessels
(undefined for other
carrier modes)
OutboundCarrierOpe null java.lang.String Yes No
ratorId
OutboundCarrierOpe null java.lang.String Yes No
ratorName
OutboundCarrierOut Departure Carrier: java.lang.String Yes No
VoyageCall Outbound call
number for vessels
(undefined for other
carrier modes)
OutboundCarrierOut Departure Carrier: java.lang.String Yes No
VoyageNbr For vessel it is the
outbound voyage
number, for trains it
is the train ID
OutboundCarrierSer ID ID null java.lang.String Yes Yes
viceId
OutboundCarrierTyp Carrier Mode Mode The type of the java.lang.String Yes Yes
e outbound carrier: V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
U for 'Unknown'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 268
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
OutboundCarrierlInV Departure Carrier: java.lang.String Yes No
oyageNbr Inbound call number
for vessels
(undefined for other
carrier modes)
OutboundVesselNam Carrier Name Carrier Name The name of the java.lang.String Yes No
e inbound carrier
vessel (only usable
for inbound carrier of
type vessel)
OwedStorageDays Storage Days Owed Storage Days Owed null java.lang.Long Yes No
POD Point ID ID First Port of java.lang.String Yes Yes
Discharge.
POD2 Point ID ID Second Port of java.lang.String Yes Yes
Discharge.
POD2Cntry Country Code Code country code of the java.lang.String Yes Yes
Port of Load.
POD2PlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the second port of
discharge.
POD2PlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the second port of
discharge.
PODCntry Country Code Code country code of first java.lang.String Yes Yes
Port of Discharge.
PODPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the first port of
discharge.
PODPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the first port of
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
to a vessel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 269
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
POLCntry Country Code Code country code of the java.lang.String Yes Yes
Port of Load.
POLPlaceCode Place Code Place Code The place code of java.lang.String Yes Yes
the port of load.
POLPlaceName Place Name Place Name The place name of java.lang.String Yes Yes
the port of load.
PositionFull Position Position complete name as in java.lang.String Yes Yes
(type)-(carrier or
yard)-(slot) of the last
registered location
for this visit
PositionLocId Location Id LocId The ID of the last java.lang.String Yes Yes
registered location
for this visit: Yard
code, carrier visit ID.
PositionLocType Position Type Type The type of the last java.lang.String Yes Yes
registered location
for this visit: Yard,
Vessel, Train, etc.
PositionSlot Slot Slot The identification of java.lang.String Yes Yes
the slot position of
the last registered
location for this visit
PowerGuaranteePart Id Id ID of the business java.lang.String Yes Yes
yId party agreeing to
guarantee reefer
charges for Power.
PowerGuaranteePart Name Name Name of the java.lang.String Yes Yes
yName business party
agreeing to
guarantee reefer
charges for Power.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 270
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
PowerGuaranteeThr Power Guarantee Power Guarantee Day thru which java.util.Date Yes Yes
uDay Thru Day Thru Day reefer charges have
been guaranteed for
Power
PowerLastFreeDay Power Last Free Day Power Last Free Day The last day the unit java.lang.String Yes No
can use power at the
terminal without
charges. If the date
has a preceding '!',
the date has been
manually overridden
and is not calculated
using the power
rules.
RequiredCO2Percen CO2 required, % CO2 Req.% null java.lang.Double Yes Yes
tage
RequiredHumidityPe Humidity required, % Humd Req.% null java.lang.Double Yes Yes
rcentage
RequiredMaxTempC Temp. Max Temp. Max null java.lang.Double Yes Yes
RequiredMinTempC Temp. Min Temp. Min null java.lang.Double Yes Yes
RequiredO2Percenta O2 required, % O2 Req.% null java.lang.Double Yes Yes
ge
RequiredTempC Temp. Required Temp Required null java.lang.Double Yes Yes
RequiredVentPercen Ventilation Required Vent Req null java.lang.Double Yes Yes
tage
RequiresPower Requires Power Reqs Power True if unit needs java.lang.Boolean Yes Yes
power to its reefer
unit, or, in case of
porthole reefer,
forced air

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 271
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Exchange Instructions

External Tag Long Label Short Label Description Type In Design In Sort
RestowType Restow Type Restow The restow type for java.lang.String Yes Yes
restowed through
containers: '-' for 'No
restow', R for
'Restow', H for 'Shift
move'.
RoutingGroup Group ID Grp ID null java.lang.String Yes Yes
SealNbr1 Seal Number 1 Seal Nbr1 null java.lang.String Yes Yes
SealNbr2 Seal Number 2 Seal Nbr2 null java.lang.String Yes Yes
SealNbr3 Seal Number 3 Seal Nbr3 null java.lang.String Yes Yes
SealNbr4 Seal Number 4 Seal Nbr4 null java.lang.String Yes Yes
SpecialStow ID ID Special stow java.lang.String Yes Yes
requirement #1
SpecialStow2 ID ID Special stow java.lang.String Yes Yes
requirement #2
SpecialStow3 ID ID Special stow java.lang.String Yes Yes
requirement #3
StorageIsPaid Is Storage Paid Is Storage Paid null java.lang.Boolean Yes No
TimeOfLoading Time of Loading Loaded The time the unit java.util.Date Yes Yes
was loaded on the
Outbound Carrier,
empty if not yet
loaded.
UnitHoldsAndPermis Unit Applied Holds/ Unit Hold/Perm Active Holds and java.lang.String Yes No
sions Permissions granted Permissions
attached to the unit
UnitImpediments Unit Impediments Unit Impediments Active Holds and java.lang.String Yes No
Required
Permissions
preventing an event
for this unit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 272
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
UnitNbr Unit Nbr Unit Nbr Unit Identifier: java.lang.String Yes Yes
Container number,
Chassis number,
Marks and Numbers,
etc.
VisitsState Visit State V-State The state the unit is java.lang.String Yes Yes
in: 'Advised', 'Active',
'Departed', etc.
VisitsTransitState Transit State T-State The transit state the java.lang.String Yes Yes
unit is in: Inbound,
Advised, EcIn, Yard,
EcOut, Loaded,
Departed, Retired
etc.
YardStowageType Yard Stowage Type Yard Stow Type null java.lang.String Yes Yes
unitNeedsReview Needs Review Needs Review True if the unit was java.lang.Boolean Yes Yes
created on-the-fly
and needs to be
manually reviewed.

2.2.15 Che Move Statistics

The CHE Move Statistics reporting entity describes all the moves carried out by the Carry CHE.

External Tag Long Label Short Label Description Type In Design In Sort
BufferEnterTime Buffer Enter Time Buffer Enter Time AGV Parallel Buffer java.util.Date Yes Yes
enter time
BufferExitTime Buffer Exit Time Buffer Exit Time AGV Parallel Buffer java.util.Date Yes Yes
exit time
CheMovePurpose Move Purpose Move Purpose Category of the java.lang.String Yes Yes
move (Transfer In,
Transfer Out,
Preposition etc)
CheName CHE Name CHE Name Name of the CHE java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 273
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
CheOperatorLoginTi Login Time Login Time The time at which java.util.Date Yes Yes
me che operator logged
in to the che
CheOperatorLogoutT Logout Time Logout Time The time at which java.util.Date Yes Yes
ime che operator logged
out of this che
CheOperatorName EC User Name EC User Name The operator or java.lang.String Yes Yes
driver of this che for
the given move
CheOperatorPeriodD Che Session Period Che Session Period The total duration for java.lang.Long Yes Yes
uration Duration Duration this che period
CheOperatorPeriodE Che Session Period Che Session Period The time at which java.util.Date Yes Yes
ndTime End Time End Time che operator made
himself unAvailable
for this che
CheOperatorPeriodS Che Session Period Che Session Period The time at which java.util.Date Yes Yes
tartTime Start Time Start Time che operator made
himself available for
this che
CheOperatorPeriodT Che Session Period Che Session Period The period type for java.lang.String Yes Yes
ype Type Type the che session,
AVAILABILITY,
BREAK etc.
ChePOW POW POW The Point of Work for java.lang.String Yes Yes
this che move
ChePhase Visit Phase Visit Phase Move Phase for java.lang.String Yes Yes
which che performed
this move: F, C, P,
FCP, FC and CP
ChePool Pool Pool The pool for this che java.lang.String Yes Yes
move
CheQuayCrane CHE Name CHE Name CHE Id involved in java.lang.String Yes Yes
this che move
CheType CHE Type CHE Type Type of the CHE java.lang.Long Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 274
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
CheWorkQueue Work Queue Work Queue The work queue for java.lang.String Yes Yes
this che move
CtrBasicLength Ctr Basic Length Ctr Basic Length The basic length of java.lang.String Yes Yes
the container (20' or
40')
CtrNominalLength Ctr Nominal Length Ctr Nominal Length The nominal length java.lang.String Yes Yes
of the container,
such as 20', 40', 45',
or 53'
CycleTime Cycle Time Cycle Time Cycle time for QC, in java.lang.Long Yes Yes
ms
DeclaredIbCarrierId Visit Ref Visit The declared/ java.lang.String Yes Yes
documented inbound
carrier, to the facility,
for a unit (this may
differ from the actual
inbound carrier).
DeclaredIbCarrierVe Carrier Name Carrier Name The name of the java.lang.String Yes No
hicleName carrier, vessel name
for vessel, Train Id
for Train and Truck
License Nbr for
Truck
DeclaredObCarrierId Visit Ref Visit The declared java.lang.String Yes Yes
outbound carrier,
from the facility, for a
unit (this may differ
from the actual
outbound carrier).
DeclaredObCarrierV Carrier Name Carrier Name The name of the java.lang.String Yes No
ehicleName carrier, vessel name
for vessel, Train Id
for Train and Truck
License Nbr for
Truck

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 275
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
DropIdleTime Drop Idle Time Drop Idle Time Total time elapsed java.lang.Long Yes No
between when the
container was loaded
on the che and drop
dispatch to the che,
in milliseconds
DropIdleTimeString Drop Idle Time Drop Idle Time Drop idle time in java.lang.String Yes No
HH:mm:ss format
DropWaitTime Drop Wait Time Drop Wait Time Total time elapsed java.lang.Long Yes Yes
between when the
che arrived to drop a
container and when
the container was
actually taken off the
che, in milliseconds
DropWaitTimeString Drop Wait Time Drop Wait Time Drop wait time in java.lang.String Yes No
HH:mm:ss format
ElapsedTime Elapsed Time Elapsed Time Difference between java.lang.Long Yes No
pick arrive time and
carry complete time ,
in milliseconds
ElapsedTimeString Elapsed Time Elapsed Time String representation java.lang.String Yes No
of elapsed time
EqTypeIso Equipment Type Equipment Type Equipment type code java.lang.String Yes Yes
(ISO or other)
FreightKind Freight Kind Freight Kind The freight kind, java.lang.String Yes Yes
such as MTY, FCL or
BBK
FromBlock Block Id Block Id The block from which java.lang.String Yes Yes
the move is done
FromBlockType From Block Type From Block Type The type of the block java.lang.String Yes Yes
from which the move
is done i.e Stack/
Heap

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 276
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
FromPositionLocId Location Id LocId A string that gives java.lang.String Yes No
the Id of the From
location, either a
yard code or carrier
visit Id
FromPositionLocTyp Position Type Type An enumeration that java.lang.String Yes No
e gives the type of
From position
FromPositionName Position Position A string that gives java.lang.String Yes No
the coordinates of
the From position
within its location
FromPositionOrientat Orientation Orientation A string that defines java.lang.String Yes No
ion the orientation of the
unit within this
position
FromPositionSlot Slot Slot A string that gives java.lang.String Yes No
the coordinates of
the From position
slot within its location
IsLiveReefer Is Live Reefer Is Live Reefer A flag that specifies java.lang.Boolean Yes Yes
whether the
container is a live
refrigerated
container or not
IsQuad Is Quad Is Quad True if the move is java.lang.Boolean Yes Yes
Quad
IsTandem Is Tandem Is Tandem True if the move is java.lang.Boolean Yes Yes
Tandem
LaneChange Lane Change Lane Change True if RTG changed java.lang.Boolean Yes Yes
lanes in order to
perform this move.
Not Available

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 277
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
MoveCategory Move Category Move Category Move Category of java.lang.String Yes Yes
the move i.e. WS In,
Preposition etc.Not
used, Refer to
cmsMovePurpose
(move_purpose)
MoveDirection Move Direction Move Direction Move direction of the java.lang.String Yes Yes
move i.e from TZ, to
TZ etc
MoveType Move Kind Move Kind The type of move for java.lang.String Yes Yes
the che: Receival,
Delivery, Discharge,
Load, Rail Load, Rail
Disch, Shift O.B.,
Yard Move, Yard
Shift, or Other
PickIdleTime Pick Idle Time Pick Idle Time Total time elapsed java.lang.Long Yes Yes
between last che
move and the time at
which the next move
is dispatched, in
milliseconds
PickIdleTimeString Pick Idle Time Pick Idle Time Pick idle time in java.lang.String Yes No
HH:mm:ss format
PickWaitTime Pick Wait Time Pick Wait Time Total time elapsed java.lang.Long Yes No
between when the
che arrived to pick
the container and
when the container
was actually loaded
on the che, in
milliseconds
PickWaitTimeString Pick Wait Time Pick Wait Time Pick wait time in java.lang.String Yes No
HH:mm:ss format
Rehandles Rehandle Count Rehandle Count Total wait time at java.lang.Long Yes Yes
crane for this move

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 278
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
SpreaderId Spreader Id Spreader Id Spreader Id for QC java.lang.String Yes Yes
(Portal or
Secondary)
TimeContainerOff Container Off Time Cntr Off Time The time at which java.util.Date Yes Yes
container was taken
off the che
TimeContainerOn Container On Time Cntr On Time The time at which java.util.Date Yes Yes
container was loaded
on the che
TimeDropArrive Drop Arrive Time Drop Arrive Time The time at which java.util.Date Yes Yes
che arrived to drop a
container either at
yard, vessel or rail
TimeDropDispatch Drop Dispatch Time Drop Disp. Time The time at which java.util.Date Yes Yes
che was dispatched
to drop a container
TimePickArrive Pick Arrive Time Pick Arrive Time The time at which java.util.Date Yes Yes
che arrived to pick a
container at either
yard, vessel or rail
TimePickDispatch Pick Dispatch Time Pick Disp. Time The time at which java.util.Date Yes Yes
che was dispatched
to pick a container
ToBlock Block Id Block Id The block to which java.lang.String Yes Yes
the move is done
ToBlockType To Block Type To Block Type The type of the block java.lang.String Yes Yes
to which the move is
done i.e Stack/ Heap
ToPositionLocId Location Id LocId A string that gives java.lang.String Yes No
the To Id of the
location, either a
yard code or a
carrier visit Id

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 279
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Che Move Statistics

External Tag Long Label Short Label Description Type In Design In Sort
ToPositionLocType Position Type Type An enumeration that java.lang.String Yes No
gives the type of To
position
ToPositionName Position Position A string that gives java.lang.String Yes No
the coordinates of
the To position within
its location
ToPositionSlot Slot Slot A string that gives java.lang.String Yes No
the coordinates of
the To position slot
within its location
TotalIdleTime Total Idle Time Total Idle Time Sum of PickIdleTime java.lang.Long Yes No
and DropIdleTime ,
in milliseconds
TotalIdleTimeString Total Idle Time Total Idle Time Total idle time in java.lang.String Yes No
HH:mm:ss format
TotalWaitTime Total Wait Time Total Wait Time Sum of java.lang.Long Yes No
PickWaitTime and
DropWaitTime , in
milliseconds
TotalWaitTimeString Total Wait Time Total Wait Time Total wait time in java.lang.String Yes No
HH:mm:ss format
TransactionType Transaction Type Transaction Type Transaction type for java.lang.String Yes No
Receival or Delivery
move : DI, DE, DM,
RI, RE, RM etc..
TripDistanceLaden Laden Distance Laden Distance The total laden java.lang.Long Yes Yes
distance for the che
for this trip
TripDistanceUnladen Unladen Distance Unladen Distance The total unladen java.lang.Long Yes Yes
distance for the che
for this trip
TripId Trip Id Trip Id Unique che trip id java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 280
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
CHE Trip Statistics

External Tag Long Label Short Label Description Type In Design In Sort
TripLadenTravelTime Laden Travel Time Laden Travel Time The total laden travel java.lang.Long Yes No
time for the che for
this trip
TripTotalIdleTime The total idle time for java.lang.Long Yes No
the che for this trip
TripTotalWaitAtCrane The total wait time java.lang.Long Yes No
for the che at the
crane for this trip
TripTotalWaitAtYard The total wait time java.lang.Long Yes No
for the che at the
yard for this trip
TripUnladenTravelTi Unladen Travel Time Unladen Travel Time The total unladen java.lang.Long Yes No
me travel time for the
che for this trip
TwinMove Is Twin Move Is Twin Move True if this was a java.lang.Boolean Yes Yes
twin move
UnitCategory Unit Category Category Unit Category, java.lang.String Yes Yes
IMPORT, EXPORT,
TRANSSHIP etc.
UnitId Unit Id Unit Id Container Id involved java.lang.String Yes Yes
in this che move
WaitTimeAtBlock Wait time at Block Wait time at Block Wait time at Block (in java.lang.Long Yes Yes
ms)
WaitTimeAtCrane Wait time at QC Wait time at QC Wait time at QC (in java.lang.Long Yes Yes
ms)
toPositionOrientation Orientation Orientation A string that defines java.lang.String Yes No
the orientation of the
unit within this
position

2.2.16 CHE Trip Statistics

The CHE Trip Statistics reporting entity describes all the trips carried out by the Carry CHE.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 281
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
CHE Trip Statistics

External Tag Long Label Short Label Description Type In Design In Sort
CheName CHE Name CHE Name Name of the CHE java.lang.String Yes No
CheOperatorName EC User Name EC User Name The operator or java.lang.String Yes Yes
driver of this che for
the given trip
CheTripDistanceLad Laden Distance Laden Distance The total laden java.lang.Long Yes Yes
en distance for the che
for this trip
CheTripDistanceUnla Unladen Distance Unladen Distance The total unladen java.lang.Long Yes Yes
den distance for the che
for this trip
CheTripId Trip Id Trip Id Unique che trip id java.lang.String Yes Yes
CheTripLadenTravel Laden Travel Time Laden Travel Time The total laden travel java.lang.Long Yes No
Time time for the che for
this trip
CheTripTotalIdleTime The total idle time for java.lang.Long Yes No
the che for this trip
CheTripTotalMoves The total moves java.lang.Long Yes No
done by the che for
this trip
CheTripTotalWaitAtC The total wait time java.lang.Long Yes No
rane for the che at the
crane for this trip
CheTripTotalWaitAtY The total wait time java.lang.Long Yes No
ard for the che at the
yard for this trip
CheTripUnladenTrav Unladen Travel Time Unladen Travel Time The total unladen java.lang.Long Yes No
elTime travel time for the
che for this trip
CheType CHE Type CHE Type Type of the CHE java.lang.Long Yes Yes
FirstContainerOnTim First Cntr On Time First Cntr On Time The time at which java.util.Date Yes Yes
e che picked up first
container involved in
this trip

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 282
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Equipment Block Visit

External Tag Long Label Short Label Description Type In Design In Sort
FirstDispatchTime First Dispatch Time First Dispatch Time The time at which java.util.Date Yes Yes
che was dispatched
to pick first container
involved in this trip
LastContainerOffTim Last Cntr Off Time Last Cntr Off Time The time at which java.util.Date Yes Yes
e che dropped last
container involved in
this trip
MoveType Move Kind Move Kind The type of move for java.lang.String Yes Yes
the che: Receival,
Delivery, Discharge,
Load, Rail Load, Rail
Disch, Shift O.B.,
Yard Move, Yard
Shift, or Other

2.2.17 Equipment Block Visit

The Equipment Block Visit reportable entity provides a count of moves done for a unit with respect to a block during its unit facility visit.

External Tag Long Label Short Label Description Type In Design In Sort
BlockId Block Id Block Id A string that java.lang.String Yes Yes
represents the Block
EqTypeIso Equipment Type Equipment Type A String that java.lang.String Yes Yes
represents the Iso
Type of Equipment
Equipment Equipment Equipment A string that java.lang.String Yes Yes
represents the unit
InTime Time In Time In The Time when Unit java.util.Date Yes Yes
Enters the Block
IsTwinMove Is Twin Move Is Twin Move TRUE if Move is java.lang.Boolean Yes No
TwinMove

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 283
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Yard Block Statistics

External Tag Long Label Short Label Description Type In Design In Sort
MoveCount Ebv MoveCount Ebv MoveCount A Number that java.lang.Long Yes Yes
represents the
Equipment Block
Visit Move count
MoveDirection Ebv Move Direction Ebv Move Direction An Enumerator that java.lang.String Yes Yes
represents the Move
Direction of the Unit
OutTime Time Out Time Out The definition of the java.util.Date Yes Yes
visit phase
Unit_BasicLength Ctr Basic Length Ctr Basic Length A String that java.lang.String Yes Yes
represents the
BasicLength of
Equipment
Unit_Category Unit Category Category A String that java.lang.String Yes Yes
represents the
Category of
Equipment
Unit_FreightKind Freight Kind Freight Kind A String that java.lang.String Yes Yes
represents the
FreightKind of
Equipment
Unit_IsLiveReefer Is Live Reefer Is Live Reefer TRUE if Equipment java.lang.Boolean Yes No
is reefer
Unit_NominalLength Ctr Nominal Length Ctr Nominal Length A String that java.lang.String Yes Yes
represents the
NominalLength of
Equipment
Yard Yard Yard A string that java.lang.String Yes Yes
represents the Yard

2.2.18 Yard Block Statistics

The Yard Block Statistics reporting entity includes the performance metrics for the entire yard.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 284
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Yard Block Statistics

External Tag Long Label Short Label Description Type In Design In Sort
AreaCode Area Code Area Code Reference to Area java.lang.String Yes Yes
Code
AvailableSlots Available Slots Available Slots Available slots in the java.lang.Long Yes No
yard
Block Block Id Block Id Id of the Block java.lang.String Yes Yes
BlockType Block Type Block Type Type of the Block java.lang.String Yes Yes
either stack or heap
HasReeferPlugs Has Reefer Plugs Has Reefer Plugs TRUE if the block java.lang.Boolean Yes No
has any usable
reefer plugs
Time Time Time Time (Retrieved from java.lang.String Yes No
UpdateTime)
TotalReeferPlugs Total Reefer Slots Total Reefer Slots Total number of java.lang.Long Yes Yes
blocks selected by
the user to support
reefer plugs
TotalSlots Total Slots Total Slots Total slots in the yard java.lang.Long Yes Yes
UpdateTime Extracted Time Extracted Time TimeStamp of when java.util.Date Yes Yes
the snapshot of the
record is taken
(Round to hour)
UsableReeferPlugs Usable Reefer Slots Usable Reefer Slots Total reefer plugs - java.lang.Long Yes Yes
plugs blocked due to
restriction
UsableSlots Usable Slots Usable Slots Usable slots in the java.lang.Long Yes Yes
yard (Total slots - No.
of blocked or
restricted slots etc)
UsedReeferPlugs Used Reefer Slots Used Reefer Slots Total number of java.lang.Long Yes Yes
active reefer
containers in the
block
UsedSlots Used Slots Used Slots Used slots in the java.lang.Long Yes Yes
yard

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 285
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Booking

2.2.19 Booking
The Booking reporting entity corresponds to the booking information. This reporting entity does not include information on booking items. For information on
booking items reporting entity, see Booking Item (on page 291).

External Tag Long Label Short Label Description Type In Design In Sort
Agent Id Id The agent for the java.lang.String Yes Yes
booking.
BookingNbr Number Number Identifier of this java.lang.String Yes Yes
booking.
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the booking
ClienReferenceNum Client Ref.Number Client Ref The client's own java.lang.String Yes Yes
ber reference number for
the booking.
ConsigneeId Id Id The consignee for java.lang.String Yes Yes
the booking.
Creator Creator Creator The user who java.lang.String Yes Yes
created the booking
DateCreated Created Created The date the booking java.util.Date Yes Yes
was created.
DateUpdated Changed Changed The date the booking java.util.Date Yes Yes
was last changed.
Destination Destination Dest The final destination java.lang.String Yes Yes
of the containers.
This is where the
containers will be
stripped.
DispatchComplete Dispatch Complete Disp Complete True if the amount of java.lang.Boolean Yes No
the QuantityTotal
field is equal or
smaller to the
TallyTotal field.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 286
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking

External Tag Long Label Short Label Description Type In Design In Sort
DispatchReserved Dispatch Reserved Dispatch Reserved Whether to dispatch java.lang.String Yes Yes
reserved equipment
before other
equipment or to
dispatch only
reserved equipment
(FIRST, ONLY).
DrayOff Dray Status Dray Status The dray-off status of java.lang.String Yes Yes
the booking. Must be
set to Forward/
Return to allow a full
export container out
of the complex: 'F' =
Forward to Loading
Point; 'R' = Return to
shipper; 'I' = Dray In;
'O' = Dray Out and
Back.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
HasReefers Reefers? Reefers? True if any of the java.lang.Boolean Yes No
booking items is for
life reefers.
HazardCodes Hazards Hazards All hazard codes java.lang.String Yes No
associated with the
booking as a comma
separated text field.
Hazardous Hazardous? Hazardous? If true, the booking java.lang.Boolean Yes No
has hazards defined.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 287
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking

External Tag Long Label Short Label Description Type In Design In Sort
HoldPartials Hold Partials Hold Partials If set to true, java.lang.Boolean Yes Yes
received containers
are put on hold until
all containers are
received against the
booking.
LineOperator Id Id The line operator of java.lang.String Yes Yes
the booking.
Notes Notes Notes Notes captured for java.lang.String Yes Yes
the booking.
OOGAllowed Over Dimension Over Dimension If true, out-of-gauge java.lang.Boolean Yes Yes
containers are
allowed.
Origin Origin Origin The point of origin of java.lang.String Yes Yes
the containers. This
is where the
containers will be
stuffed.
OverrideCutoff Override Cutoff Override Cutoff If set to true, vessel java.lang.Boolean Yes Yes
schedule cutoffs are
overridden.
Pod1 Point ID ID The POD1 defined java.lang.String Yes Yes
for the booking.
Pod2 Point ID ID The POD2 defined java.lang.String Yes Yes
for the booking.
PodOptional Point ID ID The optional POD java.lang.String Yes Yes
defined for the
booking.
Pol Point ID ID The POL defined for java.lang.String Yes Yes
the booking.
QuantityTotal Quantity Quantity The total amount of java.lang.Long Yes Yes
containers defined
for this booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 288
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking

External Tag Long Label Short Label Description Type In Design In Sort
ReceiveComplete Receive Complete Receive Complete True if the amount of java.lang.Boolean Yes No
the QuantityTotal
field is equal or
smaller to the
TallyReceiveTotal
field.
ShipperId Id Id The shipper for the java.lang.String Yes Yes
booking.
ShippingMode Shipping Mode Shipping Mode The standard java.lang.String Yes Yes
shipping industry
code used to indicate
if the marine terminal
operator is
responsible for
stripping or stuffing
the cargo: 'PP' = Pier
to Pier; 'PH' = Pier to
House; 'HP' = House
to Pier; 'HH' = House
to House;
UNKNOWN
SpecialStow ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
SpecialStow2 ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
SpecialStow3 ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
StowBlock Stow block Stow block The stow block for java.lang.String Yes Yes
this booking.
TallyReceiveTotal Tally In Tally In The total amount of java.lang.Long Yes Yes
containers that were
received for this
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 289
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking

External Tag Long Label Short Label Description Type In Design In Sort
TallyTotal Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
order.
TruckingCompanyId Id Id The Id of the trucking java.lang.String Yes Yes
company defined for
the booking.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
defined for the
booking.
TypeSubstitutionPrev Prevent Type PreventTypeSubst Do not allow the java.lang.Boolean Yes Yes
ented Substitution substitution of similar
equipment types for
empty containers.
VesselName Name Name The name of the java.lang.String Yes No
vessel for the
defined vessel visit.
VesselVisitEstimated Est. Time of Arrival ETA The estimated date java.util.Date Yes Yes
DateOfArrival of the arrival of the
vessel for the
booking.
VesselVisitEstimated Est. Time of Depart. ETD The estimated date java.util.Date Yes Yes
DateOfDeparture of the departure of
the vessel for the
booking.
VesselVisitIbVoyage Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
Nbr number for the
vessel visit defined
for the booking.
VesselVisitId Visit Ref Visit The vessel visit java.lang.String Yes Yes
defined for the
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 290
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
VesselVisitObVoyag Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
eNbr voyage number for
the vessel visit
defined for the
booking.
VesselVisitPhase Visit Phase Phase The phase of the java.lang.String Yes Yes
vessel visit (Created,
Inbound, Arrived,...).
VesselVisitServiceId ID ID The service for the java.lang.String Yes Yes
vessel visit defined
for the booking.
eqoOverrideCutoffFo Override cutoffs for Override cutoffs for If set to true, vessel java.lang.Boolean Yes Yes
rRail rail containers rail cntr schedule cutoffs are
overridden if
container received
through Rail.

2.2.20 Booking Item

The Booking Item reporting entity represents all the order items created for any bookings in the system. It includes information on the booking itself - which can
be of type Booking (on page 286), EDO (on page 302), ELO (on page 300) - with which it is associated.

External Tag Long Label Short Label Description Type In Design In Sort
AccessoryTypeLong Accessory Type Acc Type The ISO group code java.lang.String Yes Yes
of the required
accessory as a
descriptive value.
Long value, e.g.
'Cooling Unit'
AccessoryTypeShort Accessory Type Acc Type The ISO group code java.lang.String Yes No
of the required
accessory. Short
value, e.g. 'CU'.
Agent Id Id The agent for the java.lang.String Yes Yes
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 291
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
BookingClienReferen Client Ref.Number Client Ref The client's own java.lang.String Yes Yes
ceNumber reference number for
the booking.
BookingDispatchCo Dispatch Complete Disp Complete True if the amount of java.lang.Boolean Yes No
mplete the
BookingQuantityTotal
field is equal or
smaller to the
BookingTallyTotal
field.
BookingHasReefers Reefers? Reefers? True if any of the java.lang.Boolean Yes No
booking items is for
life reefers.
BookingNbr Number Number Id of the parent java.lang.String Yes Yes
booking (Booking,
EDO, ELO).
BookingNotes Notes Notes Notes captured for java.lang.String Yes Yes
the booking.
BookingQuantityTotal Quantity Quantity The total amount of java.lang.Long Yes Yes
containers defined
for this order.
BookingReceiveCom Receive Complete Receive Complete True if the amount of java.lang.Boolean Yes No
plete the
BookingQuantityTotal
field is equal or
smaller to the
BookingTallyReceive
Total field.
BookingTallyReceive Tally In Tally In The total amount of java.lang.Long Yes Yes
Total containers that were
received for this
order.
BookingTallyTotal Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
order.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 292
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the booking
item
CommodityId Commodity ID Id A code identifying java.lang.String Yes Yes
the commodity type,
e.g 'HFMT'
CommodityName Commodity Short Cmdy Short Name A name defining the java.lang.String Yes No
Name commodity type, e.g.
'HARD FROZEN
MEAT'
ConsigneeId Id Id The consignee for java.lang.String Yes Yes
the booking.
Creator Creator Creator The user who java.lang.String Yes Yes
created the booking
item
DamagesIgnored Ignore Damages Ignore Damages The order allows to java.lang.Boolean Yes Yes
pick damaged
containers for
delivery.
DateCreated Created Created The Date the java.util.Date Yes Yes
booking item was
created.
DateEarliest Earliest Date Earliest Date The earliest date java.util.Date Yes Yes
allowed to pick up
the equipment.
DateEstimated Estimated Date Estimated Date The estimated date java.util.Date Yes Yes
the equipment will be
picked up.
DateLatest Latest Date Latest Date The latest date java.util.Date Yes Yes
allowed to pick up
equipment.
DateUpdated Changed Changed The Date the java.util.Date Yes Yes
booking item was
last changed.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 293
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
Destination Destination Dest The final destination java.lang.String Yes Yes
of the containers.
This is where the
containers will be
stripped.
DispatchReserved Dispatch Reserved Dispatch Reserved Whether to dispatch java.lang.String Yes Yes
reserved equipment
before other
equipment or to
dispatch only
reserved equipment
(FIRST, ONLY).
DrayOff Dray Status Dray Status The dray-off status of java.lang.String Yes Yes
the booking. Must be
set to Forward/
Return to allow a full
export container out
of the complex: 'F' =
Forward to Loading
Point; 'R' = Return to
shipper; 'I' = Dray In;
'O' = Dray Out and
Back.
EquipmentHeight Height Height The nominal height java.lang.String Yes Yes
of the equipment:
4'0, 4'3, 8'0, 8'6, 9'0,
or 9'6..

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 294
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentISOGroup ISO Group ISO group The equipment type java.lang.String Yes No
Long ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
Long value, e.g. 'Dry
bulk container non-
pressurized, box
type'.
EquipmentISOGroup ISO Group ISO group The equipment type java.lang.String Yes Yes
Short ISO group code. For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
Short value, e.g.
'BU'.
EquipmentLength Length Length The nominal length java.lang.String Yes Yes
of the equipment:
20', 24', 30', 40', 45',
48', or 53'.
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
GrossWeight Gross Weight Gross Weight The gross weight for java.lang.Double Yes Yes
the units of this
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 295
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
HazardCodes Hazards Hazards All hazard codes java.lang.String Yes No
associated with the
booking as a comma
separated text field.
Hazardous Hazardous? Hazardous? If true, the booking java.lang.Boolean Yes No
has hazards defined.
HoldPartials Hold Partials Hold Partials If set to true, java.lang.Boolean Yes Yes
received containers
are put on hold until
all containers are
received against the
booking.
HoldsIgnored Ignore Holds Ignore Holds The order allows to java.lang.Boolean Yes Yes
pick held containers
for delivery.
LineOperator Id Id The line operator of java.lang.String Yes Yes
the booking.
Material Material Material The material the java.lang.String Yes Yes
equipment is made
of (Steel, Aluminum).
OOGAllowed Over Dimension Over Dimension If true, out-of-gauge java.lang.Boolean Yes Yes
containers are
allowed.
Origin Origin Origin The point of origin of java.lang.String Yes Yes
the containers. This
is where the
containers will be
stuffed.
OverrideCutoff Override Cutoff Override Cutoff If set to true, vessel java.lang.Boolean Yes Yes
schedule cutoffs are
overridden.
Pod1 Point ID ID The POD1 defined java.lang.String Yes Yes
for the booking.
Pod2 Point ID ID The POD2 defined java.lang.String Yes Yes
for the booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 296
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
PodOptional Point ID ID The optional POD java.lang.String Yes Yes
defined for the
booking.
Pol Point ID ID The POL defined for java.lang.String Yes Yes
the booking.
Quantity Quantity Qty The quantity defined java.lang.Long Yes Yes
for this order item.
RequiredCO2 CO2 required, % CO2 Req.% The percentage of java.lang.Double Yes Yes
carbon dioxide
required.
RequiredEquipment ID ID The required java.lang.String Yes Yes
Grade equipment grade.
RequiredHumidity Humidity required, % Humd Req.% The percentage of java.lang.Double Yes Yes
humidity required.
RequiredO2 O2 required, % O2 Req.% The percentage of java.lang.Double Yes Yes
oxygen required.
RequiredTemperatur Temp Required Temp Reqd. The temperature java.lang.Double Yes Yes
e required in
Centigrade.
RequiredVent Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required; the
measurement unit for
this field is defined in
the separate field
'RequiredVentUnit'.
RequiredVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for this field
'RequiredVent'
(Percentage, Cubic
Meters/Hour, Cubic
Feet/Min)
ShipperId Id Id The shipper for the java.lang.String Yes Yes
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 297
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
ShippingMode Shipping Mode Shipping Mode The standard java.lang.String Yes Yes
shipping industry
code used to indicate
if the marine terminal
operator is
responsible for
stripping or stuffing
the cargo: 'PP' = Pier
to Pier; 'PH' = Pier to
House; 'HP' = House
to Pier; 'HH' = House
to House;
UNKNOWN
SpecialStow ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
SpecialStow2 ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
SpecialStow3 ID ID Special Stowage java.lang.String Yes Yes
Instructions for this
booking.
StowBlock Stow block Stow block The stow block for java.lang.String Yes Yes
this booking.
TallyDispatch Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
order item.
TallyLimit Tally Limit Tally Limit A limit on the number java.lang.Long Yes Yes
of empty containers
that can be out of the
yard against a
booking at one time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 298
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Booking Item

External Tag Long Label Short Label Description Type In Design In Sort
TallyReceive Tally In Tally In The total amount of java.lang.Long Yes No
containers that were
received for this
order item.
TruckingCompanyId Id Id The Id of the trucking java.lang.String Yes Yes
company defined for
the booking.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
defined for the
booking.
TypeSubstitutionPrev Prevent Type PreventTypeSubst Do not allow the java.lang.Boolean Yes Yes
ented Substitution substitution of similar
equipment types for
empty containers.
VesselName Name Name The name of the java.lang.String Yes No
vessel for the
defined vessel visit.
VesselVisitEstimated Est. Time of Arrival ETA The estimated date java.util.Date Yes Yes
DateOfArrival of the arrival of the
vessel for the
booking.
VesselVisitEstimated Est. Time of Depart. ETD The estimated date java.util.Date Yes Yes
DateOfDeparture of the departure of
the vessel for the
booking.
VesselVisitIbVoyage Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
Nbr number for the
vessel visit defined
for the booking.
VesselVisitId Visit Ref Visit The vessel visit java.lang.String Yes Yes
defined for the
booking.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 299
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Equipment Loadout Order

External Tag Long Label Short Label Description Type In Design In Sort
VesselVisitObVoyag Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
eNbr voyage number for
the vessel visit
defined for the
booking.
VesselVisitPhase Visit Phase Phase The phase of the java.lang.String Yes Yes
vessel visit (Created,
Inbound, Arrived,...)).
VesselVisitServiceId ID ID The service for the java.lang.String Yes Yes
vessel visit defined
for the booking.
eqoOverrideCutoffFo Override cutoffs for Override cutoffs for If set to true, vessel java.lang.Boolean Yes Yes
rRail rail containers rail cntr schedule cutoffs are
overridden if
container received
through Rail.

2.2.21 Equipment Loadout Order

The Empty Loadout Order (ELO) reporting entity corresponds to the ELO information. This reporting entity does not include information on order items.

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the ELO
Creator Creator Creator The user who java.lang.String Yes Yes
created the ELO
DateCreated Created Created The date the ELO java.util.Date Yes Yes
was created.
DateUpdated Changed Changed The date the ELO java.util.Date Yes Yes
was last changed.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 300
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Equipment Loadout Order

External Tag Long Label Short Label Description Type In Design In Sort
DispatchComplete Dispatch Complete Disp Complete True if the amount of java.lang.Boolean Yes No
the QuantityTotal
field is equal or
smaller to the
TallyTotal field.
ELONbr Number Number Identifier of this ELO. java.lang.String Yes Yes
LineOperator Id Id The line operator of java.lang.String Yes Yes
the ELO.
Notes Notes Notes Notes captured for java.lang.String Yes Yes
the booking.
Pod1 Point ID ID The POD1 defined java.lang.String Yes Yes
for the ELO.
PodOptional Point ID ID The optional POD java.lang.String Yes Yes
defined for the ELO.
QuantityTotal Quantity Quantity The total amount of java.lang.Long Yes Yes
containers defined
for this booking.
TallyTotal Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
order.
VesselName Name Name The name of the java.lang.String Yes No
vessel for the
defined vessel visit.
VesselVisitEstimated Est. Time of Arrival ETA The estimated date java.util.Date Yes Yes
DateOfArrival of the arrival of the
vessel for the ELO.
VesselVisitEstimated Est. Time of Depart. ETD The estimated date java.util.Date Yes Yes
DateOfDeparture of the departure of
the vessel for the
ELO.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 301
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Equipment Delivery Order

External Tag Long Label Short Label Description Type In Design In Sort
VesselVisitIbVoyage Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
Nbr number for the
vessel visit defined
for the ELO.
VesselVisitId Visit Ref Visit The vessel visit java.lang.String Yes Yes
defined for the ELO.
VesselVisitObVoyag Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
eNbr voyage number for
the vessel visit
defined for the ELO.
VesselVisitOperatorI Id Id The shipper for the java.lang.String Yes Yes
d ELO.
VesselVisitPhase Visit Phase Phase The phase of the java.lang.String Yes Yes
vessel visit (Created,
Inbound, Arrived,...).
VesselVisitServiceId ID ID The service for the java.lang.String Yes Yes
vessel visit defined
for the ELO.

2.2.22 Equipment Delivery Order

The Equipment Delivery Order (EDO) reporting entity corresponds to the EDO information. This reporting entity does not include information on order items.

External Tag Long Label Short Label Description Type In Design In Sort
Agent Id Id The agent for the java.lang.String Yes Yes
EDO.
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the EDO
Creator Creator Creator The user who java.lang.String Yes Yes
created the EDO
DamagesIgnored Ignore Damages Ignore Damages The order allows to java.lang.Boolean Yes Yes
pick damaged
containers for
delivery.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 302
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Equipment Delivery Order

External Tag Long Label Short Label Description Type In Design In Sort
DateCreated Created Created The date the EDO java.util.Date Yes Yes
was created.
DateEarliest Earliest Date Earliest Date The earliest date java.util.Date Yes Yes
allowed to pick up
the equipment.
DateEstimated Estimated Date Estimated Date The estimated date java.util.Date Yes Yes
the equipment will be
picked up.
DateLatest Latest Date Latest Date The latest date java.util.Date Yes Yes
allowed to pick up
equipment.
DateUpdated Changed Changed The date the EDO java.util.Date Yes Yes
was last changed.
Destination Destination Dest The final destination java.lang.String Yes Yes
of the containers.
This is where the
containers will be
stripped.
DispatchComplete Dispatch Complete Disp Complete True if the amount of java.lang.Boolean Yes No
the QuantityTotal
field is equal or
smaller to the
TallyTotal field.
DispatchReserved Dispatch Reserved Dispatch Reserved Whether to dispatch java.lang.String Yes Yes
reserved equipment
before other
equipment or to
dispatch only
reserved equipment
(FIRST, ONLY).
EDONbr Number Number Identifier of this java.lang.String Yes Yes
EDO.
HoldsIgnored Ignore Holds Ignore Holds The order allows to java.lang.Boolean Yes Yes
pick held containers
for delivery.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 303
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Rail Order

External Tag Long Label Short Label Description Type In Design In Sort
LineOperator Id Id The line operator of java.lang.String Yes Yes
the EDO.
Notes Notes Notes Notes captured for java.lang.String Yes Yes
the booking.
QuantityTotal Quantity Quantity The total amount of java.lang.Long Yes Yes
containers defined
for this booking.
ShipperId Id Id The shipper for the java.lang.String Yes Yes
EDO.
TallyTotal Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
order.
TruckingCompanyId Id Id The Id of the trucking java.lang.String Yes Yes
company defined for
the EDO.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
defined for the EDO.
TypeSubstitutionPrev Prevent Type PreventTypeSubst Do not allow the java.lang.Boolean Yes Yes
ented Substitution substitution of similar
equipment types for
empty containers.

2.2.23 Rail Order

The Rail Order reporting entity allows you to create reports on the rail order information. This reporting entity does not include information on order items.

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the rail
order

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 304
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Rail Order

External Tag Long Label Short Label Description Type In Design In Sort
ClienReferenceNum Client Ref.Number Client Ref The client's own java.lang.String Yes Yes
ber reference number for
the Rail Order.
Creator Creator Creator The user who java.lang.String Yes Yes
created the rail order
DateCreated Created Created The date the rail java.util.Date Yes Yes
order was created.
DateUpdated Changed Changed The date the rail java.util.Date Yes Yes
order was last
changed.
Destination Destination Dest The final destination java.lang.String Yes Yes
of the containers.
This is where the
containers will be
stripped.
DispatchComplete Dispatch Complete Disp Complete True if the amount of java.lang.Boolean Yes No
the QuantityTotal
field is equal or
smaller to the
TallyTotal field.
DispatchReserved Dispatch Reserved Dispatch Reserved Whether to dispatch java.lang.String Yes Yes
reserved equipment
before other
equipment or to
dispatch only
reserved equipment
(FIRST, ONLY).
DrayOff Dray Status Dray Status The dray-off status of java.lang.String Yes Yes
the Rail Order:'F' =
Forward to Loading
Point; 'R' = Return to
shipper; 'I' = Dray In;
'O' = Dray Out and
Back.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 305
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Rail Order

External Tag Long Label Short Label Description Type In Design In Sort
FreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
LineOperator Id Id The line operator of java.lang.String Yes Yes
the Rail Order.
Notes Notes Notes Notes captured for java.lang.String Yes Yes
the Rail Order.
OOGAllowed Over Dimension Over Dimension If true, out-of-gauge java.lang.Boolean Yes Yes
containers are
allowed.
OverrideCutoff Override Cutoff Override Cutoff If set to true, vessel java.lang.Boolean Yes Yes
schedule cutoffs are
overridden.
QuantityTotal Quantity Quantity The total amount of java.lang.Long Yes Yes
containers defined
for this Rail Order.
RailOrderNbr Number Number Identifier of this Rail java.lang.String Yes Yes
Order.
RailRoad Id Id The Rail Road for java.lang.String Yes Yes
the Rail Order.
ShipperId Id Id The shipper for the java.lang.String Yes Yes
Rail Order.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 306
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Service Order

External Tag Long Label Short Label Description Type In Design In Sort
ShippingMode Shipping Mode Shipping Mode The standard java.lang.String Yes Yes
shipping industry
code used to indicate
if the marine terminal
operator is
responsible for
stripping or stuffing
the cargo: 'PP' = Pier
to Pier; 'PH' = Pier to
House; 'HP' = House
to Pier; 'HH' = House
to House;
UNKNOWN
TallyTotal Tally Out Tally Out The total amount of java.lang.Long Yes Yes
containers that were
dispatched for this
Rail Order.
TruckingCompanyId Id Id The Id of the trucking java.lang.String Yes Yes
company assigned to
pick up the empties/
deliver the exports
for this Rail Order.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
assigned to pick up
the empties/deliver
the exports for this
Rail Order.
TypeSubstitutionPrev Prevent Type PreventTypeSubst Do not allow the java.lang.Boolean Yes Yes
ented Substitution substitution of similar
equipment types for
empty containers.

2.2.24 Service Order

The Service Order reporting entity corresponds to the service order information. This reporting entity does not include information on the service order items
(on page 309).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 307
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Service Order

External Tag Long Label Short Label Description Type In Design In Sort
BillOfLadingNbr BL Number BL Nbr Bill Of Lading java.lang.String Yes Yes
associated with this
Service Order
BillingParty Id Id The Billing line of the java.lang.String Yes Yes
Service Order.
BookingNumber Number Number The Equipment java.lang.String Yes Yes
Order associated
with Service Order
(E.g. Booking)
CancelDate Cancel Date Cancel Date The time this java.util.Date Yes Yes
individual container's
delivery order
expires.
CancelNotes Cancel Notes Cancel Notes Cancel Notes. java.lang.String Yes Yes
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the service
order
CompletionDate End By Date End By Date Requested Date to java.util.Date Yes Yes
complete the Service
Order.
Creator Creator Creator The user who java.lang.String Yes Yes
created the service
order
DateCreated Created Created The date the service java.util.Date Yes Yes
order was created.
DateUpdated Changed Changed The date the service java.util.Date Yes Yes
order was last
changed.
Notes Notes Notes Notes. java.lang.String Yes Yes
OrderLine Id Id The Order line of the java.lang.String Yes Yes
Service Order.
OrderStatus Order Status Order Status The Service Order java.lang.String Yes Yes
Status.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 308
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Service Order Item

External Tag Long Label Short Label Description Type In Design In Sort
ServiceOrderNbr Service Order Order Nbr Identifier of this java.lang.String Yes Yes
Number Service Order.
StartDate Start By Date Start By Date Date work was java.util.Date Yes Yes
started for the
service order.

2.2.25 Service Order Item

The Service Order Item reporting entity represents all the order items created for a service order in the system. It includes information on the service order (on
page 307) with which it is associated.

External Tag Long Label Short Label Description Type In Design In Sort
BillingParty Id Id The Billing party of java.lang.String Yes Yes
the Service Order.
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the Service
order item
Creator Creator Creator The user who java.lang.String Yes Yes
created the Service
order item
DateCreated Created Created The date the Service java.util.Date Yes Yes
order item was
created.
DateUpdated Changed Changed The date the Service java.util.Date Yes Yes
order item was last
changed.
EquipmentHeight Height Height Service order item java.lang.String Yes Yes
equipment height:
4'0, 4'3, 8'0, 8'6, 9'0,
or 9'6..

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 309
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Service Types

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentISOGroup ISO Group ISO Service order item java.lang.String Yes No
equipment iso group
code. For information
about ISO codes,
see the Documents
section at
http:www.smdg.org.
Long value, e.g. 'Dry
bulk container non-
pressurized, box
type'.
EquipmentLength Length Length Service order item java.lang.String Yes Yes
equipment size: 20',
24', 30', 40', 45', 48',
or 53'.
EquipmentType ISO Id ISO Id The ISO type of the java.lang.String Yes Yes
order item.
LineOperator Id Id The line operator of java.lang.String Yes Yes
the Service Order.
Quantity Quantity Qty Quantity of Service java.lang.Long Yes No
order item
ServiceOrderNbr Service Order Order Nbr Id of the parent java.lang.String Yes Yes
Number Service Order.

2.2.26 Service Types

The Service Types reporting entity represents the service types in the system. It includes information on the service order (on page 307) with which it is
associated.

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the service
type

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 310
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Item Service Type Unit

External Tag Long Label Short Label Description Type In Design In Sort
Creator Creator Creator The user who java.lang.String Yes Yes
created the service
type
DateCreated Created Created The date the service java.util.Date Yes Yes
type was created.
DateUpdated Changed Changed The date the service java.util.Date Yes Yes
type was last
changed.
ItemServiceTypeEve Id Id Event Type Id. java.lang.String Yes Yes
nt
ItemServiceTypeStat Service Type Status Service Status Service Type Status. java.lang.String Yes No
us
Quantity Quantity Qty Quantity of Item java.lang.Long Yes Yes
Service Type
ServiceOrderItemEq ISO Id ISO Id The ISO type of the java.lang.String Yes Yes
Type order item.
ServiceOrderNbr Service Order Order Nbr The Service Order to java.lang.String Yes Yes
Number which the Service
associated.
Tally Tally Tally Number of units java.lang.Long Yes No
serviced for this
service type.

2.2.27 Item Service Type Unit

The Item Service Type Unit reporting entity represents the units associated with a service order in the system. It includes information on the service order (on
page 307) with which it is associated.

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the item
Service type for unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 311
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Item Service Type Unit

External Tag Long Label Short Label Description Type In Design In Sort
Creator Creator Creator The user who java.lang.String Yes Yes
created the item
Service type for unit
DateCreated Created Created The date the item java.util.Date Yes Yes
Service type for unit
was created.
DateUpdated Changed Changed The date the item java.util.Date Yes Yes
Service type for unit
was last changed.
ServiceOrderNbr Service Order Service Order No. Service Order to java.lang.String Yes No
Number which the Unit is
associated.
ServiceType Id Id Service Type Id. java.lang.String Yes Yes
UnitCategory Category Category The category of the java.lang.String Yes Yes
unit: I for 'Import', E
for 'Export', T for
'Transship', D for
'Domestic', S for
'Storage', or R for
'Through' (includes
Restow).
UnitFreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: E for
'Empty', F for 'Full
Container Load', L
for 'Less than
Container Load', or B
for 'Break-bulk'.
UnitLineOperator Id Id The current operator java.lang.String Yes Yes
(shipping line) of the
unit.
UnitNbr Unit Nbr Unit Nbr Unit Id. java.lang.String Yes Yes
UnitStatus Unit Status Unit Status Unit Status. java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 312
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Carrier Visit Service Order

2.2.28 Carrier Visit Service Order

The Carrier Visit Service Order reporting entity corresponds to the carrier visit service order information.

External Tag Long Label Short Label Description Type In Design In Sort
BillingParty Id Id The Billing line of the java.lang.String Yes Yes
Service Order.
CancelDate Cancel Date Cancel Date The time this java.util.Date Yes Yes
individual container's
delivery order
expires.
CancelNotes Cancel Notes Cancel Notes Cancel Notes. java.lang.String Yes Yes
CarrierVisit Visit Ref Visit The carrier visit Id java.lang.String Yes Yes
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the service
order
CompletionDate End By Date End By Date Requested Date to java.util.Date Yes Yes
complete the Service
Order.
Creator Creator Creator The user who java.lang.String Yes Yes
created the service
order
DateCreated Created Created The date the service java.util.Date Yes Yes
order was created.
DateUpdated Changed Changed The date the service java.util.Date Yes Yes
order was last
changed.
Notes Notes Notes Notes. java.lang.String Yes Yes
OrderLine Id Id The Order line of the java.lang.String Yes Yes
Service Order.
OrderStatus Order Status Order Status The Service Order java.lang.String Yes Yes
Status.
ServiceOrderNbr Service Order Order Nbr Identifier of this java.lang.String Yes Yes
Number Service Order.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 313
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Carrier Visit Service Type

External Tag Long Label Short Label Description Type In Design In Sort
StartDate Start By Date Start By Date Date work was java.util.Date Yes Yes
started for the
service order.

2.2.29 Carrier Visit Service Type

The Carrier Visit Service Type reporting entity represents the carrier visit service types in the system. It includes information on the service order (on page
307) with which it is associated.

External Tag Long Label Short Label Description Type In Design In Sort
Changer Changer Changer The user who last java.lang.String Yes Yes
changed the service
type
Creator Creator Creator The user who java.lang.String Yes Yes
created the service
type
CvsoServiceType Id Id Event Type Id. java.lang.String Yes Yes
CvsoServiceTypeSta Service Status Service Status Service Type Status. java.lang.String Yes Yes
tus
DateCreated Created Created The date the service java.util.Date Yes Yes
type was created.
DateUpdated Changed Changed The date the service java.util.Date Yes Yes
type was last
changed.
ServiceOrderNbr Service Order Order Nbr Identifier of this java.lang.String Yes Yes
Number Service Order.

2.2.30 Railcar Visit

The Railcar Visit reporting entities provide details about a specific railcar visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 314
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
ConvertibleCarConfi Configuration Config A String giving the java.lang.String Yes Yes
g platform
configuration of a
convertible car.
DamageNotes Damage Notes Damage Notes Specify damage java.lang.String Yes Yes
notes, if damaged
Destination Destination Dest Final Destination java.lang.String Yes Yes
FlexString01 Flex String #01 Flex String #01 String flex-field #01 java.lang.String Yes Yes
FlexString02 Flex String #02 Flex String #02 String flex-field #02 java.lang.String Yes Yes
FlexString03 Flex String #03 Flex String #03 String flex-field #03 java.lang.String Yes Yes
FlexString04 Flex String #04 Flex String #04 String flex-field #04 java.lang.String Yes Yes
FlexString05 Flex String #05 Flex String #05 String flex-field #05 java.lang.String Yes Yes
FlexString06 Flex String #06 Flex String #06 String flex-field #06 java.lang.String Yes Yes
FlexString07 Flex String #07 Flex String #07 String flex-field #07 java.lang.String Yes Yes
FlexString08 Flex String #08 Flex String #08 String flex-field #08 java.lang.String Yes Yes
IbTrainOperatorId Id Id The carrier visit java.lang.String Yes Yes
operator Id.
IbTrainVisitDataSour Data Source Source Source of this carrier java.lang.String Yes Yes
ce visit record
IbTrainVisitDestinatio Destination Destination Train Destination java.lang.String Yes Yes
n
IbTrainVisitDirection Train Direction Direction Train is inbound only, java.lang.String Yes Yes
outbound only or a
through train
IbTrainVisitDurationP Duration Periodic Duration Periodic Periodic Visit interval java.lang.Long Yes Yes
eriodicRecur Recur Recur
IbTrainVisitFlexString FlexString 01 FlexString 01 String flex-field #01 java.lang.String Yes Yes
01
IbTrainVisitFlexString FlexString 02 FlexString 02 String flex-field #02 java.lang.String Yes Yes
02

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 315
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
IbTrainVisitFlexString FlexString 03 FlexString 03 String flex-field #03 java.lang.String Yes Yes
03
IbTrainVisitFlexString FlexString 04 FlexString 04 String flex-field #04 java.lang.String Yes Yes
04
IbTrainVisitFlexString FlexString 05 FlexString 05 String flex-field #05 java.lang.String Yes Yes
05
IbTrainVisitFlexString FlexString 06 FlexString 06 String flex-field #06 java.lang.String Yes Yes
06
IbTrainVisitFlexString FlexString 07 FlexString 07 String flex-field #07 java.lang.String Yes Yes
07
IbTrainVisitFlexString FlexString 08 FlexString 08 String flex-field #08 java.lang.String Yes Yes
08
IbTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes
IbTrainVisitInCallNu Inbound Call Nbr In Call Nbr Inbound Call Number java.lang.String Yes Yes
mber
IbTrainVisitIsDrayOff Dray Off Dray Off Checked to forward java.lang.Boolean Yes Yes
all exports to another
facility
IbTrainVisitMaxLengt Maximum Length Max Length Maximum length java.lang.Double Yes Yes
hCm allowed for the train
IbTrainVisitMaxWeig Maximum Weight Max Weight Maximum weight java.lang.Double Yes Yes
htKg allowed for the train
IbTrainVisitNotes Notes Notes Notes about the visit java.lang.String Yes Yes
IbTrainVisitOutCallN Outbound Call Nbr Out Call Nbr Outbound Call java.lang.String Yes Yes
umber Number
IbTrainVisitPhaseCo Phase Comment Phase Comment SPARCS notion of java.lang.String Yes Yes
mment 'visit phase
comment'
IbTrainVisitTimeBegi Begin Receive Begin Receive Begin receive time java.util.Date Yes Yes
nReceive
IbTrainVisitTimeDisc Discharge Complete Discharge Complete Time discharge of java.util.Date Yes Yes
hargeComplete entire carrier visit
completed

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 316
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
IbTrainVisitTimeETA Est. Time of Arrival ETA Estimated Time of java.util.Date Yes Yes
Arrival
IbTrainVisitTimeETD Est. Time of Depart. ETD Estimated Time of java.util.Date Yes Yes
Departure
IbTrainVisitTimeEnd Time End Work End Work Work ending time java.util.Date Yes Yes
Work
IbTrainVisitTimeFirst Begin Delivery Begin Delivery Date/time discharged java.util.Date Yes Yes
Availability cargo is available for
pickup
IbTrainVisitTimeInbo First Free Day First Free Day Storage First Free java.util.Date Yes Yes
undFirstDayFree Day for inbound
cargo
IbTrainVisitTimePerio Time Periodic End Time Periodic End Last Periodic Visit java.util.Date Yes Yes
dicEnd time
IbTrainVisitTimePerio Time Periodic Start Time Periodic Start First Periodic Visit java.util.Date Yes Yes
dicStart time
IbTrainVisitTimeStart Time Start Work Start Work Work starting time java.util.Date Yes Yes
Work
IbTrainVisitTrack Track Track Track position where java.lang.String Yes Yes
the train is
InSequence I/B Sequence I/B Sequence Order of railcar in java.lang.Long Yes Yes
inbound train.
InspectionStatus Inspection Status Insp Status Inspection status - java.lang.String Yes Yes
OK or BAD
IsActive Is Active Is Active If true, is in the java.lang.Boolean Yes Yes
facility now.
IsDamaged Damaged Damaged If true, the railcar is java.lang.Boolean Yes Yes
defined to be
damaged
IsDirFlipped Is Car Dir Flipped Dir Flipped If true, then direction java.lang.Boolean Yes Yes
is flipped.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 317
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
IsDisconnectedAtLo Segment break Disconnected If true, then railcar is java.lang.Boolean Yes Yes
w (disconnected) at low disconnected at low
end end with respect to
RailTrack origin.
LastDeparted Last Departed Last Departed Date and time of last java.util.Date Yes Yes
time the railcar left
the terminal
LoadedUnits Loaded Units Units A comma separated java.lang.String Yes No
list of all Units loaded
to this railcar visit.
LoadedUnitsSlots Loaded Unit Slots Loaded Unit Slots A comma separated java.lang.String Yes No
list of the slots of
Units loaded to this
railcar visit
ObTrainOperatorId Id Id The carrier visit java.lang.String Yes Yes
operator Id.
ObTrainVisitDataSou Data Source Source Source of this carrier java.lang.String Yes Yes
rce visit record
ObTrainVisitDestinati Destination Destination Train Destination java.lang.String Yes Yes
on
ObTrainVisitDirection Train Direction Direction Train is inbound only, java.lang.String Yes Yes
outbound only or a
through train
ObTrainVisitDuration Duration Periodic Duration Periodic Periodic Visit interval java.lang.Long Yes Yes
PeriodicRecur Recur Recur
ObTrainVisitFlexStrin FlexString 01 FlexString 01 String flex-field #01 java.lang.String Yes Yes
g01
ObTrainVisitFlexStrin FlexString 02 FlexString 02 String flex-field #02 java.lang.String Yes Yes
g02
ObTrainVisitFlexStrin FlexString 03 FlexString 03 String flex-field #03 java.lang.String Yes Yes
g03
ObTrainVisitFlexStrin FlexString 04 FlexString 04 String flex-field #04 java.lang.String Yes Yes
g04

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 318
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
ObTrainVisitFlexStrin FlexString 05 FlexString 05 String flex-field #05 java.lang.String Yes Yes
g05
ObTrainVisitFlexStrin FlexString 06 FlexString 06 String flex-field #06 java.lang.String Yes Yes
g06
ObTrainVisitFlexStrin FlexString 07 FlexString 07 String flex-field #07 java.lang.String Yes Yes
g07
ObTrainVisitFlexStrin FlexString 08 FlexString 08 String flex-field #08 java.lang.String Yes Yes
g08
ObTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes
ObTrainVisitInCallNu Inbound Call Nbr In Call Nbr Inbound Call Number java.lang.String Yes Yes
mber
ObTrainVisitIsDrayOf Dray Off Dray Off Checked to forward java.lang.Boolean Yes Yes
f all exports to another
facility
ObTrainVisitMaxLen Maximum Length Max Length Maximum length java.lang.Double Yes Yes
gthCm allowed for the train
ObTrainVisitMaxWei Maximum Weight Max Weight Maximum weight java.lang.Double Yes Yes
ghtKg allowed for the train
ObTrainVisitNotes Notes Notes Notes about the visit java.lang.String Yes Yes
ObTrainVisitOutCall Outbound Call Nbr Out Call Nbr Outbound Call java.lang.String Yes Yes
Number Number
ObTrainVisitPhaseC Phase Comment Phase Comment SPARCS notion of java.lang.String Yes Yes
omment 'visit phase
comment'
ObTrainVisitTimeBeg Begin Receive Begin Receive Begin receive time java.util.Date Yes Yes
inReceive
ObTrainVisitTimeDis Discharge Complete Discharge Complete Time discharge of java.util.Date Yes Yes
chargeComplete entire carrier visit
completed
ObTrainVisitTimeET Est. Time of Arrival ETA Estimated Time of java.util.Date Yes Yes
A Arrival
ObTrainVisitTimeET Est. Time of Depart. ETD Estimated Time of java.util.Date Yes Yes
D Departure

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 319
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
ObTrainVisitTimeEnd Time End Work End Work Work ending time java.util.Date Yes Yes
Work
ObTrainVisitTimeFirs Begin Delivery Begin Delivery Date/time discharged java.util.Date Yes Yes
tAvailability cargo is available for
pickup
ObTrainVisitTimeInb First Free Day First Free Day Storage First Free java.util.Date Yes Yes
oundFirstDayFree Day for inbound
cargo
ObTrainVisitTimePeri Time Periodic End Time Periodic End Last Periodic Visit java.util.Date Yes Yes
odicEnd time
ObTrainVisitTimePeri Time Periodic Start Time Periodic Start First Periodic Visit java.util.Date Yes Yes
odicStart time
ObTrainVisitTimeStar Time Start Work Start Work Work starting time java.util.Date Yes Yes
tWork
ObTrainVisitTrack Track Track Track position where java.lang.String Yes Yes
the train is
Origin Origin Origin Origin java.lang.String Yes Yes
OutSequence O/B Sequence O/B Sequence Order of railcar in java.lang.Long Yes Yes
outbound train.
PlatTransferPoints Platform Transfer Plt Transfer Pts Platform Transfer java.lang.String Yes Yes
Points points
PositionLocId Location Id LocId A String giving the Id java.lang.String Yes Yes
of the location
PositionLocType Position Type Type An Enum giving the java.lang.String Yes Yes
type of position.
PositionOrientation Orientation Orientation A String defining the java.lang.String Yes Yes
orientation of the
Unit
PositionSlot Slot Slot A String giving the java.lang.String Yes Yes
coordinates of the
Position

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 320
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
PositionTrack Track-Pos Track-Pos The track on which a java.lang.String Yes No
railcarvisit is located
in the terminal. Note:
only available in
case the railcar is
still in the terminal.
For sorting use
PositionSlot which is
the combination of
'Track-Slot'.
PositionTrackSlot Track Slot Slot The slot on the track java.lang.String Yes No
on which a
railcarvisit is located
in the terminal. Note:
only available in
case the railcar is
still in the terminal.
For sorting use
PositionSlot which is
the combination of
'Track-Slot'.
RailCarVisitId Railcar Visit Id Visit A unique identifier for java.lang.String Yes Yes
the rail visit.
RailCarVisitNbr Visit Nbr Visit Nbr A number to java.lang.Long Yes Yes
disambiguate the
visit: 1=first visit,
2=second, etc.
RailTrackXCoord Track X Coordinate Track X Coord Track X Coordinate. java.lang.Long Yes Yes
RailcarFlatCarType Flat Car Type Flat Type Type of the flat car java.lang.String Yes Yes
being used: TOFC,
COFC, or convertible
RailcarFloorHeightC Floor Height Floor Height Floor height of the java.lang.Double Yes Yes
m railroad car
RailcarId ID ID Associated Railcar Id java.lang.String Yes Yes
RailcarIsHighSide Has High Side High Side True if access to java.lang.Boolean Yes Yes
forklift available

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 321
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
RailcarLengthCm Length Length Overall length of this java.lang.Double Yes Yes
car
RailcarMax20sPerPl Max 20' Count 20' Count Maximum number of java.lang.Long Yes Yes
atform 20 foot containers
that can be
accommodated per
platform
RailcarMaxTiersPerP Max Tier Count Tier Count Maximum number of java.lang.Long Yes Yes
latform tiers that can be
accommodated per
platform
RailcarNotes Description Description Notes java.lang.String Yes Yes
RailcarSafeWeightK Safe Weight Safe Weight Maximum safe java.lang.Double Yes Yes
g weight capacity of
railroad cars of this
type
RailcarTareWeightKg Tare Weight Tare Weight Empty weight of java.lang.Double Yes Yes
railroad car
RailcarTemplateType ID ID Associated railcar's java.lang.String Yes Yes
Id template type Id.
RailcarTemplateType Description Description Associated railcar's java.lang.String Yes Yes
Name template type Id
RailcarVisitChanger Changer Changer The user who last java.lang.String Yes Yes
changed the railcar
visit
RailcarVisitCreated Created Created The date the railcar java.util.Date Yes Yes
visit was created
RailcarVisitCreator Creator Creator The user who java.lang.String Yes Yes
created the railcar
visit
RailcarVisitUnitsArriv Units Arrived On Railcar Arr. Units A comma separated java.lang.String Yes No
ed Railcar list of Units that
arrived on the
Railcar

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 322
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
RailcarVisitUnitsSlot Slots of Units that Railcar Arr. Unit A comma separated java.lang.String Yes No
sArrived Arrived on this Slots list of the slots of
Railcar Units that arrived on
the Railcar
RailcarVisitUpdated Changed Changed The date the railcar java.util.Date Yes Yes
visit was last
changed
SpottingStatus Spotting Status Spot Stat Spotting status java.lang.String Yes Yes
WagonPinConfig Pin Configuration Pin Config A String giving the java.lang.String Yes Yes
pin configuration of a
railcar.
WorkPattern Work Pattern Work Pattern Work Pattern java.lang.String Yes Yes

2.2.31 Train Visit

The Train Visit reporting entities provide details about a specific train visit.

External Tag Long Label Short Label Description Type In Design In Sort
CarrierVisitATA Act. Time of Arrival ATA The carrier visit ATA. java.util.Date Yes Yes
CarrierVisitATD Act. Time of Depart. ATD The carrier visit ATD. java.util.Date Yes Yes
CarrierVisitCarrierMo Carrier Mode Mode The carrier visit java.lang.String Yes Yes
de mode.
CarrierVisitComplexI Complex Complex The carrier visit java.lang.String Yes Yes
d complex Id.
CarrierVisitCustomsI Customs ID Customs ID The customs Id of java.lang.String Yes Yes
d the carrier visit.
CarrierVisitFacilityId Facility Facility The carrier visit java.lang.String Yes Yes
facility Id.
CarrierVisitId Visit Ref Visit The Id of the carrier java.lang.String Yes Yes
visit.
CarrierVisitNbr Call Number Number The carrier visit java.lang.Long Yes Yes
number.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 323
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
CarrierVisitNextFacili Facility Facility The carrier visit next java.lang.String Yes Yes
tyId facility Id.
CarrierVisitOperatorI Id Id The carrier visit java.lang.String Yes Yes
d operator Id.
CarrierVisitPhase Visit Phase Phase The carrier visit java.lang.String Yes Yes
phase.
Cus1 Customer 1 Cust 1 Train Cus Field 1. java.lang.String Yes Yes
Cus2 Customer 2 Cust 2 Train Cus Field 2. java.lang.String Yes Yes
Cus3 Customer 3 Cust 3 Train Cus Field 3. java.lang.String Yes Yes
DataSource Data Source Source Source of this train java.lang.String Yes Yes
visit record.
Destination Destination Destination The destination of java.lang.String Yes Yes
the train.
Direction Train Direction Direction Train is inbound only, java.lang.String Yes No
outbound only or a
through train
DirectionDesc Train Direction Direction Description of java.lang.String Yes Yes
direction viz Inbound
Only Train,
Outbound Only Train
or Through Train
DurationPeriodicRec Duration Periodic Duration Periodic Periodic visit interval. java.lang.Long Yes Yes
ur Recur Recur
FlexString01 FlexString 01 FlexString 01 String flex-field #01. java.lang.String Yes Yes
FlexString02 FlexString 02 FlexString 02 String flex-field #02. java.lang.String Yes Yes
FlexString03 FlexString 03 FlexString 03 String flex-field #03. java.lang.String Yes Yes
FlexString04 FlexString 04 FlexString 04 String flex-field #04. java.lang.String Yes Yes
FlexString05 FlexString 05 FlexString 05 String flex-field #05. java.lang.String Yes Yes
FlexString06 FlexString 06 FlexString 06 String flex-field #06. java.lang.String Yes Yes
FlexString07 FlexString 07 FlexString 07 String flex-field #07. java.lang.String Yes Yes
FlexString08 FlexString 08 FlexString 08 String flex-field #08. java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 324
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
InCallNumber Inbound Call Nbr In Call Nbr Inbound call number. java.lang.String Yes Yes
IsDrayOff Dray Off Dray Off Checked to forward java.lang.Boolean Yes Yes
all exports to another
facility.
MaxLengthCm Maximum Length Max Length Maximum length java.lang.Double Yes Yes
allowed for the train.
MaxWeightKg Maximum Weight Max Weight Maximum weight java.lang.Double Yes Yes
allowed for the train.
NonDoubleStackCar The Percentage of java.lang.Double Yes No
s the cars on the train
which are non-
double-stack rail
cars.
Notes Notes Notes Notes about the visit. java.lang.String Yes Yes
OutCallNumber Outbound Call Nbr Out Call Nbr Outbound call java.lang.String Yes Yes
number.
RailLastMoveTime For inbound trains, java.util.Date Yes No
the date and time
when the train is
completely unloaded
and all the units are
off the train and in
location. For
outbound trains, the
date and time when
all the units are
loaded on the
railcars and the train
is complete and
ready to be pulled
from the yard.
RailOperator Id Id Rail road company java.lang.String Yes Yes
operating the train.
TimeBeginReceive Begin Receive Begin Receive Begin receive time. java.util.Date Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 325
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Train Visit

External Tag Long Label Short Label Description Type In Design In Sort
TimeDischargeComp Discharge Complete Discharge Complete Time discharge of java.util.Date Yes Yes
lete entire train visit
completed.
TimeETA Est. Time of Arrival ETA Estimated time of java.util.Date Yes Yes
arrival.
TimeETD Est. Time of Depart. ETD Estimated time of java.util.Date Yes Yes
departure.
TimeEndWork Time End Work End Work Work ending time. java.util.Date Yes Yes
TimeFirstAvailability Begin Delivery Begin Delivery Date/time discharged java.util.Date Yes Yes
cargo is available for
pickup.
TimeInboundFirstDa First Free Day First Free Day Storage First Free java.util.Date Yes Yes
yFree Day for inbound
cargo.
TimePeriodicEnd Time Periodic End Time Periodic End Last periodic visit java.util.Date Yes Yes
time.
TimePeriodicStart Time Periodic Start Time Periodic Start First periodic visit java.util.Date Yes Yes
time.
TimeStartWork Time Start Work Start Work Work starting time. java.util.Date Yes Yes
Track Track Track Track position of the java.lang.String Yes Yes
train.
TrainVisitChanger Changer Changer The user who last java.lang.String Yes Yes
changed the train
visit
TrainVisitCreated Created Created The date the train java.util.Date Yes Yes
visit was created
TrainVisitCreator Creator Creator The user who java.lang.String Yes Yes
created the train visit
TrainVisitId Train Id Train Id A unique Id that java.lang.String Yes Yes
identifies this train
visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 326
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
TrainVisitPhaseCom Phase Comment Phase Comment SPARCS notion of java.lang.String Yes Yes
ment 'visit phase
comment'
TrainVisitUpdated Changed Changed The date the train java.util.Date Yes Yes
visit was last
changed
User1 User 1 User 1 Train User Field 1. java.lang.String Yes Yes
User2 User 2 User 2 Train User Field 2. java.lang.String Yes Yes
User3 User 3 User 3 Train User Field 3. java.lang.String Yes Yes
User4 User 4 User 4 Train User Field 4. java.lang.String Yes Yes

2.2.32 UFV Arrived on Railcar Visit

The UFV Arrived on Railcar Visit reporting entity joins the Railcar Visit (on page 314) and the Unit (on page 89) reporting entities to represent the units that
arrived at the facility on a railcar. This reporting entity is based on Arrival Position Location Gkey of the Unit Facility Visit (UFV).

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: Y for 'Yard', V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 327
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other).
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 328
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
FlexString01 Flex String #01 Flex String #01 String flex-field #01 java.lang.String Yes Yes
FlexString02 Flex String #02 Flex String #02 String flex-field #02 java.lang.String Yes Yes
FlexString03 Flex String #03 Flex String #03 String flex-field #03 java.lang.String Yes Yes
FlexString04 Flex String #04 Flex String #04 String flex-field #04 java.lang.String Yes Yes
FlexString05 Flex String #05 Flex String #05 String flex-field #05 java.lang.String Yes Yes
FlexString06 Flex String #06 Flex String #06 String flex-field #06 java.lang.String Yes Yes
FlexString07 Flex String #07 Flex String #07 String flex-field #07 java.lang.String Yes Yes
FlexString08 Flex String #08 Flex String #08 String flex-field #08 java.lang.String Yes Yes
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
IBDeclaredCarrierId Visit Ref Visit Inbound declared java.lang.String Yes Yes
carrier: Train ID for
train
IbTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes
InSequence I/B Sequence I/B Sequence Order of railcar in java.lang.Long Yes Yes
inbound train.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
ObTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 329
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
OutSequence O/B Sequence O/B Sequence Order of railcar in java.lang.Long Yes Yes
outbound train.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
train ID for train.
OutboundIntendedC Visit Ref Visit Intended Departure java.lang.String Yes Yes
arrierId carrier: train ID for
train.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
train.
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 330
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
RailCarPositionLocId Location Id LocId A String giving the Id java.lang.String Yes Yes
of the location
RailCarPositionLocT Position Type Type An Enum giving the java.lang.String Yes Yes
ype type of position.
RailCarPositionSlot Slot Slot A String giving the java.lang.String Yes Yes
coordinates of the
Position
RailCarVisitId Railcar Visit Id Visit A unique identifier for java.lang.String Yes Yes
the rail visit.
RailCarVisitNbr Visit Nbr Visit Nbr A number to java.lang.Long Yes Yes
disambiguate the
visit: 1=first visit,
2=second, etc.
RailcarId ID ID Associated Railcar Id java.lang.String Yes Yes
RailcarNotes Description Description Notes java.lang.String Yes Yes
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 331
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 332
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString05.
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString10.
UnitCategory Category Category The category of the java.lang.String Yes Yes
unit
UnitDrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 333
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV Arrived on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 334
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitFreightKind Freight Kind Frght Kind The freight kind of java.lang.String Yes Yes
the unit
UnitId Unit Nbr Unit Nbr The Unit Id java.lang.String Yes Yes
UnitVisitState Visit State (Master) State (Master) The visit state of the java.lang.String Yes Yes
unit
VisitState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.

2.2.33 UFV on Railcar Visit

The UFV on Railcar Visit reporting entity joins the Railcar Visit (on page 314) and the Unit (on page 89) reporting entities to represent the units where the last
known position of the unit is a railcar. This reporting entity is based on Last Known Position Gkey of the Unit Facility Visit (UFV).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 335
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
ArrivalPositionFull Position Position The complete name java.lang.String Yes Yes
of the arrival
position, '(Type)-
(Carrier or Yard)-
(Slot)'.
ArrivalPositionLocId Location Id LocId The arrival location java.lang.String Yes Yes
ID: Carrier visit ID.
ArrivalPositionLocTy Position Type Type The arrival location java.lang.String Yes Yes
pe type: Y for 'Yard', V
for 'Vessel', R for
'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
ArrivalPositionSlot Slot Slot The arrival slot java.lang.String Yes Yes
position ID.
EquipmentISOGroup ISO Group ISO Grp The equipment type java.lang.String Yes Yes
ISO group code.
EquipmentReeferTyp Reefer Type Rfr Type The reefer type code java.lang.String Yes Yes
e of the primary
container. NOTE:
This field can only be
used if the report
data is filtered for
'Equipment Class =
Container'.
EquipmentTareWeig Tare Weight Tare Wt The equipment tare java.lang.Double Yes Yes
htKg weight in kilograms.
The tare weight is
the empty weight of
the equipment.
EquipmentType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 336
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
EquipmentTypeBasic Basic Length Basic Length The Basic length of java.lang.String Yes Yes
Length the primary
equipment: 20' or
40'.
EquipmentTypeClass General Class Class The reefer type code java.lang.String Yes Yes
of the primary
container: X for 'Non-
reefer', I for 'Air-
cooled, Dual Volt', V
for 'Air-cooled, Single
Volt', W for 'H2O-
cooled, Dual Volt', X
for 'H2O-cooled,
Single Volt', A for
'Integral, cooling
unknown', F for
'Fantainer/Starvent',
or P for 'Porthole
(forced-air)'.
EquipmentTypeNomi Nominal Height Height The nominal height java.lang.String Yes Yes
nalHeight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
EquipmentTypeNomi Nominal Length Length The nominal length java.lang.String Yes Yes
nalLength of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
FlexString01 Flex String #01 Flex String #01 String flex-field #01 java.lang.String Yes Yes
FlexString02 Flex String #02 Flex String #02 String flex-field #02 java.lang.String Yes Yes
FlexString03 Flex String #03 Flex String #03 String flex-field #03 java.lang.String Yes Yes
FlexString04 Flex String #04 Flex String #04 String flex-field #04 java.lang.String Yes Yes
FlexString05 Flex String #05 Flex String #05 String flex-field #05 java.lang.String Yes Yes
FlexString06 Flex String #06 Flex String #06 String flex-field #06 java.lang.String Yes Yes
FlexString07 Flex String #07 Flex String #07 String flex-field #07 java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 337
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
FlexString08 Flex String #08 Flex String #08 String flex-field #08 java.lang.String Yes Yes
GoodsConsignee Id Id The specified java.lang.String Yes Yes
consignee for the
goods.
GoodsShipper Id Id The specified java.lang.String Yes Yes
shipper for the
goods.
IBDeclaredCarrierId Visit Ref Visit Inbound declared java.lang.String Yes Yes
carrier: Train ID for
train
IbTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes
InSequence I/B Sequence I/B Sequence Order of railcar in java.lang.Long Yes Yes
inbound train.
InboundCarrierId Visit Ref Visit The inbound carrier java.lang.String Yes Yes
visit ID.
ObTrainVisitId Visit Ref Visit Identifier of the train java.lang.String Yes Yes
OutSequence O/B Sequence O/B Sequence Order of railcar in java.lang.Long Yes Yes
outbound train.
OutboundCarrierId Visit Ref Visit Departure carrier: java.lang.String Yes Yes
train ID for train.
OutboundIntendedC Visit Ref Visit Intended Departure java.lang.String Yes Yes
arrierId carrier: train ID for
train.
POD Point ID ID The first port of java.lang.String Yes Yes
discharge.
POD2 Point ID ID The second port of java.lang.String Yes Yes
discharge.
POL Point ID ID The port at which the java.lang.String Yes Yes
container was loaded
or will be loaded to a
train.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 338
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
PositionFull Position Position The complete name, java.lang.String Yes Yes
'(Type)-(Carrier or
Yard)-(Slot)' of the
last registered
location for this visit
of the unit.
PositionLocId Location Id LocId The last registered java.lang.String Yes Yes
location ID for this
visit of the unit: Yard
code, or the Carrier
Visit ID.
PositionLocType Position Type Type The last registered java.lang.String Yes Yes
location type for this
visit of the unit: Y for
'Yard', V for 'Vessel',
R for 'Railcar', T for
'Truck', N for 'Train',
C for 'Community', or
U for 'Unknown'.
PositionOfRailcar Railcar Position Railcar Position The position of the java.lang.String Yes No
(Track-Slot) Railcar Visit in the
Yard in the format
'Track-Slot'. Only
populated if the unit's
last known position is
on a railcar.
PositionSlot Slot Slot The slot position ID java.lang.String Yes Yes
of the last registered
location for this visit
of the unit.
RailCarPositionLocId Location Id LocId A String giving the Id java.lang.String Yes Yes
of the location
RailCarPositionLocT Position Type Type An Enum giving the java.lang.String Yes Yes
ype type of position.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 339
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
RailCarPositionSlot Slot Slot A String giving the java.lang.String Yes Yes
coordinates of the
Position
RailCarVisitId Railcar Visit Id Visit A unique identifier for java.lang.String Yes Yes
the rail visit.
RailCarVisitNbr Visit Nbr Visit Nbr A number to java.lang.Long Yes Yes
disambiguate the
visit: 1=first visit,
2=second, etc.
RailcarId ID ID Associated Railcar Id java.lang.String Yes Yes
RailcarNotes Description Description Notes java.lang.String Yes Yes
UfvFlexDate01 ufvFlexDate01 ufvFlexDate01 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate01.
UfvFlexDate02 ufvFlexDate02 ufvFlexDate02 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate02.
UfvFlexDate03 ufvFlexDate03 ufvFlexDate03 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate03.
UfvFlexDate04 ufvFlexDate04 ufvFlexDate04 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate04.
UfvFlexDate05 ufvFlexDate05 ufvFlexDate05 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate05.
UfvFlexDate06 ufvFlexDate06 ufvFlexDate06 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate06.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 340
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexDate07 ufvFlexDate07 ufvFlexDate07 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate07.
UfvFlexDate08 ufvFlexDate08 ufvFlexDate08 The flex field of the java.util.Date Yes Yes
Unit Facility Visit with
name:
ufvFlexDate08.
UfvFlexString01 UFV Flex-01 UFV Flex-01 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString01.
UfvFlexString02 UFV Flex-02 UFV Flex-02 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString02.
UfvFlexString03 UFV Flex-03 UFV Flex-03 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString03.
UfvFlexString04 UFV Flex-04 UFV Flex-04 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
UfvFlexString04.
UfvFlexString05 UFV Flex-05 UFV Flex-05 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString05.
UfvFlexString06 UFV Flex-06 UFV Flex-06 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString06.
UfvFlexString07 UFV Flex-07 UFV Flex-07 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString07.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 341
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UfvFlexString08 UFV Flex-08 UFV Flex-08 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString08.
UfvFlexString09 UFV Flex-09 UFV Flex-09 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString09.
UfvFlexString10 UFV Flex-10 UFV Flex-10 The flex field of the java.lang.String Yes Yes
Unit Facility Visit with
name:
ufvFlexString10.
UnitCategory Category Category The category of the java.lang.String Yes Yes
unit
UnitDrayStatus Dray Status Dray Status The dray status of java.lang.String Yes Yes
the unit
UnitFlexString01 Flex-01 Flex-01 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString01.
UnitFlexString02 Flex-02 Flex-02 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString02.
UnitFlexString03 Flex-03 Flex-03 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString03.
UnitFlexString04 Flex-04 Flex-04 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString04.
UnitFlexString05 Flex-05 Flex-05 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString05.
UnitFlexString06 Flex-06 Flex-06 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString06.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 342
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
UFV on Railcar Visit

External Tag Long Label Short Label Description Type In Design In Sort
UnitFlexString07 Flex-07 Flex-07 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString07.
UnitFlexString08 Flex-08 Flex-08 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString08.
UnitFlexString09 Flex-09 Flex-09 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString09.
UnitFlexString10 Flex-10 Flex-10 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString10.
UnitFlexString11 Flex-11 Flex-11 The flex field of the java.lang.String Yes Yes
unit with name:
unitFlexString11.
UnitFlexString12 Flex-12 Flex-12 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString12.
UnitFlexString13 Flex-13 Flex-13 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString13.
UnitFlexString14 Flex-14 Flex-14 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString14.
UnitFlexString15 Flex-15 Flex-15 The flex field of the java.lang.String Yes Yes
unit with name:
UnitFlexString15.
UnitFreightKind Freight Kind Frght Kind The freight kind of java.lang.String Yes Yes
the unit
UnitId Unit Nbr Unit Nbr The Unit Id java.lang.String Yes Yes
UnitVisitState Visit State (Master) State (Master) The visit state of the java.lang.String Yes Yes
unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 343
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
VisitState Visit State V-State The current visit java.lang.String Yes Yes
state of a unit:
'Advised', 'Active',
'Departed', or
'Retired'.
VisitsTransitState Transit State T-State The current transit java.lang.String Yes Yes
state of a unit:
'Inbound', 'Advised',
'EC/In', 'Yard', 'EC/
Out', 'Loaded',
'Departed', or
'Retired'.

2.2.34 Appointments
The Appointments reporting entity represents all appointments made for upcoming or passed gate traffic. Some appointments have an actual unit associated
while others are mere placeholders for unregistered units.

The Appt prefix in the External Tag represents the unit related values entered in the appointment and the Unit prefix represents the values from the actual unit.

External Tag Long Label Short Label Description Type In Design In Sort
ApptBlItemNbr Item Number Item Nbr The Bl Item number java.lang.String Yes Yes
defined in the
appointment.
ApptBlNbr BL Number BL Nbr The Bl number java.lang.String Yes Yes
defined in the
appointment.
ApptBookingNbr Number Number The booking number java.lang.String Yes Yes
defined in the
appointment.
ApptChassisAccesso Chassis Accessory Chassis Accs Id The accessory id java.lang.String Yes Yes
ryId Id associated with the
chassis defined in
the appointment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 344
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
ApptChassisId Chassis Id Chassis Id The chassis id java.lang.String Yes Yes
defined in the
appointment.
ApptChassisType ISO Id ISO Id The chassis type java.lang.String Yes Yes
defined in the
appointment.
ApptContainerAcces Container Accessory Ctr Accs Id The accessory id java.lang.String Yes Yes
soryId Id associated with the
container defined in
the appointment.
ApptContainerGross Gross Weight Weight The gross weight of java.lang.Double Yes Yes
Weight container and goods
in kg defined in the
appointment.
ApptContainerId Container Id Ctr Id The container id java.lang.String Yes Yes
defined in the
appointment.
ApptContainerIsoGro ISO Group ISO Grp The iso group of the java.lang.String Yes Yes
up container defined in
the appointment (e.g.
'General purpose
container without
ventilation', 'Self-
powered
refrigerated/heated',
'Dry bulk container,
pressurized', etc..
ApptContainerReefer Reefer Type Rfr Type The reefer type of java.lang.String Yes Yes
Type the container defined
in the appointment
(e.g. 'Air-cooled,
Dual Volt', 'Fantainer/
Starvent', 'Non-
reefer' etc..

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 345
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
ApptContainerType ISO Id ISO Id The container type java.lang.String Yes Yes
defined in the
appointment.
ApptContainerTypeH Nominal Height Height The nominal height java.lang.String Yes Yes
eight of the container
defined in the
appointment.
ApptContainerTypeL Nominal Length Length The nominal length java.lang.String Yes Yes
ength of the container
defined in the
appointment.
ApptFreightKind Freight Kind Frght Kind The freight kind java.lang.String Yes Yes
defined in the
appointment.
ApptImportReleaseN Import Release Import Release The truck license java.lang.String Yes Yes
umber Number Number number (group ID or
B/L number) defined
in the appointment.
ApptNbr Appointment Nbr Nbr The number of this java.lang.Long Yes Yes
appointment.
ApptNotes Notes Notes Notes defined in the java.lang.String Yes Yes
appointment.
ApptSealNbr1 Seal Number 1 Seal Nbr1 The seal number 1 java.lang.String Yes Yes
defined in the
appointment.
ApptSealNbr2 Seal Number 2 Seal Nbr2 The seal number 2 java.lang.String Yes Yes
defined in the
appointment.
ApptSealNbr3 Seal Number 3 Seal Nbr3 The seal number 3 java.lang.String Yes Yes
defined in the
appointment.
ApptSealNbr4 Seal Number 4 Seal Nbr4 The seal number 4 java.lang.String Yes Yes
defined in the
appointment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 346
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
ApptState State State The state of this java.lang.String Yes Yes
appointment created,
used, expired etc.
ApptTruckId Truck Id Truck Id The truck id defined java.lang.String Yes Yes
in the appointment.
ApptTruckLicenseNb Truck License Nbr Truck License The truck license java.lang.String Yes Yes
r number defined in
the appointment.
ApptUfvFlexDate01 Gappt Ufv Flex Gappt Ufv Flex null java.util.Date Yes Yes
Date-01 Date-01
ApptUfvFlexDate02 Gappt Ufv Flex Gappt Ufv Flex null java.util.Date Yes Yes
Date-01 Date-01
ApptUfvFlexString01 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-01 String-01
ApptUfvFlexString02 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-02 String-02
ApptUfvFlexString03 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-03 String-03
ApptUfvFlexString04 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-04 String-04
ApptUfvFlexString05 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-05 String-05
ApptUfvFlexString06 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-06 String-06
ApptUfvFlexString07 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-07 String-07
ApptUfvFlexString08 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-08 String-08
ApptUfvFlexString09 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-09 String-09
ApptUfvFlexString10 Gappt Ufv Flex Gappt Ufv Flex null java.lang.String Yes Yes
String-10 String-10

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 347
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
ApptUnitFlexString01 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-01 String-01
ApptUnitFlexString02 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-02 String-02
ApptUnitFlexString03 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-03 String-03
ApptUnitFlexString04 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-04 String-04
ApptUnitFlexString05 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-05 String-05
ApptUnitFlexString06 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-06 String-06
ApptUnitFlexString07 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-07 String-07
ApptUnitFlexString08 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-08 String-08
ApptUnitFlexString09 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-09 String-09
ApptUnitFlexString10 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-10 String-10
ApptUnitFlexString11 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-11 String-11
ApptUnitFlexString12 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-12 String-12
ApptUnitFlexString13 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-13 String-13
ApptUnitFlexString14 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-14 String-14
ApptUnitFlexString15 Gappt Unit Flex Gappt Unit Flex null java.lang.String Yes Yes
String-15 String-15

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 348
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
ApptXrayRequired Requires Xray Requires Xray True if xray is java.lang.Boolean Yes Yes
required for this
appointment, false
otherwise.
DriverId Driver Card Id Card Id The card ID of the java.lang.String Yes Yes
truck driver for this
appointment.
GateFacilityId Facility Facility The identifier of the java.lang.String Yes Yes
facility the gate is
associated with.
GateId Gate ID Gate ID The gate id for which java.lang.String Yes Yes
the appointment was
made.
LineOperatorId Id Id The identifier of the java.lang.String Yes Yes
line operator defined
in the appointment.
TimeCreated Created Created The time the java.util.Date Yes Yes
appointment was
created.
TimeEndApp Appointment End End Time The end time by java.util.Date Yes Yes
Time which the truck has
to show up for the
appointment.
TimeStartAppt Appointment Start Start Time The start time the java.util.Date Yes Yes
Time truck can show up
for the appointment.
TimeUpdated Changed Changed The time the java.util.Date Yes Yes
appointment
information was last
updated.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 349
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Appointments

External Tag Long Label Short Label Description Type In Design In Sort
TransactionType Transaction Type Trans Type Definition of java.lang.String Yes Yes
transaction types
from the trucker point
of view (e.g 'Pick Up
Chassis', 'Pick Up
Import', 'Drop Off
Empty', 'Through
Container', etc.
TruckingCompanyId Id Id The id of the trucking java.lang.String Yes Yes
company responsible
for this appointment.
TruckingCompanyNa Name Name The full name of the java.lang.String Yes Yes
me trucking company
responsible for this
appointment.
UserCreator Creator Creator The user who java.lang.String Yes Yes
created the
appointment.
UserUpdater Changer Changer The user who last java.lang.String Yes Yes
updated the
appointment.
gapptCargoServiceO Service Order Order Nbr The Delivery Order java.lang.String Yes Yes
rder Number defined in the
appointment.
gapptCommodity Commodity ID Id The Commodity java.lang.String Yes Yes
defined in the
appointment.
gapptPackageType Id Id The Package Type java.lang.String Yes Yes
defined in the
appointment.
gapptQty Cargo Appointment Cargo Appointment The BL Cargo java.lang.Double Yes Yes
Qty Qty Quantity defined in
the appointment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 350
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
gapptTotalVolumeC Total Volume Total Volume The Cargo Volume java.lang.Double Yes Yes
m3 defined in the
appointment.
gapptUnitId Unit Nbr Unit Nbr Identified Cargo Lot java.lang.String Yes Yes
defined in the
appointment.

2.2.35 Truck Transaction Stage

The Truck Transaction Stage reporting entity lists the stages that have been processed for gate transaction.

External Tag Long Label Short Label Description Type In Design In Sort
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
StageChanged Changed Changed The last date the java.util.Date Yes Yes
truck transaction
stage was updated
StageChanger Changer Changer The name of the java.lang.String Yes Yes
clerk who update the
truck transaction
stage
StageCreated Created Created The date and time java.util.Date Yes Yes
the truck transaction
stage was created
StageCreator Creator Creator The name of the java.lang.String Yes Yes
clerk who created
the truck transaction
stage

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 351
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
StageEndTime Stage End Time End The time processing java.util.Date Yes Yes
of this truck
transaction stage
was completed
StageHadTrouble Stage Trouble Trouble True if there was a java.lang.Boolean Yes Yes
problem while
processing the
transaction stage.
StageId Stage ID Stage The identifier of the java.lang.String Yes Yes
truck transaction
stage
StageProblemResolv Tran. Stage Trouble Tran Trouble Time The time to resolve java.lang.Long Yes Yes
eTime Resolve Time the problem that
occurred in this
stage (in
milliseconds)
StageProblemResolv Tran. Stage Resolve Stage Resolve Time The time to resolve java.lang.String Yes No
eTimeString Time the problem that
occurred in this
stage in HH:mm:ss
format
StageQueueTime Tran. Stage Queue Tran Queue Time Time the truck waited java.lang.Long Yes Yes
Time to start this
transaction stage (in
milliseconds)
StageQueueTimeStri Tran. Stage Queue Stage Queue Time Time the truck waited java.lang.String Yes No
ng Time to start this
transaction stage in
HH:mm:ss format
StageSequence Stage Sequence Seq The sequence of the java.lang.Long Yes Yes
truck transaction
stage
StageStartTime Stage Start Time Start The time processing java.util.Date Yes Yes
of this truck
transaction stage
was started

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 352
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
StageStatus Stage Status Status The status of the java.lang.String Yes Yes
truck transaction
stage
TranAppointmentNbr Appointment Number Appt Nbr The appointment java.lang.String Yes Yes
number of the
transaction
TranBlNbr Bill of Lading BL The container's bill of java.lang.String Yes Yes
lading number
TranCancelReasonC Code Code The code for the java.lang.String Yes Yes
ode reason the
transaction was
canceled
TranCancelReasonD Description Description The description of java.lang.String Yes Yes
esc the transaction's
cancel code
TranChanged Transaction Changed Date The date the gate java.util.Date Yes Yes
Changed Date transaction was last
changed
TranChanger Record Changer Changer The user who last java.lang.String Yes Yes
changed the
transaction
TranChsAccNbr Chassis Accessory Chs Acc Number A unique ID for the java.lang.String Yes Yes
Number chassis accessory
TranChsAccTareWei Chassis Accessory Chs Acc Tare The weight of the java.lang.Double Yes Yes
ght Tare bare chassis
accessory, in
kilograms
TranChsAccTypeId Chassis Accessory Chs Acc Type The accessory type java.lang.String Yes Yes
Type of the chassis
TranChsIsDamaged Chassis Damaged Chs Damaged If TRUE, indicates java.lang.Boolean Yes Yes
that the chassis is
damaged

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 353
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranChsIsOwners Chassis IsOwners Chs IsOwners If TRUE, indicates java.lang.Boolean Yes Yes
that the trucking
company is the
owner of the chassis
TranChsLicenseNbr Chassis License Chs License The license number java.lang.String Yes Yes
of the chassis
TranChsNbr Chassis Number Chs Number The unique ID for the java.lang.String Yes Yes
chassis
TranChsNbrAssigne Chassis Number Chs Nbr Requested The chassis number java.lang.String Yes Yes
d Requested requested by the
driver/user or
assigned at the
ingate
TranChsOwnerId Chassis Owner ID Chs Owner ID The unique ID for the java.lang.String Yes Yes
chassis owner
TranChsSafeWeight Chassis Safe Weight Chs Safe Weight The maximum java.lang.Double Yes Yes
weight that the
chassis can safely
carry, in kilograms
TranChsTareWeight Chassis Tare Chs Tare The weight of the java.lang.Double Yes Yes
bare chassis, in
kilograms
TranCo2Required CO2 required, % CO2 Req.% The amount of java.lang.Double Yes Yes
carbon dioxide
required, in
kilograms
TranCommodityCode Commodity Commodity The container's java.lang.String Yes Yes
commodity code
TranConsignee Consignee Consignee The party that will java.lang.String Yes Yes
receive the cargo
TranConsigneeName Consignee Name Consignee Name The party Name that java.lang.String Yes No
will receive the cargo
TranCreated Transaction Start Start Date The date the gate java.util.Date Yes Yes
Date transaction started

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 354
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranCreator Record Create User Creator The user who java.lang.String Yes Yes
created the
transaction
TranCscDate CSC Expiration Ctr CSC Expiry The container's java.lang.String Yes Yes
expiration date,
according to the
International
Convention for Safe
Containers
TranCtrAccNbr Container Accessory Ctr Acc Number The number of the java.lang.String Yes Yes
Nbr container accessory
TranCtrAccTareWeig Container Accessory Ctr Acc Tare The weight of the java.lang.Double Yes Yes
ht Tare container accessory,
in kilograms
TranCtrAccTypeId Container Accessory Ctr Acc Type The type of container java.lang.String Yes Yes
Type accessory
TranCtrBuildDate Container Build Date Ctr Built The container's build java.util.Date Yes Yes
date (MMYY)
TranCtrDoorDirection Door Direction Door Direction The direction of the java.lang.String Yes Yes
doors on a container,
which can be any of
the following:
UNKNOWN, ANY,
FWD, AFT, NORTH,
SOUTH, EAST, or
WEST

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 355
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranCtrFreightKind Freight Kind Freight Kind The freight kind of java.lang.String Yes Yes
the container, which
indicates whether a
shipment is all from
one source (full),
from several different
sources (less than
full container),
empty, or break bulk
cargo (not
containerized)
TranCtrFreightKindS Freight Kind Freight Kind The short code for java.lang.String Yes No
hort the freight kind of the
container, which
indicates whether a
shipment is all from
one source (F), from
several different
sources (L), empty
(E), or break bulk
cargo (B)
TranCtrGrossWeight Gross Wt. Gross Wt. The weight of the java.lang.Double Yes Yes
container including
its cargo, in
kilograms
TranCtrIsDamaged Damaged Damaged If TRUE, indicates java.lang.Boolean Yes Yes
that the container is
damaged
TranCtrNbr Container Nbr Ctr Number A unique ID for the java.lang.String Yes Yes
container
TranCtrNbrAssigned Container Nbr Ctr Nbr Requested The number of the java.lang.String Yes Yes
Requested container requested
by the driver or
assigned at the
ingate

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 356
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranCtrNbrProvided Container Nbr Container Nbr The number of the java.lang.String Yes Yes
provided provided container provided to
the driver
TranCtrOwnerId Container Owner ID Owner A unique ID for the java.lang.String Yes Yes
line operator
(shipping line) that
owns the container
TranCtrSafeWeight Container Safe Safe Weight The maximum java.lang.Double Yes Yes
Weight allowed weight of the
container including
cargo, in kilograms
TranCtrTareWeight Container Tare Tare Weight The weight of the java.lang.Double Yes Yes
container without
cargo, in kilograms
TranCtrTruckPosition Pos on Truck Pos on Truck The container java.lang.Integer Yes Yes
position (sequence)
on the truck, which
can be ONE, TWO,
or THREE
TranCtrTypeId Container Type ISO Type The ISO java.lang.String Yes Yes
(International
Standards
Organization) type
for the container
TranDestination Destination Destination The final destination java.lang.String Yes Yes
of the container,
which is the place
where it will be
stripped
TranEndTime End Time End Time Transaction end time java.util.Date Yes No
TranEqoNbr Booking Number Booking Number The unique ID for the java.lang.String Yes Yes
export container
booking

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 357
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranEquipIsoGroup ISO Group (order) ISO Group (order) The ISO java.lang.String Yes Yes
(International
Standards
Organization) group
for the booking
equipment, which
can be any of the
following: GP, VH,
BU, BK, SN, RE, RT,
RS, HR, HI, UT, PL,
PF, PC, PS, PW, TN,
TD, TG, AS, NA, CH,
HH, GS, GU, CU.
TranEquipNominalH Height (order) Height (order) The nominal height java.lang.String Yes Yes
eight of the booking
equipment, in
centimeters, which
can be any of the
following: NOM21,
NOM40, NOM43,
NOM49, NOM76,
NOM80, NOM86,
NOM90, NOM91,
NOM96, NOM10,
NOM102, NOM114,
NOM116, NOM130
TranEquipNominalLe Length (order) Length (order) The nominal length java.lang.String Yes Yes
ngth of the booking
equipment, in
centimeters, which
can be any of the
following: NOM20,
NOM22, NOM24,
NOM30, NOM32,
NOM40, NOM42,
NOM45, NOM48,
NOM51, NOM53,
NOM546, NOM60.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 358
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranExportReleaseN Export Release Nbr Export Release Nbr A number needed to java.lang.String Yes Yes
br release an export
container to be
loaded to a vessel
TranFlexDate01 Tran Flex Date-01 Tran Flex Date-01 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #1
TranFlexDate02 Tran Flex Date-02 Tran Flex Date-02 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #2
TranFlexDate03 Tran Flex Date-03 Tran Flex Date-03 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #3
TranFlexDate04 Tran Flex Date-04 Tran Flex Date-04 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #4
TranFlexString01 Tran Flex String-01 Tran Flex String-01 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #1
TranFlexString02 Tran Flex String-02 Tran Flex String-02 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #2
TranFlexString03 Tran Flex String-03 Tran Flex String-03 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #3
TranFlexString04 Tran Flex String-04 Tran Flex String-04 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #4
TranFlexString05 Tran Flex String-05 Tran Flex String-05 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #5
TranFlexString06 Tran Flex String-06 Tran Flex String-06 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #6

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 359
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranFlexString07 Tran Flex String-07 Tran Flex String-07 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #7
TranFlexString08 Tran Flex String-08 Tran Flex String-08 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #8
TranHadTrouble Had Trouble Had Trouble True if there was a java.lang.Boolean Yes Yes
problem while
processing the
transaction.
TranHasDocuments Has Documents Has Documents If TRUE, indicates java.lang.Boolean Yes Yes
that the driver has
documentation to be
processed
TranHasTrouble Has Trouble Has Trouble If TRUE, indicates java.lang.Boolean Yes No
that a problem
occurred while
processing the truck
transaction
TranHumidityRequire Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
d required, in
Centigrade
TranImportReleaseN Import Release Nbr Import Release The container's java.lang.String Yes Yes
br Number group ID or B/L
number, which is
needed to release an
import container to
be discharged from a
vessel
TranIsConfirmed Is Confirmed Is Confirmed If TRUE, indicates java.lang.Boolean Yes Yes
that the driver has
confirmed the
transaction
TranIsHazard Hazardous Hazardous If TRUE, indicates java.lang.Boolean Yes Yes
that the container
has hazardous cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 360
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranIsHazardChecke Hazard Checked Hazard Checked If TRUE, indicates java.lang.Boolean Yes Yes
d that the container is
checked for
hazardous cargo
TranIsOog OOG OOG A flag that indicates java.lang.Boolean Yes Yes
(if set to TRUE) that
the container is out
of gauge
TranIsPlacarded Is Placarded Is Placarded If TRUE, indicates java.lang.Boolean Yes Yes
that the container
has placards
TranIsPlacardedOk Is Placarded OK Is Placarded OK If TRUE, indicates java.lang.Boolean Yes Yes
that it is OK if the
container has
placards
TranIsXrayRequired Xray Required Xray If TRUE, indicates java.lang.Boolean Yes Yes
that Xray is required
for the container or
cargo
TranLineId Id Id The unique identifier java.lang.String Yes Yes
for the line operator
used in the
transaction
TranLinename Name Name The name of the line java.lang.String Yes Yes
operator used in the
transaction
TranMaterial Material Material The unique ID for the java.lang.String Yes Yes
container material,
which can be any of
the following:
STEEL, ALUMINUM,
UNKNOWN

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 361
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranMilitaryTcn Military Transaction Military Tcn The Military java.lang.String Yes Yes
Transaction used
when exporting
military cargo in the
US
TranMilitaryVNbr Military V Number V Nbr The number used java.lang.String Yes Yes
when exporting
military cargo in the
US
TranNextStageId Next Stage ID Next Stage ID The identifier for the java.lang.String Yes Yes
next gate stage
where the truck will
be processed
TranNotes Notes Notes A short note about java.lang.String Yes Yes
the container
transaction
TranNumber Transaction Number Number The transaction java.lang.Long Yes Yes
number, which is an
automatically
generated and
unique ID
TranO2Required O2 required, % O2 Req.% The amount of java.lang.Double Yes Yes
oxygen required, in
kilograms
TranOogBack OOG Back OOG Back The side that the java.lang.Long Yes Yes
equipment is out of
gauge (back)
TranOogFront OOG Front OOG Front The side that the java.lang.Long Yes Yes
equipment is out of
gauge (front)
TranOogLeft OOG Left OOG Left The side that the java.lang.Long Yes Yes
equipment is out of
gauge (left)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 362
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranOogRight OOG Right OOG Right The side that the java.lang.Long Yes Yes
equipment is out of
gauge (right)
TranOogTop OOG Top OOG Top The side that the java.lang.Long Yes Yes
equipment is out of
gauge (top)
TranOrigin Origin Origin The origin of the java.lang.String Yes Yes
container, which is
the place where it
was stuffed
TranPinNbr Pin Number Pin Nbr The verification code java.lang.String Yes Yes
required to pick up a
container
TranReeferFuelLevel Reefer Fuel Level, % Reefer Fuel% The last fuel level full java.lang.Double Yes Yes
percent recorded for
the refrigerated unit
TranReeferHours Reefer Hours Reefer Hours The number of hours java.lang.Double Yes Yes
the reefer has been
in operation at the
last reefer recording
TranScAgent Shipper/Consignee S/C Agent The unique ID of the java.lang.String Yes Yes
Agent agent used by the
shipper or the
consignee
TranSealNbr1 Seal #1 Seal #1 The first seal number java.lang.String Yes Yes
of the container
TranSealNbr2 Seal #2 Seal #2 The second seal java.lang.String Yes Yes
number of the
container
TranSealNbr3 Seal #3 Seal #3 The third seal java.lang.String Yes Yes
number of the
container
TranSealNbr4 Seal #4 Seal #4 The fourth seal java.lang.String Yes Yes
number of the
container

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 363
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranSeqNbr Sequence Nbr Seq# The transaction's java.lang.Integer Yes Yes
sequence number
TranShandId Special Stow Stow The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShandId2 Special Stow 2 Stow 2 The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShandId3 Special Stow 3 Stow 3 The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShipper Shipper Shipper The party that java.lang.String Yes Yes
shipped the cargo
TranStatus Transaction Status Status The status of the java.lang.String Yes Yes
transaction, which
can be any of the
following: OK,
TROUBLE,
COMPLETE,
CANCEL, CLOSED,
or INCOMPLETE
TranTempObserved Temperature Temp Observed The currently java.lang.Double Yes Yes
Observed observed
temperature for a
refrigerated
container, in
Centigrade
TranTempRequired Temperature Temp Required The temperature java.lang.Double Yes Yes
Required required for a
refrigerated
container, in
centigrade

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 364
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranTempSetting Temperature Setting Temp Setting The temperature java.lang.Double Yes Yes
setting for a
refrigerated
container, in
Centigrade
TranTroubleMsgs Trouble transaction Trouble tran msgs The trouble java.lang.String Yes No
messages transaction
messages,
separated by
semicolon (;)
TranType Transaction Type Transaction Type The type of java.lang.String Yes Yes
transaction, which
can be any of the
following: Deliver
Chassis, Dray Off,
Deliver Import,
Deliver Empty,
Receive Chassis,
Receive Export, Dray
In, Receive Empty,
Through Container,
Receive Break-Bulk,
Unknown
TranTypeShort Transaction Type Transaction Type The short identifier java.lang.String Yes No
for the transaction
type, which can be
any of the following:
DC, DE, DI, DM, RC,
RE, RI, RM, TC, RB,
or UK
TranUfvFlexDate01 Ufv Flex Date-01 Ufv Flex Date-01 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#1
TranUfvFlexDate02 Ufv Flex Date-02 Ufv Flex Date-02 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#2

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 365
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranUfvFlexDate03 Ufv Flex Date-03 Ufv Flex Date-03 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#3
TranUfvFlexDate04 Ufv Flex Date-04 Ufv Flex Date-04 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#4
TranUfvFlexString01 Ufv Flex String-01 Ufv Flex String-01 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #1
TranUfvFlexString02 Ufv Flex String-02 Ufv Flex String-02 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #2
TranUfvFlexString03 Ufv Flex String-03 Ufv Flex String-03 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #3
TranUfvFlexString04 Ufv Flex String-04 Ufv Flex String-04 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #4
TranUfvFlexString05 Ufv Flex String-05 Ufv Flex String-05 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #5
TranUfvFlexString06 Ufv Flex String-06 Ufv Flex String-06 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #6
TranUfvFlexString07 Ufv Flex String-07 Ufv Flex String-07 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #7
TranUfvFlexString08 Ufv Flex String-08 Ufv Flex String-08 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #8
TranUfvFlexString09 Ufv Flex String-09 Ufv Flex String-09 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #9
TranUfvFlexString10 Ufv Flex String-10 Ufv Flex String-10 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #10
TranUnitCategory Category Category The category of the java.lang.String Yes Yes
unit, which can be
any of the following:
Import, Export,
Transship, Domestic,
Storage, or Through

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 366
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranUnitCategorySh Category Category The short identifier java.lang.String Yes No
ort for the unit's
category, which can
be any of the
following: I, E, T, D,
S, R
TranUnitFlexString01 Unit Flex String-01 Unit Flex String-01 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #1
TranUnitFlexString02 Unit Flex String-02 Unit Flex String-02 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #2
TranUnitFlexString03 Unit Flex String-03 Unit Flex String-03 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #3
TranUnitFlexString04 Unit Flex String-04 Unit Flex String-04 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #4
TranUnitFlexString05 Unit Flex String-05 Unit Flex String-05 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #5
TranUnitFlexString06 Unit Flex String-06 Unit Flex String-06 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #6
TranUnitFlexString07 Unit Flex String-07 Unit Flex String-07 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #7
TranUnitFlexString08 Unit Flex String-08 Unit Flex String-08 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #8
TranUnitFlexString09 Unit Flex String-09 Unit Flex String-09 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #9
TranUnitFlexString10 Unit Flex String-10 Unit Flex String-10 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #10
TranUnitFlexString11 Unit Flex String-11 Unit Flex String-11 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #11
TranUnitFlexString12 Unit Flex String-12 Unit Flex String-12 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #12
TranUnitFlexString13 Unit Flex String-13 Unit Flex String-13 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #13

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 367
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TranUnitFlexString14 Unit Flex String-14 Unit Flex String-14 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #14
TranUnitFlexString15 Unit Flex String-15 Unit Flex String-15 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #15
TranUnitId Unit Id Unit Id The unique ID for the java.lang.String Yes Yes
breakbulk unit
TranVentRequired Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required for the unit
TranVentSetting Ventilation Setting Vent Set The ventilation java.lang.Double Yes Yes
setting for the unit
TranVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the values
defined in the fields
'Ventilation Setting'
and 'Ventilation
Required', which can
be any of the
following:
Percentage, Cubic
Feet/Min, Cubic
Meters/Hour
TruckAeiTagId Tag ID Tag ID The transponder java.lang.String Yes Yes
number, if the truck
has a transponder on
board
TruckBatNbr BAT Number BAT Number The permanently java.lang.String Yes Yes
assigned and facility-
specific ID number
for the truck visit
TruckCallUpTime Callup Time Called Up The date/time the java.util.Date Yes Yes
truck was called up
TruckChanged Changed Changed The date/time the java.util.Date Yes Yes
truck visit was
changed

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 368
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckChanger Changer Changer The user who last java.lang.String Yes Yes
changed the truck
visit
TruckChassisDeliveri Deliver Chassis Deliver Chassis The number of java.lang.Long Yes Yes
esCount chassis delivered for
the truck visit
TruckChassisReceiv Receive Chassis Receive Chassis The number of java.lang.Long Yes Yes
alsCount chassis received for
the truck visit
TruckCreated Created Created The date/time the java.util.Date Yes Yes
truck visit was
created
TruckCreator Creator Creator The user who java.lang.String Yes Yes
created the truck visit
TruckDeliveryUnitLin BIC Code BIC Code The code that the java.lang.String Yes Yes
eBic line operator uses to
deliver the unit,
assigned by the
Bureau International
des Containers et du
Transport Intermodal
TruckDeliveryUnitLin Id Id The identifier of the java.lang.String Yes Yes
eId line operator of the
unit that was
delivered (might be
null)
TruckDeliveryUnitLin SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
eScac Alpha Code of a line
operator used to
deliver the unit
TruckDriverBatNbr Callup ID Callup ID The truck driver's java.lang.String Yes Yes
permanently
assigned BAT
number (short ID)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 369
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckDriverCardId Driver Card Id Card Id The truck driver's java.lang.String Yes Yes
card ID
TruckDriverIsHazard Is Driver Hazard Is Hazard Licensed If TRUE, indicates java.lang.Boolean Yes Yes
Licensed Licensed that the truck driver
has a license for
hazards
TruckDriverLicenseN Driver License License The license number java.lang.String Yes Yes
br of the truck driver
TruckDriverName Driver Name Name The truck driver's full java.lang.String Yes Yes
name
TruckEmptyDeliverie Deliver Empty Deliver Empties The number of java.lang.Long Yes Yes
sCount empty deliveries for
the truck visit
TruckEmptyReceival Receive Empty Receive Empties The number of java.lang.Long Yes Yes
sCount empty receivals for
the truck visit
TruckEnteredYard Entered Yard Entered Yard The date and time java.util.Date Yes Yes
the truck entered the
yard
TruckExchangeArea Exchange Area Id Exchange Area Id The truck exchange java.lang.String Yes Yes
id
TruckExitedYard Exited Yard Exited Yard The date and time java.util.Date Yes Yes
the truck left the yard
TruckFullDeliveriesC Deliver Fulls Deliver Fulls The number of full java.lang.Long Yes Yes
ount deliveries for the
truck visit
TruckFullReceivalsC Receive Fulls Receive Fulls The number of full java.lang.Long Yes Yes
ount receivals for the
truck visit
TruckGateFacilityId Facility Facility The identifier of the java.lang.String Yes Yes
facility that the gate
is associated with for
the truck visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 370
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckGateId Gate ID Gate ID The identifier of the java.lang.String Yes Yes
gate for the truck
visit
TruckHadTrouble Trouble Trouble Flag that (if set to java.lang.Boolean Yes Yes
TRUE) indicates a
problem that
occurred while
processing the
complete truck visit
(in any of the stages)
TruckHasDoubleMov Double Move? Double Move? If TRUE, indicates a java.lang.Boolean Yes No
e truck visit with at
least one receival
move and one
delivery move
TruckId Truck Id Truck Id The Truck ID java.lang.String Yes Yes
assigned by the
trucking company
TruckLicenseNbr Truck License Truck License The license number java.lang.String Yes Yes
for the truck visit
TruckOutBatNbr Out BAT Number Out BAT Number The BAT/Placard java.lang.String Yes Yes
number, assigned by
the gate clerk at
OutGate
TruckPriority Truck Visit Priority Priority The visit priority of java.lang.String Yes Yes
the truck, which
determines the order
in which the truck
visit is processed:
NORMAL,
CRITICAL, or HIGH
TruckProblemResolv Trouble Resolve Trouble Resolve The total time to java.lang.Long Yes Yes
eTime Time Time resolve the problem
that occurred in any
stage of the visit (in
milliseconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 371
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckProblemResolv Total Resolve Time Total Resolve Time The total time to java.lang.String Yes No
eTimeString resolve the problem
that occurred in any
stage of the visit in
HH:mm:ss format
TruckProcessingEnd End Time End The time the truck java.util.Date Yes Yes
Date visit ended
TruckProcessingStar Start Time Start The time the truck java.util.Date Yes Yes
tDate visit started
TruckReceivalUnitLin BIC Code BIC Code The code that the java.lang.String Yes Yes
eBic line operator uses to
receive the unit,
assigned by the
Bureau International
des Containers et du
Transport Intermodal
TruckReceivalUnitLin Id Id The identifier of the java.lang.String Yes Yes
eId line operator of the
unit that was
received (might be
null)
TruckReceivalUnitLin SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
eScac Alpha Code of a line
operator used to
receive the unit
TruckScaleWeight Scale Weight Scale Weight The total recorded java.lang.Double Yes Yes
weight of the truck
with its chassis and
cargo, in kilograms
TruckTotalDeliveries Total Delivery Count Total Delivery Count The total number of java.lang.Long Yes No
Count delivery transactions
involved in the truck
visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 372
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckTotalReceivals Total Receival Count Total Receival Count The total number of java.lang.Long Yes No
Count receival transactions
involved in the truck
visit
TruckTotalTransactio Total Transactions Transactions The number of java.lang.Long Yes Yes
nCount transactions involved
in the truck visit
TruckTurnTime Turn Time MS Turn Time MS The time elapsed to java.lang.Long Yes Yes
complete the truck
visit (in milliseconds)
TruckTurnTimeNet Turn Time Net Turn Time Net The truck turn time java.lang.Long Yes Yes
minus the truck
trouble time (in
milliseconds)
TruckTurnTimeNetSt Turn Time Net Turn Time Net The truck turn time java.lang.String Yes No
ring minus the truck
trouble time in
HH:mm:ss format
TruckTurnTimeString Turn Time Turn Time The time elapsed to java.lang.String Yes No
complete the truck
visit in HH:mm:ss
format
TruckVisitCanceled Canceled Canceled If TRUE, indicates java.lang.Boolean Yes Yes
the truck visit has
been canceled (in
any of the stages)
TruckVisitStatus Truck Visit Status Status The status of the java.lang.String Yes Yes
truck visit, which can
be any of the
following: OK,
TROUBLE,
COMPLETE,
CANCEL, or
CLOSED
TruckWaitStatus Truck Visit Wait Wait Status The truck's wait java.lang.String Yes Yes
Status status

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 373
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
TruckingCompanyBI BIC Code BIC Code The official container java.lang.String Yes Yes
C owner code for the
trucking company,
assigned by the
Bureau International
des Containers et du
Transport Intermodal
TruckingCompanyId Id Id The identifier of the java.lang.String Yes Yes
trucking company
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
TruckingCompanySC SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
AC Alpha Code used to
identify the trucking
company
UnitEquipNominalHe Nominal Height Height The nominal height java.lang.String Yes Yes
ight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6
UnitEquipNominalLe Nominal Length Length The nominal length java.lang.String Yes Yes
ngth of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'
UnitInboundCarrierId Visit Ref Visit The visit ID of the java.lang.String Yes Yes
inbound carrier,
which is the visit ID
for a vessel, the train
ID for a train, or the
license number for a
truck
UnitInboundCarrierN Carrier Name Carrier Name The name of the java.lang.String Yes No
ame inbound carrier, such
as vessel name,
truck license number,
or train ID

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 374
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Transaction Stage

External Tag Long Label Short Label Description Type In Design In Sort
UnitNotes Unit Notes Unit Notes Any notes attached java.lang.String Yes Yes
to the unit
UnitOutboundCarrier Visit Ref Visit The visit ID of the java.lang.String Yes Yes
Id outbound carrier,
which is the visit ID
for a vessel, the train
ID for a train, or the
license number for a
truck
UnitOutboundCarrier Carrier Name Carrier Name The name of the java.lang.String Yes No
Name outbound carrier,
such as vessel
name, truck license
number, or train ID
UnitTransitState Transit State T-State The transit state of java.lang.String Yes Yes
the unit with respect
to its trip through the
facility, which can be
any of the following:
Inbound, EC/In,
Yard, EC/Out,
Loaded, Departed, or
Retired
UnitVisitState Visit State (Master) State (Master) The visit state of the java.lang.String Yes Yes
unit with respect to
the complex, which
can be any of the
following: Active,
Advised, Departed,
or Retired
UnitsAttached Attached Attached The equipment IDs java.lang.String Yes No
Equipments Equipments of attached units,
separated by
semicolon (;)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 375
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Truck Visit Details

2.2.36 Truck Visit Details

The Truck Visit Details reporting entities provide details about a specific truck visit.

External Tag Long Label Short Label Description Type In Design In Sort
BatNbr BAT Number BAT Number The BAT/Placard java.lang.String Yes Yes
number, permanently
assigned, and
facility-specific ID for
the truck.
CallUpTime Callup Time Called Up The date/time the java.util.Date Yes Yes
truck was called up.
DriverCardId Driver Card Id Card Id The truck driver's java.lang.String Yes Yes
card Id.
DriverId Driver Id Driver Id The card ID of the java.lang.String Yes Yes
truck driver for this
appointment.
DriverIsHazardLicen Is Driver Hazard Is Hazard Licensed Is Hazard Licensed java.lang.Boolean Yes Yes
sed Licensed Truck Driver.
DriverLicenseNbr Driver License License The license number java.lang.String Yes Yes
of the truck driver.
DriverName Driver Name Name The truck driver's full java.lang.String Yes Yes
name.
EnteredYard Entered Yard Entered Yard The date the truck java.util.Date Yes Yes
entered the yard.
EntryLaneClass Class Class The gate lane java.lang.String Yes No
class:IN,OUT,INOUT,
TROUBLE
EntryLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used to enter
the terminal.
ExchangeLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used to
exchange the Yard.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 376
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Details

External Tag Long Label Short Label Description Type In Design In Sort
ExitLaneClass Class Class The gate lane class java.lang.String Yes No
used to exit the
Yard:IN,OUT,INOUT,
TROUBLE
ExitLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used to exit the
Yard.
ExitedYard Exited Yard Exited Yard The date the truck java.util.Date Yes Yes
left the yard.
GateDescription Description Description A short description of java.lang.String Yes No
the gate.
GateId Gate ID Gate ID The identifier of the java.lang.String Yes Yes
gate of this truck visit
statistic.
GateVisitNbr Gate Visit Nbr Gate Visit Nbr The unique id for the java.lang.Long Yes Yes
truck visit from the
Gate System.
NextStageId Next Stage Next Stage The next gate stage java.lang.String Yes Yes
where the truck will
be processed.
OutBatNbr Out BAT Number Out BAT Number The BAT/Placard java.lang.String Yes Yes
number, assigned by
Gate clerk at
OutGate.
Priority Truck Visit Priority Priority The Truck Visit java.lang.String Yes Yes
Priority decides the
order in which the
truck visit is
processed:NORMAL,
CRITICAL,HIGH.
ScaleWeight Scale Weight Scale Weight The total recorded java.lang.Double Yes Yes
weight of the truck
with its chassis and
cargo in kilograms.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 377
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Details

External Tag Long Label Short Label Description Type In Design In Sort
Status Truck Visit Status Truck Visit Status The status of this java.lang.String Yes Yes
truck visit: OK,
TROUBLE,
COMPLETE,
CANCEL,
CLOSED,INCOMPL
ETE.
TroubleLaneClass Class Class The gate lane class java.lang.String Yes No
used for Trouble
transaction:IN,OUT,I
NOUT,TROUBLE
TroubleLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used for
Trouble transaction.
TruckAeiTagId Tag ID Tag ID The transponder java.lang.String Yes Yes
number, if the truck
has a transponder on
board.
TruckId Truck Id ID The truck Id. java.lang.String Yes Yes
TruckLicenseExpirati License Expiration License Expiration The date the truck java.util.Date Yes Yes
on Date Date license will be no
longer valid.
TruckLicenseNbr Truck License License The truck license java.lang.String Yes Yes
number for the truck
visit.
TruckLicenseState License State License State The state that issued java.lang.String Yes Yes
the truck license.
TruckNotes Notes Notes A short note about java.lang.String Yes Yes
the Truck.
TruckVisitChanged Changed Changed The date/time the java.util.Date Yes Yes
truck visit was
changed
TruckVisitChanger Changer Changer The user who last java.lang.String Yes Yes
changed the truck
visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 378
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Details

External Tag Long Label Short Label Description Type In Design In Sort
TruckVisitCreated Created Created The date/time the java.util.Date Yes Yes
truck visit was
created
TruckVisitCreator Creator Creator The user who java.lang.String Yes Yes
created the truck visit
TruckVisitDetailsDriv Driver Card Driver Card The truck driver's java.lang.String Yes Yes
erCardId card ID.
TruckVisitDetailsDriv Driver License Driver License The truck driver's java.lang.String Yes Yes
erLicenseNbr license number.
TruckVisitDetailsDriv Driver Name Driver Name The truck driver's java.lang.String Yes Yes
erName name.
TruckVisitDetailsTruc Truck Id Truck Id The Truck ID java.lang.String Yes Yes
kId assigned by trucking
company.
TruckVisitDetailsTruc Truck License Truck License The truck license java.lang.String Yes Yes
kLicenseNbr number for the truck
visit.
TruckVisitFlexDate01 Truck Visit Flex Truck Visit Flex Customer Extensible java.util.Date Yes Yes
Date-01 Date-01 Truck Visit Flex Date
#1
TruckVisitFlexDate02 Truck Visit Flex Truck Visit Flex Customer Extensible java.util.Date Yes Yes
Date-02 Date-02 Truck Visit Flex Date
#2
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
1 String-01 String-01 Truck Visit Flex
String #1
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
2 String-02 String-02 Truck Visit Flex
String #2
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
3 String-03 String-03 Truck Visit Flex
String #3

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 379
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
4 String-04 String-04 Truck Visit Flex
String #4
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
5 String-05 String-05 Truck Visit Flex
String #5
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
6 String-06 String-06 Truck Visit Flex
String #6
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
7 String-07 String-07 Truck Visit Flex
String #7
TruckVisitFlexString0 Truck Visit Flex Truck Visit Flex Customer Extensible java.lang.String Yes Yes
8 String-08 String-08 Truck Visit Flex
String #8
TruckingCompanyId Id Id The identifier of the java.lang.String Yes Yes
trucking company.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company.
WaitStatus Truck Visit Wait Wait Status Truck Wait Status. java.lang.String Yes Yes
Status

2.2.37 Truck Visit Stage and Transaction

The Truck Visit Stage and Transaction reporting entity combines the information of a truck visit stage with the truck visit transaction and enables you to create
reports that help you track of clerk statistics at a stage level and evaluate productivity.

This reporting entity represents the attributes of a unit at the time the gate transaction took place.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 380
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
MoveTimeCarryChe Time Carry CHE Time Carry CHE The dispatch time of java.util.Date Yes No
Dispatch Dispatch Dispatch the carry CHE for the
receival or delivery
move for the
transaction
MoveTimeCarryChe Time Carry Che Time Carry Che The ready time of the java.util.Date Yes No
Ready Ready Ready carry CHE for the
receival or delivery
move for the
transaction
MoveTimeCarryCom Time Carry Complete Time Carry Complete The complete time of java.util.Date Yes No
plete the carry phase for
the receival or
delivery move for the
transaction
MoveTimeComplete Time Completed Time Completed The move complete java.util.Date Yes No
time of the receival
or delivery phase for
the transaction
MoveTimeDispatch Time of Dispatch Time of Dispatch The dispatch time of java.util.Date Yes No
the receival or
delivery phase for
the transaction
OveriddenLastFreeD Last Free Day LFD Override Fixed (not java.util.Date Yes Yes
ay Override calculated) date of
last free day for
Storage.
OveriddenPowerLast Power Last Free Day Power LFD Override Fixed (not java.util.Date Yes Yes
FreeDay Override calculated) date of
power last free day.
StageChanged Changed Changed The last updated java.util.Date Yes Yes
date the truck visited
the stage

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 381
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
StageChanger Changer Changer The name of the java.lang.String Yes Yes
clerk who update the
truck that visited at
this stage
StageCreated Created Created The date and time java.util.Date Yes Yes
the truck visited the
stage
StageCreator Creator Creator The name of the java.lang.String Yes Yes
clerk who created
the truck visited at
this stage
StageEndTime Stage End Time End The time processing java.util.Date Yes Yes
of this visit stage was
completed
StageHadTrouble Stage Trouble Trouble If TRUE, indicates a java.lang.Boolean Yes Yes
problem occurred
while processing the
truck for this stage
StageId Stage ID Stage The identifier of the java.lang.String Yes Yes
truck's visit stage
StageProblemResolv Stage Trouble Trouble Time The time taken to java.lang.Long Yes Yes
eTime Resolve Time resolve the problem
that occurred during
this visit stage (in
milliseconds)
StageQueueTime Stage Queue Time Queue Time The time the truck java.lang.Long Yes Yes
waited to start this
visit stage (in
milliseconds)
StageSequence Stage Sequence Seq The sequence of the java.lang.Long Yes Yes
truck's visit stage
StageStartTime Stage Start Time Start The time processing java.util.Date Yes Yes
of this visit stage was
started

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 382
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranAppointmentNbr Appointment Number Appt Nbr The appointment java.lang.String Yes Yes
number of the
transaction
TranBlNbr Bill of Lading BL The bill of lading java.lang.String Yes Yes
number of the
container
TranCancelReasonC Code Code The cancel code of java.lang.String Yes Yes
ode the transaction
TranCancelReasonD Description Description The description of java.lang.String Yes Yes
esc the transaction's
cancel code
TranChanged Transaction Changed Date The date the gate java.util.Date Yes Yes
Changed Date transaction was last
changed
TranChanger Record Changer Changer The user who last java.lang.String Yes Yes
changed the
transaction
TranChsAccNbr Chassis Accessory Chs Acc Number A unique ID for the java.lang.String Yes Yes
Number chassis accessory
TranChsAccTareWei Chassis Accessory Chs Acc Tare The weight of the java.lang.Double Yes Yes
ght Tare chassis accessory, in
kilograms
TranChsAccTypeId Chassis Accessory Chs Acc Type The accessory type java.lang.String Yes Yes
Type of the chassis
TranChsIsDamaged Chassis Damaged Chs Damaged If TRUE, indicates java.lang.Boolean Yes Yes
that the chassis is
damaged
TranChsIsOwners Chassis IsOwners Chs IsOwners If TRUE, indicates java.lang.Boolean Yes Yes
that the trucking
company is the
owner of the chassis
TranChsLicenseNbr Chassis License Chs License The license number java.lang.String Yes Yes
of the chassis

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 383
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranChsNbr Chassis Number Chs Number The unique ID for the java.lang.String Yes Yes
chassis
TranChsNbrAssigne Chassis Number Chs Nbr Requested The chassis number java.lang.String Yes Yes
d Requested requested by the
driver/user or
assigned at the
ingate
TranChsOwnerId Chassis Owner ID Chs Owner ID The unique ID for the java.lang.String Yes Yes
chassis owner
TranChsSafeWeight Chassis Safe Weight Chs Safe Weight The maximum java.lang.Double Yes Yes
weight that can be
safely carried by the
chassis, in kilograms
TranChsTareWeight Chassis Tare Chs Tare The weight of the java.lang.Double Yes Yes
bare chassis, in
kilograms
TranCo2Required CO2 required, % CO2 Req.% The amount of java.lang.Double Yes Yes
carbon dioxide
required, in
kilograms
TranCommodityCode Commodity Commodity The commodity code java.lang.String Yes Yes
of the container
TranConsignee Consignee Consignee The party that will java.lang.String Yes Yes
receive the cargo
TranConsigneeName Consignee Name Consignee Name The party Name that java.lang.String Yes No
will receive the cargo
TranCreated Transaction Start Start Date The date the gate java.util.Date Yes Yes
Date transaction started
TranCreator Record Create User Creator The user who java.lang.String Yes Yes
created the
transaction

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 384
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranCscDate CSC Expiration Ctr CSC Expiry The container's CSC java.lang.String Yes Yes
expiration date
(according to the
International
Convention for Safe
Containers)
TranCtrAccNbr Container Accessory Ctr Acc Number The number of the java.lang.String Yes Yes
Nbr container accessory
TranCtrAccTareWeig Container Accessory Ctr Acc Tare The weight of the java.lang.Double Yes Yes
ht Tare container accessory,
in kilograms
TranCtrAccTypeId Container Accessory Ctr Acc Type The type of container java.lang.String Yes Yes
Type accessory
TranCtrBuildDate Container Build Date Ctr Built The container's build java.util.Date Yes Yes
date (MMYY)
TranCtrDoorDirection Door Direction Door Direction The direction of the java.lang.String Yes Yes
doors on a container,
which can be any of
the following:
UNKNOWN, ANY,
FWD, AFT, NORTH,
SOUTH, EAST, or
WEST
TranCtrFreightKind Freight Kind Freight Kind The freight kind of java.lang.String Yes Yes
the container, which
indicates whether a
shipment is all from
one source (full),
from several different
sources (less than
full container),
empty, or break bulk
cargo (not
containerized)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 385
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranCtrFreightKindS Freight Kind Freight Kind The freight kind of java.lang.String Yes No
hort the container, which
indicates whether a
shipment is all from
one source (F), from
several different
sources (L), E, or
break bulk cargo (B)
TranCtrGrossWeight Gross Wt. Gross Wt. The weight of the java.lang.Double Yes Yes
container including
its cargo, in
kilograms
TranCtrIsDamaged Damaged Damaged If TRUE, indicates java.lang.Boolean Yes Yes
that the container is
damaged
TranCtrNbr Container Nbr Ctr Number A unique ID for the java.lang.String Yes Yes
container
TranCtrNbrAssigned Container Nbr Ctr Nbr Requested The number of the java.lang.String Yes Yes
Requested container requested
by the driver or
assigned at the
ingate
TranCtrNbrProvided Container Nbr Container Nbr The number of the java.lang.String Yes Yes
provided provided container provided to
the driver
TranCtrOwnerId Container Owner ID Owner A unique ID for the java.lang.String Yes Yes
line operator
(shipping line) that
owns the container
TranCtrSafeWeight Container Safe Safe Weight The maximum java.lang.Double Yes Yes
Weight allowed weight of the
container including
cargo, in kilograms
TranCtrTareWeight Container Tare Tare Weight The weight of the java.lang.Double Yes Yes
container without
cargo, in kilograms

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 386
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranCtrTruckPosition Pos on Truck Pos on Truck The Container java.lang.Integer Yes Yes
Position (sequence)
on the truck, which
can be ONE, TWO,
or THREE
TranCtrTypeId Container Type ISO Type The ISO java.lang.String Yes Yes
(International
Standards
Organization) type
for the container
TranDestination Destination Destination The final destination java.lang.String Yes Yes
of the container,
which is the place
where it will be
stripped
TranEndTime End Time End Time Transaction end time java.util.Date Yes No
TranEqoNbr Booking Number Booking Number The unique ID for the java.lang.String Yes Yes
export container
booking
TranEquipIsoGroup ISO Group (order) ISO Group (order) The ISO java.lang.String Yes Yes
(International
Standards
Organization) group
for the booking
equipment, which
can be any of the
following: GP, VH,
BU, BK, SN, RE, RT,
RS, HR, HI, UT, PL,
PF, PC, PS, PW, TN,
TD, TG, AS, NA, CH,
HH, GS, GU, CU.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 387
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranEquipNominalH Height (order) Height (order) The height of the java.lang.String Yes Yes
eight booking equipment,
in centimeters, which
can be any of the
following: NOM21,
NOM40, NOM43,
NOM49, NOM76,
NOM80, NOM86,
NOM90, NOM91,
NOM96, NOM10,
NOM102, NOM114,
NOM116, NOM130
TranEquipNominalLe Length (order) Length (order) The length of the java.lang.String Yes Yes
ngth booking equipment,
in centimeters, which
can be any of the
following: NOM20,
NOM22, NOM24,
NOM30, NOM32,
NOM40, NOM42,
NOM45, NOM48,
NOM51, NOM53,
NOM546, NOM60.
TranExportReleaseN Export Release Nbr Export Release Nbr A number needed to java.lang.String Yes Yes
br release an export
container to be
loaded to a vessel
TranFlexDate01 Tran Flex Date-01 Tran Flex Date-01 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #1
TranFlexDate02 Tran Flex Date-02 Tran Flex Date-02 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #2
TranFlexDate03 Tran Flex Date-03 Tran Flex Date-03 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #3

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 388
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranFlexDate04 Tran Flex Date-04 Tran Flex Date-04 Customer Extensible java.util.Date Yes Yes
Transaction Flex
Date Field #4
TranFlexString01 Tran Flex String-01 Tran Flex String-01 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #1
TranFlexString02 Tran Flex String-02 Tran Flex String-02 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #2
TranFlexString03 Tran Flex String-03 Tran Flex String-03 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #3
TranFlexString04 Tran Flex String-04 Tran Flex String-04 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #4
TranFlexString05 Tran Flex String-05 Tran Flex String-05 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #5
TranFlexString06 Tran Flex String-06 Tran Flex String-06 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #6
TranFlexString07 Tran Flex String-07 Tran Flex String-07 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #7
TranFlexString08 Tran Flex String-08 Tran Flex String-08 Customer Extensible java.lang.String Yes Yes
Transaction Flex
Field #8
TranHasDocuments Has Documents Has Documents If TRUE, indicates java.lang.Boolean Yes Yes
that the driver has
documentation to be
processed

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 389
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranHasTrouble Has Trouble Has Trouble If TRUE, indicates java.lang.Boolean Yes No
that a problem
occurred while
processing the truck
transaction
TranHumidityRequire Humidity required, % Humd Req.% The humidity java.lang.Double Yes Yes
d required, in
Centigrade
TranImportReleaseN Import Release Nbr Import Release The container's java.lang.String Yes Yes
br Number group ID or B/L
number, which is
needed to release an
import container to
be discharged from a
vessel
TranIsConfirmed Is Confirmed Is Confirmed If TRUE, indicates java.lang.Boolean Yes Yes
that the driver has
confirmed the
transaction
TranIsHazard Hazardous Hazardous If TRUE, indicates java.lang.Boolean Yes Yes
that the container
has hazardous cargo
TranIsHazardChecke Hazard Checked Hazard Checked If TRUE, indicates java.lang.Boolean Yes Yes
d that the container is
checked for
hazardous cargo
TranIsOog OOG OOG A flag that indicates java.lang.Boolean Yes Yes
(if set to TRUE) that
the container is out
of gauge
TranIsPlacarded Is Placarded Is Placarded If TRUE, indicates java.lang.Boolean Yes Yes
that the container
has placards

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 390
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranIsPlacardedOk Is Placarded OK Is Placarded OK If TRUE, indicates java.lang.Boolean Yes Yes
that it is OK if the
container has
placards
TranIsXrayRequired Xray Required Xray If TRUE, indicates java.lang.Boolean Yes Yes
that Xray is required
for the container or
cargo
TranLineId Id Id The unique ID for the java.lang.String Yes Yes
line operator used in
the transaction.
TranLinename Name Name The name of the line java.lang.String Yes Yes
operator used in the
transaction
TranMaterial Material Material The unique ID for the java.lang.String Yes Yes
container material,
which can be any of
the following:
STEEL, ALUMINUM,
UNKNOWN
TranMilitaryTcn Military Transaction Military Tcn The Military java.lang.String Yes Yes
Transaction used
when exporting
military cargo in the
US
TranMilitaryVNbr Military V Number V Nbr The number used java.lang.String Yes Yes
when exporting
military cargo in the
US
TranNextStageId Next Stage ID Next Stage ID The next gate stage java.lang.String Yes Yes
where the truck will
be processed
TranNotes Notes Notes A short note about java.lang.String Yes Yes
the container

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 391
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranNumber Transaction Number Number The transaction java.lang.Long Yes Yes
number, which is an
automatically
generated and
unique ID
TranO2Required O2 required, % O2 Req.% The amount of java.lang.Double Yes Yes
oxygen required, in
kilograms
TranOogBack OOG Back OOG Back The equipment is out java.lang.Long Yes Yes
of gauge in the back
TranOogFront OOG Front OOG Front The equipment is out java.lang.Long Yes Yes
of gauge in the front
TranOogLeft OOG Left OOG Left The equipment is out java.lang.Long Yes Yes
of gauge on the left
TranOogRight OOG Right OOG Right The equipment is out java.lang.Long Yes Yes
of gauge on the right
TranOogTop OOG Top OOG Top The container is out java.lang.Long Yes Yes
of gauge on the top
TranOrigin Origin Origin The origin of the java.lang.String Yes Yes
container, which is
the place where it
was stuffed
TranPinNbr Pin Number Pin Nbr The verification code java.lang.String Yes Yes
required to pick up a
container
TranReeferFuelLevel Reefer Fuel Level, % Reefer Fuel% The last fuel level full java.lang.Double Yes Yes
percent recorded for
the refrigerated unit
TranReeferHours Reefer Hours Reefer Hours The number of hours java.lang.Double Yes Yes
the reefer has been
in operation at the
last reefer recording

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 392
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranScAgent Shipper/Consignee S/C Agent The unique ID of the java.lang.String Yes Yes
Agent agent used by the
shipper or the
consignee
TranSealNbr1 Seal #1 Seal #1 The first seal number java.lang.String Yes Yes
of the container
TranSealNbr2 Seal #2 Seal #2 The second seal java.lang.String Yes Yes
number of the
container
TranSealNbr3 Seal #3 Seal #3 The third seal java.lang.String Yes Yes
number of the
container
TranSealNbr4 Seal #4 Seal #4 The fourth seal java.lang.String Yes Yes
number of the
container
TranSeqNbr Sequence Nbr Seq# The transaction java.lang.Integer Yes Yes
sequence number
TranShandId Special Stow Stow The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShandId2 Special Stow 2 Stow 2 The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShandId3 Special Stow 3 Stow 3 The unique ID for java.lang.String Yes Yes
special handling of
the container
TranShipper Shipper Shipper The party that java.lang.String Yes Yes
shipped the cargo

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 393
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranStatus Transaction Status Status The status of the java.lang.String Yes Yes
transaction, which
can be any of the
following: OK,
TROUBLE,
COMPLETE,
CANCEL, CLOSED,
INCOMPLETE
TranTempObserved Temperature Temp Observed The currently java.lang.Double Yes Yes
Observed observed
temperature for a
refrigerated
container, in
Centigrade
TranTempRequired Temperature Temp Required The temperature java.lang.Double Yes Yes
Required required for a
refrigerated
container, in
Centigrade
TranTempSetting Temperature Setting Temp Setting The temperature java.lang.Double Yes Yes
setting for a
refrigerated
container, in
Centigrade
TranTroubleMsgs Trouble transaction Trouble tran msgs The trouble java.lang.String Yes No
messages transaction
messages,
separated by
semicolon (;).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 394
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranType Transaction Type Transaction Type The type of java.lang.String Yes Yes
transaction, which
can be any of the
following: Deliver
Chassis, Dray Off,
Deliver Import,
Deliver Empty,
Receive Chassis,
Receive Export, Dray
In, Receive Empty,
Through Container,
Receive Break-Bulk,
Unknown
TranTypeShort Transaction Type Transaction Type The type of java.lang.String Yes No
transaction, which
can be any of the
following: DC, DE,
DI, DM, RC, RE, RI,
RM, TC, RB, or UK
TranUfvFlexDate01 Ufv Flex Date-01 Ufv Flex Date-01 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#1
TranUfvFlexDate02 Ufv Flex Date-02 Ufv Flex Date-02 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#2
TranUfvFlexDate03 Ufv Flex Date-03 Ufv Flex Date-03 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#3
TranUfvFlexDate04 Ufv Flex Date-04 Ufv Flex Date-04 Customer Extensible java.util.Date Yes Yes
UFV Flex Date Field
#4
TranUfvFlexString01 Ufv Flex String-01 Ufv Flex String-01 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #1
TranUfvFlexString02 Ufv Flex String-02 Ufv Flex String-02 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #2

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 395
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranUfvFlexString03 Ufv Flex String-03 Ufv Flex String-03 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #3
TranUfvFlexString04 Ufv Flex String-04 Ufv Flex String-04 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #4
TranUfvFlexString05 Ufv Flex String-05 Ufv Flex String-05 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #5
TranUfvFlexString06 Ufv Flex String-06 Ufv Flex String-06 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #6
TranUfvFlexString07 Ufv Flex String-07 Ufv Flex String-07 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #7
TranUfvFlexString08 Ufv Flex String-08 Ufv Flex String-08 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #8
TranUfvFlexString09 Ufv Flex String-09 Ufv Flex String-09 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #9
TranUfvFlexString10 Ufv Flex String-10 Ufv Flex String-10 Customer Extensible java.lang.String Yes Yes
UFV Flex Field #10
TranUnitCategory Category Category The category of the java.lang.String Yes Yes
unit, which can be
any of the following:
Import, Export,
Transship, Domestic,
Storage, or Through
TranUnitCategorySh Category Category The category of the java.lang.String Yes No
ort unit, which can be
any of the following:
I, E, T, D, S, R
TranUnitFlexString01 Unit Flex String-01 Unit Flex String-01 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #1
TranUnitFlexString02 Unit Flex String-02 Unit Flex String-02 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #2
TranUnitFlexString03 Unit Flex String-03 Unit Flex String-03 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #3
TranUnitFlexString04 Unit Flex String-04 Unit Flex String-04 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #4

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 396
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranUnitFlexString05 Unit Flex String-05 Unit Flex String-05 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #5
TranUnitFlexString06 Unit Flex String-06 Unit Flex String-06 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #6
TranUnitFlexString07 Unit Flex String-07 Unit Flex String-07 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #7
TranUnitFlexString08 Unit Flex String-08 Unit Flex String-08 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #8
TranUnitFlexString09 Unit Flex String-09 Unit Flex String-09 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #9
TranUnitFlexString10 Unit Flex String-10 Unit Flex String-10 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #10
TranUnitFlexString11 Unit Flex String-11 Unit Flex String-11 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #11
TranUnitFlexString12 Unit Flex String-12 Unit Flex String-12 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #12
TranUnitFlexString13 Unit Flex String-13 Unit Flex String-13 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #13
TranUnitFlexString14 Unit Flex String-14 Unit Flex String-14 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #14
TranUnitFlexString15 Unit Flex String-15 Unit Flex String-15 Customer Extensible java.lang.String Yes Yes
Unit Flex Field #15
TranUnitId Unit Id Unit Id The unique ID for the java.lang.String Yes Yes
breakbulk unit
TranVentRequired Ventilation Required Vent Req The ventilation java.lang.Double Yes Yes
required for the unit
TranVentSetting Ventilation Setting Vent Set The ventilation java.lang.Double Yes Yes
setting for the unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 397
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TranVentUnit Ventilation Unit Vent Unit The measurement java.lang.String Yes Yes
unit for the values
defined in the fields
'Ventilation Setting'
and 'Ventilation
Required', which can
be any of the
following:
Percentage, Cubic
Feet/Min, Cubic
Meters/Hour
TruckAeiTagId Tag ID Tag ID The transponder java.lang.String Yes Yes
number, if the truck
has a transponder on
board
TruckBatNbr BAT Number BAT Number The bat number for java.lang.String Yes Yes
the truck visit
TruckCallUpTime Callup Time Called Up The date/time the java.util.Date Yes Yes
truck was called up
TruckChanged Changed Changed The date/time the java.util.Date Yes Yes
truck visit was
changed
TruckChanger Changer Changer The user who last java.lang.String Yes Yes
changed the truck
visit
TruckChassisDeliveri Deliver Chassis Deliver Chassis The amount of java.lang.Long Yes Yes
esCount chassis delivered for
the truck visit
TruckChassisReceiv Receive Chassis Receive Chassis The amount of java.lang.Long Yes Yes
alsCount chassis receivals for
the truck visit
TruckCreated Created Created The date/time the java.util.Date Yes Yes
truck visit was
created

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 398
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckCreator Creator Creator The user who java.lang.String Yes Yes
created the truck visit
TruckDeliveryUnitLin BIC Code BIC Code The code that the java.lang.String Yes Yes
eBic line operator uses to
deliver the unit,
assigned by the
Bureau International
des Containers et du
Transport Intermodal
TruckDeliveryUnitLin Id Id The identifier of the java.lang.String Yes Yes
eId line operator of the
unit that was
delivered (might be
null)
TruckDeliveryUnitLin SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
eScac Alpha Code of a line
operator used to
deliver the unit
TruckDriverBatNbr Callup ID Callup ID The truck driver's java.lang.String Yes Yes
permanently
assigned Bat Nbr
(Short ID)
TruckDriverCardId Driver Card Id Card Id The truck driver's java.lang.String Yes Yes
card ID
TruckDriverIsHazard Is Driver Hazard Is Hazard Licensed Flag that identifies java.lang.Boolean Yes Yes
Licensed Licensed the truck driver has a
license for hazards
TruckDriverLicenseN Driver License License The license number java.lang.String Yes Yes
br of the truck driver
TruckDriverName Driver Name Name The truck driver's full java.lang.String Yes Yes
name
TruckEmptyDeliverie Deliver Empty Deliver Empties The amount of empty java.lang.Long Yes Yes
sCount deliveries for the
truck visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 399
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckEmptyReceival Receive Empty Receive Empties The amount of empty java.lang.Long Yes Yes
sCount receivals for the
truck visit
TruckEnteredYard Entered Yard Entered Yard The date and time java.util.Date Yes Yes
the truck entered the
yard
TruckExchangeAreaI Exchange Area Exchange Area The exchange area java.lang.String Yes No
d of the truck visit
TruckExchangeLaneI Lane ID Lane ID The exchange lane java.lang.String Yes No
d of the truck visit
TruckExitedYard Exited Yard Exited Yard The date and time java.util.Date Yes Yes
the truck left the yard
TruckFullDeliveriesC Deliver Fulls Deliver Fulls The amount of full java.lang.Long Yes Yes
ount deliveries for the
truck visit
TruckFullReceivalsC Receive Fulls Receive Fulls The amount of full java.lang.Long Yes Yes
ount receivals for the
truck visit
TruckGateFacilityId Facility Facility The identifier of the java.lang.String Yes Yes
facility that the gate
is associated with for
the truck visit.
TruckGateId Gate ID Gate ID The identifier of the java.lang.String Yes Yes
gate for the truck
visit
TruckGateVisitNbr Gate Visit Nbr Gate Visit Nbr The unique id for the java.lang.Long Yes Yes
truck visit from the
Gate System.
TruckHadTrouble Trouble Trouble Flag that (if set to java.lang.Boolean Yes Yes
TRUE) indicates a
problem occurred
while processing the
complete truck visit
(in any of the stages)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 400
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckHasDoubleMov Double Move? Double Move? Flag that (if set to java.lang.Boolean Yes No
e TRUE) indicates a
truck visit with at
least one receival
move and one
delivery move
TruckId Truck Id Truck Id The Truck ID java.lang.String Yes Yes
assigned by the
trucking company
TruckLicenseNbr Truck License Truck License The truck license java.lang.String Yes Yes
number for the truck
visit
TruckOutBatNbr Out BAT Number Out BAT Number The BAT/Placard java.lang.String Yes Yes
number, assigned by
the gate clerk at
OutGate.
TruckPriority Truck Visit Priority Priority The visit priority of java.lang.String Yes Yes
the truck, which
determines the order
in which the truck
visit is processed:
NORMAL,
CRITICAL, or HIGH
TruckProblemResolv Trouble Resolve Trouble Resolve The total time to java.lang.Long Yes Yes
eTime Time Time resolve the problem
that occurred in any
stage of the visit (in
milliseconds).
TruckProblemResolv Total Resolve Time Total Resolve Time The total time to java.lang.String Yes No
eTimeString resolve the problem
that occurred in any
stage of the visit in
HH:mm:ss format
TruckProcessingEnd End Time End The time the truck java.util.Date Yes Yes
Date visit ended

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 401
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckProcessingStar Start Time Start The time the truck java.util.Date Yes Yes
tDate visit started
TruckReceivalUnitLin BIC Code BIC Code The code that the java.lang.String Yes Yes
eBic line operator uses to
receive the unit,
assigned by the
Bureau International
des Containers et du
Transport Intermodal
TruckReceivalUnitLin Id Id The identifier of the java.lang.String Yes Yes
eId line operator of the
unit that was
received (might be
null)
TruckReceivalUnitLin SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
eScac Alpha Code of a line
operator used to
receive the unit
TruckScaleWeight Scale Weight Scale Weight The total recorded java.lang.Double Yes Yes
weight of the truck
with its chassis and
cargo, in kilograms
TruckTotalDeliveries Total Delivery Count Total Delivery Count The total number of java.lang.Long Yes No
Count delivery transactions
involved in the truck
visit
TruckTotalReceivals Total Receival Count Total Receival Count The total number of java.lang.Long Yes No
Count receival transactions
involved in the truck
visit
TruckTotalTransactio Total Transactions Transactions The amount of java.lang.Long Yes Yes
nCount transactions involved
in the truck visit
TruckTurnTime Turn Time MS Turn Time MS The time elapsed to java.lang.Long Yes Yes
complete the truck
visit (in milliseconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 402
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckTurnTimeNet Turn Time Net Turn Time Net The truck turn time java.lang.Long Yes Yes
minus the truck
trouble time (in
milliseconds)
TruckTurnTimeNetSt Turn Time Net Turn Time Net The truck turn time java.lang.String Yes No
ring minus the truck
trouble time in
HH:mm:ss format
TruckTurnTimeString Turn Time Turn Time The time elapsed to java.lang.String Yes No
complete the truck
visit in HH:mm:ss
format
TruckVisitCanceled Canceled Canceled If TRUE, indicates java.lang.Boolean Yes Yes
the truck visit has
been canceled (in
any of the stages)
TruckVisitStatus Truck Visit Status Status The status of the java.lang.String Yes Yes
truck visit, which can
be any of the
following: OK,
TROUBLE,
COMPLETE,
CANCEL, or
CLOSED
TruckWaitStatus Truck Visit Wait Wait Status The truck's wait java.lang.String Yes Yes
Status status
TruckingCompanyBI BIC Code BIC Code The official container java.lang.String Yes Yes
C owner code for the
trucking company,
assigned by the
Bureau International
des Containers et du
Transport
TruckingCompanyId Id Id The identifier of the java.lang.String Yes Yes
trucking company

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 403
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stage and Transaction

External Tag Long Label Short Label Description Type In Design In Sort
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company
TruckingCompanySC SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
AC Alpha Code used to
identify the trucking
company
UnitEquipNominalHe Nominal Height Height The nominal height java.lang.String Yes Yes
ight of the primary
equipment: 4'0, 4'3,
8'0, 8'6, 9'0, or 9'6.
UnitEquipNominalLe Nominal Length Length The nominal length java.lang.String Yes Yes
ngth of the primary
equipment: 20', 24',
30', 40', 45', 48', or
53'.
UnitInboundCarrierId Visit Ref Visit The visit ID of the java.lang.String Yes Yes
inbound carrier,
which is the visit ID
for a vessel, the train
ID for a train, or the
license number for a
truck
UnitInboundCarrierN Carrier Name Carrier Name The name of the java.lang.String Yes No
ame inbound carrier, such
as vessel name,truck
license number, or
train ID
UnitNotes Unit Notes Unit Notes Unit Notes java.lang.String Yes Yes
UnitOutboundCarrier Visit Ref Visit The visit ID of the java.lang.String Yes Yes
Id outbound carrier,
which is the visit ID
for a vessel, the train
ID for a train, or the
license number for a
truck

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 404
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Truck Visit Stages

External Tag Long Label Short Label Description Type In Design In Sort
UnitOutboundCarrier Carrier Name Carrier Name The name of the java.lang.String Yes No
Name outbound carrier ,
such as vessel
name, truck license
number, or train ID
UnitTransitState Transit State T-State The transit state of java.lang.String Yes Yes
the unit with respect
to its trip through the
facility, which can be
any of the following:
Inbound, EC/In,
Yard, EC/Out,
Loaded, Departed, or
Retired
UnitVisitState Visit State (Master) State (Master) The visit state of the java.lang.String Yes Yes
unit with respect to
the complex, which
can be any of the
following: Active,
Advised, Departed,
or Retired
UnitsAttached Attached Attached The equipment IDs java.lang.String Yes No
Equipments Equipments of attached units,
separated by
semicolon (;)

2.2.38 Truck Visit Stages

The Truck Visit Stages reporting entity combines the information of a single stage for a truck visit and also information on the complete truck visit.

External Tag Long Label Short Label Description Type In Design In Sort
BatNbr BAT Number BAT Number The bat number for java.lang.String Yes Yes
the truck visit.
ChassisDeliveriesCo Deliver Chassis Deliver Chassis The amount of java.lang.Long Yes Yes
unt chassis delivered for
that truck visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 405
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stages

External Tag Long Label Short Label Description Type In Design In Sort
ChassisReceivalsCo Receive Chassis Receive Chassis The amount of java.lang.Long Yes Yes
unt chassis receivals for
that truck visit.
DeliveryUnitLineOpe Id Id The identifier of the java.lang.String Yes Yes
ratorId line operator of the
unit that was
delivered. (Might be
null)
EmptyDeliveriesCou Deliver Empty Deliver Empties The amount of empty java.lang.Long Yes Yes
nt deliveries for that
truck visit.
EmptyReceivalsCou Receive Empty Receive Empties The amount of empty java.lang.Long Yes Yes
nt receivals for that
truck visit.
FullDeliveriesCount Deliver Fulls Deliver Fulls The amount of full java.lang.Long Yes Yes
deliveries for that
truck visit.
FullReceivalsCount Receive Fulls Receive Fulls The amount of full java.lang.Long Yes Yes
receivals for that
truck visit.
GateFacilityId Facility Facility The identifier of the java.lang.String Yes Yes
facility the gate is
associated with.
GateId Gate ID Gate ID The identifier of the java.lang.String Yes Yes
gate for the truck
visit stage.
ProblemResolveTim Stage Trouble Trouble Time The time that was java.lang.Long Yes Yes
e Resolve Time needed to solve the
problem that
occurred during this
stage (in
milliseconds).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 406
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stages

External Tag Long Label Short Label Description Type In Design In Sort
ProblemsOccuredDu Stage Trouble Trouble True if there was a java.lang.Boolean Yes Yes
ringStage problem while
processing the truck
for this stage.
ProblemsOccuredDu Trouble Trouble True if there was a java.lang.Boolean Yes Yes
ringTruckVisit problem while
processing this
complete truck visit
(in any of the
stages).
ReceivalUnitLineOpe Id Id The identifier of the java.lang.String Yes Yes
ratorId line operator of the
unit that was
received. (Might be
null)
StageChanged Changed Changed The last updated java.util.Date Yes Yes
date the truck visited
the stage
StageChanger Changer Changer The name of the java.lang.String Yes Yes
clerk who update the
truck that visited at
this stage
StageCreated Created Created The date and time java.util.Date Yes Yes
the truck visited the
stage
StageCreator Creator Creator The name of the java.lang.String Yes Yes
clerk who created
the truck visited at
this stage
StageEndTime Stage End Time End The time processing java.util.Date Yes Yes
of this stage was
completed.
StageId Stage ID Stage The identifier of this java.lang.String Yes Yes
stage.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 407
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stages

External Tag Long Label Short Label Description Type In Design In Sort
StageQueueTime Stage Queue Time Queue Time Time the truck waited java.lang.Long Yes Yes
to start this stage (in
milliseconds).
StageSequence Stage Sequence Seq The sequence of this java.lang.Long Yes Yes
stage.
StageStartTime Stage Start Time Start The time processing java.util.Date Yes Yes
of this stage was
started.
TransactionCount Total Transactions Transactions The amount of java.lang.Long Yes Yes
transactions involved
in the truck visit.
TruckDriverBatNbr Callup ID Callup ID The truck driver's java.lang.String Yes Yes
permanently
assigned Bat Nbr
(Short Id).
TruckDriverCardId Driver Card Id Card Id The truck driver's java.lang.String Yes Yes
card Id.
TruckDriverLicenseN Driver License License The license number java.lang.String Yes Yes
br of the truck driver.
TruckDriverName Driver Name Name The truck driver's full java.lang.String Yes Yes
name.
TruckLicenseNbr Truck License Truck License The truck license java.lang.String Yes Yes
number for the truck
visit.
TruckProcessingEnd End Time End The time the truck java.util.Date Yes Yes
Date visit entered.
TruckProcessingStar Start Time Start The time the truck java.util.Date Yes Yes
tDate visit started.
TruckTurnTime Turn Time MS Turn Time MS The time elapsed to java.lang.Long Yes Yes
complete this truck
visit (in milliseconds).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 408
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Stages

External Tag Long Label Short Label Description Type In Design In Sort
TruckVisitCanceled Canceled Canceled True if the truck visit java.lang.Boolean Yes Yes
has been canceled
(in any of the
stages).
TruckVisitEndTime End Time End DEPRECATED - Use java.util.Date Yes No
TruckProcessingEnd
Date instead: The
time the complete
truck visit ended.
TruckVisitStartTime Start Time Start DEPRECATED - Use java.util.Date Yes No
TruckProcessingStar
tDate instead: The
time the complete
truck visit started.
TruckVisitStatus Truck Visit Status Status The status of this java.lang.String Yes Yes
truck visit
considering all
stages: OK,
TROUBLE,
COMPLETE,
CANCEL, CLOSED.
TruckingCompanyBI BIC Code BIC Code The official container java.lang.String Yes Yes
C owner code,
assigned by the
Bureau International
des Containers et du
Transport
TruckingCompanyId Id Id The identifier of the java.lang.String Yes Yes
trucking company.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company.
TruckingCompanySC SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
AC Alpha Code used to
identify a trucking
company.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 409
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Truck Visit Statistics

2.2.39 Truck Visit Statistics

The Truck Visit Statistics reporting entity combines the information of a single truck visit (including all stages).

External Tag Long Label Short Label Description Type In Design In Sort
BatNbr BAT Number BAT Number The bat number for java.lang.String Yes Yes
the truck visit.
Changer Changer Changer The changer, who is java.lang.String Yes Yes
most likely the
outgate clerk.
ChassisDeliveriesCo Deliver Chassis Deliver Chassis The amount of java.lang.Long Yes Yes
unt chassis delivered for
that truck visit.
ChassisReceivalsCo Receive Chassis Receive Chassis The amount of java.lang.Long Yes Yes
unt chassis receivals for
that truck visit.
Creator Creator Creator The user who java.lang.String Yes Yes
created the truck visit
(most likely the
ingate clerk).
DateCreated Created Created The date the truck java.util.Date Yes Yes
visit statistics was
created.
DateUpdated Changed Changed The date the truck java.util.Date Yes Yes
visit statistics was
last changed.
DeliveryUnitLineId Id Id The identifier of the java.lang.String Yes Yes
line operator of the
unit that was
delivered. (Might be
null)
EmptyDeliveriesCou Deliver Empty Deliver Empties The amount of empty java.lang.Long Yes Yes
nt deliveries for that
truck visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 410
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Statistics

External Tag Long Label Short Label Description Type In Design In Sort
EmptyReceivalsCou Receive Empty Receive Empties The amount of empty java.lang.Long Yes Yes
nt receivals for that
truck visit.
EntryLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used to enter
the terminal.
ExitLaneId Lane ID Lane ID The gate lane the java.lang.String Yes Yes
truck used to exit the
terminal.
FullDeliveriesCount Deliver Fulls Deliver Fulls The amount of full java.lang.Long Yes Yes
deliveries for that
truck visit.
FullReceivalsCount Receive Fulls Receive Fulls The amount of full java.lang.Long Yes Yes
receivals for that
truck visit.
GateFacilityId Facility Facility The identifier of the java.lang.String Yes Yes
facility the gate is
associated with.
GateId Gate ID Gate ID The identifier of the java.lang.String Yes Yes
gate of this truck visit
statistic.
ProblemsOccuredDu Trouble Trouble True if there was a java.lang.Boolean Yes Yes
ringTruckVisit problem while
processing this truck
visit.
ReceivalUnitLineId Id Id The identifier of the java.lang.String Yes Yes
line operator of the
unit that was
received. (Might be
null)
Status Truck Visit Status Status The status of this java.lang.String Yes Yes
truck visit: OK,
TROUBLE,
COMPLETE,
CANCEL, CLOSED.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 411
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Truck Visit Statistics

External Tag Long Label Short Label Description Type In Design In Sort
TransactionCount Total Transactions Transactions The amount of java.lang.Long Yes Yes
transactions involved
in the truck visit.
TruckDriverBatNbr Callup ID Callup ID The truck driver's java.lang.String Yes Yes
permanently
assigned Bat Nbr
(Short Id).
TruckDriverCardId Driver Card Driver Card The truck driver's java.lang.String Yes Yes
card Id.
TruckDriverLicenseN Driver License Driver License The license number java.lang.String Yes Yes
br of the truck driver.
TruckDriverName Driver Name Driver Name The truck driver's full java.lang.String Yes Yes
name.
TruckId Truck Id Truck Id The truck Id java.lang.String Yes Yes
TruckLicenseNbr Truck License Truck License The truck license java.lang.String Yes Yes
number for the truck
visit.
TruckTurnTime Turn Time MS Turn Time MS The time elapsed java.lang.Long Yes Yes
from truck arrival to
final departure (in
milliseconds).
TruckVisitCanceled Canceled Canceled True if the truck visit java.lang.Boolean Yes Yes
has been canceled.
TruckVisitEndTime End Time End The time the java.util.Date Yes Yes
processing of the
truck visit ended.
TruckVisitStartTime Start Time Start The time the java.util.Date Yes Yes
processing of the
truck visit started.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 412
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Event

External Tag Long Label Short Label Description Type In Design In Sort
TruckingCompanyBI BIC Code BIC Code The official container java.lang.String Yes Yes
C owner code,
assigned by the
Bureau International
des Containers et du
Transport.
TruckingCompanyId Id Id The identifier of the java.lang.String Yes Yes
trucking company.
TruckingCompanyNa Name Name The name of the java.lang.String Yes Yes
me trucking company.
TruckingCompanySC SCAC Code SCAC Code The Standard Carrier java.lang.String Yes Yes
AC Alpha Code used to
identify a trucking
company.

2.2.40 Event
The Event reporting entity includes all events recorded for any serviceable entities (container, goods, vessel visit, etc.) through the system.

External Tag Long Label Short Label Description Type In Design In Sort
AppliedBy Applied By Applied By The user with which java.lang.String Yes Yes
this event was
recorded.
AppliedInComplex Complex Name Cpx Name The complex where java.lang.String Yes Yes
this event was
recorded.
AppliedInFacility Facility Name Facility Name The facility where java.lang.String Yes Yes
this event was
recorded.
AppliedInYard Yard Name Yard Name The yard where this java.lang.String Yes Yes
event was recorded.
AppliedOn Apply Date Apply Date The date the system java.util.Date Yes Yes
recorded this event.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 413
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Event

External Tag Long Label Short Label Description Type In Design In Sort
AppliedToId Applied To Id Applied To Id The Id of the entity java.lang.String Yes Yes
for which the event
has been recorded
(e.g. for a Container
the EquipmentId).
AppliedToType Applied To Type Applied To Type The entity type to java.lang.String Yes Yes
which the event has
been applied:
Container, Chassis,
Goods, Vessel,
Vessel Visit, Train
Visit, Booking,
Delivery Order,
Loadout Order, EDI
Session, Yard.
EventCreated Created Date Created The date and time java.util.Date Yes Yes
the event was
created
EventCreator Creator Creator The user who java.lang.String Yes Yes
created the event
EventRelatedEntityCl Related Entity Class Related Entity Class Type of entity i.e unit, java.lang.String Yes Yes
ass equipment,
serviceOrderItem,
etc.
EventRelatedEntityId Related Entity Id Related Entity Id Identifier of related java.lang.String Yes Yes
entity i.e. unit ID,
equipment ID,
service order ID, etc.
EventTypeDescriptio Description Description A description for the java.lang.String Yes Yes
n recorded event type.
EventTypeId Id Id The identifier of the java.lang.String Yes Yes
recorded event type.
FieldChanges Changes Changes null java.lang.String Yes No
FlexDate01 FlexDate-01 FlexDate-01 Flex Date 01 java.util.Date Yes Yes
FlexDate02 FlexDate-01 FlexDate-01 Flex Date 02 java.util.Date Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 414
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Event

External Tag Long Label Short Label Description Type In Design In Sort
FlexDate03 FlexDate-01 FlexDate-01 Flex Date 03 java.util.Date Yes Yes
FlexDouble01 FlexDouble-01 FlexDouble-01 Flex Double 01 java.lang.Double Yes Yes
FlexDouble02 FlexDouble-02 FlexDouble-02 Flex Double 02 java.lang.Double Yes Yes
FlexDouble03 FlexDouble-03 FlexDouble-03 Flex Double 03 java.lang.Double Yes Yes
FlexDouble04 FlexDouble-04 FlexDouble-04 Flex Double 04 java.lang.Double Yes Yes
FlexDouble05 FlexDouble-05 FlexDouble-05 Flex Double 05 java.lang.Double Yes Yes
FlexString01 Flex-01 Flex-01 Flex String 01 java.lang.String Yes Yes
FlexString02 Flex-02 Flex-02 Flex String 02 java.lang.String Yes Yes
FlexString03 Flex-03 Flex-03 Flex String 03 java.lang.String Yes Yes
FlexString04 Flex-04 Flex-04 Flex String 04 java.lang.String Yes Yes
FlexString05 Flex-05 Flex-05 Flex String 05 java.lang.String Yes Yes
IsBillable Billable Billable True if this event is java.lang.Boolean Yes Yes
billable.
IsBuiltInEvent Is Built In Built In True if this is a built java.lang.Boolean Yes Yes
in event type
(meaning it is not a
custom defined
event type).
IsBulkApplicable Can be Bulk-applied Bulkable True if this event java.lang.Boolean Yes Yes
type can be applied
in a bulk update.
IsFacilityPerformed Is Service Is Service True if this is an java.lang.Boolean Yes Yes
actual service event.
Note: Only service
event types can be
used in service
business rules.
IsNotifiableEvent Notifiable Notifiable True if this event java.lang.Boolean Yes Yes
type allows triggering
of notifications.
Notes Note Note Event Notes java.lang.String Yes Yes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 415
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Line DischargeList

2.2.41 Line DischargeList

The Line DischargeList reporting entity represents the discharge list information sent by a line operator.

External Tag Long Label Short Label Description Type In Design In Sort
LinedlActionCode Action Action Effect of Discharge java.lang.String Yes Yes
list: Original, Update,
Revoke
LinedlActionCodeSh Action Action Effect of Discharge java.lang.String Yes No
ort list(Short name): A
for Original, U for
Update, R for
Revoke
LinedlAgent1 Id Id categorized custom java.lang.String Yes Yes
or ship agent one
LinedlAgent1Name Name Name categorized custom java.lang.String Yes Yes
or ship agent one
name
LinedlAgent2 Id Id categorized custom java.lang.String Yes Yes
or ship agent two
LinedlAgent2Name Name Name categorized custom java.lang.String Yes Yes
or ship agent two
name
LinedlBlNbr Bl Number Bl Nbr. Associated Bill of java.lang.String Yes Yes
lading Number for
container
LinedlChanged Changed Changed The date and time java.util.Date Yes Yes
the line discharge list
was updated
LinedlChanger Changer Changer The user who java.lang.String Yes Yes
updated the line
discharge list
LinedlCommodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 416
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlCommodityDe Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
scription Name description for the
contents of a unit
LinedlComplex Complex Complex The Complex id java.lang.String Yes Yes
where Discharge list
is received
LinedlComplexName Complex Name Cpx Name The Complex name java.lang.String Yes Yes
where Discharge list
is received
LinedlConsigneeBzu Id Id The specified java.lang.String Yes Yes
consignee for the
goods
LinedlConsigneeBzu Name Name The specified java.lang.String Yes Yes
Name consignee name for
the goods
LinedlCreated Created Created The date and time java.util.Date Yes Yes
the discharge list
was created
LinedlCreator Creator Creator The user who java.lang.String Yes Yes
created the line
discharge list
LinedlCtrCategory Category Category The category of the java.lang.String Yes Yes
unit: Import, Export,
Transship, Domestic,
Storage, Through
LinedlCtrCategorySh Category Category The category of the java.lang.String Yes No
ort unit(Short name): I
for Import, E for
Export, T for
Transship, D for
Domestic, S for
Storage, or R for
Through (includes
Restow)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 417
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlCtrEquipType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
LinedlCtrFreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: Empty, Full
Container Load, L for
Less than Container
Load, or B for Break-
bulk
LinedlCtrFreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes No
Short the unit(Short name):
E for Empty, F for
Full Container Load,
L for Less than
Container Load, or B
for B-bulk
LinedlCtrGrossWeig Gross Weight Weight The weight of a java.lang.Double Yes Yes
htKg container including
the weight of its
cargo
LinedlCtrId Unit Nbr Unit Nbr A unique code java.lang.String Yes Yes
identifying the unit,
container number
LinedlCtrIntendedOb Intended Ob Mode Intend. Ob Mode Container Intended java.lang.String Yes Yes
Mode Outbound Mode of
carrier: Vessel,
Railcar, Train, Truck

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 418
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlCtrIntendedOb Intended Ob Mode Intend. Ob Mode Container Intended java.lang.String Yes No
ModeShort Outbound Mode of
carrier: V for Vessel,
R for Railcar, N for
Train, T for Truck
LinedlCtrOperator Id Id container Operator, java.lang.String Yes Yes
who sends the
Discharge list
LinedlCtrOperatorNa Name Name container Operator java.lang.String Yes Yes
me name, who sends
the Discharge list
LinedlCtrWtKgVerfie VGM Weight VGM Weight The verified weight java.lang.Double Yes Yes
dGross of a container
including the weight
of its cargo
LinedlHzrdItemImdg Hazard Imdg Code Hazard Imdg Code Hazard item's imdg java.lang.String Yes No
Code code separated by
semicolon(;)
LinedlIbVesselVisit Visit Ref Visit Vessel Visit Id for java.lang.String Yes Yes
which the Discharge
list pertains to
LinedlLineOperator Id Id Line Operator, who java.lang.String Yes Yes
sends the Discharge
list
LinedlLineOperatorN Name Name Line Operator name, java.lang.String Yes Yes
ame who sends the
Discharge list
LinedlObVesselVisit Visit Ref Visit Vessel which may java.lang.String Yes Yes
carry Transship
containers from the
inbound Vessel
LinedlOogBackCm Overlong Back OL-B The unit is java.lang.Long Yes Yes
overdimensional in
the back

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 419
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlOogFrontCm Overlong Front OL-F The unit is java.lang.Long Yes Yes
overdimensional in
the front
LinedlOogLeftCm Overwide Left OW-L The unit is java.lang.Long Yes Yes
overdimensional in
the Left
LinedlOogRightCm Overwide Right OW-R The unit is java.lang.Long Yes Yes
overdimensional in
the Right
LinedlOogTopCm Overheight OH The unit is java.lang.Long Yes Yes
overdimensional in
the Top
LinedlPOD Point ID ID The first port at java.lang.String Yes Yes
which the container
will be discharged
LinedlPOL Point ID ID The port at which the java.lang.String Yes Yes
container will be
loaded to a vessel
LinedlSealNbr1 Seal Number 1 Seal Nbr1 The first container java.lang.String Yes Yes
seal number
LinedlSealNbr2 Seal Number 2 Seal Nbr2 The second java.lang.String Yes Yes
container seal
number
LinedlSealNbr3 Seal Number 3 Seal Nbr3 The third container java.lang.String Yes Yes
seal number
LinedlSealNbr4 Seal Number 4 Seal Nbr4 The forth container java.lang.String Yes Yes
seal number
LinedlSenderId Sender Id Sender Line who sends the java.lang.String Yes Yes
Discharge List
LinedlStowPosition Stow Position Stow Container stow java.lang.String Yes Yes
position on Vessel
LinedlTempLimitMax Temp. Max Temp. Max The highest java.lang.Double Yes Yes
C temperature allowed
for a refrigerated unit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 420
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlTempLimitMin Temp. Min Temp. Min The lowest java.lang.Double Yes Yes
C temperature allowed
for a refrigerated unit
LinedlTempRequired Temp. Required Temp Required The container's java.lang.Double Yes Yes
C target temperature
(for a refrigerated
unit)
LinedlUfvFlexDate01 UFV Flex Date-01 UFV Flex Date-01 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate01.
LinedlUfvFlexDate02 UFV Flex Date-02 UFV Flex Date-02 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate02.
LinedlUfvFlexDate03 UFV Flex Date-03 UFV Flex Date-03 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate03.
LinedlUfvFlexDate04 UFV Flex Date-04 UFV Flex Date-04 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate04.
LinedlUfvFlexDate05 UFV Flex Date-05 UFV Flex Date-05 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate05.
LinedlUfvFlexDate06 UFV Flex Date-06 UFV Flex Date-06 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate06.
LinedlUfvFlexDate07 UFV Flex Date-07 UFV Flex Date-07 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate07.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 421
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlUfvFlexDate08 UFV Flex Date-08 UFV Flex Date-08 The flex field of the java.util.Date Yes Yes
line discharge list
with name:
linedlUfvFlexDate08.
LinedlUfvFlexString0 UFV Flex String-01 UFV Flex String-01 The flex field of the java.lang.String Yes Yes
1 line discharge list
with name:
linedlUfvFlexString01
.
LinedlUfvFlexString0 UFV Flex String-02 UFV Flex String-02 The flex field of the java.lang.String Yes Yes
2 line discharge list
with name:
linedlUfvFlexString02
.
LinedlUfvFlexString0 UFV Flex String-03 UFV Flex String-03 The flex field of the java.lang.String Yes Yes
3 line discharge list
with name:
linedlUfvFlexString03
.
LinedlUfvFlexString0 UFV Flex String-04 UFV Flex String-04 The flex field of the java.lang.String Yes Yes
4 line discharge list
with name:
linedlUfvFlexString04
.
LinedlUfvFlexString0 UFV Flex String-05 UFV Flex String-05 The flex field of the java.lang.String Yes Yes
5 line discharge list
with name:
linedlUfvFlexString05
.
LinedlUfvFlexString0 UFV Flex String-06 UFV Flex String-06 The flex field of the java.lang.String Yes Yes
6 line discharge list
with name:
linedlUfvFlexString06
.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 422
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlUfvFlexString0 UFV Flex String-07 UFV Flex String-07 The flex field of the java.lang.String Yes Yes
7 line discharge list
with name:
linedlUfvFlexString07
.
LinedlUfvFlexString0 UFV Flex String-08 UFV Flex String-08 The flex field of the java.lang.String Yes Yes
8 line discharge list
with name:
linedlUfvFlexString08
.
LinedlUfvFlexString0 UFV Flex String-09 UFV Flex String-09 The flex field of the java.lang.String Yes Yes
9 line discharge list
with name:
linedlUfvFlexString09
.
LinedlUfvFlexString1 UFV Flex String-10 UFV Flex String-10 The flex field of the java.lang.String Yes Yes
0 line discharge list
with name:
linedlUfvFlexString10
.
LinedlUnitFlexString Unit Flex String-01 Unit Flex String-01 The flex field of the java.lang.String Yes Yes
01 line discharge list
with name:
linedlUnitFlexString0
1.
LinedlUnitFlexString Unit Flex String-02 Unit Flex String-02 The flex field of the java.lang.String Yes Yes
02 line discharge list
with name:
linedlUnitFlexString0
2.
LinedlUnitFlexString Unit Flex String-03 Unit Flex String-03 The flex field of the java.lang.String Yes Yes
03 line discharge list
with name:
linedlUnitFlexString0
3.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 423
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line DischargeList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlUnitFlexString Unit Flex String-04 Unit Flex String-04 The flex field of the java.lang.String Yes Yes
04 line discharge list
with name:
linedlUnitFlexString0
4.
LinedlUnitFlexString Unit Flex String-05 Unit Flex String-05 The flex field of the java.lang.String Yes Yes
05 line discharge list
with name:
linedlUnitFlexString0
5.
LinedlUnitFlexString Unit Flex String-06 Unit Flex String-06 The flex field of the java.lang.String Yes Yes
06 line discharge list
with name:
linedlUnitFlexString0
6.
LinedlUnitFlexString Unit Flex String-07 Unit Flex String-07 The flex field of the java.lang.String Yes Yes
07 line discharge list
with name:
linedlUnitFlexString0
7.
LinedlUnitFlexString Unit Flex String-08 Unit Flex String-08 The flex field of the java.lang.String Yes Yes
08 line discharge list
with name:
linedlUnitFlexString0
8.
LinedlUnitFlexString Unit Flex String-09 Unit Flex String-09 The flex field of the java.lang.String Yes Yes
09 line discharge list
with name:
linedlUnitFlexString0
9.
LinedlUnitFlexString Unit Flex String-10 Unit Flex String-10 The flex field of the java.lang.String Yes Yes
10 line discharge list
with name:
linedlUnitFlexString1
0.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 424
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinedlUnitFlexString Unit Flex String-11 Unit Flex String-11 The flex field of the java.lang.String Yes Yes
11 line discharge list
with name:
linedlUnitFlexString1
1.
LinedlUnitFlexString Unit Flex String-12 Unit Flex String-12 The flex field of the java.lang.String Yes Yes
12 line discharge list
with name:
linedlUnitFlexString1
2.
LinedlUnitFlexString Unit Flex String-13 Unit Flex String-13 The flex field of the java.lang.String Yes Yes
13 line discharge list
with name:
linedlUnitFlexString1
3.
LinedlUnitFlexString Unit Flex String-14 Unit Flex String-14 The flex field of the java.lang.String Yes Yes
14 line discharge list
with name:
linedlUnitFlexString1
4.
LinedlUnitFlexString Unit Flex String-15 Unit Flex String-15 The flex field of the java.lang.String Yes Yes
15 line discharge list
with name:
linedlUnitFlexString1
5.
LinedlVgmVerifierEnt VGM Verifier VGM Verifier The VGM verifier java.lang.String Yes Yes
ity entity weight

2.2.42 Line LoadList

The Line LoadList reporting entity represents the load list information sent by a line operator.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 425
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellActionCode Action Action Effect of an Load list: java.lang.String Yes Yes
Original, Update,
Revoke
LinellActionCodeSho Action Action Effect of an Load java.lang.String Yes No
rt list(Short name): A
for Original, U for
Update, R for
Revoke
LinellChanged Changed Changed The date and time java.util.Date Yes Yes
the line load list was
updated
LinellChanger Changer Changer The user who java.lang.String Yes Yes
updated the line load
list
LinellCommodity Commodity ID Id The commodity ID java.lang.String Yes Yes
for the contents of a
unit
LinellCommodityDes Commodity Short Cmdy Short Name The commodity java.lang.String Yes No
cription Name description for the
contents of a unit
LinellComplex Complex Complex The Complex id java.lang.String Yes Yes
where Loadlist is
received
LinellComplexName Complex Name Cpx Name The Complex name java.lang.String Yes Yes
where Loadlist is
received
LinellConsigneeBzu Id Id The specified java.lang.String Yes Yes
consignee for the
goods
LinellConsigneeBzu Name Name The specified java.lang.String Yes Yes
Name consignee name for
the goods
LinellCreated Created Created The date and time java.util.Date Yes Yes
the line load list was
created

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 426
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellCreator Creator Creator The user who java.lang.String Yes Yes
created the line load
list
LinellCtrCategory Category Category The category of the java.lang.String Yes Yes
unit: Import, Export,
Transship, Domestic,
Storage, Through
LinellCtrCategorySh Category Category The category of the java.lang.String Yes No
ort unit(Short name): I
for Import, E for
Export, T for
Transship, D for
Domestic, S for
Storage, or R for
Through (includes
Restow)
LinellCtrEquipType ISO Id ISO Id The primary java.lang.String Yes Yes
equipment type code
(ISO or other). For
information about
ISO codes, see the
Documents section
at
http:www.smdg.org.
LinellCtrFreightKind Freight Kind Frght Kind The filling status of java.lang.String Yes Yes
the unit: Empty, Full
Container Load, L for
Less than Container
Load, or B for Break-
bulk
LinellCtrFreightKindS Freight Kind Frght Kind The filling status of java.lang.String Yes No
hort the unit(Short name):
E for Empty, F for
Full Container Load,
L for Less than
Container Load, or B
for B-bulk

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 427
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellCtrGrossWeight Gross Weight Weight The weight of a java.lang.Double Yes Yes
Kg container including
the weight of its
cargo
LinellCtrId Unit Nbr Unit Nbr A unique code java.lang.String Yes Yes
identifying the unit,
container number
LinellCtrOperator Id Id container Operator, java.lang.String Yes Yes
who sends the Load
list
LinellCtrOperatorNa Name Name container Operator java.lang.String Yes Yes
me name, who sends
the Load list
LinellCtrWtKgVerfied VGM Weight VGM Weight The verified weight java.lang.Double Yes Yes
Gross of a container
including the weight
of its cargo
LinellDestination Destination Destination The cargo's final java.lang.String Yes Yes
destination (the
container will be
stripped at this
location)
LinellHzrdItemImdgC Hazard Imdg Code Hazard Imdg Code Hazard item's imdg java.lang.String Yes No
ode code separated by
semicolon(;)
LinellLineOperator Id Id Line Operator, who java.lang.String Yes Yes
sends the Load list
LinellLineOperatorNa Name Name Line Operator name, java.lang.String Yes Yes
me who sends the Load
list
LinellOogBackCm Overlong Back OL-B The unit is java.lang.Long Yes Yes
overdimensional in
the back

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 428
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellOogFrontCm Overlong Front OL-F The unit is java.lang.Long Yes Yes
overdimensional in
the front
LinellOogLeftCm Overwide Left OW-L The unit is java.lang.Long Yes Yes
overdimensional in
the Left
LinellOogRightCm Overwide Right OW-R The unit is java.lang.Long Yes Yes
overdimensional in
the Right
LinellOogTopCm Overheight OH The unit is java.lang.Long Yes Yes
overdimensional in
the Top
LinellOrderNbr Order Number Order Nbr. Associated Booking java.lang.String Yes Yes
Number for container
LinellPOD Point ID ID The first port at java.lang.String Yes Yes
which the container
will be discharged
LinellPOL Point ID ID The port at which the java.lang.String Yes Yes
container will be
loaded to a vessel
LinellSealNbr1 Seal Number 1 Seal Nbr1 The first container java.lang.String Yes Yes
seal number
LinellSealNbr2 Seal Number 2 Seal Nbr2 The second java.lang.String Yes Yes
container seal
number
LinellSealNbr3 Seal Number 3 Seal Nbr3 The third container java.lang.String Yes Yes
seal number
LinellSealNbr4 Seal Number 4 Seal Nbr4 The forth container java.lang.String Yes Yes
seal number
LinellSenderId Sender Id Sender Line who sends the java.lang.String Yes Yes
Load List
LinellSpecialStow ID ID The special stow java.lang.String Yes Yes
requirement ID

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 429
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellTempLimitMax Temp. Max Temp. Max The highest java.lang.Double Yes Yes
C temperature allowed
for a refrigerated unit
LinellTempLimitMinC Temp. Min Temp. Min The lowest java.lang.Double Yes Yes
temperature allowed
for a refrigerated unit
LinellTempRequired Temp. Required Temp Required The container's java.lang.Double Yes Yes
C target temperature
(for a refrigerated
unit)
LinellUfvFlexDate01 UFV Flex Date-01 UFV Flex Date-01 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate01.
LinellUfvFlexDate02 UFV Flex Date-02 UFV Flex Date-02 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate02.
LinellUfvFlexDate03 UFV Flex Date-03 UFV Flex Date-03 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate03.
LinellUfvFlexDate04 UFV Flex Date-04 UFV Flex Date-04 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate04.
LinellUfvFlexDate05 UFV Flex Date-05 UFV Flex Date-05 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate05.
LinellUfvFlexDate06 UFV Flex Date-06 UFV Flex Date-06 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate06.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 430
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellUfvFlexDate07 UFV Flex Date-07 UFV Flex Date-07 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate07.
LinellUfvFlexDate08 UFV Flex Date-08 UFV Flex Date-08 The flex field of the java.util.Date Yes Yes
line load list with
name:
linellUfvFlexDate08.
LinellUfvFlexString01 UFV Flex String-01 UFV Flex String-01 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString01.
LinellUfvFlexString02 UFV Flex String-02 UFV Flex String-02 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString02.
LinellUfvFlexString03 UFV Flex String-03 UFV Flex String-03 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString03.
LinellUfvFlexString04 UFV Flex String-04 UFV Flex String-04 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString04.
LinellUfvFlexString05 UFV Flex String-05 UFV Flex String-05 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString05.
LinellUfvFlexString06 UFV Flex String-06 UFV Flex String-06 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString06.
LinellUfvFlexString07 UFV Flex String-07 UFV Flex String-07 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString07.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 431
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellUfvFlexString08 UFV Flex String-08 UFV Flex String-08 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString08.
LinellUfvFlexString09 UFV Flex String-09 UFV Flex String-09 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString09.
LinellUfvFlexString10 UFV Flex String-10 UFV Flex String-10 The flex field of the java.lang.String Yes Yes
line load list with
name:
linellUfvFlexString10.
LinellUnitFlexString0 Unit Flex String-01 Unit Flex String-01 The flex field of the java.lang.String Yes Yes
1 line load list with
name:
linellUnitFlexString01
.
LinellUnitFlexString0 Unit Flex String-02 Unit Flex String-02 The flex field of the java.lang.String Yes Yes
2 line load list with
name:
linellUnitFlexString02
.
LinellUnitFlexString0 Unit Flex String-03 Unit Flex String-03 The flex field of the java.lang.String Yes Yes
3 line load list with
name:
linellUnitFlexString03
.
LinellUnitFlexString0 Unit Flex String-04 Unit Flex String-04 The flex field of the java.lang.String Yes Yes
4 line load list with
name:
linellUnitFlexString04
.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 432
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Line LoadList

External Tag Long Label Short Label Description Type In Design In Sort
LinellUnitFlexString0 Unit Flex String-05 Unit Flex String-05 The flex field of the java.lang.String Yes Yes
5 line load list with
name:
linellUnitFlexString05
.
LinellUnitFlexString0 Unit Flex String-06 Unit Flex String-06 The flex field of the java.lang.String Yes Yes
6 line load list with
name:
linellUnitFlexString06
.
LinellUnitFlexString0 Unit Flex String-07 Unit Flex String-07 The flex field of the java.lang.String Yes Yes
7 line load list with
name:
linellUnitFlexString07
.
LinellUnitFlexString0 Unit Flex String-08 Unit Flex String-08 The flex field of the java.lang.String Yes Yes
8 line load list with
name:
linellUnitFlexString08
.
LinellUnitFlexString0 Unit Flex String-09 Unit Flex String-09 The flex field of the java.lang.String Yes Yes
9 line load list with
name:
linellUnitFlexString09
.
LinellUnitFlexString1 Unit Flex String-10 Unit Flex String-10 The flex field of the java.lang.String Yes Yes
0 line load list with
name:
linellUnitFlexString10
.
LinellUnitFlexString1 Unit Flex String-11 Unit Flex String-11 The flex field of the java.lang.String Yes Yes
1 line load list with
name:
linellUnitFlexString11
.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 433
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
LinellUnitFlexString1 Unit Flex String-12 Unit Flex String-12 The flex field of the java.lang.String Yes Yes
2 line load list with
name:
linellUnitFlexString12
.
LinellUnitFlexString1 Unit Flex String-13 Unit Flex String-13 The flex field of the java.lang.String Yes Yes
3 line load list with
name:
linellUnitFlexString13
.
LinellUnitFlexString1 Unit Flex String-14 Unit Flex String-14 The flex field of the java.lang.String Yes Yes
4 line load list with
name:
linellUnitFlexString14
.
LinellUnitFlexString1 Unit Flex String-15 Unit Flex String-15 The flex field of the java.lang.String Yes Yes
5 line load list with
name:
linellUnitFlexString15
.
LinellVesselVisit Visit Ref Visit Vessel Visit Id for java.lang.String Yes Yes
which the Load list
pertains to
LinellVgmVerifierEnti VGM Verifier VGM Verifier The VGM verifier java.lang.String Yes Yes
ty entity weight

2.2.43 Vessel Crane Statistics

The Vessel Crane Statistics reporting entity is used to generate crane statistics for a selected vessel. Crane statistics includes all crane shifts defined in XPS,
along with the crane activities, move counts, move types, etc.

You can use the Vessel Inspector Actions Generate Vessel Statistics option to generate the vessel statistics or you can manually enter the information.

Also see Vessel Crane Statistics - Delays (on page 442)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 434
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
ATA Act. Time of Arrival ATA The actual time of java.util.Date Yes Yes
arrival of the carrier.
ATD Act. Time of Depart. ATD The actual time of java.util.Date Yes Yes
departure of the
carrier.
CraneBreakBulkMov Break Bulk Moves Break Bulk Moves The amount of bulk java.lang.Long Yes Yes
es units moved.
CraneCargoMoves The amount of total java.lang.Long Yes No
cargo moves (full
and empty
containers and
breakbulk) - is never
null!
CraneEmptyContain Empty Containers Empty Containers The amount of empty java.lang.Long Yes Yes
erMoves containers moved.
CraneEmptyTeuMov Empty Teus Empty Teus The amount of empty java.lang.Long Yes Yes
es TEU moves.
CraneEndWorkTime Shift End Shift End The time the CHE java.util.Date Yes Yes
ended the work.
CraneFullContainer Full Containers Full Containers The amount of full java.lang.Long Yes Yes
Moves containers moved.
CraneFullTeuMoves Full Teus Full Teus The amount of full java.lang.Long Yes Yes
TEU moves.
CraneGrossWorkTim The working hours of java.lang.Double Yes No
e the crane (precision
1 digit after decimal
point) - is never null!
CraneHatchCoverMo Hatch Cover Moves Hatch Cover Moves The amount of hatch java.lang.Long Yes Yes
ves cover moves.
CraneId CHE Name CHE Name The id/name of the java.lang.String Yes Yes
crane.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 435
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
CraneNetWorkTime The working hours of java.lang.Double Yes No
the crane minus the
delays time
(precision 3 digits
after decimal point) -
is never null!
CraneShiftOnBoardB SOB Line SOB Line The amount of shifts java.lang.Long Yes Yes
yLineCount on board initiated by
the line operator.
CraneShiftOnBoardB SOB Terminal SOB Terminal The amount of shifts java.lang.Long Yes Yes
yTerminalCount on board initiated by
the terminal.
CraneShiftOnBoardC SOB Total SOB Total The amount of shifts java.lang.Long Yes Yes
ount on board.
CraneShiftOnBoard SOB Others SOB Others The amount of shifts java.lang.Long Yes Yes
OtherCount on board not initiated
by terminal or line
operator.
CraneStartWorkTime Shift Start Shift Start The time the CHE java.util.Date Yes Yes
started the work.
CraneTotalContainer The amount of total java.lang.Long Yes No
Moves container moves (full
and empty) - is never
null!
CraneTotalDelayTim The amount of total java.lang.Double Yes No
e delays in hours
(precision 3 digits
after decimal point) -
is never null!
CraneTotalMoves Total Moves Total Moves The total number of java.lang.Long Yes Yes
moves performed by
the crane.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 436
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
CraneTotalTEUMove The amount of total java.lang.Long Yes No
s TEU moves (full and
empty) - is never
null!
CustomsId Customs ID Customs ID The external java.lang.String Yes Yes
customs id of the
vessel visit.
ETA Est. Time of Arrival ETA The estimated time java.util.Date Yes Yes
of arrival of the
carrier.
ETD Est. Time of Depart. ETD The estimated time java.util.Date Yes Yes
of departure of the
carrier.
InboundVoyageNbr Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
number.
NetProductivityRate The amount of java.lang.Double Yes No
container moves for
the amount of hours
between the times
'Labor On Board' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null
NetProductivityTime The amount of hours java.lang.Double Yes No
between the times
'Labor On Board' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null
OutCallNumber Outbound Call Nbr Out Call Nbr The outbound call java.lang.String Yes Yes
number.
OutboundVoyageNbr Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
voyage number.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 437
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
OverallProductivityR The amount of java.lang.Double Yes No
ate container moves for
the amount of hours
between the times
'Pilot on Board' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null!
OverallProductivityTi The amount of hours java.lang.Double Yes No
me between the times
'Pilot on Board' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null!
ProductivityRate The amount of java.lang.Double Yes No
container moves for
the amount of hours
between the times
'Vessel ATA' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null
ProductivityTime The amount of hours java.lang.Double Yes No
between the times
'Vessel ATA' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 438
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
TimeBeginReceive Begin Receive Begin Receive The earliest time at java.util.Date Yes No
which containers for
a vessel can be
received at the
facility for the vessel.
TimeCargoCutoff Dry Cutoff DryCutoff The latest time that a java.util.Date Yes No
dry container can be
received at the
facility for the vessel.
TimeDischargeComp Discharge Complete Discharge Complete The time at which all java.util.Date Yes No
lete inbound containers
were completely
discharged.
TimeEndWork Time End Work End Work The time that loading java.util.Date Yes No
and unloading the
vessel ends.
TimeFirstAvailability Begin Delivery Begin Delivery The earliest time java.util.Date Yes No
cargo discharged off
this vessel can be
picked up.
TimeHazardCutoff Hazard Cutoff HazCutoff The latest time that a java.util.Date Yes No
hazardous container
can be received at
the facility for the
vessel.
TimeLaborOffBoard Labor Off Board LaborOffBoard The date that labor java.util.Date Yes No
departs the ship.
TimeLaborOnBoard Labor On Board LaborOnBoard The date that labor java.util.Date Yes No
boards the ship.
TimeOffPortArrive Off Port Arrival OPA The off-port arrival java.util.Date Yes No
time.
TimeOffPortDepart Off Port Departure OPD The off-port java.util.Date Yes No
departure time.
TimePilotOffBoard Pilot Off Board PilotOffBoard The time the pilot java.util.Date Yes No
leaves the ship.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 439
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
TimePilotOnBoard Pilot On Board PilotOnBoard The date that the java.util.Date Yes No
pilot boards the ship.
TimeReeferCutoff Reefer Cutoff ReeferCutoff The latest time that a java.util.Date Yes No
reefer container can
be received at the
facility for the vessel.
TimeStartWork Time Start Work Start Work The time that loading java.util.Date Yes No
and unloading the
vessel begins.
VesselId Visit Ref Visit The id of the vessel java.lang.String Yes Yes
visit
VesselLineOperator Id Id The vessel's line java.lang.String Yes Yes
operator.
VesselName Name Name The name of the java.lang.String Yes Yes
vessel.
VesselService ID ID The service id java.lang.String Yes Yes
(rotation) that applies
to the carrier.
VvFlexDate01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #01 Date #01 vessel visit details
with name:
vvFlexDate01.
VvFlexDate02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #02 Date #02 vessel visit details
with name:
vvFlexDate02.
VvFlexDate03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #03 Date #03 vessel visit details
with name:
vvFlexDate03.
VvFlexDate04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #04 Date #04 vessel visit details
with name:
vvFlexDate04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 440
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexDate05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #05 Date #05 vessel visit details
with name:
vvFlexDate05.
VvFlexDate06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #06 Date #06 vessel visit details
with name:
vvFlexDate06.
VvFlexDate07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #07 Date #07 vessel visit details
with name:
vvFlexDate07.
VvFlexDate08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #08 Date #08 vessel visit details
with name:
vvFlexDate08.
VvFlexString01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #01 String #01 vessel visit details
with name:
vvFlexString01.
VvFlexString02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #02 String #02 vessel visit details
with name:
vvFlexString02.
VvFlexString03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #03 String #03 vessel visit details
with name:
vvFlexString03.
VvFlexString04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #04 String #04 vessel visit details
with name:
vvFlexString04.
VvFlexString05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #05 String #05 vessel visit details
with name:
vvFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 441
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexString06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #06 String #06 vessel visit details
with name:
vvFlexString06.
VvFlexString07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #07 String #07 vessel visit details
with name:
vvFlexString07.
VvFlexString08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #08 String #08 vessel visit details
with name:
vvFlexString08.

2.2.44 Vessel Crane Statistics - Delays

The Vessel Crane Statistics - Delays reporting entity allows you to report on crane delay codes, delay date/time, delay duration, total number of delays, etc.,
that occurred when a specific vessel was worked. While reporting crane delays, you can filter data based on the date/time or, shift start and shift end times.

You can use the Vessel Inspector Actions Generate Vessel Statistics option to generate the vessel statistics or you can manually enter the information.

External Tag Long Label Short Label Description Type In Design In Sort
ATA Act. Time of Arrival ATA The actual time of java.util.Date Yes Yes
arrival of the carrier.
ATD Act. Time of Depart. ATD The actual time of java.util.Date Yes Yes
departure of the
carrier.
CraneBreakBulkMov Break Bulk Moves Break Bulk Moves The amount of bulk java.lang.Long Yes Yes
es units moved.
CraneCargoMoves The amount of total java.lang.Long Yes No
cargo moves (full
and empty
containers and
breakbulk) - is never
null!
CraneDelayCode Delay Type Delay Type The crane delay type java.lang.String Yes No

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 442
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
CraneDelayDate Date/Time Date The date and time java.util.Date Yes Yes
the delay occurred.
CraneDelayDescripti Delay Description Delay Description The crane delay type java.lang.String Yes No
on
CraneDelayMinutes Minutes Minutes The time of the delay java.lang.Long Yes No
(in minutes).
CraneDelayRemarks Remarks Remarks Remarks recorded java.lang.String Yes No
with this delay.
CraneEmptyContain Empty Containers Empty Containers The amount of empty java.lang.Long Yes Yes
erMoves containers moved.
CraneEmptyTeuMov Empty Teus Empty Teus The amount of empty java.lang.Long Yes Yes
es TEU moves.
CraneEndWorkTime Shift End Shift End The time the CHE java.util.Date Yes Yes
ended the work.
CraneFullContainer Full Containers Full Containers The amount of full java.lang.Long Yes Yes
Moves containers moved.
CraneFullTeuMoves Full Teus Full Teus The amount of full java.lang.Long Yes Yes
TEU moves.
CraneGrossWorkTim The working hours of java.lang.Double Yes No
e the crane (precision
1 digit after decimal
point) - is never null!
CraneHatchCoverMo Hatch Cover Moves Hatch Cover Moves The amount of hatch java.lang.Long Yes Yes
ves cover moves.
CraneId CHE Name CHE Name The id/name of the java.lang.String Yes Yes
crane.
CraneNetWorkTime The working hours of java.lang.Double Yes No
the crane minus the
delays time
(precision 3 digits
after decimal point) -
is never null!

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 443
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
CraneShiftOnBoardB SOB Line SOB Line The amount of shifts java.lang.Long Yes Yes
yLineCount on board initiated by
the line operator.
CraneShiftOnBoardB SOB Terminal SOB Terminal The amount of shifts java.lang.Long Yes Yes
yTerminalCount on board initiated by
the terminal.
CraneShiftOnBoardC SOB Total SOB Total The amount of shifts java.lang.Long Yes Yes
ount on board.
CraneShiftOnBoard SOB Others SOB Others The amount of shifts java.lang.Long Yes Yes
OtherCount on board not initiated
by terminal or line
operator.
CraneStartWorkTime Shift Start Shift Start The time the CHE java.util.Date Yes Yes
started the work.
CraneTotalContainer The amount of total java.lang.Long Yes No
Moves container moves (full
and empty) - is never
null!
CraneTotalDelayTim The amount of total java.lang.Double Yes No
e delays in hours
(precision 3 digits
after decimal point) -
is never null!
CraneTotalMoves Total Moves Total Moves The total number of java.lang.Long Yes Yes
moves performed by
the crane.
CraneTotalTEUMove The amount of total java.lang.Long Yes No
s TEU moves (full and
empty) - is never
null!
CustomsId Customs ID Customs ID The external java.lang.String Yes Yes
customs id of the
vessel visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 444
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
ETA Est. Time of Arrival ETA The estimated time java.util.Date Yes Yes
of arrival of the
carrier.
ETD Est. Time of Depart. ETD The estimated time java.util.Date Yes Yes
of departure of the
carrier.
InboundVoyageNbr Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
number.
NetProductivityRate The amount of java.lang.Double Yes No
container moves for
the amount of hours
between the times
'Labor On Board' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null
NetProductivityTime The amount of hours java.lang.Double Yes No
between the times
'Labor On Board' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null
OutCallNumber Outbound Call Nbr Out Call Nbr The outbound call java.lang.String Yes Yes
number.
OutboundVoyageNbr Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
voyage number.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 445
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
OverallProductivityR The amount of java.lang.Double Yes No
ate container moves for
the amount of hours
between the times
'Pilot on Board' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null!
OverallProductivityTi The amount of hours java.lang.Double Yes No
me between the times
'Pilot on Board' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null!
ProductivityRate The amount of java.lang.Double Yes No
container moves for
the amount of hours
between the times
'Vessel ATA' and
'Labor Off Board'
(Units/Time)
(precision 1 digit
after decimal point) -
is never null
ProductivityTime The amount of hours java.lang.Double Yes No
between the times
'Vessel ATA' and
'Labor Off Board'
(precision 1 digit
after decimal point) -
is never null

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 446
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
TimeBeginReceive Begin Receive Begin Receive The earliest time at java.util.Date Yes No
which containers for
a vessel can be
received at the
facility for the vessel.
TimeCargoCutoff Dry Cutoff DryCutoff The latest time that a java.util.Date Yes No
dry container can be
received at the
facility for the vessel.
TimeDischargeComp Discharge Complete Discharge Complete The time at which all java.util.Date Yes No
lete inbound containers
were completely
discharged.
TimeEndWork Time End Work End Work The time that loading java.util.Date Yes No
and unloading the
vessel ends.
TimeFirstAvailability Begin Delivery Begin Delivery The earliest time java.util.Date Yes No
cargo discharged off
this vessel can be
picked up.
TimeHazardCutoff Hazard Cutoff HazCutoff The latest time that a java.util.Date Yes No
hazardous container
can be received at
the facility for the
vessel.
TimeLaborOffBoard Labor Off Board LaborOffBoard The date that labor java.util.Date Yes No
departs the ship.
TimeLaborOnBoard Labor On Board LaborOnBoard The date that labor java.util.Date Yes No
boards the ship.
TimeOffPortArrive Off Port Arrival OPA The off-port arrival java.util.Date Yes No
time.
TimeOffPortDepart Off Port Departure OPD The off-port java.util.Date Yes No
departure time.
TimePilotOffBoard Pilot Off Board PilotOffBoard The time the pilot java.util.Date Yes No
leaves the ship.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 447
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
TimePilotOnBoard Pilot On Board PilotOnBoard The date the pilot java.util.Date Yes No
boards the ship.
TimeReeferCutoff Reefer Cutoff ReeferCutoff The latest time that a java.util.Date Yes No
reefer container can
be received at the
facility for the vessel.
TimeStartWork Time Start Work Start Work The time that loading java.util.Date Yes No
and unloading the
vessel begins.
VesselId Visit Ref Visit The id of the vessel java.lang.String Yes Yes
visit.
VesselLineOperator Id Id The vessel's line java.lang.String Yes Yes
operator.
VesselName Name Name The name of the java.lang.String Yes Yes
vessel.
VesselService ID ID The service id java.lang.String Yes Yes
(rotation) that applies
to the carrier.
VvFlexDate01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #01 Date #01 vessel visit details
with name:
vvFlexDate01.
VvFlexDate02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #02 Date #02 vessel visit details
with name:
vvFlexDate02.
VvFlexDate03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #03 Date #03 vessel visit details
with name:
vvFlexDate03.
VvFlexDate04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #04 Date #04 vessel visit details
with name:
vvFlexDate04.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 448
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Crane Statistics - Delays

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexDate05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #05 Date #05 vessel visit details
with name:
vvFlexDate05.
VvFlexDate06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #06 Date #06 vessel visit details
with name:
vvFlexDate06.
VvFlexDate07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #07 Date #07 vessel visit details
with name:
vvFlexDate07.
VvFlexDate08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #08 Date #08 vessel visit details
with name:
vvFlexDate08.
VvFlexString01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #01 String #01 vessel visit details
with name:
vvFlexString01.
VvFlexString02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #02 String #02 vessel visit details
with name:
vvFlexString02.
VvFlexString03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #03 String #03 vessel visit details
with name:
vvFlexString03.
VvFlexString04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #04 String #04 vessel visit details
with name:
vvFlexString04.
VvFlexString05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #05 String #05 vessel visit details
with name:
vvFlexString05.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 449
Confidential -- Proprietary
 Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexString06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #06 String #06 vessel visit details
with name:
vvFlexString06.
VvFlexString07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #07 String #07 vessel visit details
with name:
vvFlexString07.
VvFlexString08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #08 String #08 vessel visit details
with name:
vvFlexString08.

2.2.45 Vessel Visit

The Vessel Visit reporting entity represents the data related to a vessel visit.

External Tag Long Label Short Label Description Type In Design In Sort
Classification Classification Classification The classification of java.lang.String Yes Yes
Vessel Visit: 'DS' for
Deep Sea, 'F' for
Feeder and 'B' for
Barge
DataSource Data Source Source The data source for java.lang.String Yes Yes
the vessel visit
details.
DurationPeriodicRec Duration Periodic Duration Periodic The cyclic duration of java.lang.Long Yes Yes
ur Recur Recur a recurring event.
EstimatedBreakBulk BBK Disch bbk-d java.lang.Long Yes Yes
DischargeCount
EstimatedBreakBulk BBK Load bbk-l java.lang.Long Yes Yes
LoadCount
EstimatedDischarge Discharge dsch java.lang.Long Yes Yes
Count

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 450
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
EstimatedLoadCount Load load java.lang.Long Yes Yes
EstimatedRestowCo Restow rstw java.lang.Long Yes Yes
unt
EstimatedShiftCount Shift shft java.lang.Long Yes Yes
IbCallNbr Inbound Call Nbr In Call Nbr The inbound call java.lang.String Yes Yes
number.
IbCustomsVoyageNb Inbound Customs In Cust.Vyg The inbound java.lang.String Yes Yes
r Vyg Nbr customs voyage
number.
IbVesselCaptain Inbound Captain Inbound Captain The captain of the java.lang.String Yes Yes
inbound vessel.
IbVoyageNbr Inbound Voyage I/B Vyg The inbound voyage java.lang.String Yes Yes
number.
IsCommonCarrier Common Carrier CCR The visiting vessel is java.lang.Boolean Yes Yes
a common carrier. A
common carrier can
carry cargo from any
line operator.
IsDrayOff Dray Off Dray Off The container is a java.lang.Boolean Yes Yes
dray-off.
IsNoClientAccess Locked Locked The client cannot java.lang.Boolean Yes Yes
make changes to the
booking.
LastBerthingQuayId java.lang.String Yes No
LastBerthingQuayNa java.lang.String Yes No
me
LastBerthingSideTo java.lang.String Yes No
LifeCycleState Life Cycle Life Cycle Entity Life Cycle java.lang.String Yes Yes
State
Notes Visit Notes Notes java.lang.String Yes Yes
ObCallNbr Outbound Call Nbr Out Call Nbr The outbound call java.lang.String Yes Yes
number.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 451
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
ObCustomsVoyageN Outbound Customs Out Cust.Out Vyg The outbound java.lang.String Yes Yes
br Vyg Nbr customs voyage
number.
ObVesselCaptain Outbound Captain Outbound Captain The captain of the java.lang.String Yes Yes
outbound vessel.
ObVoyageNbr Outbound Voyage O/B Vyg The outbound java.lang.String Yes Yes
voyage number.
StackingStrategy Stacking Strategy StkStrtgy The type of stacking java.lang.String Yes Yes
strategy.
TimeActualArrival Act. Time of Arrival ATA The actual time of java.util.Date Yes Yes
arrival.
TimeActualDeparture Act. Time of Depart. ATD The actual time of java.util.Date Yes Yes
departure.
TimeBeginReceive Begin Receive Begin Receive The earliest time that java.util.Date Yes Yes
a dry container can
be received at the
facility for the vessel.
TimeCargoCutoff Dry Cutoff DryCutoff The latest time that a java.util.Date Yes Yes
dry container can be
received at the
facility for the vessel.
TimeDischargeComp Discharge Complete Discharge Complete The time at which all java.util.Date Yes Yes
lete inbound containers
were completely
discharged.
TimeEndWork Time End Work End Work The time that loading java.util.Date Yes Yes
and unloading the
vessel ends.
TimeEstimatedArrival Est. Time of Arrival ETA The estimated time java.util.Date Yes Yes
of arrival.
TimeEstimatedDepar Est. Time of Depart. ETD The estimated time java.util.Date Yes Yes
ture of departure.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 452
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
TimeFirstAvailability Begin Delivery Begin Delivery The earliest time java.util.Date Yes Yes
cargo discharged off
this vessel can be
picked up.
TimeHazCutoff Hazard Cutoff HazCutoff The latest time that a java.util.Date Yes Yes
hazardous container
can be received at
the facility for the
vessel.
TimeIbFirstFreeDay First Free Day First Free Day The day free storage java.util.Date Yes Yes
begins for inbound
cargo.
TimeLaborOffBoard Labor Off Board LaborOffBoard The date that labor java.util.Date Yes Yes
departs the ship.
TimeLaborOnBoard Labor On Board LaborOnBoard The date that labor java.util.Date Yes Yes
boards the ship.
TimeOffPortArrive Off Port Arrival OPA The off-port arrival. java.util.Date Yes Yes
TimeOffPortDepart Off Port Departure OPD The off-port java.util.Date Yes Yes
departure.
TimePeriodicEnd Time Periodic End Time Periodic End The end of a time java.util.Date Yes Yes
period.
TimePeriodicStart Time Periodic Start Time Periodic Start The start of a time java.util.Date Yes Yes
period.
TimePilotOffBoard Pilot Off Board PilotOffBoard The time the pilot java.util.Date Yes Yes
leaves the ship.
TimePilotOnBoard Pilot On Board PilotOnBoard The time the pilot java.util.Date Yes Yes
boards the ship.
TimePublishedEta Published ETA PETA The vessel's java.util.Date Yes Yes
published estimated
time of arrival.
TimePublishedEtd Published ETD PETD The vessel's java.util.Date Yes Yes
published estimated
time of departure.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 453
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
TimeReeferCutoff Reefer Cutoff ReeferCutoff The latest time that a java.util.Date Yes Yes
reefer container can
be received at the
facility for the vessel.
TimeStartWork Time Start Work Start Work The time that loading java.util.Date Yes Yes
and unloading the
vessel begins.
VesselCaptain Captain Captain The captain of the java.lang.String Yes Yes
vessel.
VesselClassBaysAft Bays Aft Bays Aft The number of bays java.lang.Long Yes Yes
aft of the bridge.
VesselClassBaysFor Bays Forward Bays Forward The number of bays java.lang.Long Yes Yes
ward forward of the bridge.
VesselClassBeamC Beam Beam The vessel's beam java.lang.Long Yes Yes
m (width) in
centimeters.
VesselClassBowOve Bow Overhang Bow Ovrhng The distance from java.lang.Long Yes Yes
rhangCm the bow to the first
bay in centimeters.
VesselClassBridgeTo Bridge To Bow Bridge-Bow The distance from java.lang.Long Yes Yes
BowCm Length the bridge to the bow
in centimeters.
VesselClassGrossRe Gross Registered GRT The capacity of java.lang.Double Yes Yes
gTon Tons spaces, in cubic feet,
within the hull and
above deck available
for cargo, stores,
passengers, and
crew, divided by 100.
One gross ton is
equivalent to 100
cubic feet.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 454
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VesselClassId Identity Id A unique identifier for java.lang.String Yes Yes
the vessel class. The
class defines the
physical
configuration of the
vessel.
VesselClassIsActive Is Active SPARCS Is Active Sparcs The vessel class is java.lang.Boolean Yes Yes
active in SPARCS.
VesselClassIsSelfSu Is Self Sustaining Is Self Sustaining The vessel class is java.lang.Boolean Yes Yes
staining equipped with its
own crane for
moving containers
on and off the ship.
Can be used for
billing purposes.
VesselClassLoaCm LOA LOA The vessel class java.lang.Long Yes Yes
total length in
centimeters.
VesselClassName Name Name The name of the java.lang.String Yes Yes
vessel class.
VesselClassNetRegT Net Registered Tons NRT A value derived from java.lang.Double Yes Yes
on the gross tonnage by
subtracting spaces
used for crew,
navigation
machinery, and fuel.
VesselClassNotes Note Note A short note java.lang.String Yes Yes
describing the vessel
class.
VesselClassSternOv Stern Overhang Stern Ovrhng The distance from java.lang.Long Yes Yes
erhangCm the last bay to the
stern of ship in
centimeters.
VesselClassVesselTy Type Type The basic type of the java.lang.String Yes Yes
pe vessel class.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 455
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VesselCountry Country Name Country Name The country from java.lang.String Yes Yes
which the vessel
originates.
VesselDocumentatio Documentation Nbr DocumentationNbr A documentation java.lang.String Yes Yes
nNbr number that can be
used if there is no
Lloyds of London ID.
VesselId Vessel Identity Vessel Id The identity of the java.lang.String Yes Yes
vessel.
VesselIsActive Is Active Is Active The vessel is active. java.lang.Boolean Yes Yes
VesselLineOperator Id Id The vessel's line java.lang.String Yes Yes
operator ID.
VesselLineOperator Name Name The name of the java.lang.String Yes Yes
Name vessel's line
operator.
VesselLloydsId Lloyds Identity Lloyds Id A unique identifier for java.lang.String Yes Yes
the hull of the vessel.
A Lloyd's ID is issued
by the insurance
company, Lloyd's of
London.
VesselName Name Name The name of the java.lang.String Yes Yes
vessel.
VesselNotes Notes Notes A short note about java.lang.String Yes Yes
the vessel.
VesselOwnerId Id Id The owner id of the java.lang.String Yes Yes
vessel.
VesselRadioCallSign Radio CallSign RadioCallSign The radio call sign java.lang.String Yes Yes
assigned by the
national licensing
authority for the
country of origin. A
call sign is a unique
designation for a
transmitting station..

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 456
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VesselService ID ID The service id java.lang.String Yes Yes
(rotation) that applies
to the carrier.
VesselServiceName Service Name Name The service name java.lang.String Yes Yes
(rotation) that applies
to the carrier.
VesselServiceRegistr Service Registry SrvcRegNbr The U.N. country java.lang.String Yes Yes
yNbr Number code or ships
registry.
VesselStowageSche Stowage Scheme StowageScheme The stowage java.lang.String Yes Yes
me scheme for the
vessel.
VesselTemperatureU Temperatures Temps The units of java.lang.String Yes Yes
nits temperature used on
the ship, Centigrade
or Fahrenheit.
VesselUnitSystem Measurements Msrmnts The units of java.lang.String Yes Yes
measurement used
on the ship
(excluding
temperature).
VesselVisitId Visit Ref Visit A unique reference java.lang.String Yes Yes
code for the carrier
visit.
VesselVisitNbr Call Number Number The vessel visit java.lang.Long Yes Yes
number.
VisitPhase Visit Phase Phase The visit phase that java.lang.String Yes Yes
applies to the carrier.
VvFlexDate01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #01 Date #01 vessel visit details
with name:
vvFlexDate01.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 457
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexDate02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #02 Date #02 vessel visit details
with name:
vvFlexDate02.
VvFlexDate03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #03 Date #03 vessel visit details
with name:
vvFlexDate03.
VvFlexDate04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #04 Date #04 vessel visit details
with name:
vvFlexDate04.
VvFlexDate05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #05 Date #05 vessel visit details
with name:
vvFlexDate05.
VvFlexDate06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #06 Date #06 vessel visit details
with name:
vvFlexDate06.
VvFlexDate07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #07 Date #07 vessel visit details
with name:
vvFlexDate07.
VvFlexDate08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.util.Date Yes Yes
Date #08 Date #08 vessel visit details
with name:
vvFlexDate08.
VvFlexString01 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #01 String #01 vessel visit details
with name:
vvFlexString01.
VvFlexString02 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #02 String #02 vessel visit details
with name:
vvFlexString02.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 458
Confidential -- Proprietary
Part 2: Reports Configuration Reporting Entities
Vessel Visit

External Tag Long Label Short Label Description Type In Design In Sort
VvFlexString03 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #03 String #03 vessel visit details
with name:
vvFlexString03.
VvFlexString04 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #04 String #04 vessel visit details
with name:
vvFlexString04.
VvFlexString05 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #05 String #05 vessel visit details
with name:
vvFlexString05.
VvFlexString06 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #06 String #06 vessel visit details
with name:
vvFlexString06.
VvFlexString07 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #07 String #07 vessel visit details
with name:
vvFlexString07.
VvFlexString08 Vessel Visit Flex Vessel Visit Flex The flex field of the java.lang.String Yes Yes
String #08 String #08 vessel visit details
with name:
vvFlexString08.
exportManifestDate Export Manifest Date Export Mnft Date Manifest date of java.util.Date Yes Yes
export manifest
exportManifestNbr Export Manifest Export Mnft Nbr Manifest number java.lang.String Yes Yes
Number received for export
manifest
importManifestDate Import Manifest Date Import Mnft Date Manifest date of java.util.Date Yes Yes
import manifest
importManifestNbr Import Manifest Import Mnft Nbr Manifest number java.lang.String Yes Yes
Number received for import
manifest

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 459
Confidential -- Proprietary
2.3 Monitoring and Reporting Configuration
In This Section

Monitoring and Reporting Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Monitor and Analytics configuration settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Reporting job settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 460
Confidential -- Proprietary
 Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitoring and Reporting Privileges

2.3.1 Monitoring and Reporting Privileges

2.3.1.1 Media Assets Privileges

These privileges allow you to add, edit, and remove media objects used for reports and main N4 frame.

ID Name Description License Required Option Name

MEDIA_ASSET_ADD Media Assets - Add Add media assets CORE_FEAT System Foundation II
MEDIA_ASSET_DEL Media Assets - Delete Delete media assets CORE_FEAT System Foundation II
ETE
MEDIA_ASSET_EDIT Media Assets - Edit Edit media assets CORE_FEAT System Foundation II
MEDIA_ASSET_VIE Media Assets - View View media assets CORE_FEAT System Foundation II
W

2.3.1.2 Monitor Privileges

The following privileges control functionality found in the Operations Dashboards menu.

Only available with Monitor license.

ID Name Description License Required Option Name

DASHBOARD_ADD Dashboard - Add Add dashboards MONITOR Monitor
DASHBOARD_DELE Dashboard - Delete Delete dashboards MONITOR Monitor
TE
DASHBOARD_EDIT Dashboard - Edit Edit existing MONITOR Monitor
dashboards
DASHBOARD_VIEW Dashboard - View View the dashboard MONITOR Monitor
GADGET_ADD Gadget - Add Add a gadget to the MONITOR Monitor
dashboard
GADGET_EDIT Gadget - Edit Edit the properties of MONITOR Monitor
a gadget
GADGET_MODIFY_ Gadget - Modify Modify a gadget's MONITOR Monitor
DEFAULT_PROPERT Default Properties default values for all
IES users
GADGET_VIEW Gadget - View View dashboards in MONITOR Monitor
the Dashboards menu
MONITOR_ADMIN Monitor - Admin Manipulate monitor MONITOR Monitor
jobs, such as starting
and stopping the
harvester job
VIEW_MENSA_TABL Monitor - Table View View Monitor tables MONITOR Monitor
ES

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 461
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitoring and Reporting Privileges

ID Name Description License Required Option Name

MANAGE_YARD_AR Yard Area Code Table View the Manage MONITOR Monitor
EA_CODE - View Yard Area Codes
menu and add, edit,
and dlete area codes
in the Manage Yard
Area Codes view.

The minimum scope for adding, deleting, and editing dashboards is Facility. Users created on the Yard level
cannot manage dashboards.

2.3.1.3 Report Privileges

The following table lists privileges related to the creation, modification, and running of reports.

ID Name Description License Required Option Name

REPORT_DEFINITIO Report Definitions - Add report definitions CORE_FEAT System Foundation II
NS Add
REPORTS_RUN Report Definitions Run reports using the CORE_FEAT System Foundation II
Actions - Run report Report Definitions
Actions menu
REPORTS_DESIGN Report Designs - Add Add report designs CORE_FEAT System Foundation II

REPORTING_JOB_D Reporting Jobs - Add Add reporting jobs CORE_FEAT System Foundation II
EFINITION_ADD
REPORTING_JOB_D Reporting Jobs - Delete reporting jobs CORE_FEAT System Foundation II
EFINITION_DELETE Delete
REPORTING_JOB_D Reporting Jobs - Edit Edit reporting jobs CORE_FEAT System Foundation II
EFINITION_EDIT
REPORTING_JOB_D Reporting Jobs - View View the reporting CORE_FEAT System Foundation II
EFINITION_VIEW jobs
REPORTING_JOB_D Reporting Jobs Schedule, un- CORE_FEAT System Foundation II
EFINITION_SCHEDU Actions - All schedule, and
LE execute a reporting
job on demand

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 462
Confidential -- Proprietary
 Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitor and Analytics configuration settings

RUN_ADVANCED_R Run Advanced MONITOR, Monitor, Analytics

EPORTS Reports Available only ANALYTICS
with Monitor
and Analytics
license.

Run CHE and Yard

productivity reports
and view the related
report designs and
definitions. Also run
the Yard Block
Statistics and the
CHE Statistics
background jobs.
This privilege
becomes available
with either the Monitor
or the Analytics
license.

2.3.1.4 Terminal Monitor Privileges

ID Name Description License Required Option Name
POW_OVERVIEW_ POW Overview - View POW Overview AUTOMATION,ASC, AYC Manager
VIEW View AGV,ASH
POW_MONITOR_VI POW Monitor - View View POW Monitor CORE_FEAT System Foundation
EW II
ASC_SCHEDULE_ ASC Schedule View ASC Schedule AUTOMATION,ASC AYC Manager
MONITOR_VIEW Monitor - View Monitor
ACTIVE_ALARMS_ Active Alarms - View View Active Alarms CORE_FEAT System Foundation
VIEW II
ACTIVE_ALARMS_ Active Alarms - Assign Active CORE_FEAT System Foundation
ASSIGN Assign Alarms II
ALARMS_RESOLV Alarms - Resolve Resolve Alarms CORE_FEAT System Foundation
E (Active Alarms II
view and All Alarms
view)
ALL_ALARMS_VIE All Alarms - View View All Alarms CORE_FEAT System Foundation
W II

2.3.2 Monitor and Analytics configuration settings

You can use the following settings to manage data retrieval from the XPS statistics server. In N4 this data is displayed
in the form of various Dashboard gadgets.

You need a license to be able to view the Dashboards menu. To ensure you have a current license, contact
your Professional Services representative.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 463
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitor and Analytics configuration settings

ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP)
Specifies the host name or IP address of the XPS client used as the statistics server. See Configuring settings for the
XPS statistics server (on page 475).

ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT)
Specify the port number of the XPS client. The default value for ARGOMONITOR003 is 13301.

ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ)
Specify the frequency, in minutes, at which the Yard Block Statistics job retrieves data from the XPS statistics server.
N4 makes this data available in yard-related gadgets and reports. To facilitate calculating the daily average utilization,
the job should run at least every hour on the hour. If you want to get utilization updates at regular time intervals, we
recommend setting the job to run at intervals that are a divisor or factor of 60, such as 10, 15, 20, 30, or 60. To ensure
accurate results, determine how Analytics rounds off the Extract Date to the closest minutes when generating the
utilization reports. For example, at the default setting of 30 minutes, if you enter an Extract Date between 9:31 to 9:59,
the actual time stamp that the Reefer Plug Utilization report (on page 590) uses to select yard utilization data is 9:30.
Navis recommends not to change this setting over time. Otherwise, scenarios like the following may occur:

• From 1/1 to 6/1, you set the parameter to 30 minutes. You change the setting to 20 minutes on 6/2. The same day,
you run the Yard Reefer Plug Utilization report or the Yard Stack Block Utilization report with an Extract Date of
6/1 1:40. In this case, N4 rounds off the timestamp to 6/1 1:20 and returns no utilization data.
• From 1/1 to 6/1, you set the parameter to 20 minutes. You change the setting to 30 minutes on 1/8. On 6/2, you run
the Reefer Plug Utilization report or the Stack Block Utilization report (on page 589) with an Extract Date of 6/1
1:40. In this case, N4 rounds off the timestamp to 6/1 1:30 and returns no utilization data.
Also specify the refresh rate of the Yard Utilization gadget. For example, when ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) has a value of 10, the Yard Utilization gadget tries to retrieve yard block
statistics extracted within the last 10 minutes. If it does not find any statistics extracted within this time frame, it looks at
the previous 10 minutes. It keeps checking back in 10-minute intervals, up to the last hour. If N4 cannot find any yard
block statistics extracted within the last hour, the gadget goes blank.

This is a global setting that you can specify within these values:

Default: 30

Minimum: 10

Maximum: 60

ARGOMONITOR006 (BREAK_BULK_CRANE_ACTIVITY_ID)
Specify the crane delay type that designates crane activity involving break bulk. The default value is B3.

ARGOMONITOR007 (HATCH_LID_CRANE_ACTIVITY_ID)
Specify the crane delay type that designates crane activity involving hatch lids. The default value is B5.

ARGOMONITOR008 (TWIST_LOCK_CRANE_ACTIVITY_ID)
Specify the crane delay type that designates crane activity involving twist locks. The default value is B2.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 464
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitor and Analytics configuration settings

ARGOMONITOR009 (EGEAR_CRANE_ACTIVITY_ID)
Specify the crane delay type that designates crane activity involving egear.The default value is B4.

ARGOMONITOR010 (MENSA_SERVER_SOCKET_TIMEOUT)'
You can use this setting ARGOMONITOR010 (MENSA_SERVER_SOCKET_TIMEOUT) to determine the number of
seconds after the connect timeout error that the yard statistics job runs again.

The default value for the setting is 20 seconds. When the yard statistics job displays the connecting timeout error, N4
logs the error and executes the job again based on the interval that is set in the setting.

FRMCARINA033 (GADGET_REFRESH_PERIOD)
Specify the interval (in seconds) at which N4 refreshes the data in all gadgets. If you set FRMCARINA033 to '0', it turns
off the setting. A value of less than 10 is not recommended.

Default: 180

Minimum: 5

Maximum: 300

MENCHEMETRICS001 (CHE_METRICS_FOR_MINUTES_AGO)
Specify how far back in time the CHE Statistics job should look for CHE events. By default, N4 retrieves CHE events
for the last 4 hours (240 minutes), which is also the maximum value. The minimum value is 5. This setting affects CHE-
related gadgets and reports.

MENDASHBOARD001 (AUTO_CREATE_DASHBOARD_FREQUENCY)
Specify the frequency, in minutes, at which the background job Auto-Create Dashboards runs. This job automatically
creates dashboards (on page 482) based on the current vessels on berth.

This is a global setting that you can specify within these values:

Default = 5
Minimum = 5
Maximum = 120

MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD)
Specify the period, in minutes, after a vessel departs during which N4 keeps calculating and displaying statistics data
for this vessel. When this period ends, N4 stops calculating metrics for this vessel and removes it from the Vessel
Statistics table and the Vessel Crane Statistics table. At the same time, vessel and crane gadgets for the vessel will
go blank. In addition, N4 deletes automatically created dashboards (on page 482). The departure time is based on the
vessel's ATD.

This is a global setting that you can specify within these values:

Default = 60
Minimum = 0
Maximum = 240

For example, if a vessel's ATD is 08/10/2009 10:00 AM and MENDASHBOARD002 = 60, then you can view the

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 465
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Monitor and Analytics configuration settings

vessel's metrics in related tables and gadgets until 08/10/2009 11:00 AM. At this time, N4 removes the data from
display and also removes the automatically created dashboard for the vessel, if it still exists.

MENDASHBOARD003 (AUTO_CREATE_DASHBOARD_ROLE)
Specify the role that is allowed to view automatically created dashboards (on page 482). Only users with this role can
see these dashboards.

MENDASHBOARD005 (VSL_SHOW_ALL_CRANES)
Specify if the crane related gadgets, Crane KPIs, Crane Metrics, and Crane Rhythm, should display all cranes for a
vessel or only cranes that are currently working on a vessel.

• Set it to true if N4 should display all cranes.

• Set it to false if N4 should display only the currently working cranes.

MENDATAMART001 (MONITOR_MOVES_EXTRACT_LATENCY)
Specify the latency for getting completed moves from the operational data store (ODS), in hours.

The default value for MENDATAMART001 is 48, the maximum value is 240, and the minimum value is 2.

Apply this setting at the global level only. Applying it at the complex, facility, or yard level might cause the ETL
process for Analytics to fetch incorrect values.

MENJOBS001 (VESSEL_STATISTICS_JOB_FREQUENCY)
Specify the number of minutes in which the Launch Vessel Statistics job should run to extract Vessel and Crane
statistics from XPS that appear in vessel-related BI Monitor gadgets. By default, N4 retrieves vessel and crane
statistics every minute.

Minimum: 1

Maximum: 10

MENJOBS002 (CHE_STATISTICS_JOB_FREQUENCY)
Specify the number of minutes in which the CHE Statistics job should run to extract CHE statistics from EC events. By
default, N4 retrieves CHE events every five minutes. This setting affects CHE-related gadgets and reports.

Minimum: 5

Maximum: 60

The CHE Statistics job requires that ECN4 be configured to generate equipment control events. This includes
setting the EEVENH setting in XPS to Y.

MENJOBS003 (EC_EVENT_IMPORTER_JOB_FREQUENCY)
Specify the frequency, in minutes, at which the background job EC Event Importer runs. This job extracts EC Events
from the SPARCS database.

Default: 5

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 466
Confidential -- Proprietary
 Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

Minimum: 5

Maximum: 60

This setting is applicable only for Monitor and Analytics and is not used for N4.

MENJOBS004 (EC_EVENT_IMPORTER_FILE_PATH)
Specify the path to the system folder on the SPARCS server where Monitor and Analytics stores the EC event log files.

This setting is applicable only for Monitor and Analytics and is not used for N4.

MENJOBS005 (EC_EVENT_IMPORTER_PROCESSED_FILE_PATH)
Specify the path where Monitor and Analytics stores the EC event log files after successfully extracting EC events and
saving them to the database.

MENSPARCS003 (SPARCS_STATISTICS_SERVER_HARVEST_FREQ)
Specify the frequency, in minutes, at which N4 attempts to harvest data from the XPS statistics server.

MENSPARCS004 (SPARCS_STATISTICS_SERVER_REQUEST_DELAY)
Specify the global delay, in milliseconds, between two Bento requests to the XPS statistics server.

ROADMONITOR001 (MONITOR_REFRESH)
Specify the refresh rate (in seconds) of the Gate Lane Monitor view.

Default: 10

Minimum: 1

Maximum: 60

ROADMONITOR002 (YARD_SERVICE_TIME)
Specify the expected yard service time for a truck, in minutes. N4 includes trucks that exceed the time specified by this
setting when calculating the Trucks of Long Stay metric in the Truck KPIs gadget.

Default: 40 minutes

Minimum: 10 minutes

Maximum: 120 minutes

2.3.3 Reporting job settings

You can use the following settings to configure and manage reporting jobs for your site.

In addition, reporting jobs also use the MSEMAIL_SERVER_CONFIG001 (HOST),

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 467
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

MSEMAIL_SERVER_CONFIG002 (PORT), and MSEMAIL_SERVER_CONFIG003 (PROTOCOL) settings to

access the mail server configured for your site.

ARGOREPORTING001 (REPORTING_TEMP_FILE_FOLDER)
Specify the file system folder where temporary reporting files can be saved.

You can use any folder that is accessible from each application server. This can be a local folder present on all
application servers or a shared network folder with read/write permissions for the application.

If the folder does not exist, N4 creates the folder before executing the reporting job.

On-demand jobs (that are not triggered automatically) will store the reports in the same location as the scheduled jobs
on this setting.

The folder's storage limit is based on the capacity of the machine where that folder is located. There is no maximum
size limit defined in N4. If you want to delete files automatically, you will need to set that up outside of N4 on your
machine.

ARGOREPORTING002 (REPORTING_FROM_EMAIL)
Specify the Email ID for the From field when sending an Email to the specified recipient.

N4 uses this Email ID for sending notifications configured for scheduled jobs, such as the Reporting Jobs and Groovy
Jobs.

ARGOREPORTING003 (REPORTING_REPLY_TO_EMAIL)
Specify the Email ID for the Reply-To field when sending an Email to the specified recipient.

The email ID specified for ARGOREPORTING003 can be the same as specified for ARGOREPORTING002
(REPORTING_FROM_EMAIL) (on page 468).

ARGOREPORTING004 (REPORTING_NULL_PARAM_VALUE)
Determines whether N4 must display all the values of a LOV as Report Parameter if you do not select a value for a
parameterized filter criteria when you run the report.

For example, if you have Line Operator as a parameter in a report but you do not select a value or select null (--) as the
value when you run the report, this setting determines whether N4 returns all the available line operators as the Report
Parameter.

Set it to true (default) if you want N4 to display all the available values of an LOV as Report Parameter if you do not
select a value for a parameterized filter criteria when you run the report.

Set it to false if you want N4 to not display all the available values as Report Parameter for a null filter criteria.

ARGOREPORTING005 (REPORTING_SQL_TIMEOUT)
Specifies the time in milliseconds (ms) after which the SQL query in the report is timed out. You can use this setting to
ensure that the SQL query in any report does not overload the server resources causing N4 to crash.

Use this setting to optimize the performance of the SQL query based reports. For more information, see SQL Query
Reports (on page 32).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 468
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

Default: 180000 milliseconds (3 minutes)

Minimum: 0

If you use this value, the SQL query does not time out. We recommend that you use a value greater than zero.
Maximum: 1800000 milliseconds (30 minutes)

See also ARGOREPORTING006 (REPORTING_SQL_ROWS) (on page 469) and ARGOREPORTING007

(REPORTING_SQL_FETCH_SIZE) (on page 469).

ARGOREPORTING006 (REPORTING_SQL_ROWS)
Specifies the maximum number of rows that are retrieved from the database as part of a single SQL query.

Use this setting to optimize the performance of the SQL Query based reports.

Default: 500

Minimum: 0

Maximum: 100000

See also, ARGOREPORTING005 (REPORTING_SQL_TIMEOUT) (on page 468) and ARGOREPORTING007

(REPORTING_SQL_FETCH_SIZE) (on page 469).

ARGOREPORTING007 (REPORTING_SQL_FETCH_SIZE)
Specifies the maximum number of rows that are fetched from the database at a time, it helps optimize bandwidth
usage and improve performance.

Use this setting to optimize the performance of the SQL Query based reports.

Default: 100

Minimum: 1

Maximum: 100000

Do not set the value of ARGOREPORTING006 (REPORTING_SQL_ROWS) less than ARGOREPORTING007

because this would render the ARGOREPORTING007 setting ineffective.
See also, ARGOREPORTING005 (REPORTING_SQL_TIMEOUT) (on page 468) and ARGOREPORTING006
(REPORTING_SQL_ROWS) (on page 469).

ARGOREPORTING008 (REPORTING_CLEANUP_TIME_MILLIS)
Specifies the time in milliseconds after which a generated report is deleted from memory. The default setting is 1 sec
(1000 milliseconds); however, you can set it to any value from 1000 to 60000 (60 seconds).

Default: 1000 (1 second)

Minimum: 1000 (1 second)

Maximum: 60000 (60 seconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 469
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

ARGOREPORTING009 (REPORTING VIEW VESSEL VISIT CLOSED)

You can use this setting when there are more closed vessel visits for the Inbound Bill of Lading Item Vessel visit
filter criteria of the Report Design form (on page 19) and the Report Definition form (on page 30).

The valid values are

• DO_NOT_INCLUDE (Default)
• INCLUDE
You set the setting to INCLUDE if you want N4 to display closed vessel visits for the Inbound Bill of Lading Item
Vessel visit filter criteria of the Report Design form (on page 19) and the Report Definition form (on page 30) for
the Cargo Lot reporting entity.

When you set the setting to include the closed vessel visit N4 may run into performance issues if there are more
records.

For example, when the vessel visit phase of the vessel visit 161237 is Closed and ARGOREPORTING009 is set to
INCLUDE, N4 displays the closed vessel visit for the Inbound Bill of Lading Item Vessel visit filter criteria.

If you set the setting ARGOREPORTING009 to DO_NOT_INCLUDE (Default) then the vessel visit 161237 is not
included in the Inbound Bill of Lading Item Vessel visit filter criteria.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 470
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

MENCHEMETRICS001 (CHE_METRICS_FOR_MINUTES_AGO)
Specify how far back in time the CHE Statistics job should look for CHE events. By default, N4 retrieves CHE events
for the last 4 hours (240 minutes), which is also the maximum value. The minimum value is 5. This setting affects CHE-
related gadgets and reports.

MENJOBS001 (VESSEL_STATISTICS_JOB_FREQUENCY)
Specify the number of minutes in which the Launch Vessel Statistics job should run to extract Vessel and Crane
statistics from XPS that appear in vessel-related BI Monitor gadgets. By default, N4 retrieves vessel and crane
statistics every minute.

Minimum: 1

Maximum: 10

MENJOBS002 (CHE_STATISTICS_JOB_FREQUENCY)
Specify the number of minutes in which the CHE Statistics job should run to extract CHE statistics from EC events. By
default, N4 retrieves CHE events every five minutes. This setting affects CHE-related gadgets and reports.

Minimum: 5

Maximum: 60

The CHE Statistics job requires that ECN4 be configured to generate equipment control events. This includes
setting the EEVENH setting in XPS to Y.

SRVNOTICE001 (NOTICE_RETURN_EMAIL_ADDRESS)
Specify the return email address that you want to use when you send an email as part of a general notice request.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 471
Confidential -- Proprietary
Part 2: Reports Configuration Monitoring and Reporting Configuration
Reporting job settings

N4 validates the email address format and accepts only the email addresses that are entered in the
'[email protected]' format (for example: [email protected]). N4 does not accept an email address that:

• Does not contain the '@' symbol.

• Contains more than one '@' symbols.
• Contains a period (.) either at the start or at the end of the user name, or immediately following the '@' symbol.
• Contains any other letters or symbols except a-z, A-Z, 0-9, period (.), or underscore (_) in the user name.
• Contains any other letters or symbols except a-z, A-Z, or 0-9 in the company name (the string that follows the '@'
symbol).
• Has a Domain name shorter than two characters (for example: [email protected]).
• Has a Domain name ending with a numeric domain identifier (for example: [email protected]).

N4 allows you to use an apostrophe anywhere in the recipient's name in an email address, such as
O'[email protected].

For information about setting up a general notice request, see Notice Request form.

You must override this setting at the Global scope level if you want to use the same email ID across facilities
and complexes in your topology.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 472
Confidential -- Proprietary
Part 3
Business Intelligence
In this Section:
Configuring the Business Intelligence Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Enabling the Dashboards menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
<Dashboard> tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
BI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Validating BI data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 473
Confidential -- Proprietary
3.1 Configuring the Business Intelligence Option
Before using the Business Intelligence option, you need to configure N4 so that it can properly retrieve and compute
the relevant report- and gadget-related metrics, generate and populate gadgets, and display standard report designs.

Configuring initial settings for the Business Intelligence option involves these tasks:

1. Configuring settings for the XPS statistics server (on page 475)
2. Installing standard report designs (on page 476)
3. Starting background jobs (on page 477)
4. Editing gadget-related settings (on page 477)
In This Section

Setting up a Navis N4 XPS client as the statistics server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Configuring settings for the XPS statistics server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Initializing standard report designs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Starting BI-related background jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Editing gadget-related settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 474
Confidential -- Proprietary
 Part 3: Business Intelligence Configuring the Business Intelligence Option
Setting up a Navis N4 XPS client as the statistics server

3.1.1 Setting up a Navis N4 XPS client as the statistics

server
Setting up an XPS client as the statistics server requires that you first create a dedicated Mensa user and group in XPS
and assign the MENSVR privilege to only this group. Then you can log in to the XPS client to set the port ID that is to
be used for the communication between N4 and the statistics server.

Any other configuration may disrupt the connection to the statistics server.

In XPS, do the following:

1. From the File menu, select Groups.
2. In the Groups window, create a new group called Mensa.
3. Assign the MENSVR privilege to this group
4. From the File menu, select Users.
5. In the Users dialog box, create a new user called Mensa.
6. Add the Mensa user as a member to the Mensa group.

In the XPS client that you want to set up as the statistics server, do the following:
1. Log in to the XPS client using the Mensa user ID.
2. From the File menu, select Mensa Statistics Server Options.
3. In the Mensa Statistics Server Options window, click Set Port.
4. In the Set Port dialog box, enter the Sub Server port ID to use for the communication between N4 and the
Statistics Server. This is also required to run the Xps Data Harvester job.
The default port ID is 13301.
5. Click OK to save the port configuration.

3.1.2 Configuring settings for the XPS statistics server

As part of setting up the framework for the Business Intelligence option, you need to configure the following N4 settings
for the XPS statistics server:

• ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP) (on page 464): Specify the host name or IP address of the
XPS client.
• ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT) (on page 464): Specify the port number of the XPS
client. The default value for is 13301.
• MENSPARCS003 (SPARCS_STATISTICS_SERVER_HARVEST_FREQ) (on page 467): Specify the frequency, in
minutes, at which N4 attempts to harvest data from the XPS statistics server.

To configure settings for the XPS statistics server:

1. In Administration mode, from the Settings menu, select Settings.
2. Repeat the following steps for each setting:
a. Double-click the setting you want to edit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 475
Confidential -- Proprietary
 Part 3: Business Intelligence Configuring the Business Intelligence Option
Initializing standard report designs

b. In the Edit Configuration form, select a scope and click Override.

c. In the Setting field, enter the new value, as follows:
For ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP) (on page 464), enter the IP address of the XPS
client that is running as the statistics server.
For ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT) (on page 464), enter the port that you
designated on the statistics server for communication with N4.
For MENSPARCS003 (SPARCS_STATISTICS_SERVER_HARVEST_FREQ) (on page 467), enter the frequency
at which you want Monitor and Analytics to attempt to harvest data from the XPS Statistics Server, in minutes.
d. Click Save.
N4 should now be able to connect to the XPS statistics server. The changes take effect the next time you log in to
N4.
In addition to the N4 settings listed above, you need to configure the following ECN4 settings in the
ecn4_settings_prod.xml file:

• gc.ENABLED: Enables garbage collection of domain model objects owned by ECN4.

• gc.OBJECT_RETENTION_TIME: Retention time, in hours, for garbage collection candidates.
N4 processes all CHE-related information using the CHE statistics job. Records in the work assignment table are
retained based on the value you set for these two ECN4 settings. To retain work assignment records to help process
the CHE statistics job for ASCs, you can either set the gc.ENABLED setting to False or set the
gc.OBJECT_RETENTION_TIME setting to a higher value, say 5 hours (minimum).

See the Navis N4 Reference Manual for detailed information about these two settings.

3.1.3 Initializing standard report designs

N4 provides the following standard report designs:

• Move Count by POW by CHE

• Moving CHE Productivity Analysis
• Yard Rehandle
• Truck Turn Time Analysis
• Clerk Activity
However, to be able to generate reports based on these standard designs, you need to initialize them first.

To initialize standard report designs:

1. In Administration mode, from the DBA menu, select Set-up Database.
2. Click Set-up Basic Reports.
N4 creates the standard report designs and adds them to the Report Designs view.
3. In Operations mode, from the Reports menu, select Report Designs.

If the Report Designs view is already open, close it, and then open it again.

4. In the Report Designs view, make sure all standard report designs exist in the list.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 476
Confidential -- Proprietary
 Part 3: Business Intelligence Configuring the Business Intelligence Option
Starting BI-related background jobs

3.1.4 Starting BI-related background jobs

For N4 to get regular updates from the XPS statistics server, the following background jobs must be running:

• XPS Data Harvester

This job writes data to the following tables: mns_move_record and mns_vessel_crane_statistics
Make sure you provide the correct XPS client IP address and port information. For details, see Configuring
settings for the XPS statistics server (on page 475).

• CHE Statistics
This job writes data to the following tables: mns_che_trip_statistics and mns_che_move_statistics. CHE-related
gadgets and reports rely on this information.
The job requires that ECN4 be configured to generate equipment control events. This includes setting the EEVENH
setting in XPS to Y.
You can check the xps_ec_event table in the database to make sure you get EC events.
• Vessel Statistics
This job writes data to the following tables: mns_move_record and mns_vessel_crane_statistics tables
Vessel and crane-related gadgets and the Yard Rehandle report rely on this information.
• Auto-Create Dashboards
This job automatically creates dashboards for vessels currently on berth and removes them when a vessel departs.
See also Setting up the automatic creation of vessel/crane dashboards (on page 482).
For more information, see Background Jobs view.

To start a background job:

1. In Administration mode, from the System menu, select Background Jobs.
2. In the Background Jobs view, click Actions and select the job that you want to start.
3. In the Node Selection form, select the relevant node and click OK.

3.1.5 Editing gadget-related settings

• ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP) (on page 464): Specify the host name or IP address of the
XPS client.
• ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT) (on page 464): Specify the port number of the XPS
client. The default value for ARGOMONITOR003 is 13301.
• FRMCARINA033 (GADGET_REFRESH_PERIOD) (on page 465): Specify the interval, in seconds, at which N4
refreshes the data in all gadgets.
• MENSPARCS003 (SPARCS_STATISTICS_SERVER_HARVEST_FREQ) (on page 467): Specify the frequency, in
minutes, at which N4 attempts to harvest data from the XPS statistics server.
• MENSPARCS004 (SPARCS_STATISTICS_SERVER_REQUEST_DELAY) (on page 467): Specify the global delay,
in milliseconds, between two Bento requests to the XPS statistics server.
MENPURGE001 (ARCH_PURGE_MENSA_CUT_OFF): Specify the number of days after which all Monitor and
Analytics-related entities must be archived and purged. This includes information pertaining to yards, secondary
statistics, vessel crane statistics, carrier statistics, and CHEs. For more information, see Archiving Data.

Default: 90 (days)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 477
Confidential -- Proprietary
Part 3: Business Intelligence Configuring the Business Intelligence Option
Editing gadget-related settings

Minimum: 45

Maximum: 90

Purge Query Name Data Purged Table Child Table(s)

MensaPurgeCarrierStatistic Statistics information of mns_carrier_statistics none

s carriers
MensaPurgeCheMoveStatis Statistical information of mns_che_move_statistics none
tics individual CHE moves
MensaPurgeCheOperatorSt Statistical information of mns_che_operator_statistic none
atistics CHE operators s
MensaPurgeCheSession CHE sessions mns_che_session none

MensaPurgeCheSessionPe CHE session periods mns_che_session_period none

riod
MensaPurgeCheTripStatisti Statistical information of mns_che_trip_statistics none
cs individual CHE trips
MensaPurgeSecondaryStati mensa statistics mns_secondary_statistics none
stics
MensaPurgeYardBlock Yard Blocks mns_yard_block none

MensaPurgeYardBlockStati Statistical information of mns_yard_block_statistics none

stics yard blocks
MensaPurgeYardTierStatisti Statistical information of mns_yard_tier_statistics none
cs yard tiers
MensaPurgeEquipmentBloc Equipment Block Visit mns_equipment_block_visit none
kVisit
MensaPurgeVesselCraneSt VesselCraneStatistics mns_vessel_crane_statistic none
atistics s

• MENDASHBOARD001 (AUTO_CREATE_DASHBOARD_FREQUENCY) (on page 465): Specify the frequency, in

minutes, at which the background job Auto-Create Dashboards runs. This job automatically creates dashboards
(on page 482) based on the current vessels on berth.
• MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD) (on page 465): Specify the period, in minutes, after a
vessel departs during which N4 keeps calculating and displaying statistics data for this vessel. When this period
ends, N4 stops calculating metrics for this vessel and removes it from the Vessel Statistics table and the Vessel
Crane Statistics table. At the same time, vessel and crane gadgets for the vessel will go blank. In addition, N4
deletes automatically created dashboards (on page 482). The departure time is based on the vessel's ATD.
• MENDASHBOARD003 (AUTO_CREATE_DASHBOARD_ROLE) (on page 466): Specify the role that is allowed to
view automatically created dashboards (on page 482). Only users with this role can see these dashboards.
• MENDASHBOARD005 (VSL_SHOW_ALL_CRANES) (on page 466): Specify if the crane related gadgets, Crane
KPIs, Crane Metrics, and Crane Rhythm, should display all cranes for a vessel or only cranes that are currently
working on a vessel.
▪ Set it to true if N4 should display all cranes.
▪ Set it to false if N4 should display only the currently working cranes.
• ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ) (on page 464): Specify the frequency, in minutes, at
which the Yard Block Statistics job retrieves data from the XPS statistics server. N4 makes this data available in
yard-related gadgets and reports. To facilitate calculating the daily average utilization, the job should run at least

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 478
Confidential -- Proprietary
Part 3: Business Intelligence Configuring the Business Intelligence Option
Editing gadget-related settings

every hour on the hour. If you want to get utilization updates at regular time intervals, we recommend setting the job
to run at intervals that are a divisor or factor of 60, such as 10, 15, 20, 30, or 60. To ensure accurate results,
determine how Analytics rounds off the Extract Date to the closest minutes when generating the utilization reports.
For example, at the default setting of 30 minutes, if you enter an Extract Date between 9:31 to 9:59, the actual time
stamp that the Reefer Plug Utilization report (on page 590) uses to select yard utilization data is 9:30.
• MENCHEMETRICS001 (CHE_METRICS_FOR_MINUTES_AGO): Specify how far back in time the CHE Statistics
job should look for CHE events. By default, N4 retrieves CHE events for the last 4 hours (240 minutes), which is
also the maximum value. The minimum value is 5.

To edit settings:
1. In Administration mode, from the Settings menu, select Settings.
2. In the Settings view, edit the settings as required.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 479
Confidential -- Proprietary
3.2 Enabling the Dashboards menu
You need a license to be able to view the Dashboards menu. To ensure you have a current license, contact your
Professional Services representative.

When the license is in place, perform the following procedure to enable the Dashboards menu and gadgets.

The Dashboards menu only becomes available at the Yard or Facility level.
In This Section

Manage Dashboards view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

Manage Dashboards Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Setting up the automatic creation of vessel/crane dashboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Adding or editing a dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 480
Confidential -- Proprietary
 Part 3: Business Intelligence Enabling the Dashboards menu
Manage Dashboards view

3.2.1 Manage Dashboards view

Operations Dashboards Manage Dashboards Manage Dashboards view

Prerequisites
• To access the Manage Dashboards view, you need to assign the Dashboard - View privilege to your user role.

The Manage Dashboards view displays the dashboards that are associated with a role that is assigned to your user
account and the dashboards that you add. A dashboard is a visual display of performance information that has been
consolidated and arranged on a single screen so that you can monitor the information at a glance.

You can add, edit, and delete dashboards from this view depending on the privileges that are associated with the role
that is assigned to your user account. For more information about privileges that are associated with dashboards and
gadgets, see Dashboard Privileges (on page 461).

We recommend that you assign privileges to add, edit, or delete dashboards and gadgets only to users with
administrative roles. All other users should have view privileges to be able to view dashboards. For more
information on privileges and roles, see Privileges view and Roles view.

The minimum scope for adding, deleting, and editing dashboards is Facility. Users created on the Yard level
cannot manage dashboards.
For more information on data in Monitor and possible operation scenarios, see BI reference information (on page 526).

To add a new record:

Click .

To edit or delete a record:

1. In the list view, select the record(s) that you want to edit or delete.
2. Do one of the following:

▪ Click to edit a selected record.

▪ Click to delete the selected record(s).

After you add a dashboard, you can use the Dashboards <Dashboard> option to display the dashboard as a tab.

To configure an existing dashboard:

1. Select Operations Dashboards <Dashboard> to access the dashboard that you want to configure.
2. Continue with one of the following:
▪ Display a gadget (on page 484)
▪ Move a gadget (on page 509)
▪ Edit a gadget
▪ Hide a gadget (on page 523)
For more information on the available gadgets, see Gadget form (on page 486).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 481
Confidential -- Proprietary
 Part 3: Business Intelligence Enabling the Dashboards menu
Manage Dashboards Columns

Manage Dashboards Columns

Short Label Long Label In Filter? Sorting?
Created By Created By X X
Dashboard Dashboard X X
Description Description X X
Role Name Role Name X X

3.2.2 Setting up the automatic creation of vessel/crane

dashboards
With appropriate configuration, SPARCS Monitor can automatically create dashboards for all vessels on berth. Each
dashboard displays information on a single vessel and the cranes working it. All automatically created dashboards
have a name prefixed with VSL_, which makes them easy to recognize.

Only users with a specific role can view automatically created dashboards. You use the MENDASHBOARD003
(AUTO_CREATE_DASHBOARD_ROLE) (on page 466)setting to define the role that is allowed to view these
dashboards.

SPARCS Monitor identifies vessels on berth based on the following criteria:

• A vessel has arrived (actual time of arrival (ATA) lies in the past, that is ATA < now).
• A vessel has not departed (actual time of departure (ATD) lies in the future, that is ATD > now).
The background job Auto-Create Dashboards runs regularly to create dashboards for the vessels currently on berth
and removes them when a vessel departs. For example, if a new vessel arrives on berth at 12:03 and the Auto-Create
Dashboard job runs at 12:05, SPARCS Monitor creates a new dashboard while it is running.

If a vessel departed (ATD lies in the past), SPARCS Monitor deletes the related dashboard after a period specified by
the MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD) (on page 465) setting. For example, for a vessel with an
ATD of 08/10/2009 10:00 AM, if the setting uses the default value of 60 minutes, Monitor deletes the vessel's
dashboard at 11:00 AM.

SPARCS Monitor updates and removes automatically created dashboards based on the prefix VSL_. If you
create any dashboard with the same prefix, SPARCS Monitor deletes it along with automatically created
dashboards when running the Auto-Create Dashboards job.
You can also delete an automatically created dashboard manually from the Manage Dashboards view. In this case, if
the vessel is still on berth the next time that the background job runs, SPARCS Monitor will not create the dashboard
again, unless you restart the Tomcat server.

To make sure you view the latest list of available dashboards, you need to refresh the Manage Dashboards view.
Otherwise, if you try to view a dashboard that SPARCS Monitor already deleted, an error message appears, indicating
that the dashboard is not available.

All automatically generated dashboards follow a two-column layout with three rows. The following table shows how
Monitor arranges the gadgets in each dashboard.

Row Left gadget Right gadget

1 Vessel KPIs (on Vessel Metrics
page 503)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 482
Confidential -- Proprietary
 Part 3: Business Intelligence Enabling the Dashboards menu
Adding or editing a dashboard

Row Left gadget Right gadget

2 Crane KPIs (on Crane Rhythm (on
page 491) page 493)
3 Crane Metrics

To set up the automatic creation of vessel/crane dashboards:

1. Set the following parameters:
▪ MENDASHBOARD001 (AUTO_CREATE_DASHBOARD_FREQUENCY) (on page 465) to specify the frequency
at which the background job Auto-Create Dashboards runs.
Default = 5 min
Minimum = 5 min
Maximum = 120 min
▪ MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD) (on page 465) to specify the period after a vessel
departed during which SPARCS Monitor keeps calculating and displaying statistics data for the vessel.
Default = 60 min
Minimum = 0 min
Maximum = 240 min
▪ MENDASHBOARD003 (AUTO_CREATE_DASHBOARD_ROLE) (on page 466) to specify the role that is allowed
to view these dashboards.
For details, see Editing configuration settings in the SPARCS Monitor online help.

2. In the Manage Dashboards view, click the Refresh button to make sure you look at the latest list of available
dashboards, both on the Dashboards menu and in the Manage Dashboards view.

3.2.3 Adding or editing a dashboard

Operations Dashboards Manage Dashboards Manage Dashboards view Dashboard form

The Dashboard form enables you to add or edit a dashboard. When you add a new dashboard, N4 adds a
corresponding menu item on the Operations Dashboards menu. When you select Operations Dashboards
<Dashboard>, N4 displays the dashboard as a tab.

For information on privileges that control dashboard-related functionality, see Monitor Privileges (on page 461).

To add or edit a dashboard:

1. In the Dashboard field, enter a name that uniquely identifies the dashboard.
2. Optionally, in the Description field, enter a short description of the purpose of the dashboard. Optionally, from the
Role drop-down list, select the role for the users with whom you want to share the dashboard.

If a dashboard is not assigned a role, it is only available to the user who creates the dashboard.

3. The user role that you select from the Role drop-down list must at least have the Dashboard - View privilege to be
able to view the dashboard. For more information about the privileges associated with the dashboards, see the topic
on dashboard-related privileges (on page 461).
4. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 483
Confidential -- Proprietary
 Part 3: Business Intelligence <Dashboard> tab
Displaying gadgets

3.3 <Dashboard> tab

Operations Dashboards <Dashboard> <Dashboard> tab

A <Dashboard> tab displays a dashboard that you define in the Manage Dashboards view. <Dashboard> is the
name of the dashboard that you specify in the Dashboard form (on page 483) and is listed in the Operations
Dashboards menu.

3.3.1 Displaying gadgets

Operations Dashboards <Dashboard> <Dashboard> tab

In N4 2.5 and later, all gadgets have been converted to platform-neutral gadgets. If you are upgrading from a
version prior to N4 2.5, you need to remove all platform-dependent gadgets from the Dashboard and add the
new platform-neutral gadgets.

The <Dashboard> tab is used for displaying gadgets. A gadget is a visual representation of a business entity. If
displayed in a dashboard, the gadget lives in the dashboard and automatically refreshes at its own refresh rate when
the dashboard is left open. The table gadgets maintain customized display settings, including column order and filters.

To display gadgets, a user needs the respective privileges. We recommend that you assign privileges to add gadgets
only to users with administrative roles. All other users should have view privileges to be able to view gadgets. For more
information on privileges and roles, see Privileges view and Roles view.

To display a gadget:
1. On the <Dashboard> tab, right-click and select the Add Gadget option.
The Gadget form (on page 486) displays.
2. In the Gadget form, select the gadget that you want to display and click OK.
The selected gadget opens on the <Dashboard> tab.
N4 displays the gadget at the top left of the dashboard tab.
N4 allows you to add as many gadgets as you want to the dashboard. As you keep adding gadgets, N4 places them at
the top left and on top of gadgets that already exist. You can move them as required and use the and buttons
to minimize or maximize a gadget view. After adding the required gadgets to the dashboard, you can save the current
gadgets list layout as the default layout by right-clicking on the dashboard and selecting the Save as Default Layout
option or you can revert to the default layout by selecting the Reset to Default Layout option.

Information regarding vessel and crane related gadgets

The Vessel list for vessel and crane gadgets contains:

• Vessels with an actual time of arrival (ATA) that is not null (ATA != null) and that is before or equal to now (ATA
<=now)
• Vessels with an actual time of departure (ATD) that is null (ATD == null) or that is after or equal to now plus the
defined data display period for the vessel (ETA >= now+MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD)
(on page 465))

For the Vessel list to include any values, the Vessel Statistics job must be running in the background
(Administration System Background Jobs). For details, see Background Jobs view.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 484
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Displaying gadgets

For details about configuring appropriate settings for vessel and crane gadgets, see Configuring vessel and crane
gadgets (on page 485).

3.3.1.1 About data availability in Crane gadgets

Crane gadgets display information on crane activity if N4 retrieves a valid crane schedule from XPS. If the N4 database
does not contain any moves for a crane, it displays crane schedule information only. In the following cases, crane
gadgets may not display any information:

• If a crane is no longer working on a vessel

• If the connection between XPS and N4 is interrupted
• If the N4 database contains moves for a vessel/crane combination, but the vessel schedule is unavailable

3.3.1.2 About gadget titles

The title of vessel- and crane-related gadgets reflects the vessel name and visit for which the gadget shows
information. This helps you quickly identify the relevant gadget when a dashboard includes multiple gadgets of the
same kind, for example two different Vessel KPIs gadgets, each showing information for a different vessel.

In addition, gadgets that include a table with multiple rows also display the number of rows appended to the title.

The title of CHE Details gadgets is Moving CHE Details. If you specify a CHE type and POW ID in the filter options for
Moving (on page 518) CHE Details, N4 appends this information to the title.

To limit gadget width, gadget titles cannot exceed 60 characters.

3.3.1.3 Configuring settings for vessel and crane gadgets

You must configure some N4 settings so that the vessel and crane related gadgets display the required details.

To configure the settings for vessel- and crane-related gadgets:

1. You must have the privilege for Background Jobs Actions - Launch Vessel Statistics assigned.
2. In the Cluster Services view, check that the XPS-N4 bridge is active and XPS server and XPS client are up and
running.
3. You must configure these settings:
▪ ARGOMONITOR002 (MONITOR_SPARCS_CLIENT_IP) (on page 464): Specifies the host name or IP address
of the XPS client used as the statistics server. See Configuring settings for the XPS statistics server (on page
475).
▪ ARGOMONITOR003 (MONITOR_SPARCS_CLIENT_PORT) (on page 464): Specify the port number of the XPS
client. The default value for ARGOMONITOR003 is 13301.
▪ FRMCARINA033 (on page 465) - Specify the interval at which N4 refreshes the data in the various Vessel, Crane,
and CHE gadgets.
4. From the Background Jobs view, select Launch Vessel Statistics job.
The job calculates the vessel- and crane-related metrics for the user's facility and yard.
To stop the background job, select Background Jobs view Actions Halt Job.
Dashboard gadgets only work when the Vessel Statistics job is running.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 485
Confidential -- Proprietary
 Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2 Adding gadgets

Operations Dashboards <Dashboard> <Dashboard> tab Right-Click Add Gadget Gadget form

The Gadget form lists the available gadgets that you can display on the <Dashboard> tab for the selected dashboard.

To be able to add gadgets, a user needs the respective privileges. We recommend that you assign privileges to
add gadgets only to users with administrative roles. All other users should have view privileges to be able to
view gadgets. For more information on privileges and roles, see Privileges view and Roles view.

To display a gadget:
1. Select the gadget that you want to display in the selected dashboard.
2. Click OK.
The Gadget form closes and the selected gadget opens in the dashboard.

3.3.2.1 AGV Average moves per hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Average moves per hour gadget

The AGV Average moves per hour gadget displays a line chart of the average move count of AGVs within the last
hour in the yard that you are currently logged in. The x-axis represents the time and the y-axis the AGV moves. By
default, the gadget displays data for the last hour for the selected pool. However, you can edit the number of hours that
is displayed in the AGV Average moves per hour form.

The average is calculated as 'number of moves divided by number of AGVs that worked in the last hour in the selected
pool.'

This gadget displays data only when you select the required pool in the AGV Average moves per hour form.

3.3.2.2 AGV Travel Distance gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Travel Distance gadget

The AGV Travel Distance gadget displays a stacked bar chart of the laden and unladen travel distance for all AGVs
for the selected pool. The x-axis represents the time period and the y-axis the AGV driving distance per job, in meters.
By default, the gadget displays data for the last 4 hours. However, you can edit the number of hours that is displayed in
the AGV Travel Distance form.

This gadget displays data only when you select the required pool in the AGV Travel Distance form.

3.3.2.3 AGV Idle Time By AGV Pool gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Idle Time By AGV Pool gadget

The AGV Idle Time By AGV Pool gadget displays a bar chart of an AGV’s idle time based on the selected pool. The
x-axis represents the AGV and the y-axis represents the idle time, in minutes. By default, the gadget displays data for
the last 4 hours. However, you can edit the number of hours that is displayed in the AGV Idle Time By AGV Pool form.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 486
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Idle time is calculated as ‘the difference between the time when the AGV goes idle and the time the next dispatch starts
for that AGV’.

N4 displays data in the gadget only if the idle time duration is at least 1 minute. If it is below 1 minute, N4
displays zero in the gadget.

3.3.2.4 AGV Moves Per Hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Moves Per Hour gadget

The AGV Moves Per Hour gadget displays a bar chart of gross moves per hour (GMPH) within the last 4 hours based
on the selected pool. The x-axis represents the time and the y-axis GMPH. This gadget helps you monitor quay crane
productivity.

GMPH = movecount / (lastMoveTime – firstMoveTime)

This gadget displays data only when you select the required pool in the AGV Moves Per Hour form.

3.3.2.5 AGV Wait at QC gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Wait at QC gadget

The AGV Wait at QC gadget displays a bar chart of AGV wait time in quay crane transfer zones for a selected quay
crane for both inbound and outbound moves. The x-axis represents the AGV and the y-axis the AGV wait time at QC,
in minutes. By default, the gadget displays data for the last hour for the selected quay crane. However, you can edit the
number of hours that is displayed in the AGV Wait at QC form.

Wait time is calculated as ‘the difference between the time when the AGV goes idle and the time the next dispatch
starts for that AGV’.

3.3.2.6 AGV Wait At Parallel Buffer gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Wait For ASC TZ gadget

The AGV Wait At Parallel Buffer gadget displays a stacked bar chart of the wait time at the parallel buffer for all AGVs
in the selected pool for both inbound and outbound moves. The x-axis represents the ASC Blocks and y-axis the AGV
wait time for ASC TZ.

Wait time in parallel buffer is the time difference between parallel buffer entry time and buffer exit time.

This gadget displays data only when you select the required pool in the AGV Wait At Parallel Buffer form.

3.3.2.7 AGV Wait In ASC TZ gadget

Operations Dashboards <Dashboard> <Dashboard> tab AGV Wait In ASC TZ gadget

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 487
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The AGV Wait in ASC TZ gadget displays a stacked bar chart of the wait time in ASC transfer zones for a given block
for both inbound and outbound moves. The x-axis represents the ASC Blocks and y-axis the AGV wait time in ASC TZ.

This gadget displays data only when you select the required pool in the AGV Wait In ASC TZ form.

3.3.2.8 ASC Driving Time gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Driving Time gadget

The ASC Driving Time gadget displays a stacked bar chart for the laden and unladen driving time for the selected
ASC. The y-axis represents the driving time, in minutes. By default, the gadget displays data for the last 4 hours.
However, you can edit the number of hours that is displayed in the ASC Driving Time form.

This gadget displays data only when you select an ASC in the ASC Driving Time form (on page 512).

3.3.2.9 ASC Idle Time by Yard Block gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Idle Time By Yard Block gadget

The ASC Idle Time by Yard Block gadget displays a bar chart of the idle time between moves for all ASCs working in
the selected yard block(s). The x-axis represents the ASCs and the y-axis the idle time, in minutes. By default, the
gadget displays data for the last 4 hours. However, you can edit the number of hours that is displayed in the ASC Idle
Time by Yard Block form.

This gadget displays data only when you select the yard block in the ASC Idle Time by Yard Block form.

3.3.2.10 ASC Moves by Move Kind gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Moves by Move Kind gadget

The ASC Moves by Move Kind gadget displays a bar chart of the move count for the selected ASC based on the
move kind. The x-axis represents the time and the y-axis the moves. By default, the gadget displays data for the last 4
hours. However, you can edit the number of hours that are displayed in the ASC Moves by Move Kind form.

N4 divides each bar by the following move types:

• Shifts
• Rehandles
• Housekeeping moves
• Pre-position moves
• Delivery moves
• Receival moves
• Discharge moves
• Load moves

This gadget displays data only when you select an ASC in the ASC Moves by Move Kind form.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 488
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2.11 ASC Moves last hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Moves last hour gadget

The ASC Moves last hour gadget displays a stacked bar chart of the move count for the selected ASC(s) based on
the move purpose, which is retrieved from the CheMoveStatistics entity. The x-axis represents the time and the y-axis
the moves. This gadget displays data for the last 1 hour.

N4 divides each bar by the following move types:

• Shifts
• Rehandles
• Housekeeping moves
• Pre-position moves
• Delivery moves
• Receival moves
• Discharge moves
• Load moves

This gadget displays data only when you select an ASC in the ASC Moves last hour form.

3.3.2.12 ASC Productivity gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Productivity gadget

The ASC Productivity gadget displays a bar chart of the gross moves per hour (GMPH) for the selected ASC(s) for
the last hour. The x-axis represents the ASCs and the y-axis the GMPH.

GMPH = movecount / (lastMoveTime – FirstMoveTime)

This gadget displays data only when you select an ASC in the ASC Productivity form.

3.3.2.13 ASC Red Time For Date Range gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Red Time for Date Range gadget

The ASC Red Time For Date Range gadget displays a bar chart of the red time for the selected ASC. Red time
indicates ASC breakdown time. The x-axis represents the date range and the y-axis the red time, in minutes. By
default, the gadget displays data for the last 7 days. However, you can edit the number of days that is displayed in the
ASC Red Time For Date Range form.

This gadget displays data only when you select an ASC in the ASC Red Time For Date Range form.

3.3.2.14 ASC Red Time Current Day Range gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Red Time Current Day Range gadget

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 489
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The ASC Red Time Current Day Range gadget displays a stacked bar chart of the red time per day by ASC(s). Red
time indicates ASC breakdown time. The x-axis represents the ASC blocks and the y-axis the red time today, in
minutes. By default, the gadget displays data for the last 24 hours.

This gadget displays data only when you select an ASC in the ASC Red Time Current Day Range form.

3.3.2.15 ASC Summary gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Summary gadget

The ASC Summary gadget displays a list view of metrics for all ASCs based on the CheMoveStatistics entity. By
default, the gadget displays data for the last 1 hour. However, you can edit the number of hours that is displayed in the
ASC Summary form.

The list view displays the following metrics for an ASC.

Column (metric) Description

ASC The ID of the ASC
No. of Moves Moves done in the last 60 minutes
Avg. Laden Dis The average laden distance for all trips, in meters
Avg. Unladen Distance The average unladen distance for all trips, in meters
Avg. Idle Time The total idle time across all moves, in minutes
Avg. Delay Time The total delay time across all moves, in minutes,
which is 'pick arrive time minus pick dispatch'

3.3.2.16 ASC Travel Distance gadget

Operations Dashboards <Dashboard> <Dashboard> tab ASC Travel Distance gadget

The ASC Travel Distance gadget displays a stacked bar chart of the laden and unladen travel distance for the
selected ASC. The x-axis represents the time and the y-axis the laden and unladen travel distance, in meters. By
default, the gadget displays data for the last 4 hours. However, you can edit the number of days that is displayed in the
ASC Travel Distance form (on page 515).

This gadget displays data only when you select an ASC in the ASC Travel Distance form.

3.3.2.17 Average ASC Cycle Time by ASC gadget

Operations Dashboards <Dashboard> <Dashboard> tab Average ASC Cycle Time by ASC gadget

The Average ASC Cycle Time by ASC gadget displays the average cycle time for an ASC or multiple ASCs. The x-
axis represents the ASCs and the y-axis the average cycle time, in minutes. Cycle time is the difference between
container put time and container fetch time. By default, the gadget displays data for the last 4 hours. However, you can
edit the number of hours that is displayed in the Average ASC Cycle Time by ASC form.

Average Cylce time is calculated as 'timetaken (cntrOff (put time)- cntrOn (fetch time) / no. of moves'

This gadget displays data only when you select an ASC in the Average ASC Cycle Time by ASC form.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 490
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2.18 Block Fullness for ASC yard blocks gadget

Operations Dashboards <Dashboard> <Dashboard> tab Block Fullness for ASC yard blocks gadget

The Block Fullness for ASC yard blocks gadget displays the most recent ASC yard blocks utilization. The x-axis
represents the ASC blocks and the y-axis the block fullness, in percentage. By default, the gadget displays data for the
last 30 minutes. You can also determine how frequently this job runs by adjusting the ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) (on page 464) setting.

This gadget does not have any editable parameters.

3.3.2.19 Crane KPIs gadget

Operations Dashboards <Dashboard> <Dashboard> tab Crane KPIs gadget

The Crane KPIs gadget displays key performance indicators for all the cranes that were working on a specific vessel.

To review historical performance, look at the trend that is indicated by the sparkline in the Moves/hr last 36 hours
column. To review the current performance, look at the value that is displayed in the Actual column and the gauge that
is displayed in the Actual vs. Threshold column. These values reflect the crane moves in the last 60 minutes.

The list view contains the columns described in the following table.

Column Description

Actual vs. threshold A gauge illustrating the current value of a crane's plot
moves in the last hour
By default, the thresholds are defined as follows: poor
< 15, good > 20

Gauges indicate whether the current metric

value falls into an acceptable or unacceptable
range, and how close the value is to the
threshold. Every gauge depicts poor
performance on the left (indicated by a dark
shade of grey) and better to good
performance on the right (indicated by lighter
shades of grey). This means that the threshold
values on the left can start out low, for
example for productivity gauges, or high, for
example for turn time gauges.

Actual An integer value indicating the actual current value of

a crane's moves in the last hour
Cranes The crane ID
Moves/Hr Last 36 Hr A sparkline illustrating a crane's plot moves per hour,
on the hour, for the last 36 hours
By default, the lower and upper bounds for this metric
are defined as 10 and 30.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 491
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2.20 Crane Metrics gadget

Operations Dashboards <Dashboard> <Dashboard> tab Crane Metrics gadget

The Crane Metrics gadget displays a list view of metrics for all the cranes working on a specific vessel. The list view
displays the actual current value of the following metrics for a crane.

Column Description
% Force Majeure Delays Sum of delays caused by acts of nature divided
by eGGH (effective gross gang hours) for the
crane

N4 lets you configure custom crane

activities (using the Crane Delay Types
form) and assign them to the pre-defined
delay categories Terminal, Non-terminal,
or Force Majeure. You can also use the
Crane Delay Types view to identify
delay categories.

% Non Term Delays Sum of non-terminal delays divided by eGGH

(effective gross gang hours) for the crane
% Term Delays Sum of terminal delays divided by eGGH
(effective gross gang hours) for the crane
Cranes Crane ID
eGGH Effective gross gang hours. See effective
productivity metrics for more information.
eGMPH The effective gross moves per hour. See
effective productivity metrics for more
information.
eNGH Effective net gang hours. See effective
productivity metrics for more information.
eNMPH Effective net moves per hour. See effective
productivity metrics for more information.
ETC Estimated time of completion
Final ETC Final estimated time of completion
Final Mvs to Go Moves to go final
First Mv/Act Time Time of first move or activity
GGH Gross gang hours
GMPH Gross moves per hour
Last Mv Time The last move time of the crane that worked on
the vessel
Last Mv/Act Time Time of last completed move or activity
Mvs Compl Moves completed
Mvs to Go Remaining moves to go

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 492
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description
NGH Net gang hours, which is gross gang hours
minus total delays.
NMPH Net moves per hour, calculated by moves
complete divided by net gross gang hours
Plan Dev. Plan deviation, which is equal to Final ETC -
PTC
PTC Planned time of completion
Req GMPH Required productivity for the crane to complete
on time, which is equal to Moves to Go/Time to
PTC

Time Since Last Mv Time since last move

Time to PTC Time to planned completion, which is equal to the

planned completion time minus the current time.
If the PTC for a crane has passed, the value for
this metric is negative.

Calculation of effective productivity metrics

Monitor and Analytics calculate effective productivity metrics by determining if the crane has worked for any other
vessel, based on the crane's moves or activities.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.21 Crane Rhythm gadget

Operations Dashboards <Dashboard> <Dashboard> tab Crane Rhythm gadget

The Crane Rhythm gadget is a list view of crane moves and activities. It displays real-time operations for a crane. For
example, if it is currently 4:00 pm and the cutoff time is 2:00 pm, then the gadget displays all activities that:

• Started before 2:00 pm but ended between 2:00 and 4:00 pm

• Started and ended between 2:00 pm and 4:00 pm
• Started after 2:00pm and have not ended yet
• Started before 2:00 pm and have not ended yet
The gadget displays the columns described in the following table.

Column Description

Cranes The crane ID

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 493
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description

Crane Mvs and Activities A time line for:

• Crane activities, indicating terminal, non-
terminal, and force majeure delays
• Crane moves, indicating load, discharge, and
shift on board (SHOB) moves
The left end of the time line represents the point in
time 1 - 4 hours ago, depending on the amount of
data displayed; the right end represents the current
time. The granularity of the time line depends on
the amount of data displayed and the layout of the
dashboard.
Mvs Last Hour The number of moves the crane performed in the
last hour
Total Delays The sum of all terminal, non-terminal, and force-
majeure delays for the crane servicing the vessel
visit

For optimal display, Navis recommends that you view 4 hours worth of data in a single-column layout.
You can edit the gadget properties to specify the vessel being served and the amount of data to be displayed.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.22 Crane Worked Last Hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab Crane Worked Last Hour gadget

The Crane Worked Last Hour gadget displays a list view of metrics for all the cranes that worked in the last hour,
which is retrieved based on the VesselCraneStatistics entity. If a crane performs moves for two different vessels in the
last hour, the gadget displays two rows for the crane in the gadget.

Example:

If the total moves for a crane is 10 (1 twin, 1 quad, 1 tandem, and 2 single), then PCPH is 5.

The list view displays the following metrics for a crane.

Column (metric) Description

Cranes The crane ID
Carrier Visit Carrier visit
Time Since Last Mv Time since last move
GMPH Gross moves per hour
NMPH Net moves per hour
PCPH Productive cycles per hour

To hide or remove columns, see Managing columns.

This gadget does not have any editable parameters.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 494
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2.23 Facility TEU gadget

Operations Dashboards <Dashboard> <Dashboard> tab Facility TEU gadget

The Facility TEU gadget displays a circular gauge of the TEU in the facility. N4 counts one TEU for each 20-foot
container and two TEU for each 40-foot container in the facility. The pointer in the circular gauge indicates the current
TEU value.

The containers represented in the gadget include all containers with current location = Y, T, I, and E, but filters out E
containers in Vessel and In Community, that is, the current location is E with current location code (CLQL) = C or V.

The green, yellow, and red areas represent TEU capacity thresholds of Good, OK, and Poor respectively.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

This gadget does not have any editable parameters.

3.3.2.24 Fixed CHE Details gadget

Operations Dashboards <Dashboard> <Dashboard> tab Fixed CHE Details gadget

The Fixed CHE Details gadget displays a list view of metrics for all fixed CHEs of a certain CHE type that made a
move within the last hour in the yard that you are currently logged in to. The CHE type is determined by the option you
select in the Fixed CHE Details form.

On editing the Fixed CHE Details, CHE type is a required field and filters are applied based on CHE type, with POW
and POOL optional. N4 appends the CHE type and any POW or Pool ID used in the definition are appended to the
name.

For details on how CHE moves are counted, see Which CHE are credited with a move (on page 558).

The list view displays the actual current value of the following metrics for a CHE.

Column Description
CHE ID The ID of the CHE
If the fetch CHE (for LOAD, YARD, or RLOD) or
put CHE (for DSCH, YARD, or RDSC) is null for
any move, N4 counts up the records and lists the
CHE ID as "?". In this case, if one Fixed CHE
Details gadget shows information on RTGs and
another one on RMGs, for example, the same
CHE appears in both gadgets as "?" because ID
and type are both unknown.
Mvs Last Hr The moves that this CHE completed in the last 60
minutes
Last Mv Time End time of the last completed move by the CHE
Time since last Mv Current time minus the last move time of the CHE
Crane Mv Cnt The moves that this CHE completed in the last 60

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 495
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description
minutes filtered by moves of kind VESSEL
DISCHARGE and VESSEL LOAD
Non Crane Mv Cnt The moves completed in the last 60 minutes
minus the crane move count
Rail Mv Cnt The moves that this CHE completed in the last 60
minutes filtered by moves of kind RAIL LOAD and
RAIL DISCHARGE
Non Rail Mv Cnt The moves that this CHE completed in the last 60
minutes minus the rail move count

To hide or remove columns, see Managing columns.

For more information on the related metrics, see Fixed CHE metrics (on page 557).

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.25 Moves per Day gadget

Operations Dashboards <Dashboard> <Dashboard> tab Moves per Day gadget

The Moves per Day gadget displays a stacked bar chart of the number of moves per day in the yard by move type. By
default, the last 5 days display. However, you can edit the number of days that is displayed in the Moves per Day form
(on page 517).

The x-axis represents the days of the week. Each x-axis label displays a bar that represents the number of moves that
were completed that day between 00:00 and 23:59 hours, based on the local time at the facility.

In addition, N4 divides each bar by the following move types:

• Yard moves
• Yard shifts
• Receival
• Delivery
• Vessel discharge
• Vessel load
• Rail discharge
• Rail load
• SHOB
• Other
N4 also displays the number of completed moves for each move type for that day.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 496
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

3.3.2.26 Moving CHE Details gadget

Operations Dashboards <Dashboard> <Dashboard> tab Moving CHE Details gadget

The Moving CHE Details gadget displays a list view of metrics for all moving CHEs of a certain CHE type that made a
move within the last hour in the yard that you are currently logged in to. The CHE type is determined by the option you
set in the Moving CHE Details form (on page 518).

When editing the Moving CHE Details gadget, CHE Type is a required field and filters are applied based on CHE
Type, with POW ID and Pool ID optional. The CHE Type and any POW ID and Pool ID specified are appended to the
name in the gadget header.

For details on how CHE moves are counted, see Which CHE are credited with a move (on page 558).

Column Description
CHE ID The ID of the CHE

If the carry CHE is null for any move,

N4 counts up the records and lists the
CHE ID as "?". In this case, if one
Moving CHE Details gadget shows
information on TRKs and the other
one on STRs, the same CHE appears
in both gadgets as "?" because ID and
type are both unknown.

Moves Last Hr The total number of moves (work instructions)

completed by the moving CHE in the last 60
minutes. Twin moves are counted as two.
Last Move Time End time of the last completed move by the
moving CHE
Time Since Last Move The current time minus the last move time of
the CHE
Avg Dis Laden The average of laden distance for all trips (for
details, see Moving CHE metrics (on page
555)).
Avg Dis Unladen The average of unladen distance for all trips.
Trip Count The number of trips completed by the moving
CHE in the last 60 minutes. The trip count is 1
for twin moves.
Tot Dis Laden The sum of laden distance for all trips
completed by the moving CHE in the carry
phase in the last 60 minutes.
Tot Dis Unladen The sum of unladen distance for all trips
completed by the moving CHE in the carry
phase in the last 60 minutes.
Tot Dis The sum of laden and unladen distance for all
trips.

To hide or remove columns, see Managing columns.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 497
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

For more information on the related metrics, see Moving CHE metrics (on page 555).

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.27 Quay Cranes Moves By Hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Moves By Hour gadget

The Quay Cranes Moves By Hour gadget displays a bar chart of the gross moves per hour (GMPH) of cranes that
worked in the last hour. The x-axis represents the quay cranes and the y-axis the gross moves per hour.

GMPH = movecount / (lastMoveTime - firstMoveTime)

This gadget does not have any editable parameters.

You can also create a gadget to view productive cycles per hour (PCPH) for a quay crane using Database
Backed Variforms. For more information, see Creating a PCPH gadget. (on page 524)

3.3.2.28 Quay Cranes Moves by Lift Mode for selected Quay

gadget
Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Moves by Lift Mode for selected Quay gadget

The Quay Cranes Moves by Lift Mode for selected Quay gadget displays a stacked bar chart of the move count by
lift mode (single, twin, tandem, quad) for the selected quay crane for the last 4 hours. The x-axis represents the time
and y-axis the moves.

This gadget displays data only when you select a quay crane in the Quay Cranes Moves by Lift Mode for
selected Quay form.

3.3.2.29 Quay Cranes Moves by Lift Mode gadget

Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Moves by Lift Mode gadget

The Quay Cranes Moves by Lift Mode gadget displays a stacked bar chart of the move count by lift mode (Single,
Twin, Tandem, Quad) for all quay cranes for the last hour. The x-axis represents the quay cranes and the y-axis the
moves per hour.

This gadget does not have any editable parameters.

3.3.2.30 Quay Cranes Net Moves By Hour gadget

Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Net Moves By Hour gadget

The Quay Cranes Net Moves By Hour gadget displays a bar chart of the net moves for the last hour for the selected
quay cranes (QC). By default, this gadget displays data for the last 4 hours. The x-axis represents the quay cranes and
the y-axis the net moves per hour.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 498
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

NMPH is calculated as: 'ovecount / ((lastMoveTime – firstMoveTime) – activityTime)

This gadget displays data only when you select a QC in the Quay Cranes Net Moves By Hour form (on page
519).

3.3.2.31 Truck KPIs gadget

Operations Dashboards <Dashboard> <Dashboard> tab Truck KPIs gadget

The Truck KPIs gadget displays the trend of gate performance in the last 4 to 8 hours along with the current value of
several inter-related gate and yard key performance indicators.

The list view contains the columns described in the following table.

Column Description

Last 4 hours A sparkline illustrating the value of the respective

metric every hour on the hour for the last number of
hours, as specified in the Truck KPIs form.

Metrics The name of the metric to which the data in the row
relates:

• Trucks In Yard: The number of trucks that entered

but have not exited and that have a TruckVisitStatus
of OK or Trouble.
• Trucks of Long Stay: The number of trucks
currently in the yard with an in-yard time exceeding
a defined yard service time, based on setting
ROADMONITOR002 (YARD_SERVICE_TIME) (on
page 467).
• Trucks Entered Last Hr: The number of trucks that
entered the yard in the last 60 minutes, regardless
of truck exit time.

This metric does not consider canceled or

closed transactions.

• Average Turn Time Last Hr: The average truck

turn time for all trucks, regardless of their number of
transactions, that exited the yard in the last 60
minutes and that have a status of Complete.
• % of Trouble Visits Last Hr: The percentage of the
number of trucks with trouble transactions that
entered the yard in the last 60 minutes, divided by
the total number of trucks that entered the yard in
the last 60 minutes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 499
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description

Actual vs. threshold A gauge illustrating the respective metric's value in the
context of its thresholds. To all metrics applies: The
greater the value, the worse the performance.
Gauges indicate whether the current metric value falls
into an acceptable or unacceptable range, and how
close the value is to the threshold. Every gauge
depicts poor performance on the left (indicated by a
dark shade of grey) and better to good performance on
the right (indicated by lighter shades of grey). This
means that the threshold values on the left can start
out low, for example for productivity gauges, or high,
for example for turn time gauges.
Actual A value indicating the metric's most recent update.

The Truck KPIs gadget helps you get a comprehensive picture of truck processing efficiency. The gadget also
provides starting points for investigating possible problems. For example:

• A climbing or higher than normal trouble visit percentage could indicate that more trouble desk clerks are needed or
that shifts should be extended, if possible. You should also investigate whether there is a common thread for the
troubles that could be addressed at once, such as incorrect booking information from a line.
• An increasing number of trucks entering the yard could have a negative effect on turn time that you would see in the
sparklines showing the last 4-to-8-hour trend for these metrics.
• An increase in average turn time or in the number of trucks with long visits could indicate a problem if the number of
trucks entering the yard has remained steady. In this case, you should find out where in the yard trucks are held up
and address the bottleneck to bring operation back to normal.
You can click any row in this gadget to display a list of trucks related to the respective key performance indicator.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

For this gadget to work properly, the Secondary Statistics job must be running in the background. For details,
see Background Jobs view.

3.3.2.32 Truck Turn Time gadget

Operations Dashboards <Dashboard> <Dashboard> tab Truck Turn Time gadget

The Truck Turn Time gadget displays a bar chart of the number of trucks that exited the facility on a given day, by
truck turn time.

The x-axis represents the truck turn time, in minutes. Each x-axis label displays a bar that represents the number of
truck visits within a range of truck turn times. For example, 10-20 displays the number of truck visits with turn times
between 10 and 20 minutes.

N4 calculates the truck turn time as the time of the truck visit's completion minus the time of the truck visit's creation.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 500
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The y-axis represents the total number of truck visits.

Because the gadget shows information for all trucks with an exit time on a given day, all values will drop to zero
(0) at midnight.
The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.33 Trucks in Yard gadget

Operations Dashboards <Dashboard> <Dashboard> tab Trucks in Yard

The Trucks in Yard gadget displays a stacked bar graph. Along the x-axis, the following bar graphs illustrate the
number of trucks in the yard, each for a different number of transactions, based on service-time thresholds:

• One: Trucks with a single transaction

• Two: Trucks with two transactions
• Other: Trucks with zero, three, or more transactions
• Total: All trucks
Each bar consists of differently colored segments, as described in the following table.

Segment Color Description Filter Criteria

Bottom Red The number of truck visits Time in yard >= bad
exceeding the yard service threshold
time
Middle Yellow The number of truck visits Bad threshold > time in yard
approaching the bad >= OK threshold
threshold for yard service
time
Top Green The number of truck visits OK threshold > time in yard
well under yard service time

The Trucks in Yard gadget helps you identify, in real time, the number of trucks currently in the yard that are
exceeding the service time threshold. For example, if the service time to turn around a single-transaction truck is set to
30 minutes, this gadget shows you how many trucks have exceeded 30 minutes and how many were serviced below or
approaching the specified threshold.

Usually, slow service time results from an insufficient number of CHE resources. For example, you might have a truck
sitting in an RTG block for over an hour waiting to be serviced because no RTG has been allocated to the zone. The
Trucks in Yard gadget provides context for the seriousness of truck processing and yard congestion problems. To
expedite the turnaround time, you can direct yard resources to service the trucks in the yard.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.34 Unit Dwell Time gadget

Operations Dashboards <Dashboard> <Dashboard> tab Unit Dwell Time gadget

The Unit Dwell Time gadget displays a bar chart of the number of containers in the yard by the unit dwell time. The

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 501
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

gadget lists all containers with Yard, Truck, and ITV locations if their dwell time is greater than 0 and less than 365
days.

Because this gadget does not list containers with a dwell time exceeding 365 days, the number of containers
displayed in this gadget usually differs from the number of import containers displayed in the Units In Yard
gadget. To verify this, go to the Units view, add a column called Dwell, and then sort by category.
The x-axis represents the unit dwell time, in days. Each x-axis label displays a bar that represents the number of
containers with a unit dwell time as follows:

• 1-4: Greater than 0 days (for example 2 hours) and less than or equal to 4 days
• 5-9: Greater than 4 days and less than or equal to 9 days
• 10-14: Greater than 9 days and less than or equal to 14 days
• 15-19: Greater than 14 days and less than or equal to 19 days
• 20-24: Greater than 19 days and less than or equal to 24 days
• 25-29: Greater than 24 days and less than or equal to 29 days
• 30-34: Greater than 29 days and less than or equal to 34 days
• 35-39: Greater than 34 days and less than or equal to 39 days
• 40-44: Greater than 39 days and less than or equal to 44 days
• 45-49: Greater than 44 days and less than or equal to 49 days
• 50+: Greater than or equal to 50 days and less than 365 days
N4 calculates the unit dwell time as the current time minus the time that the container entered the yard at the current
facility.

The y-axis represents the total number of containers.

The container count in the Units Dwell Time gadget includes all containers of category Transship, Export, Import and
Storage with current location = Y,T,I and E, but filters out E containers in Vessel and In Community, that is, the current
location is E with current location code (CLQL) = C or V.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

This gadget does not have any editable parameters.

3.3.2.35 Units in Yard gadget

Operations Dashboards <Dashboard> <Dashboard> tab Units in Yard gadget

The Units in Yard gadget displays a pie chart that illustrates the number of twenty-foot equivalent units (TEUs) in the
yard. N4 counts one TEU for each 20-foot container and two TEUs for each 40-foot container. The gadget counts each
container as one, irrespective of its size. Each wedge represents the number of units in a specific category, such as
EXPORT or IMPORT containers.

The container count in the Units in Yard gadget includes all containers of category Transship, Through, Export, Import,
Domestic, Storage with current location = Y,T,I and E, but filters out E containers in Vessel and In Community, that is,
the current location is E with current location code (CLQL) = C or V.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 502
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

This gadget does not have any editable parameters.

3.3.2.36 Vessel KPIs gadget

Operations Dashboard <Dashboard> <Dashboard> tab Vessel KPIs gadget

The Vessel KPIs gadget displays a list view that presents a vessel's moves in the last 60 minutes in the first row and
the plan deviation in the second row. The list view contains the columns described in the following table.

The Vessel Metrics gadget and the Vessel KPI gadget show data on a specific vessel for as long as the gadget
remains open and even after a vessel has departed. To clear data from one of these gadgets after a vessel's
departure, you close and then re-open the gadget, or you update the visit reference to monitor a different vessel.

To review historical performance, look at the trend indicated by the sparkline in the Last 36 Hours column. To
review the current performance, look at the value displayed in the Actual column and the gauge displayed in
the Actual vs. Threshold column. These values show the vessel moves in the last 60 minutes and the current
plan deviation.

Column Description 1st row Description 2nd row

Last 36 Hours A sparkline illustrating a vessel's plot A sparkline illustrating the plot plan
moves per hour, on the hour, for up deviation for the vessel on the hour,
to the last 36 hours. for up to the last 36 hours.
By default, the lower and upper By default, the lower and upper
bounds for this metric are defined as bounds for this metric are defined as
10 and 30. 10 and 30 (mins).

The sparkline does not

display null values.

Metrics Moves per hour Plan Deviation

Actual vs. threshold A gauge illustrating the current value A gauge illustrating the current value
of moves for the vessel in the last of plan deviation for the vessel.
hour. By default, the thresholds are defined
By default, the thresholds are defined as follows: poor > 30, good < -60
as follows: poor < 45, good > 60 Gauges indicate whether the current
Gauges indicate whether the current metric value falls into an acceptable
metric value falls into an acceptable or unacceptable range, and how
or unacceptable range, and how close the value is to the threshold.
close the value is to the threshold. Every gauge depicts poor
Every gauge depicts poor performance on the left (indicated by
performance on the left (indicated by a dark shade of grey) and better to
a dark shade of grey) and better to good performance on the right
good performance on the right (indicated by lighter shades of grey).
(indicated by lighter shades of grey). This means that the threshold values
This means that the threshold values on the left can start out low, for
on the left can start out low, for example for productivity gauges, or
example for productivity gauges, or high, for example for turn time
gauges.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 503
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description 1st row Description 2nd row

high, for example for turn time For more information on the behavior
gauges. of this gauge, see Understanding the
Plan Deviation gauge.

Actual An integer value indicating the actual The actual current value of plan
current value of a vessel's moves in deviation for the vessel, in minutes
the last 60 minutes

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.37 Vessel Metrics gadget

Operations Dashboard <Dashboard> <Dashboard> tab Vessel Metrics Table gadget

The Vessel Metrics gadget displays a list view of metrics for a specific vessel on berth. The list view displays the
actual current value of the following metrics for a vessel.

The Vessel Metrics gadget and the Vessel KPI gadget show data on a specific vessel for as long as the gadget
remains open and even after a vessel has departed. To clear data from one of these gadgets after a vessel's
departure, you close and then re-open the gadget, or you update the visit reference to monitor a different vessel.

Column Description
% ForceMajeure Delays Sum of delays caused by acts of nature

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 504
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description
divided by eGGH (effective gross gang
hours) for the cranes working the vessel

N4 lets you configure custom crane

activities (using the Crane Delay
Types form) and assign them to the
pre-defined delay categories
Terminal, Non-terminal, or Force
Majeure. You can also use the
Crane Delay Types view to identify
delay categories.

% Non Term Delays Sum of non-terminal delays divided by eGGH

(effective gross gang hours) for the cranes
working the vessel
% Term Delays Sum of terminal delays divided by eGGH
(effective gross gang hours) for the cranes
working the vessel
ATA Actual time of arrival
ATD Actual time of departure
eGGH Effective gross gang hours. See effective
productivity metrics for more information.
eGMPH The effective gross moves per hour. See
effective productivity metrics for more
information.
eNGH Effective net gang hours. See effective
productivity metrics for more information.
eNMPH Effective net moves per hour. See effective
productivity metrics for more information.
ETA Estimated time of arrival
ETC Estimated time of completion
ETD Estimated time of departure
First Mv/Act Time Time of first move or activity
GGH Gross gang hours
GMPH Gross moves per hour.

When no moves are performed for

the vessel, this column is blank.

Last Mv/Act Time Time of last move or activity.

Mvs Compl The moves completed
Mvs to Go The moves to go for the vessel
NGH The net gang hours for the vessel
NMPH Net moves per hour

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 505
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

Column Description
Plan Dev. Plan deviation, which is equal to Final ETC -
PTC
PTC Planned time of completion for the vessel
Req BMPH Required berth moves per hour. The required
productivity for the vessel to complete on
time, which is equal to Moves to Go divided
by the Time to PTC.
Service The service code for the vessel, such as
PSX.
Time to PTC Time to planned time of completion for the
vessel, which is equal to PTC - current
application time.
Vessel Name of the vessel
Visit Ref The vessel visit ID

Calculation of effective productivity metrics

Monitor and Analytics calculate effective productivity metrics by determining if the crane has worked for any other
vessel, based on the crane's moves or activities.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.38 Vessels Alongside gadget

Operations Dashboards <Dashboard> <Dashboard> tab Vessels Alongside gadget

The Vessels Alongside gadget displays a list view of all the vessels that have arrived but have not departed.

In addition, N4 displays an icon that indicates whether or not the vessel is running behind schedule.

In this context, the scheduled finish time is the time at which the vessel is scheduled to finish. This time is fixed. The
predicted finish time is the time at which the vessel will complete all its moves. The predicted finish time minus the
scheduled finish time determines if the vessel is late or not. This is referred to as Late Minutes.

You can edit the number of minutes that a vessel must be behind schedule to determine when the Vessels Alongside
gadget will display a yellow or red icon by modifying the values for the Late Minutes Red and Late Minutes Yellow
parameters in the Vessels Alongside form (on page 521).

If Late Minutes is greater than Late Minutes Red, the gadget displays a red error icon in the Status column. If Late
Minutes is greater than Late Minutes Yellow and less than or equal to Late Minutes Red, the gadget displays a
yellow warning icon. Otherwise, the gadget displays a green icon.

For example: When you set the Late Minutes Yellow field to 100 and the Late Minutes Red field to 200, the gadget
displays a red error icon when the vessel is more than 200 minutes behind schedule and a yellow warning icon when
the vessel is between 100 and 200 minutes behind schedule. The gadget displays a green icon when the vessel is less
than or equal to 100 minutes behind schedule.

N4 always checks for the most critical state first. So if N4 finds that the yellow value is greater than the red value, the
gadget displays a red icon.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 506
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The Vessels Alongside gadget includes data for the following:

• Vessels with an actual time of arrival (ATA) that is not null (ATA != null) and that is before or equal to now (ATA <=
now)
• Vessels with an actual time of departure (ATD) that is null (ATD == null) or that is after or equal to now plus the
defined data display period for the vessel (ATD >= now+MENDASHBOARD002 (VSL_DATA_DISPLAY_PERIOD)
(on page 465)
If you double-click a vessel, N4 opens the Vessel Inspector for the selected vessel.

The Vessels Alongside gadget displays the following information:

Metric Description
ATA A crane/vessel productivity metric. At vessel level, the
actual time of arrival for the vessel provided by XPS,
typically set in the host system.
ATD A crane/vessel productivity metric. At vessel level, the
actual time of departure for the vessel provided by XPS,
typically set in the host system.
BMPH Berth moves per hour

Crane Count Number of cranes that are working on the vessel or

scheduled to work on the vessel.
eGMPH The effective gross moves per hour. See effective
productivity metrics for more information.
ETD The estimated time of departure of a vessel or train
visit. Also a crane/vessel productivity metric.
ETC The estimated Time of Completion for the crane. This is
a projection provided by N4 for when the crane will
finish a work queue in Quay Commander. This estimate
factors in productivity assumptions, projections, and
planned breaks.
Moves Completed A crane/vessel productivity metric. At crane level, the
count of all container moves made by the crane for a
vessel that were onto, off, or on the vessel. These
moves include vessel load, discharge, and shift on
board. At vessel level, the sum of moves completed for
all the cranes that worked on the vessel.
Moves to Go A crane/vessel forward-looking metric. At vessel level,
the sum of all moves to go of all the cranes that are
working or planned to work on the vessel. Moves_to_go
does not include projections.
Status • Green icon - Vessel operations are on schedule
• Yellow icon - Warning
• Red icon - Vessel is behind schedule
Vessel Name Name of the vessel
Visit Phase The state of the visit. Values include: Arrived, Working,
Complete, Departed, Closed, Cancelled
Visit Reference The unique reference ID for the visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 507
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Adding gadgets

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.2.39 Yard Utilization gadget

Operations Dashboard <Dashboard> <Dashboard> tab Yard Utilization gadget

Reflecting the real-time status of the yard in the last hour, the Yard Utilization gadget helps you identify problematic
yard areas. For example, the yard utilization gauge and metrics provide terminal managers with a snapshot of the yard
status that indicates if the yard is running out of slots or reefer plugs, and yard managers find detailed information such
as how many slots or reefer plugs are blocked off due to stack restrictions or how many slots and reefer plugs are still
available.

The Yard Utilization gadget displays a list view of utilization metrics and other related metrics for the configurable
areas in the yard that you are currently logged on to. The list view presents information on reefer plugs in the first row
and on the total yard in the second row, providing a utilization summary across the yard. The subsequent rows show
utilization by area; hence the row labels are area codes ordered alphabetically, in ascending order. If you have not
assigned any area codes, the list includes only these rows: Reefer Plugs, Total Yard, and Unknown. The values for
Total Yard and Unknown will be the same.

The rows Reefer Plugs and Total Yard always display on top of the list. However, when you sort information by
Area, these rows get sorted along with other area codes.

The yard utilization gadget retrieves data based on ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ)

(on page 464). For example, when ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ) has a value of
10, the Yard Utilization gadget tries to retrieve yard block statistics extracted within the last 10 minutes. If it
does not find any statistics extracted within this time frame, it looks at the previous 10 minutes. It keeps
checking back in 10-minute intervals, up to the last hour. If N4 cannot find any yard block statistics extracted
within the last hour, the gadget goes blank.
The list view displays the actual current value of the metrics for a yard stack block, as described in the following table.

Column Description
Area A group of blocks, typically stack containers,
with similar characteristics, regardless of their
physical locations in the yard. Terminals can
assign area codes based on their yard
operation. For more information, see
Managing yard areas.
Available Slots The number of usable slots in the block minus
the number of used slots.
Restricted Slots The number of slots constrained due to yard
stack restrictions, which equals the number of
total slots minus the number of usable slots.
Total Slots The total number of slots configured for a yard
block or a sub-portion of the block, such as a
tier.
Update Time The last time the Yard Block Statistics job
retrieved yard block details from XPS. The
refresh rate depends on the
ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) (on
page 464) setting.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 508
Confidential -- Proprietary
 Part 3: Business Intelligence <Dashboard> tab
Moving gadgets

Column Description
Usable Slots The total number of serviceable slots in the
block, which is the number of total slots minus
the number of restricted slots.
Examples of restrictions for stack blocks
include roadways, men working, or other
temporary obstructions (as configured in the
Set Stack Status dialog box in XPS).
Used Slots The number of occupied slots in the block,
based on the number of TEU that are currently
stowed in the block plus the number of TEU
that are planned to the block.
Utilization % The utilization percentage, where utilization is
the number of used slots in the block divided
by the number of usable slots.
Utilization Gauge A gauge illustrating the percentage of yard
utilization, with 0% on the left hand side and
100% on the right hand side.
The cell's background color indicates low, OK,
or high utilization, according to the thresholds
defined in the Yard Utilization form.
By default, the thresholds are defined as
follows: low < 60%, high > 85%
If you have administrator privileges, you can
define these thresholds in the Yard Utilization
form.

For information on the data refresh rate for this gadget, see About data refresh rates.

For more information on the related metrics, see Yard metrics (on page 572).

To hide or remove columns, see Managing columns.

The gadget refreshes based on the value specified for the FRMCARINA033 (GADGET_REFRESH_PERIOD) (on
page 465) setting.

3.3.3 Moving gadgets

Operations Dashboards <Dashboard> <Dashboard> tab

You can move and resize existing gadgets as needed in a dashboard on the <Dashboard> tab.

To move a gadget:
• Click the title bar of the gadget that you want to move and drag it to the desired location on the <Dashboard> tab. If
you resize a gadget, N4 retains the change and displays the same view when you close and open the dashboard.

3.3.4 Editing the parameter settings of gadgets

Operations Dashboards <Dashboard> <Dashboard> tab

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 509
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

On the <Dashboard> tab, you can edit the parameter settings of the gadgets in a dashboard.

To be able to edit gadgets, a user needs the respective privileges. For more information on privileges and roles,
see Privileges view and Roles view.
As an administrator, you can also change a gadget's default parameter settings (on page 515).

To edit the parameter settings of an existing gadget:

1. On the <Dashboard> tab, in the upper right corner of the gadget that you want to edit, click .
2. Click one of the following:

▪ to view the form info

▪ to view the context-sensitive help for the selected gadget.

▪ to edit the selected gadget.

The form for the selected gadget opens. For example, the Units in Yard form opens for the Units in Yard gadget.

3.3.4.1 AGV Average moves per hour form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Average moves per hour form

The AGV Average moves per hour form enables you to edit properties for the AGV Average moves per hour
gadget.

To edit the AGV Average moves per hour gadget:

1. From the Pool drop-down list, select the pool. You can select only one AGV pool.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default and
minimum is 1 hour and the maximum is 8 hours.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.2 AGV Idle Time By AGV Pool form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Idle Time By AGV Pool form

The AGV Idle Time By AGV Pool form enables you to edit properties for the AGV Idle Time By AGV Pool gadget.

To edit the AGV Idle Time By AGV Pool gadget:

1. From the Pool drop-down list, select the pool. You can select only one AGV pool.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default and
maximum is 4, the minimum is 1.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 510
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

3.3.4.3 AGV Moves Per Hours form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Moves per hour form

The AGV Moves Per Hour form enables you to edit properties for the AGV Moves Per Hour gadget.

To edit the AGV Mover Per Hour gadget:

1. From the Pool drop-down list, select the pool. You can select only one AGV pool.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.4 AGV Travel Distance form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Travel Distance form

The AGV Travel Distance form enables you to edit properties for the AGV Travel Distance gadget.

To edit the AGV Travel Distance gadget:

1. From the Pool drop-down list, select the pool. You can select only one AGV pool.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.5 AGV Wait at QC form

Operations Dashboards <Dashboard> <Dashboard> tab AGV wait at QC form

The AGV Wait At QC form enables you to edit properties for the AGV Wait At QC gadget.

To edit the AGV Wait At QC gadget:

1. From the Quay Crane drop-down list, select the crane. You can select only one crane.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default and
minimum is 1, and the maximum is 8.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.6 AGV Wait At Parallel Buffer form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Wait for ASC TZ form

The AGV Wait At Parallel Buffer form enables you to edit properties for the AGV Wait At Parallel Buffer gadget.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 511
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

To edit the AGV Wait At Parallel Buffer gadget:

1. From the Pool drop-down list, select the pool. You can select only one AGV pool.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default and
maximum is 24 and the minimum is 1.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.7 AGV Wait In ASC TZ form

Operations Dashboards <Dashboard> <Dashboard> tab AGV Wait in ASC TZ form

The AGV Wait in ASC TZ form enables you to edit properties for the AGV Wait in ASC TZ gadget.

To edit the AGV Wait in ASC TZ gadget:

1. From the Yard Block list, select the required yard block or select multiple yard blocks by holding down the Shift key
while you select them.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.8 ASC Driving Time form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Driving Time form

The ASC Driving Time form enables you to edit properties for the AGV Driving Time gadget.

To edit the ASC Driving Time gadget:

1. From the ASC Reference drop-down list, select the ASC. You can select only one ASC.
2. In the Look Back Hours field, enter the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.9 ASC Idle Time by Yard Block form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Idle time by Yard Block form

The ASC Idle time by Yard Block form enables you to edit properties for the ASC Idle Time by Yard Block gadget.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 512
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

To edit the ASC Idle time by Yard Block gadget:

1. From the Yard Block list, select the required yard block or select multiple yard blocks by holding down the Shift key
while you select them.
2. From the Look Back Hours list, select the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.10 ASC Moves by Move Kind form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Moves by Move Kind form

The ASC Moves by Move Kind form enables you to edit properties for the ASC Moves by Move Kind gadget.

To edit the ASC Moves by Move Kind gadget:

1. From the ASC Reference drop-down list, select the ASC. You can select only one ASC.
2. In the Look Back Hours field, enter the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.11 ASC Moves last hour form

Operations Dashboards <Dashboard> <Dashboard> tab ASC moves last hour form

The ASC Moves last hour form enables you to edit properties for the ASC Moves last hour gadget.

To edit the ASC Moves last hour gadget:

1. From the ASC list, select the required ASC or select multiple ASCs by holding down the Shift key while you select
them.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.12 ASC Productivity form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Productivity form

The ASC Productivity form enables you to edit properties for the ASC Productivity gadget.

To edit the ASC Productivity gadget:

1. From the ASC list, select the required ASC or select multiple ASCs by holding down the Shift key while you select
them.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 513
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.13 ASC Red Time For Date Range form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Red Time for Date Range form

The ASC Red Time For Date Range form enables you to edit properties for the ASC Red Time For Date Range
gadget.

To edit the ASC Red Time For Date Range gadget:

1. From the ASC list, select the required ASC. You can select only one ASC.
2. In the Look Back Days field, enter the number of days for which you want to display data. The default and
maximum is 7, and the minimum is 1.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.14 ASC Red Time Current Day Range form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Red Time Per Day By Yard Block form

The ASC Red Time Per Day By Yard Block form enables you to edit properties for the ASC Red Time Per Day By
Yard Block gadget.

To edit the ASC Red Time Per Day By Yard Block gadget:
1. From the ASC list, select the required ASC or select multiple ASCs by holding down the Shift key while you select
them.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.15 ASC Summary form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Summary form

The ASC Summary form enables you to edit properties of the ASC Summary gadget.

To edit the properties of the ASC Summary gadget:

1. From the Look Back Hours list, select the number of hours for which you want to display data. The default is 1, and
the maximum is 8.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 514
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

3.3.4.16 ASC Travel Distance form

Operations Dashboards <Dashboard> <Dashboard> tab ASC Travel Distance form

The ASC Travel Distance form enables you to edit the properties of the ASC Travel Distance gadget.

To edit the properties of the ASC Travel Distance gadget:

1. From the ASC Reference list, select the ASC. You can select only one ASC.
2. In the Look Back Hours field, enter the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.17 Average ASC Cycle Time By ASC form

Operations Dashboards <Dashboard> <Dashboard> tab Average ASC Cycle Time By ASC form

The Average ASC Cycle Time By ASC form enables you to edit properties for the Average ASC Cycle Time By ASC
gadget.

To edit the Average ASC Cycle Time By ASC gadget:

1. From the ASC list, select the required ASC or select multiple ASCs by holding down the Shift key while you select
them.
2. In the Look Back Hours field, enter the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.18 Changing a gadget type's default parameter settings

If your role has the Gadget - Modify Default Properties privilege (on page 461), you can change the default
parameter settings for a gadget type for all users. This is helpful when you need to adjust the current default values to
reflect your terminal's operational policy.

The new default values apply to all new instances of a gadget type. Instances of a gadget that you added previously
keep their individual settings. If required, a user with a role that has the Gadget - Edit privilege may override the
default settings for a gadget.

When you close and reopen a dashboard, or you log out and log in again, all gadgets display the most recently
set parameter values, which are not necessarily the default values.
The following gadgets have parameters with system default values:

• Crane KPIs (on page 491): Minimum Threshold, Maximum Threshold, Sparkline Lower Bound, Sparkline Upper
Bound
• Moves per Day: Days Ago

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 515
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

• Vessels Alongside: Late Minutes Yellow, Late Minutes Red

• Vessel KPIs (on page 503): Moves Minimum Threshold, Moves Maximum Threshold, Moves Sparkline Lower
Bound, Moves Sparkline Upper Bound, Plan Dev Minimum Threshold, Plan, Dev Maximum Threshold, Plan Dev
Sparkline Lower Bound, Plan Dev Sparkline Upper Bound
• Fixed CHE Details (on page 517): CHE Type, POW, ID, Pool ID
• Yard Utilization: Utilization Minimum Threshold (%), Utilization Maximum Threshold (%)

To change the default parameter settings for a gadget type:

1. In a gadget, click .
2. In the Edit [Gadget Name] form, edit the parameter settings as required.
3. Select the Make Default check box.
4. Click Save.

3.3.4.19 Crane KPIs form

Operations Dashboards <Dashboard> <Dashboard> tab Crane KPIs form

The Crane KPIs form enables you to edit properties for the Crane KPIs gadget.

To edit the Crane KPIs gadget:

1. From the Vessel list, select the vessel visit ID. N4 lists all vessels belonging to the facility that you logged in to.
2. In the Minimum Threshold field, enter the value below which performance is considered poor.
The default value is 15.
3. In the Maximum Threshold field, enter a value above which performance is considered good.
The default value is 20.
4. In the Sparkline Lower Bound field, enter the lower boundary for the metric.
The default value is 10.
5. In the Sparkline Upper Bound field, enter the upper boundary for the metric.
The default value is 30.
6. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
7. Click Save.

3.3.4.20 Crane Metrics form

Operations Dashboards <Dashboard> <Dashboard> tab Crane Metrics form

The Crane Metrics form enables you to edit properties for the Crane Metrics gadget.

To edit the Crane Metrics gadget:

1. In the Vessel field, select the vessel visit ID. N4 lists all vessels belonging to the facility that you logged in to.
2. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 516
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

3.3.4.21 Crane Rhythm form

Operations Dashboards <Dashboard> <Dashboard> tab Crane Rhythm form

The Crane Rhythm form enables you to edit properties for the Crane Rhythm gadget (on page 493).

To edit the Crane Rhythm gadget:

1. From the Vessel list, select the vessel visit ID.

N4 lists all vessels belonging to the facility that you logged in to.

2. From the Look back Hours list, select the number of hours for which you want to display data.
3. Click Save.

3.3.4.22 Fixed CHE Details form

Operations Dashboards <Dashboard> <Dashboard> tab Fixed CHE Details form

The Fixed CHE Details form enables you to edit properties for the Fixed CHE Details gadget. To view information on
multiple CHE types, you can add different Fixed CHE Details gadgets to the Dashboard and specify a different CHE
type in each.

All fields in this form list entities for the current facility.

To edit the Fixed CHE Details gadget:

1. From the CHE Type drop-down list, select the type of fixed CHE on which the gadget is to show information: RTG,
FORK, MAN, RMG, or RS.
2. Optionally, specify a POW ID or Pool ID to show only fixed CHEs working for a specific POW or Pool.

The options available in the POW ID and Pool ID drop-down lists include all objects, not just those valid for
the last hour. To get relevant search results, you must select valid entries.

3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings.
4. Click Save.

3.3.4.23 Moves per Day form

Operations Dashboards <Dashboard> <Dashboard> tab Moves per Day form

The Moves per Day form enables you to edit properties for the Moves per Day gadget.

To edit the Moves per Day gadget:

1. In the Days Ago field, enter the number of days, including the current day, that N4 should display in the gadget. The
maximum number of days that can be displayed by the gadget is 7.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 517
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.24 Moving CHE Details form

Operations Dashboards <Dashboard> <Dashboard> tab Moving CHE Details form

The Moving CHE Details form enables you to edit properties for the Moving CHE Details gadget. To view information
on multiple CHE types, you can add different Moving CHE Details gadgets to the Dashboard and specify a different
CHE type in each.

All fields in this form list entities for the current facility.

To edit the Moving CHE Details gadget:

1. From the CHE Type drop-down list, select the type of moving CHE on which the gadget is to show information.
▪ For Terminal Tractor, select TRK.
▪ For Straddle, select STR.
2. Optionally, specify a POW ID or Pool ID to show only Moving CHEs working for a specific POW or Pool.

The options available in the POW ID and Pool ID drop-downs include all objects, not just those valid for the
last hour. To get relevant search results, you must select valid entries.

3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings.
4. Click Save.

3.3.4.25 Quay Cranes Moves by Lift Mode for selected Quay

form
Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Moves by Lift Mode for selected Quay form

The Quay Cranes Moves by Lift Mode for selected Quay form enables you to edit properties for the Quay Cranes
Moves by Lift Mode for selected Quay gadget.

To edit the Quay Cranes Moves by Lift Mode for selected Quay gadget:
1. From the Quay Crane list, select the required quay crane. You can select only one quay crane.
2. In the Look Back Hours field, enter the number of hours for which you want to display data. The default is 4, the
minimum is 1, and the maximum is 24.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 518
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

3.3.4.26 Quay Cranes Net Moves By Hour form

Operations Dashboards <Dashboard> <Dashboard> tab Quay Cranes Net Moves By Hour form

The Quay Cranes Net Moves By Hour form enables you to edit properties for the Quay Cranes Net Moves By Hour
gadget.

To edit the Quay Cranes Net Moves By Hour gadget:

1. From the Quay Crane list, select the required quay crane or select multiple quay cranes by holding down the Shift
key while you select them.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.27 Truck KPIs form

Operations Dashboards <Dashboard> <Dashboard> tab Trucks in Yard form

The Truck KPIs form lets you edit properties for the Truck KPIs gadget, as specified in the following table.

Field (Parameter) Description Default

Look Back Hours The number of hours for which 8
you want to display data
Trucks in Yard Minimum The value below which the 0
Threshold number of trucks in the yard is
considered okay. The minimum
value is 0, the maximum 10,000.
Trucks in Yard Maximum The value above which the 200
Threshold number of trucks in the yard is
considered too much. The
minimum value is 0, the
maximum 10,000.
Trucks in Yard Sparkline The lower boundary for the 100
Lower Bound metric.
Trucks in Yard Sparkline The upper boundary for the 150
Upper Bound metric.
Trucks of Long Stay Minimum The value below which the 0
Threshold number of trucks in the yard with
poor service time is considered
okay. The minimum value is 0,
the maximum 10,000.
Trucks of Long Stay Maximum The value above which the 40
Threshold number of trucks in the yard with
poor service time is considered
too much. The minimum value is
0, the maximum 10,000.
Trucks of long Stay Sparkline The lower boundary for the 10
Lower Bound metric.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 519
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

Field (Parameter) Description Default

Trucks of long Stay Sparkline The upper boundary for the 25
Upper Bound metric.
Trucks Entered Minimum The value below which the 0
Threshold number of trucks that entered
the yard in the last 60 minutes is
considered okay. The minimum
value is 0, the maximum 10,000.
Trucks Entered Maximum The value above which the 400
Threshold number of trucks that entered
the yard in the last 60 minutes is
considered too much. The
minimum value is 0, the
maximum 10,000.
Trucks Entered Sparkline The lower boundary for the 200
Lower Bound metric.
Trucks Entered Sparkline The upper boundary for the 300
Upper Bound metric.
Average Turn Time Minimum The value below which the 0
Threshold average turn time is considered
good. The minimum value is 0,
the maximum 10,000.
Average Turn Time Maximum The value above which the 90
Threshold average turn time is considered
poor. The minimum value is 0,
the maximum 10,000.
Average Turn Time Sparkline The lower boundary for the 40
Lower Bound metric.
Average Turn Time Sparkline The upper boundary for the 60
Upper Bound metric.
% Trouble Visit Minimum The value below which the 0
Threshold percentage of truck visits with a
trouble ticket is considered okay.
The minimum value is 0, the
maximum 100.
% Trouble Visit Maximum The value above which the 15
Threshold percentage of truck visits with a
trouble ticket is considered poor.
The minimum value is 0, the
maximum 100.
% Trouble Visit Sparkline The lower boundary for the 4
Lower Bound metric.

% Trouble Visit sparkline The upper boundary for the 10

upper bound metric.

To edit the Truck KPIs gadget:

1. Edit the required parameter fields.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 520
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.28 Trucks in Yard form

Operations Dashboards <Dashboard> <Dashboard> tab Trucks in Yard form

The Trucks in Yard form lets you edit properties for the Trucks in Yard gadget, as specified in the following table. All
parameters have a possible minimum value of 0 and maximum value of 1000 minutes.

Field (Parameter) Description Default

One-Transaction Visit OK The value below which the 20
Threshold service time for a truck with a
single transaction is considered
good.
One-Transaction Visit Bad The value above which the 30
Threshold service time for a truck with a
single transaction is considered
poor.
Two-Transaction Visit OK The value below which the 45
Threshold service time for a truck with two
transactions is considered
good.
Two-Transaction Visit Bad The value above which the 60
Threshold service time for a truck with two
transactions is considered poor.
Other-Transaction Visit OK The value below which the 60
Threshold service time for a truck with
three or more transactions is
considered good.
Other-Transaction Visit Bad The value above which the 75
Threshold service time for a truck with
three or more transactions is
considered poor.

To edit the Trucks in Yard gadget:

1. Edit the required parameter fields. All values specify minutes.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

3.3.4.29 Vessels Alongside form

Operations Dashboards <Dashboard> <Dashboard> tab Vessels Alongside form

The Vessels Alongside form enables you to edit properties for the Vessels Alongside gadget.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 521
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Editing the parameter settings of gadgets

To edit the Vessels Alongside gadget:

1. In the Late Minutes Yellow field, enter the number of minutes that a vessel visit must be behind schedule to display
a yellow warning icon in the Status column.
2. In the Late Minutes Red field, enter the number of minutes that a vessel visit must be behind schedule to display a
red warning icon in the Status column.
3. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
4. Click Save.

3.3.4.30 Vessel KPIs form

Operations Dashboards <Dashboard> <Dashboard> tab Vessel KPIs form

The Vessel KPIs form enables you to edit the properties for the Vessel KPIs gadget.

To edit the Vessel KPIs gadget:

1. You can override the default values in the following fields:
▪ Vessel: Select the vessel visit ID. N4 lists all vessels belonging to the facility that you logged in to.
▪ Moves Minimum Threshold: Enter a value below which performance is considered poor.
The default value is 45.
▪ Moves Maximum Threshold: Enter a value above which performance is considered good.
The default value is 60.
▪ Moves Sparkline Lower Bound: Enter a value for the metric's lower boundary.
The default value is 10.
▪ Moves Sparkline Upper Bound: Enter a value for the metric's upper boundary.
The default value is 30.
▪ Plan Dev Minimum Threshold: Enter a value below which performance is considered good.
The default value is -60.
▪ Plan Dev Maximum Threshold: Enter a value below which performance is considered poor.
The default value is 30.
▪ Plan Dev Sparkline Lower Bound: Enter a value for the metric's lower boundary.
The default value is 10.
▪ Plan Dev Sparkline Upper Bound: Enter a value for the metric's upper boundary.
The default value is 30.
Click Save.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings (on page 515).
3. Click Save.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 522
Confidential -- Proprietary
 Part 3: Business Intelligence <Dashboard> tab
Editing the display properties of table gadgets

3.3.4.31 Vessel Metrics form

Operations Dashboards <Dashboard> <Dashboard> tab Vessel Metrics form

The Vessel Metrics form enables you to edit properties for the Vessel Metrics gadget.

To edit the Vessel Metrics gadget:

1. In the Vessel field, select the vessel visit ID. N4 lists all vessels belonging to the facility that you logged in to.
2. To maintain these settings as the new default, select the Make Default check box. For more information, see
Changing a gadget's default parameter settings.
3. Click Save.

3.3.4.32 Yard Utilization form

Operations Dashboards <Dashboard> <Dashboard> tab Yard Utilization form

The Yard Utilization form enables you to adjust the utilization thresholds applied in the Yard Utilization gadget to your
terminal's operation. The thresholds affect the Utilization and Utilization Gauge columns.

By default, the minimum threshold is set to 60 and the maximum threshold to 85.

To edit the Yard Utilization gadget:

1. In the Utilization Minimum Threshold (%) field, enter a number.
2. In the Utilization Maximum Threshold (%) field, enter a number.
3. Click Save.

3.3.5 Editing the display properties of table gadgets

You can edit the display properties (layout) of a table in a gadget by hiding or displaying columns, by sorting,
reordering, and resizing columns, and by saving the selected display properties as a filter. In this respect, the tables in
gadgets behave like the tables in list views.

To be able to edit gadgets, a user needs the respective privileges. For more information on privileges and roles,
see Privileges view and Roles view.
A table gadget inherits its display properties as follows:

• When you open a new instance of a table gadget, it takes on the display properties most recently set. Therefore,
different instances of the same table gadget may look different if you change the display properties or filter between
creating each instance.
• If you close and reopen a dashboard or log out and log in again, Monitor refreshes all table gadgets with the display
properties or filter most recently set.

Removing a saved filter in table gadgets does not re-establish the default view.

3.3.6 Hiding gadgets

You can hide gadgets that are displayed on the Dashboard tab for the selected dashboard. You can view the hidden
gadgets by right-clicking and selecting Reset to Default Layout option when you open that Dashboard again. However,

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 523
Confidential -- Proprietary
 Part 3: Business Intelligence <Dashboard> tab
Creating a PCPH gadget

you can right-click and select Save as Default Layout option if you do not want to retain the hidden gadgets on the
Dashboard. Here, N4 does not display the hidden gadgets when you reopen that Dashboard or right-click and select
Reset to Default Layout on the Dashboard.

Instead of hiding a gadget, you can just minimize it.

To hide a gadget:

1. In the upper right corner of the gadget that you want to close, click .
N4 displays an alert message.
2. When prompted whether you want to proceed, click Yes.

3.3.7 Creating a PCPH gadget

You can use Database Backed Variforms to view Productive cycles per hour (PCPH) in the Quay Cranes Moves By
Hour gadget.

To display the PCPH gadget, do as given below.

1. In the Database Backed Variforms view (Configuration Settings Database Backed Variforms), click to
open the Variform File Definition form.
2. In the Variform File Definition form, in the Name field, enter the name, such as Quay Crane PCPH.
3. From the XML Template list, select GADGET.
4. Click Edit Contents to make the Variform XML field editable.
5. In the Variform XML field, copy-paste the following variform definition in the <gadget> tag.
<gadget id="GADGET_NAME_QUAY_PC_BY_HOUR" group="GADGET_GROUP_APPLICATION">
<title>GADGET_NAME_QUAY_PC_BY_HOUR</title>
<description>Quay Productive cycles per hour including Last Hour</description>
unit
<name>CheMoveStatistics</name>
</entity>
<barChart>
<title>Quay Productive Cycles</title>
<legend/>
<generate toolTips="true"/>
<fonts>
<font target="title" size="14pt" style="bold"/>
</fonts>
<!-- Modify it to customQuayMovesPerHourChartDataManager for GMPH -->
<dataExtensionManager ref="customQuayProdCyclesPerHourChartDataManager "/>
<attributes>
<attribute key="ignoreTacitColorTheme" value="true"/>
</attributes>
<plotPanel>
<domainAxis fieldId="qcMovesQuayNames" label="Quay Cranes"></domainAxis>
<rangeAxis label="PCPH"/>
<series label="A">
<colors>
<color target="series" value="red"/>
</colors>

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 524
Confidential -- Proprietary
Part 3: Business Intelligence <Dashboard> tab
Creating a PCPH gadget

<rangeAxis fieldId="qcMovesMoveCount"/>
</series>
<series label="B">
<colors>
<color target="series" value="blue"/>
</colors>
<rangeAxis fieldId="qcMovesMoveCount"/>
</series>
<series label="C">
<colors>
<color target="series" value="yellow"/>
</colors>
<rangeAxis fieldId="qcMovesMoveCount"/>
</series>
<series label="D">
<colors>
<color target="series" value="green"/>
</colors>
<rangeAxis fieldId="qcMovesMoveCount"/>
</series>
</plotPanel>
</barChart>
</gadget>
6. Click Save.
7. In the Database Backed Variforms view, select Actions Reload All Variforms to propagate changes:
▪ Select the Only update local node option if you want to test the form locally before propagating the changes to
all nodes.
▪ Select the Propagate changes to all nodes option if you are ready to distribute the changes to all nodes in the
cluster.
8. Reload the variform. To do so, click Actions Reload All Variforms.
The PCPH gadget gets listed in the Add gadget form.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 525
Confidential -- Proprietary
3.4 BI Reference
This section provides reference information to help you better understand the data displayed in dashboard gadgets and
reports, as provided by the Monitor option and the Reporting feature. Throughout this section, the combined
functionality of Monitor and Reporting may be referred to as BI, short for business intelligence.

This section also provides operation scenarios that describe the behavior of BI in relation to XPS.

In This Section

Understanding the Plan Deviation gauge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

Determining which quay crane made a vessel move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Crane/Vessel Forward-Looking metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Crane/Vessel Crane Activity metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
ASC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
AGV metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Quay crane metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
RTG/RMG metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Yard metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Gate metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Move count per facility visit metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Equipment block visit (EBV) count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Internal and External trucks wait time metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Sample reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Operation scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Reporting a Monitor metric issue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 526
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Understanding the Plan Deviation gauge

3.4.1 Understanding the Plan Deviation gauge

When looking at the Plan Deviation gauge in the Vessel KPIs gadget (on page 503), keep the following in mind: Every
gauge depicts poor performance on the left (indicated by black) and better to good performance on the right (indicated
by shades of grey).

The gauge uses the following thresholds: a minimum threshold, which is the threshold of the lower numerical value,
and a maximum threshold, which is the threshold of the higher numerical value in the gauge. The terms minimum or
maximum do not imply good or bad. Their position in the gauge depends on the nature of the metrics.

In terms of plan deviation, higher plan deviation means worse performance. Therefore, the threshold values in the
gauge start out high on the left (with the Plan Dev. Maximum threshold) and end up low on the right (with the Plan Dev.
Minimum threshold).

The following scenarios illustrate the behavior of the Plan Deviation gauge.

• Good plan deviation (on page 527)

• Poor plan deviation (on page 528)
• Reasonable negative plan deviation (on page 529)
• Reasonable positive plan deviation (on page 530)
For all scenarios, the plan deviation thresholds are set to a minimum of -10 and a maximum of 15, as shown in the
following figure.

3.4.1.1 Good plan deviation

This scenario provides an example for good plan deviation and how the Vessel KPIs gadget (on page 503) presents it
in the Plan Deviation gauge. It is based on the following information:

• Estimated time of completion: 19:27

• Planned time of completion: 19:40
• Plan deviation: -12

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 527
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Understanding the Plan Deviation gauge

In the Vessel KPIs gadget, the Plan Deviation gauge appears as in the following figure. Because with a value of -12,
plan deviation is below the defined minimum threshold of -10, the red indicator line reaches into the light grey-shaded
area of good plan deviation.

3.4.1.2 Poor plan deviation

This scenario provides an example for poor plan deviation and how the Vessel KPIs gadget (on page 503) presents it
in the Plan Deviation gauge. It is based on the following information:

• Estimated time of completion: 19:27

• Planned time of completion: 19:10
• Plan deviation: 17

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 528
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Understanding the Plan Deviation gauge

In the Vessel KPIs gadget, the Plan Deviation gauge appears as in the following figure. Because with a value of -17,
plan deviation is above the maximum threshold of 15, the red indicator line remains in the black-shaded area of poor
plan deviation.

3.4.1.3 Reasonable negative plan deviation

This scenario provides an example for reasonable negative plan deviation and how the Vessel KPIs gadget (on page
503) presents it in the Plan Deviation gauge. It is based on the following information:

• Estimated time of completion: 19:27

• Planned time of completion: 19:34
• Plan deviation: -6

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 529
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Understanding the Plan Deviation gauge

In the Vessel KPIs gadget, the Plan Deviation gauge appears as in the following figure. Because with a value of -6,
plan deviation is above the minimum threshold of -10 but below the maximum threshold of 15, the red indicator line
reaches into the right side of the dark grey-shaded area of reasonable plan deviation.

3.4.1.4 Reasonable positive plan deviation (Vessel KPIs

gadget)
This scenario provides an example for reasonable positive plan deviation and how the Vessel KPIs gadget (on page
503) presents it in the Plan Deviation gauge. It is based on the following information:

• Estimated time of completion: 19:27

• Planned time of completion: 19:19
• Plan deviation: +8

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 530
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Determining which quay crane made a vessel move

In the Vessel KPIs gadget, the Plan Deviation gauge appears as in the following figure. Because with a value of +8,
plan deviation is above the minimum threshold of -10 but below the maximum threshold of 15, the red indicator line
reaches into the left side of the dark grey-shaded area of reasonable plan deviation.

3.4.2 Determining which quay crane made a vessel move

XPS sets the CheQC in a move record to be the crane that made the move. In a normal vessel operation, CheQC is
the ChePut in a load move, and the CheFetch in a discharge; CheQC is the same as the POW. However, there are
times when the CHE_ID for ChePut or CheFetch is null due to missing data entry or when POW and CHE_ID (put/
fetch) do not agree. The table below explains how XPS handles these exception scenarios.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 531
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

Scenarios CheQC value in XPS Crane that performed the move

but is unknown to XPS
1. Operation scenarios that result in POW Unknown due to missing information
data gap:
• When the hatch clerk missed
confirming a discharge, then a
dispatcher, an ITV, or RTG
confirmed the move
• Or a dispatcher confirmed a load
XPS also sets POW to CheQC if it is
a fetch from a vessel and the fetch
CHE is not a crane, or if it is a put to a
vessel and the put CHE is not a
crane.
2. Box shuffles on board CHE_ID (QC2) CHE_ID (QC2)
Due to an error in BAPLIE, a box
planned for QC1 (POW) is physically
lifted by QC2 (CHE_ID) because it is
in a location different from what XPS
thinks.
3. Equipment problem: CHE_ID (QC2) POW (QC1)
If the hatch clerk @QC1 cannot
confirm a move, for example due to a
poor radio signal or another handheld
problem, to continue the operation, he
has another hatch clerk @QC2
confirm his move. So a move planned
for and moved @QC1 (POW) is
completed by QC2 (CHE_ID).
4. Human error CHE_ID (QC2) POW (QC1)
The hatch clerk working @QC1
mistakenly logged into a different
QC2. When he confirms moves
planned for QC1 (POW), the CHE_ID
appears to be QC2.

3.4.3 Crane/Vessel Forward-Looking metrics

In managing a vessel operation, the vessel planner or supervisor needs to know when the operation is projected to
finish by using forward looking metrics, such as moves to go and estimated completion time. These metrics provide
input for a number of decisions and considerations, for example whether to keep a gang on for overtime, or whether to
move a crane to another vessel, or just how much time and work remains to resolve any operation issues or delay at
hand.

To help a vessel planner or supervisor determine if an operation is ahead or behind schedule and by how much, N4
lets you enter the planned completion time for each of the cranes that are working on a vessel. It also provides a plan
deviation that measures the difference between the current estimated completion time vs. the planned completion time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 532
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

3.4.3.1 Data Element Definition for Crane/Vessel Forward-

Looking metrics
The following table describes the data elements for crane/vessel forward-looking metrics at the crane level.

Data Element Description

Estimated_completion This is a figure provided by XPS that projects the time
when the crane finishes its work at a particular vessel for
the segment (that is when it finishes its work queue in
Quay Commander). XPS factors in productivity
assumption, projection (on page 534), and planned
breaks to provide the estimated completion.
Estimated_completion_final This is a figure provided by XPS that projects the time
when the crane finishes its work at a particular vessel for
the entire visit of the vessel. Similar to
estimated_completion, XPS factors in productivity
assumptions, projection, and planned breaks.
Moves_to_go The number of moves from the current moment to when
the crane finishes its work at a particular vessel for the
segment. This is the same as the number of moves that
remained in the crane work list in XPS, excluding
projections (on page 534).
Moves_to_go_final The number of moves, excluding projections, from the
current moment to when the crane finishes its work at a
particular vessel for the entire visit of the vessel.

For cranes, the following two sets of forward-looking metrics exist:

• The regular set (for the segment):

moves_to_go, estimated_completion
• The final set (for the entire vessel visit):
moves_to_go_final, estimated_completion_final
These two sets of metrics are used to show different information for a crane/vessel combination if the crane moves
from the vessel to other vessel(s) and eventually comes back to the vessel to do more work during the vessel visit.

Each time a crane is planned to work on the vessel, there is a record in the Vessel Crane Statistics table that
corresponds to each segment of work. In each segment, the "regular" metrics are based on the last move of the crane
on the vessel before it moves off, and the "final" metrics are based on the very last move of the crane on the vessel.

So if crane CR1 works at vessel A from 10:00 to 11:00 (with ETC=10:55, moves to to=44), goes off to do something
else, and comes back to vessel A from 15:00 to 17:00 (with ETC = 17:00, moves to go = 50), then there are 2 records
in the vessel/crane statistics with its own ETC and moves to go, and the same ETC final 17:00 and moves to go final
=94. In fact, when multiple segments exist for the same crane/vessel visit combination, they only differ in ETC and
moves to go. In additional to ETC final and moves to go final, the other metrics, such as moves completed, first move,
last move, gross gang hour, and gross productivity, are all the same.

If a crane does not leave and come back to a vessel during the vessel's visit, there is only one set of "regular" metrics,
and they match the "final" metrics, and the Vessel Crane Statistics table holds only one record. The sample section (on
page 536) provides different scenarios.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 533
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

3.4.3.2 Projection scenarios

The scenarios described in the following table illustrate how the metrics moves_to_go and estimated_completion factor
in projections.

Scenario Moves_to_go Estimated_completion

1 Assign a work queue (WQ) No change Extended by the time that is
of projections only to a point required to complete added
of work (POW) and projections
schedule it mid-shift. Make
sure some real work
instructions (WIs) are
available in any other WQ.
2 Assign a WQ of projections No change Extended by the time that is
only to a POW and required to complete added
schedule it at the end of a projections
shift. Make sure some real
work instructions (WIs) are
available in any other WQ.
3 Assign a WQ of projections No change Extended by the time that is
only to a POW and required to complete added
schedule it spanning two projections
consecutive shifts. Make
sure some real work
instructions (WIs) are
available in any other WQ.
4 Assign a WQ of projections No change Extended by the time that is
to a POW and schedule it required to complete added
spanning two split* shifts. projections that fall into the
Make sure some real work first shift. The
instructions (WIs) are estimated_completion_final
available in any other WQ. is extended by the time that
is required to complete all
added projections.
5 Assign a WQ with mainly Increased by the number of Extended by the time that is
work instructions (WI) and added WIs required to complete added
few projections to a POW WIs and projections
and schedule it mid-shift
6 Assign a WQ with mainly Increase by the number of Extend by the time that is
WIs and few projections to added WIs required to complete added
a POW and schedule it at WIs and projections
the end of a shift
7 Assign a WQ with mainly Increased by the number of Extend by the time that is
WIs and few projections to added WIs required to complete added
a POW and schedule it WIs and projections
spanning two consecutive
shifts

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 534
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

Scenario Moves_to_go Estimated_completion

8 Assign a WQ with mainly Increased by the number of Extended by the time that is
WIs and few projections to added WIs required to complete added
a POW and schedule it WIs and projections that fall
spanning two split* shifts into the first shift. The
estimated_completion_final
is extended by the time that
is required to complete all
added projections.

* The term split shifts refers to a crane that works another vessel in-between two shifts.

3.4.3.3 Definition of Crane/Vessel Forward-Looking Metrics

This table describes crane/vessel forward-looking metrics at the crane level.

Metric Description
Planned_completion A value for a crane working at a vessel. It is used to
compare to the dynamic estimated_completion_final to
provide the plan_deviation. Use Initialize PTC to set PTC
as the ETC of the moment.
When multiple segments occur, be sure to Initialize PTC
for all the segments of a crane
Plan_deviation Estimated_completion_final - planned_completion
If an operation is ahead of its planned completion time,
then plan deviation is negative.

This table describes crane/vessel forward-looking metrics at the vessel level.

Metric Description
Estimated_completion Estimated_completion_final of the crane that is projected
to finish last, because this is driving the vessel's
estimated completion time
Maximum of the estimated_completion_final of all the
cranes that have worked, are working, or planned to work
on the vessel
Moves_to_go Sum of all moves_to_go_final of all the cranes that are
working or planned to work on the vessel
Planned_completion Maximum of the planned_completion of all the cranes that
have worked, are working, or planned to work on the
vessel
Plan_deviation Estimated_completion - planned_completion

In summary, each crane has its own PTC and ETC final: the vessel's PTC is a maximum of its cranes' PTC, and the
vessel's ETC is a maximum of its cranes' ETC final. Therefore, the vessel's PTC and the vessel's ETC could come
from two different cranes. For example, if CR1 and CR2 both work for vessel A:

CR PTC ETC Final Plan Deviation

CR1 08-Feb-25 12:00 08-Feb-25 13:24 01:24
CR2 08-Feb-25 11:00 08-Feb-25 14:00 03:00

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 535
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

The above table shows that vessel A's PTC is 08-Feb-25 12:00 (from CR1), vessel A's ETC Final is 08-Feb-25 14:00
(from CR2), and vessel A's plan deviation is 02:00.

3.4.3.4 Example scenarios for Crane/Vessel Forward-Looking

Metrics
The scenarios in this section explain the behavior of the forward-looking metrics for a crane/vessel combination.

• Scenario 1: A (on page 536)

A crane (QC1) stays with one vessel (A) through its visit.
Scenario 1.1: A to completion (on page 536)
A crane (QC1) stays with one vessel (A) through its visit.
Metrics observed when QC1 finishes its move for vessel (A) because:
▪ QC1 completed all work assigned to it, or
▪ QC1's remaining moves have been assigned to another crane (QC2)
• Scenario 2: A -> B (on page 537)
A crane (QC1) works on one vessel (A) first, then moves to another vessel (B) but does not come back to vessel (A)
again.
• Scenario 3: A -> B -> A (on page 539)
A crane (QC1) works on one vessel (A) first, then moves to another vessel (B), and finally returns to the first vessel
(A) for more work.
• Scenario 4: A -> B -> A -> B (on page 540)
A crane (QC1) works on one vessel (A) first, then moves to another vessel (B), returns to the first vessel (A), and
finally goes to vessel (B).
• Scenario 5: A -> B -> A -> B -> A
A crane (QC1) works on one vessel (A) first, then moves to another vessel (B), returns to the first vessel (A), then
moves to vessel (B) again and finally goes back to vessel (A).
• Scenario 6: A -> B -> C (on page 541)
A crane (QC1) works on one vessel (A) first, and then moves to another vessel (B), then moves to a third vessel (C)
and finishes there.
• Scenario 7: A -> B -> C -> A (on page 542)
A crane (QC1) works on one vessel (A) first, then moves to another vessel (B), then moves to a third vessel (C), and
finally returns to the first vessel (A).

Vessel/crane scenario: A
Throughout the entire operation of vessel A, the regular and final forecasted metrics stay the same for QC1at vessel A.
See the column Metrics Values for QC1 at vessel A at time T1, T2, and T3 in scenario A B.

Vessel/crane scenario: A to completion

A crane (QC1) stays with one vessel (A) through its visit.

Metrics are observed when QC1 finishes its move for vessel (A) because QC1 completed all work assigned to it, or
QC1's remaining moves have been assigned to another crane, QC2.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 536
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

The regular and final forecasted metrics will be the same for QC1 at vessel A.

When QC1 finishes the last move, the following will be true:

Metric Value
moves to go = moves to go final 0
estimated_completion = Last known value
estimated_completion_final
planned_completion Last user-entered value

Vessel/crane scenario: A to B

Assume that the table below and the timeline above show what N4 receives as the plan for QC1 for vessels A and B, at
time T1.

Crane/Vessel Time of First Move No. of Moves Planned Time of Last Move
QC1 at vessel A 09:00 100 12:00 for lmv1A_1 (last
move for QC1 at vessel A
before moving off the first
time)
QC1 at vessel B 12:15 30 13:45 for lmv1B_1 (last
move for !C1 at vessel B
before moving off the first
time

The gray box in the above timeline shows the duration of the work and number of moves for QC1, for each of the
vessels A and B.

The table below shows the value of the metrics at different times.

The following keys are used in the table:

• mtg = moves to go

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 537
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

• mtg final = moves to go final

• est comp = estimated_completion
• est comp final = estimated_completion_final
• pln comp = planned_completion
• pln dev = planned_deviation
Because QC1 returns to neither vessel A nor B for more work, in both cases, the "regular" metrics are the same as the
"near" metrics.

Time Metric Values for QC1 at Metric Values for QC1 at

vessel A vessel B
T1 Before operation on A "final" metrics same as "final" metrics same as
starts: "regular" metrics, which "regular" metrics, which
Assume the planned means: means:
completion time for QC1 at mtg final = mtg mtg final = mtg
vessel A was set to 12:00 est comp final = est comp est comp final = est comp
and for QC1 at vessel B to
mtg: 100 mtg: 30
13:45, their respective
estimated completion time est comp: 12:00 est comp: 13:45
at the moment. pln comp: 12:00 pln comp: 13:45
pln dev: 0 pln dev: 0
T2 Before QC1 finishes with A: "final" metrics same as "final" metrics same as
Assume QC1 completed 25 "regular" metrics: "regular" metrics
moves since T1 mtg final: 75 (=100-25) mtg final: 30
XPS reports ETC for QC1 est comp final: 12:30 est comp final: 14:15
at vessel A to be 12:30 pln comp: 12:00 pln comp: 13:45
XPS reports ETC for QC1 pln dev: 0.5 (30 mins) pln dev: 0.5 (30 mins)
at vessel B to be 14:15
T3 After QC1 finishes with A, "final" metrics same as Same as above.
before starting with B: "regular" metrics
Assume the last ETC from mtg final: 0
XPS for QC1 at vessel A is est comp final: 12:45
12:45
pln comp: 12:00
No change in ETC for QC1
pln dev: 0.75 (45 mins)
at vessel B
T4 QC1 begins work at vessel QC1 no longer works for Q1 is working for vessel B.:
B vessel A. "final" metrics same as
"regular" metrics
mtg final: 30
est comp final: 14:15
pln comp: 13:45
pln dev: 0.5 (30 mins)
T5 Before QC1 finishes with B: Same as above. "final" metrics same as
QC1 completed 12 moves "regular" metrics
on B since T4 mtg final: 18
XPS reports ETC for QC1 est comp final: 14:30
at vessel B to be 14:30 pln comp: 13:45
pln dev: 0.75 (45 mins)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 538
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

Time Metric Values for QC1 at Metric Values for QC1 at

vessel A vessel B
T6 After QC1 completes with B Same as above. "final" metrics same as
at 14:28. "regular" metrics:
mtg final: 0
est comp final: 14:28
pln comp: 13:45
pln dev: 0.71 (43 mins)

Vessel/crane scenario: A to B to A

The timeline above marks the key moves on which the forward-looking metrics are based, as follows:

• lmv1A_1: The last move for QC1 at vessel A before it first moves off to another vessel during vessel A's current visit
• lmv1A_2: The very last move for QC1 at vessel A during vessel A's current visit
• lmv1B_1: The last move for QC1 at vessel B before it first moves off to another vessel during vessel B's current visit;
also the very last move for QC1 at vessel B
For QC1 at vessel A, "regular" metrics are based on lmv1A_1 and "final" metrics on lmv1A_2, as shown in the following
table.

Metric Definition
moves_to_go for 1st record of vessel/crane statistics for Number of moves in the segment remaining to get to and
QC1/vessel A include move lmv1A_1, say 50
estimated_completion for 1st record of vessel/crane Time that XPS estimates when lmv1A_1 completes, say
statistics for QC1/vessel A 10:55
moves to go for 2nd record of vessel/crane statistics for Number of moves in the segment remaining to get to and
QC1/vessel A include move lmv1A_2, say 44
estimated completion for 2nd record of vessel/crane Time that XPS estimates when lmv1A_2 completes, say
statistics for QC1/vessel A 17:00

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 539
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

Metric Definition
moves_to_go_final for both records Number of moves remaining to get to and include move
lmv1A_2
= moves to go for 1st record + moves to go for 2nd record
= 94
estimated_completion_final Time that XPS estimates when lmv1A_2 completes, say
17:00
planned_completion A user-entered time of when lmv1A_2 is planned for
completion, say 17:30
plan_deviation Estimated_completion_final - planned_completion
= 17:00 - 17:30
= -30 mins

For QC1 at vessel B, "regular" and "final" metrics are both based on lmv1B_1, as shown in the following table.

Metric Definition
moves_to_go Number of moves in the segment remaining to get to and
include move lmv1B_1
estimated_completion Time that XPS estimates when lmv1B_1 completes
moves_to_go_final moves_to_go
estimated_completion_final estimated_completion
planned_completion A user-entered time of when lmv1B_1 is planned for
completion

Vessel/crane scenario: A to B to A to B

The timeline above marks the key moves on which the forward-looking metrics are based, as follows:

• Imv1A_1: The last move for QC1 at vessel A before it first moves off to another vessel during vessel A's current
visit.
• Imv1A_2: The very last move for QC1 at vessel A during the vessel A's current visit.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 540
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Forward-Looking metrics

• Imv1B_1: The last move for QC1 at vessel B before it first moves off to another vessel during vessel B's current
visit.
• Imv1B_2: The very last move for QC1 at vessel B during the vessel B's current visit.
QC1 at vessel A is identical to QC1 at vessel A in scenario A B A (on page 539).

QC1 at vessel B is the same as QC1 at vessel A in scenario A B A (on page 539), with vessel B replacing vessel
A, that is two sets of "regular" metrics are based on Imv1B_1 and "final" metrics are based on Imv1B_2.

Vessel/crane scenario: A to B to C

The above timeline marks the key moves on which the forward-looking metrics are based, as follows:

• lmv1A_1: The last move for QC1 at vessel A before it first moves off to another vessel during vessel A's current visit;
also the very last move for QC1 at vessel A
• lmv1B_1: The last move for QC1 at vessel B before it first moves off to another vessel during vessel B's current visit;
also the very last move for QC1 vessel B
• lmv1C_1: The last move for QC1 at vessel C before it first moves off to another vessel during vessel B's current
visit; also the very last move for QC1 at vessel C
For QC1 at vessel A, "regular" and "final" are the same and based on lmv1A_1.

For QC1 at vessel B, "regular" and "final" are the same and based on lmv1B_1.

For QC1 at vessel C, "regular" and "final" are the same and based on lmv1C_1.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 541
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

Vessel/crane scenario: A to B to C to A

The above timeline marks the key moves on which the forward looking metrics are based, as follows:

• Imv1A_1: The last move for QC1 at vessel A before it first moves off to another vessel during vessel A's current
visit; also, the very last move for QC1 at vessel A.
• Imv1A_2: The very last move for QC1 at vessel A during the vessel A's current visit.
• Imv1B_1: The last move for QC1 at vessel B before it first moves off to another vessel during vessel B's current
visit; also, the very last move for QC1 at vessel B.
• Imv1C_1: The last move for QC1 at vessel C before it first moves off to another vessel during vessel C's current
visit; also, the very last move for QC1 at vessel C.
For QC1 at vessel A, see scenario A B A (on page 539) for QC1 at vessel A.

For QC1 at vessel B, "regular" and "final" are the same and based on Imv1B_1.

For QC1 at vessel C, "regular" and "final" are the same and based on Imv1C_1.

3.4.4 Crane/Vessel Crane Activity metrics

Crane activities, such as meal break, lifting of hatch lids, or weather, are activities that a crane engages in other than
performing vessel moves (load/discharge/shift). Typically, crane activities are categorized into terminal accountable,
non-terminal accountable, and force majeure delays.

Crane activity information sometimes explains what delayed a crane. It is also used to calculate metrics such as net
gang hours and net productivity.

Specific crane activities are of particular interest to terminals. For example:

• Number of twistlock boxes, hatch lids, or break bulk lifted

• Number of containers lifted by using the emergency gear or special spreader (egear) for an OOG or heavy container

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 542
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

XPS, together with N4, supports the tracking of the crane activity metrics by category as well as the above-mentioned
crane activity count. This allows terminal managers to track crane activities accurately, without over-burdening the
hatch clerk (HC).

To count containers that are lifted by using egear, hatch clerks can record vessel moves during an active egear crane
activity, but they have to stop the egear crane activity manually. This is different from other crane activities that do not
allow a concurrent vessel move.

N4 lists all available crane activities in the Crane Delay Types view. You can configure custom activities using the
Crane Delay Types form. The Crane Delay Category field in this form lets you specify the category of an activity,
which can be either terminal-related, non-terminal related, or related to force majeure (a disruptive natural event such
as bad weather or an earthquake). For reporting purposes, if you want crane/vessel crane activity metrics to consider a
delay type, you must enter a value in this field.

3.4.4.1 Crane/vessel crane activity terminology

Crane/vessel crane activity metrics rely on the following terms:

• Activity category
• Status

Activity category
The category of a crane activity. SPARCS Monitor lets you configure custom activities (using the Crane Delay Types
form) and assign them to the following pre-defined categories:

• Terminal
• Non-terminal
• Force Majeure

Status
The status of an activity, which can take on one of the following values:

• PLANNED: An activity planned using Quay Commander

• STARTED: An activity that a hatch clerk started recording on an RDT or that a Quay Commander user started
• STOPPED: An activity that a hatch clerk stopped recording on an RDT or that a Quay Commander user stopped

SPARCS Monitor only includes activities that are started or stopped. It ignores planned activities.
Using SPARCS Quay Commander, you can start and stop an activity as follows:

1. From the Actions menu, select Create Activity for Selected Shift to create a planned activity in the current shift.
If you do not use the current shift, you cannot continue this procedure.
2. From the Crane Activity list, select the activity (with status Planned).
3. From the Actions menu, select Start Activity.
The status of the activity should change to Started in the Crane Activity list window.
4. From the Actions menu, select Stop Activity.
The status of the activity should change to Stopped.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 543
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

3.4.4.2 Definition of Crane/Vessel Crane Activity metrics

This table describes crane/vessel crane activity metrics at the crane activity level.

Metric Description
Activity ID The ID of the activity, such as "A1" or "B2"

N4 lets you configure custom crane activities

(using the Crane Delay Types form) and assign
them to the pre-defined delay categories
Terminal, Non-terminal, or Force Majeure. You
can also use the Crane Delay Types view to
identify delay categories.

Start Time The start time of a crane activity

End Time The end time of a crane activity
Activity Duration End Time minus Start Time
Activity Count The Count of activities. Some activities, such as hatch lids
and twistlock boxes, count to save a hatch clerk entry.

This table describes crane/vessel crane activity metrics at the crane level.

Metric Description
Terminal Delays The sum of terminal delays for the crane servicing the
vessel visit
Non-Terminal Delays The sum of non-terminal delays for the crane servicing
the vessel visit
Force Majeure Delays The sum of delays due to acts of nature for the crane
servicing the vessel visit.
Total Delays The sum of all delays, that is terminal, non-terminal, and
force majeure delays for the crane servicing the vessel
visit

This table describes crane/vessel crane activity metrics at the vessel level.

Metric Description
Terminal Delays The sum of terminal delays for the vessel visit
Non-Terminal Delays The sum of non-terminal delays for the vessel visit
Force Majeure Delays The sum of delays due to acts of nature for the vessel
visit.
Total Delays The sum of all delays, that is terminal, non-terminal, and
force majeure delays for the vessel visit
Percent Terminal Delays The terminal delays for the vessel visit/effective Gross
Gang Hrs for the vessel visit
Percent Non Terminal Delays The non-terminal delays for the vessel visit/effective
Gross Gang Hrs for the vessel visit
Percent Force Majeure Delays The force majeure delays for the vessel visit/effective
Gross Gang Hrs for the vessel visit

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 544
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

3.4.4.3 Relevant XPS configuration settings

The following XPS settings are relevant to crane activity recording.

XPS Setting Description

CAHAEG Defines a 2-character, user-defined activity code that
must be stopped manually. Supports counting the number
of containers that are lifted while the user-defined egear
activity code is active.

3.4.4.4 Operation guidelines for gathering decision support

data
In XPS, when you need to move a crane from Vessel A to Vessel B after the crane has performed some moves or
activities for Vessel A, you should modify the current shift for Vessel A by shortening it and create a new shift for Vessel
B. Do not delete a crane shift that already shows any moves and/or activities because this will result in incorrect crane
activity and productivity metrics for that crane.

3.4.4.5 Activity categories and codes

The following tables list the activity categories and codes used in N4 metrics.

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the pre-
defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay Types
view to identify delay categories.

Category A (terminal) delays

Category Description
A1 Boom Up/Down
A2 Quay Crane Breakdown
A3 Crane Clash
A4 Lashing
A5 Waiting for Tractor/
Straddle Carrier
A6 System Failure
A7 Incident/Accident
A8 Meal Break
A9 Stowage Replan

Category B (non-terminal) delays

Category Description
B1 Vessel Stability
B2 Gear Boxes

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 545
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

Category Description
B3 Breakbulk
B4 OOG/Heavy Lift/
Emergency Gear
B5 Hatch Covers
B6 Waiting for Export
Container
B7 Revised Plan
B8 Agent
B9 Authorities

Category C (force majeure) delays

Category Description
C1 Weather
C2 Power Failure
C3 Emergencies

3.4.4.6 Example scenarios for Crane/Vessel Crane Activity

Metrics
The operation scenarios in this section explain the behavior of the crane activity metrics.

For all scenarios, the following assumptions are true:

• The XPS setting CAMC is set.

• The changes to statistics in sample reports are included for clarification purposes only. The statistics in the sample
reports are available only after the completion of the vessel operation.
In all scenarios, the value that changes from one event to the other appears in bold type.

Vessel/crane scenario: Default behavior for crane activity recording

The hatch clerk (HC) does not have to record the move count.

The scenario is based on the following conditions:

• During the time period of the scenario, only activities mentioned are entered.
• The activity code is xN, where x is A and N is a one-digit number.

Time Event Metric

09:58 At the start of the scenario Initial value of metrics:
Terminal Delays = 8
Total Delays = 17
10:00 HC starts activity xN with start time ActivityDuration of current active
09:59 activity xN = 1

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 546
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

Time Event Metric

ActivityCount of current active
activity xN = 1
Terminal Delays = 8+1=9
Total Delays = 17+1=18
10:02 Supervisor observes N4 ActivityDuration of current active
activity xN = 3
ActivityCount of current active
activity xN = 1
Terminal Delays = 8+3=11
Total Delays = 17+3=20
10:05 HC stops activity xN by entering a ActivityDuration of activity xN just
container move stopped = 6
ActivityCount of current active
activity xN = 1
Terminal Delays = 8+6=14
Total Delays = 17+6=23
Moves Completed in N4
incremented by 1 for the container
move
VS.Total Vsl Lifts is similarly
incremented by 1
10:07 Supervisor observes N4 Because no other new activities
were entered, the metrics remain
the same as at 10:05.

• If the category for the activity is B, that is x is B, and the activity is not Breakbulk, Twist Lock, Hatch Lids, or Egear
(that is not B3, B2, B5, or B4), just replace Terminal Delays in the above scenario with Non Terminal Delays.
• If the category for the activity is C, that is x is C, then there is no change to the Terminal Delays in the above steps.

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the
pre-defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay
Types view to identify delay categories.

Vessel/crane scenario: Recording the number of hatch lids,

breakbulk, or twistlock bins
The HC records count when stopping the crane activity. The HC cannot enter a vessel move when hatch lid activity is
active.

The metrics are the same as in Scenario 1 (on page 546), except that count of B5 is based on what the HC
entered.
The scenario is based on the following conditions:

• This scenario also applies to the recording of breakbulk (B3) and twistlock bin (B2). See Support for other terminal
codes (on page 545) for the crane activity code used for each of these activities.

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 547
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

pre-defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay
Types view to identify delay categories.

• During the time period of the scenario, only the activities mentioned are entered.

Time Event Metric

09:58 At the start of scenario Initial value of metrics:
Non-Terminal Delays = 8
Total Delays = 17
10:00 HC starts activity B5 with start time ActivityDuration of current active
09:59 activity B5 = 1
ActivityCount of current active
activity B5 = 1
Non-Terminal Delays = 8+1=9
Total Delays = 17+1=18
10:02 Supervisor observes N4 ActivityDuration of current active
activity B5 = 3
ActivityCount of current active
activity B5 = 1
Non-Terminal Delays = 8+3=11
Total Delays = 17+3=20
10:04 HC tries to enter a vessel move
but is notified that he has to stop
B5 first
10:05 HC stops activity B5 and enters 4 ActivityDuration of activity B5 just
as activity count stopped = 6
ActivityCount of activity B5 just
stopped = 4
Non-Terminal Delays = 8+6=14
Total Delays = 17+6=23
Moves Completed in N4
unchanged
VS.Hatch Lids increments by 4
VS.Total Vsl Lifts also increments
by 4.
10:07 Supervisor observes N4 Because no other activities
entered, the metrics remain the
same as at 10:05.

Vessel/crane scenario: Recording the number of containers moved

using Egear
HCs can enter vessel moves while Egear is active, but they also have to stop the Egear activity manually.

The metrics are the same as those in Scenario 1 (on page 546), except that a container move made using
Egear (VS.Egear moves in SPARCS Analytics) is counted. VS.Egear counts the container move during the use
of Egear, while activity_count for B4 counts how many B4 activities have been recorded.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 548
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

The scenario is based on the following conditions:

• CAHAEG is set to B4
• recordMove for B4 =N

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the
pre-defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay
Types view to identify delay categories.

During the time period of the At the start of scenario Initial value of metrics:
scenario, only activities mentioned Non-Terminal Delays = 8
are entered. 09:58
Total Delays = 17
VS.Egear moves = 1
10:00 HC starts activity B4 with start time ActivityDuration of current active
09:59 activity B4 = 1
ActivityCount of current active
activity B4 = 1
Count of container moves during
active activity B4 = 0
Non-Terminal Delays = 8+1=9
Total Delays = 17+1=18
VS.Egear moves = 1
10:01 HC enters a vessel move ActivityDuration of current active
activity B4 = 2
ActivityCount of current active
activity B4 = 0
Count of container moves during
active activity B4 = 1
VS.Egear moves = 1+1=2
Moves Completed in N4
incremented by 1 for the vessel
move
VS.Total Vsl Lifts is similarly
incremented by 1.
10:02 Supervisor observes N4 Duration of current active activity
B4 = 3
Count of current active activity B4
=1
Count of container moves during
active activity B4 = 1
Non-Terminal Delays = 8+3=11
Total Delays = 17+3=20
VS.Egear moves = 2
10:04 HC enters a vessel move ActivityDuration of current active
activity B4 = 5
ActivityCount of current active
activity B4 = 1
Count of container moves during
active activity B4 = 2

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 549
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

VS.Egear moves = 1+2=3

Moves Completed in N4 again
incremented by 1 for the container
move
VS.Total Vsl Lifts is again
incremented by 1.
10:05 HC stops activity B4. ActivityDuration of activity B4 just
stopped = 6
ActivityCount of activity B4 just
stopped = 1
Count of container moves during
active activity B4 = 2
Non-Terminal Delays = 8+6=14
Total Delays = 17+6=23
VS.Egear moves = 3
10:07 Supervisor observes N4 Because no other new activities
entered, the metrics remain the
same as at 10:05

Vessel/crane scenario: Deleting a stopped crane activity

These scenarios are based on the following conditions:

• Terminal Delays = 10
• Non-Terminal Delays = 20
• Total Delays = 36
The parameter CAHAEG (on page 545) is set to B4 for counting vessel moves that are made using Egear.

In the following table, the Attribute column lists the crane activity attributes as follows:

• AT: Activity ID
• ST: Start time
• D: Duration
• C: Count

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the
pre-defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay
Types view to identify delay categories.

Description Attribute Value Metric

Deleting an activity AT xN Total Delays = 36 - 5 =
where recordMove = ST 0300 31
N and CAHAEG is not If x is A, Terminal
D 5
set Delays = 10 - 5 = 5
C 1
If x is B, Non-Terminal
Delays = 20 - 5 = 15
Moves Completed in
N4 are unchanged.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 550
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

Description Attribute Value Metric

VS.Total Vsl Lifts
remains unchanged if
the activity is not
breakbulk moves,
twist lock boxes, or
hatch lids. Otherwise,
it is decremented by
1, the change in
activity count.
Deleting an activity AT xN Total Delays = 36 - 5 =
where recordMove = ST 0300 31
Y and CAHAEG is not If x is A, Terminal
D 5
set Delays = 10 - 5 = 5
C 4
If x is B, Non-Terminal
Delays = 20 - 5 = 15
Moves Completed in
N4 are unchanged.
VS.Total Vsl Lifts
remains unchanged if
the activity is not
breakbulk moves,
twist lock boxes, or
hatch lids. Otherwise,
it is decremented by
4, the change in
activity count.
Deleting an activity AT xN Same as scenario 4,
that is set to ST 0300 except that VS.Egear
CAHAEG, assuming Move is decremented
D 5
there is a vessel move by 1.
from 0300 to 0305 C 1
Moves Completed in
N4 are unchanged.
VS.Total Vsl Lifts
remains unchanged.

Vessel/crane scenario: Editing a stopped crane activity

The scenarios described in this section show how editing a stopped crane activity impacts the crane activity metrics.
They are based on the following conditions:

• Terminal Delays = 10
• Non-Terminal Delays = 20
• Total Delays = 36
The parameter CAHAEG (on page 545) is set to B4 for counting vessel moves that are made using Egear.

In the following table, the Attribute column lists the crane activity attributes as follows:

• AT: Activity ID
• ST: Start time

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 551
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Crane/Vessel Crane Activity metrics

• D: Duration
• C: Count

N4 lets you configure custom crane activities (using the Crane Delay Types form) and assign them to the
pre-defined delay categories Terminal, Non-terminal, or Force Majeure. You can also use the Crane Delay
Types view to identify delay categories.
The original attribute value appears in the Original column and the new value in the New column. The Metrics column
shows how the scenario affects the relevant metrics.

Description Attribute Original New Metrics

Decreasing the AT A1 Same Activity start time =
duration by 2 while ST 0300 Same 03:00
the activity type Activity end time =
D 5 3
remains unchanged 03:03 (from 03:05)
and recordMove = N C 1 Same
Terminal Delays = 10
-5+3=8
Total Delays = 36 - 2
= 34
Increasing the count AT B5 Same Duration-related
by 1 while the activity ST 0300 Same metrics remain
type remains unchanged.
D 5 Same
unchanged and VS.Hatch Lids is
recordMove = 1 C 4 5
incremented by 1.
VS. Total Vsl Lifts is
also incremented by
1.
Changing the activity AS A1 B7 Terminal Delays = 10
ID from A1 to B7 ST 0300 Same -5=5
For both activities, the D 5 Same Non-Terminal Delays
following is true: = 20 + 5 = 25
C 1 Same
• recordMove = N The number of Total
• Not set to Delays remains 36.
CAHAEG
Changing the activity AT A1 B5 Terminal Delays = 10
ID from A1 to B5 and ST 0300 Same -5=5
increasing the count Non-Terminal Delays
D 5 Same
by 1 = 20 + 5 = 25
C 1 2
A1: recordMove = N The number of Total
B5: recordMove = Y Delays remains 36.
Changing the activity AT B5 A1 Terminal Delays = 10
ID from B5 to A1 ST 0300 Same + 5 = 15
New activity count = 1 D 5 Same Non-Terminal Delays
recordMove for A1 = = 20 - 5 = 15
C 2 1
N The number of Total
Delays remains 36.
VS.Hatch Lids is
decremented by 2.
VS.Total Vsl Lifts is

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 552
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
CHE metrics

Description Attribute Original New Metrics

also decremented by
2.
Changing the activity AT B5 B4 Duration-related
ID from B5 to B4, ST 0300 Same metrics remain
assuming N4 does unchanged.
D 5 Same
not record any vessel VS.Hatch Lids is
moves between 0300 C 1 Same
decremented by 1.
and 0305
Therefore, VS.Total
Vsl Lifts is
decremented by 1.
Changing the activity AT B4 B5 Duration-related
ID from B4 to B5, ST 0300 Same metrics remain
assuming there is a unchanged.
D 5 Same
vessel move from VS.Egear move is
0300 to 0305 C 1 Same
decremented by 1.
VS Hatch lids is
incremented by 1.
Therefore, VS.Total
Vsl Lifts is
incremented by 1
(VS.Egear move does
not affect VS.Total Vsl
Lifts.)
Keeping activity ID AT B4 Same Activity start time =
B4, changing ST 0300 Same 03:00
duration, assuming Activity end time =
D 5 10
there are 2 vessel 03:10 (from 03:05)
moves from 0305 to C 1 Same
Non-Terminal Delays
0310, which now are
= 20 - 5 + 10 = 25
counted as egear
moves Total Delays = 36 + 5
41
Count-related crane
metrics remain
unchanged.
VS.Egear move is
incremented by 2.
VS.Total Vsl Lifts
remains unchanged.

3.4.5 CHE metrics

The Moving CHE Details gadget (on page 497) lists a CHE when:

• Its operating mode is either truck or self-complete.

• It made a move in the carry phase in the last hour.
In other words, if a straddle carrier is in self-complete mode but is not the carry CHE for the moves it performs, the
Moving CHE Details gadget does not list this CHE because it does not have any meaningful trip distance information.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 553
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

Depending on a terminal's operation, the operating mode for reach stacker, forklift, and top pick can be:

• Self-complete (such as a forklift performing yard shifts in a zone)

• Require handler (a forklift fetching a container from the yard and landing it on a truck in a LOAD move)
This table describes moving CHEs and their operating mode.

N4 Code Description Operating Mode

ITV Truck Truck

TT Terminal Trailer Truck
AGV AGV Truck
MTT MultiTrailer Truck
FLT Top pick Self-complete
RST Reach Stacker Self-complete
SC Straddle Self-complete

3.4.5.1 CHE terminology

CHE metrics make use of the following terms and acronyms:

Trip: A tour that the yard CHE takes to finish a work unit. One work unit can contain one or more work instructions
(WIs), as long as the carry start time of the WIs is earlier than the earliest carry complete time of these WIs. All moves
in a trip are of the same move kind.

Move kinds:

• RECV: road receival

• DLVR: road delivery
• SHFT: yard shift
• YARD: house keeping
• DSCH: vessel discharge
• LOAD: vessel load
• RDSC: rail discharge
• RLOD: rail load
Operating modes:

• 0: Unknown
• 1: Require Handler
• 2: Self-complete
• 3: Truck
• 4: Crane
• 5: Truck-ShiftChassis
• 6: Truck-Coupled

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 554
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

3.4.5.2 Moving CHE metrics

Shift supervisors are interested in measuring the productivity of CHEs that shuttle containers between locations in the
yard, such as terminal tractors (ITV) or straddles (STR), along two dimensions: distance travel versus the number of
moves made. For example, when a terminal tractor made fewer than the average number of moves in the last 60
minutes, the reason could be low driver productivity or greater distance traveled to get containers.

For distance-related metrics, the ratio of laden (CHE carrying a container) to unladen (CHE not carrying a container)
distance traveled is another measure of CHE productivity. Travel distance represents the distance (in meters) that a
CHE travels while completing a particular EC event. The distance is determined by tracking a CHE's current and
previous yard positions. N4 then uses this positional information to calculate the relative distance between the two
positions.

When a CHE operator first logs in, the current position of the CHE is undefined. Hence, the first move that it makes has
a 0 start distance

N4 limits the calculation of distance-related metrics to carry CHEs and single moves. When a CHE is
dispatched twin moves, the start distance and travel distance is only reported for the first move dispatched.
For terms used in the CHE metrics, see CHE terminology (on page 554).

Data Element Definition for Moving CHE metrics

At the CHE move level, the data elements described in the following table specify the CHE moves in the last 60
minutes (sp:che_moves_1hr).

Data Element Description

trip_distance_unladen The distance the CHE traveled from its last known
position to the position of the first fetch in a trip.
trip_distance_laden The distance that the laden CHE is required to travel to
complete all the work instructions (WIs) for the trip.

The WI distance in XPS is that from fetch to put

for each work instruction. This is what's displayed
as WI distance in the Points of Work window in
XPS or in the ECHIST file or the 7041 message.

For a trip of one work instruction, or multiple work

instructions that share the same put and fetch locations,
trip_distance_laden in N4 = WI distance in XPS.
For a trip with multiple work instructions of different put
and/or fetch locations:
• Trip distance laden in N4 for all the WIs in the trip is
the actual CHE travel distance for handling the multiple
WIs. This may or may not have direct relationship with
the WI distance in XPS for each WI in the trip. See the
scenarios (on page 623) for more details.
• Trip metrics for affected WIs are sent from XPS to N4
after all trip-related WIs have been completed.
trip_ctr_count The number of containers handled on each trip, based on
the completed work instructions.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 555
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

Definition of Moving CHE metrics

At the CHE level, the metrics specify the moves that the moving CHE made in the last 60 minutes (itv_moves_1hr), as
described in the table.

Metric Description
last_move_time The end time of the last completed move by the moving
CHE.
time_since_last_move The current time minus the time of the last move.
move_count The sum of all moves (work instructions) completed by
the moving CHE in the last 60 minutes.
total_distance_unladen The sum of unladen distance for all trips completed by the
moving CHE in the last 60 minutes
total_distance_laden The sum of laden distance for all trips completed by the
moving CHE in the last 60 minutes.
total_distance The sum of laden and unladen distance for all trips
completed by the moving CHE in the last 60 minutes
trip_count The number of unique trips made by the moving CHE in
the last 60 minutes.
avg_distance_unladen The average of unladen distance across the trips
completed by the moving CHE in the last 60 minutes. This
value equals the total distance unladen divided by the trip
count.
avg_distance_laden The average of laden distance across the trips completed
by the moving CHE in the last 60 minutes. This value
equals the total distance laden divided by the trip count.

Duration metrics for moving CHEs

When carrying out a work instruction (WI), a moving CHE (a truck in this case) spends its time either laden (carrying
one or more containers) or unladen (carrying no containers). N4 identifies the following time periods, or durations,
which can be either laden or unladen:

Idle time The time that a moving CHE spends idle after
completing a step of the WI and before it gets the
dispatch command for the next step or the next WI.
Idle time may result from no work or from a delay in
the dispatch logic.
Wait time The time that a moving CHE spends waiting for
another CHE's action (arrival, land container, or lift
container) so that the container can change hand.
Wait time results from another CHE not being ready
for the container exchange.
Travel time The time that a moving CHE spends traveling to a
location after it gets dispatched.

N4 associates each period either with the origin of the move (where the CHE gets a container) or the destination of the
move (where the CHE drops a container) so that you can quickly determine, for example, the time spent waiting in the
yard or the time spent idle at the quay.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 556
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

The following figure illustrates the events, timestamps, and duration metrics for a single move scenario such as load,
discharge, re-load, re-discharge, or yard shift. Events and periods that depend on PrimeRoute appear in italics.

Comparing straddle productivity

To get a complete picture of efficiency and productivity when comparing different straddle carriers, you must evaluate a
sufficient set of metrics, such as moves completed, travel distance, and travel time. Consider the following points:

• Straddle carriers that have to drive a longer distance between to and from positions for a job have a lower rate of
moves per hour and a longer average trip distance.
• When calculating distance metrics, N4 assumes that straddle carriers drive along the paths that are specified in the
yard path model (which is part of your yard file), unless the terminal uses a CHE position tracking system that is
integrated with XPS to track the physical distance traveled. Therefore, two straddle carriers that service the same
crane and yard area and that are dispatched to similar jobs report comparable distance efficiency. However, you will
get a better picture of straddle carrier productivity by focusing on the moves completed. Alternatively, you can look
at the laden versus unladen travel time to compare productivity. When you assume a speed variation average over
time, the laden to unladen travel time and distance usually correlate well with each other.
• When deploying an optimization application such as PrimeRoute, terminal managers can evaluate productivity
improvement by comparing the distance or time efficiency by move kind before and after the application's
implementation. When the straddle carriers follow the yard path model, the change in distance efficiency accurately
reflects the optimization in dispatching logic.

3.4.5.3 Fixed CHE metrics

Shift supervisors are interested in measuring the productivity of fixed or non-moving CHEs, such as rubber-tired gantry
cranes (RTG) or rail-mounted gantry cranes (RMG), or equipment handlers such as forklifts, in terms of the number of
moves made. In addition, they want to know the breakdown of the moves made for crane versus non-crane and rail
versus non-rail.

For terms used in the CHE metrics, see CHE terminology (on page 554).

Definition of Fixed CHE metrics

The following table describes the metrics for fixed CHEs.

Metric Description
last_move_time The end time of the last move that the CHE completed.
time_since_last_move The current time minus the time of the last move.
move_count The sum of all moves (work instructions) completed by
the fixed CHE in the last 60 minutes.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 557
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

Metric Description
rail_move_count The number of rail loads and discharges that the CHE
completed in the last 60 minutes.
non_rail_move_count The move count minus the rail move count.
crane_move_count The number of vessel loads and discharges that the CHE
completed in the last 60 minutes.
non_crane_move_count The move count minus the crane move count.

3.4.5.4 Which CHE are credited with a move

In general, each distinct CHE that participates in a move gets credited with one move. Therefore, a straddle that
performs the fetch, carry, and put in a yard move is credited with only a single move. On the other hand, the RTG,
terminal tractor, and QC that work together in a discharge move each get credited with one move.

When the CHE participates in both fetch and put with carry CHE alone being different, then the move count should be
two (one for fetch and one for put). See also Move counts for multiple moves (on page 562).

The following tables show how the operating mode and CHE kind determine whether it is a fetch, carry or put CHE in a
move by move kind. The following applies to all tables:

• N/A means it is not applicable for the CHE.

• A number refers to the notes below.

SHOB is not listed because CHEs are not involved in SHOB moves.

Receival moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, 4 (on 4 (on Yes
Handler RMG, page page
ASC, 562) 562)
RST,
FLT
Truck ITV, TT, N/A N/A N/A
AGV,
MTT
Self- SC, Yes Yes Yes
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Delivery moves

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 558
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes 4 (on 4 (on
Handler RMG, page page
ASC, 562) 562)
RST,
FLT
Truck ITV, TT, N/A N/A N/A
AGV,
MTT
Self- SC, Yes Yes Yes
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Load moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes N/A N/A
Handler RMG,
ASC,
RST,
FLT
Truck ITV, TT, N/A Yes N/A
AGV,
MTT
Self- SC, Yes Yes 1
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Discharge moves

Operat CHE Fetch Carry Put

ing kind
mode

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 559
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

Require RTG, N/A N/A Yes

Handler RMG,
ASC,
RST,
FLT
Truck ITV, TT, N/A Yes N/A
AGV,
MTT
Self- SC, 1 Yes Yes
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Yard moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes 3 (on Yes
Handler RMG, page
ASC, 562)
RST,
FLT
Truck ITV, TT, N/A Yes N/A
AGV,
MTT
Self- SC, Yes Yes Yes
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Shift moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes 3 (on Yes
Handler RMG, page
ASC, 562)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 560
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

RST,
FLT
Truck ITV, TT, N/A Yes N/A
AGV,
MTT
Self- SC, Yes Yes Yes
complete RST,
FLT
Truck-
ShiftCha
ssis
Truck-
Coupled

Reload moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes N/A Yes
Handler RMG,
ASC,
RST,
FLT
Truck ITV, TT, N/A Yes N/A
AGV,
MTT
Self- SC, Yes Yes 2 (on
complete RST, page
FLT 562)
Truck-
ShiftCha
ssis
Truck-
Coupled

Redischarge moves

Operat CHE Fetch Carry Put

ing kind
mode
Require RTG, Yes N/A Yes
Handler RMG,
ASC,
RST,
FLT
Truck ITV, TT, N/A Yes N/A

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 561
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
CHE metrics

AGV,
MTT
Self- SC, 2 (on Yes Yes
complete RST, page
FLT 562)
Truck-
ShiftCha
ssis
Truck-
Coupled

Footnote 1
At a straddle terminal, for LOAD and DSCH moves:

• If a hatch clerk is used (XPS EC parameter VSLOAD = 'N'):

▪ In DSCH, QC is F CHE, SC is C/P CHE
▪ In LOAD, SC is F/C CHE, QC is P CHE
• If no hatch clerk is used (XPS EC parameter VSLOAD='Y'):
▪ SC is the F/C/P CHE
▪ XPS should send POW for che_qc

Footnote 2
• If a straddle or other self-complete CHE delivers a container to a rail ramp for loading by RMG, reachstacker, or
other CHE, the RLOD process is similar to a LOAD. For the reverse process, a RDCH is similar to a DSCH.
• If a straddle, or other self-complete CHE sets or lifts a container directly onto or from a railcar, the RLOD/RDSC is
similar to a yard move.

Footnote 3
In the most common YARD move, the fetch CHE and the put CHE are distinct CHEs when a container is moved from
one block to another by a carry-CHE.

Exception: XPS setting RMGZNE is set to TRUE, where an RTG can perform a YARD move with no truck. In this
case, the RTG is the fetch and put CHE. The carry CHE may be unknown.

Footnote 4
For RECV, DLVR, XPS may send some other value than the RTG/RMG ID for fetch and carry CHE. In this case, N4
credits 1 move to the put CHE.

Move counts for multiple moves

If the same CHE participates in two disjoint phases (that is the fetch and the put phases excluding the carry phase), the
CHE gets credited with 2 moves.

In the following scenario (which is quite rare), RM01 is credited with two moves because there is a carry CHE in
between:

1. Plan a yard move for a container (such as 1A to 5C).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 562
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
ASC metrics

2. Fetch the container using RMG (such as RM01).

3. Place the container on a truck (such as T01).
4. Put the container using the same RMG used for the fetch (which is RM01).
RM01 is credited with 2 moves.
Contrast the above with another infrequent scenario, where RM01 is the fetch, carry, and put CHE for a move:

1. Set RMGZNE = "Y".

2. Plan a yard-to-yard move for a container in the same block (such as A.100.L.1 TO A.100.A.1)
3. Fetch the move by using RMG (such as RM01 in operating mode "Require Handler").
4. XPS does not request any handler like a truck.
5. Complete the move by pressing F1 on RDT screen.
The CHE-fetch, CHE-carry, and CHE-put fields are all set to RM01. RM01 is credited with 1 move.
In this case, RM01 is only credited with 1 move.

Move counts for rehandles/shift moves

The value of EC parameter GENREH impacts how shift moves are counted.

When GENREH is set to "Y", rehandle work instructions are automatically created when a planned container move is
blocked. Put Che, Carry Che, and Fetch Che are all updated with the value of the CHE which completed the shift
move.

When GENREH is set to "N", shift moves are not automatically created and it is not until the CHE operator selects the
planned container move, that a rehandle will be initiated. The Put Che value is updated with the CHE which completed
the shift move. Fetch Che and Carry Che are left blank.

For example, GENREH is set to "Y" and a yard move is planned for a container which has a container that must be
rehandled on top of it. XPS creates work instructions for a yard move and a yard shift and dispatches them to RTG
RT105. The RTG operator selects the shift move from the Job List in ECN4Web and completes it. Viewing the move
history in N4 shows RT105 included in the "Put CHE Name", "Carry CHE Name", and "Fetch CHE Name" fields.

3.4.6 ASC metrics

For real-time operation purposes, terminal managers need to identify areas of bottlenecks, understand potential
causes, and implement corrective measures to improve ASC productivity and fine-tune optimization. ASC metrics is
computed based on Move Events and EC Events.

You need the BI license to be able to view ASC metrics.

3.4.6.1 Data Element Definition for ASC metrics

At the CHE move level, the data elements described in the following table specify the CHE moves in the last 60
minutes (sp:che_moves_1hr).

Data Element Description

move_purpose The purpose of the move – such as
Transfer In, Transfer Out, Preposition,
Housekeeping, Rehandle

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 563
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
ASC metrics

move_direction The direction of move with respect to the

transfer zone (at both ends of the stack),
such as To TZ, From TZ, Intrastack
unladentraveltime The total unladen travel time for the CHE to
complete the move
ladentraveltime The total laden travel time for the CHE to
complete the move

3.4.6.2 Definition of ASC metrics

This table describes the ASC metrics.

Metric Description
PickDispatchTime The time a CHE is dispatched to pick a container
PickArriveTime The time a CHE arrives to pick a container at either a
yard, vessel, or rail location
PickIdleTime The total elapsed time between the CHE’s last move and
the time the next move is dispatched (in milliseconds)
PickWaitTime The total elapsed time between the time the CHE arrived
to pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropDispatchTime The time a CHE is dispatched to drop a container
DropArriveTime The time a CHE arrives at a yard, vessel, or rail location
to drop a container
DropIdleTime The time difference between the time the CHE arrives to
pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropWaitTime The time difference between the time the CHE arrived to
drop the container and the time the container is actually
taken off the CHE (in milliseconds)
ContainerOnTime The time a container is loaded onto the CHE
ContainerOffTime The time the container is taken off the CHE
DistanceLaden The distance that the laden CHE is required to travel to
complete the work instructions (WIs)
DistanceUnladen The distance that the CHE traveled from its last known
position to the fetch position
UnladenTravelTime The total unladen travel time for the CHE to complete the
move
LadenTravelTime The total laden travel time for the CHE to complete the
move
MoveDirection The direction of the move with respect to the transfer
zone (at both ends of the stack), such as To TZ, From TZ,
Intrastack
MovePurpose The purpose of the move, such as Transfer In, Transfer
Out, Preposition, Housekeeping, Rehandle

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 564
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
ASC metrics

3.4.6.3 ASC EC Events

The following EC Events are stored in BI Portal and available for analyzing ASC performance.

ASC Status EC Events

Event ID Event Description Timing

SUTS Status Update Automatic TOS Occurs after a status change
from ECS to indicate the crane
is controlled by TOS
autodispatcher
SUMA Status Update Manual Occurs after ECS inserts/
updates a command without
order (unordered move) to
indicate the crane is controlled
manually
SUOF Status Update Offline Occurs after a status change
from ECS to indicate the crane
is unavailable
SUBD Status Update Break Down Occurs after a status change
from ECS to indicate the crane
is out of service

ASC Operational EC Events

Event ID Event Description Timing

DSPT Dispatch CHE Occurs after ECN4 validates
dispatch request
IDLE Idle CHE Occurs after CHE completes
job and before next job dispatch
ERTC Empty in row to Carry-CHE Occurs when ASC traveling
empty to Carry-CHE
ERAC Empty in row at Carry-CHE Occurs when ASC traveling
empty arrived at Carry-CHE
ERTP Empty In row to container Occurs when ASC traveling
position empty to container position
LRTC Laden in row to Carry-CHE Occurs when ASC laden
traveling to Carry CHE
LRAC Laden in row at Carry-CHE Occurs when ASC laden
traveling arrived at Carry CHE
LRTP Laden in row to container Occurs when ASC is laden
position traveling to container position

ASC Abort EC Events

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 565
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
AGV metrics

Event ID Event Description Timing Example

ABLF Abort on Crane Lift Occurs after ASC When an ASC goes to
sends validated abort pick a container and
command while trying the container is not at
to lift container the designated position
we get this abort
ABST Abort on Crane Set Occurs after ASC When ASC is dropping
sends validated abort a container to its
command while trying designated position
to set container and finds some
obstruction
ABCN Abort on TOS Cancel Occurs after operator Operator cancels the
cancels the transport transport order from an
order from an XPS XPS client - for both
client hard and soft cancels
ABRJ Abort on ECS Occurs when the order N4 Automation sends a
Rejection is rejected by ECS move order to ECS. It
is rejected by ECS

3.4.7 AGV metrics

For real-time operation purposes, terminal managers need to analyze operational performance and implement
corrective measures to improve AGV productivity. AGV metrics is computed based on Move Events and EC Events.

You need the BI license to be able to view AGV metrics.

3.4.7.1 Data Element Definition for AGV metrics

At the CHE move level, the data elements described in the following table specify the CHE moves in the last 60
minutes (sp:che_moves_1hr).

Data Element Description

t_buffer_enter Time AGV entered into the parallel buffer
t_buffer_exit Time AGV exited the parallel buffer
is_tandem True if move is a tandem move
is_quad True if move is a quad move

3.4.7.2 Definition of AGV metrics

This table describes the AGV metrics.

Metric Description
PickDispatchTime The time a CHE is dispatched to pick a container
PickArriveTime The time a CHE arrives to pick a container at either a
yard, vessel, or rail location
PickIdleTime The total elapsed time between the CHE’s last move and
the time the next move is dispatched (in milliseconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 566
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
AGV metrics

Metric Description
PickWaitTime The total elapsed time between the time the CHE arrived
to pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropDispatchTime The time a CHE is dispatched to drop a container
DropArriveTime The time a CHE arrives at a yard, vessel, or rail location
to drop a container
DropIdleTime The time difference between the time the CHE arrives to
pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropWaitTime The time difference between the time the CHE arrived to
drop the container and the time the container is actually
taken off the CHE (in milliseconds)
ContainerOnTime The time a container is loaded onto the CHE

ContainerOffTime The time the container is taken off the CHE

WaitTimeQC For vessel and rail loads - the time difference between the
time the CHE arrives at the QC to drop the container on
the AGV and the time when it actually drops the container
on the AGV
For vessel and rail discharges - the time difference
between the time the CHE arrives at the QC to pick the
container from the AGV and the time when it actually
picks the container from the AGV
WaitTimeBlock For vessel and rail discharges – the time difference
between the time the CHE arrives at the block to drop the
container on an AGV and the time when it actually drops
the container on the AGV
For vessel and rail loads – the time difference between
the time the CHE arrives at the block to pick the container
from an AGV and the time when it actually picks the
container from the AGV
For yard moves and yard shifts – the total wait time is the
sum of ‘pick wait time’ and ‘drop wait time’
BufferEnterTime The time when the AGV entered the parallel buffer

BufferExitTime The time when the AGV exited the parallel buffer

3.4.7.3 AGV/AHT EC Events

N4 generates the following EC Events to calculate AGV metrics.

AGV Status EC Events

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 567
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
AGV metrics

Event ID Timing
AVAL Occurs when AGV/ AHT is
available
DSPT Occurs when AGV/ AHT is
dispatched
IDLE Occurs when AGV/ AHT is idle
UNAV Occurs when AGV/ AHT is
unavailable
OTSV Occurs when AGV/ AHT is out of
service (broke down red)
RPSN Occurs when AGV/ AHT is
repositioned

AGV Operational EC Events

Event ID Long Name Timing

TYCO TO ROW TO COLLECT CHE sent to row to lift container
ARCO ARRIVE AT RAIL TO CHE at rail to lift container
COLLECT
AYCO ARRIVE AT ROW TO CHE arrives row to lift container
COLLECT
TYDR TO ROW TO DROP CHE sent to row to drop
container
AYDR ARRIVE AT ROW TO DROP CHE arrives row to drop
container
CMPL COMPLETE CHE job complete

TVCO TO VESSEL TO COLLECT CHE sent to ship to lift

container
TRCO TO RAIL TO COLLECT CHE sent to rail to lift container

AVCO ARRIVE AT VESSEL TO CHE arrives ship to lift

COLLECT container
TVDR TO VESSEL TO DROP CHE sent to ship to drop
container
TRDR TO RAIL TO DROP CHE sent to rail to drop
container
AVDR ARRIVE AT VESSEL TO DROP CHE arrives ship to drop
container
ARDR ARRIVE AT RAIL TO DROP CHE at rail to drop container

ENPB ENTER PARALLEL BUFFER CHE entered parallel buffer

EXPB EXIT PARALLEL BUFFER CHE exited parallel buffer

RPSN REPOSITIONING CHE drives to other place

AGV Abort EC Events

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 568
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Quay crane metrics

Event ID Event Description Timing Example

ABUL Abort on Unladen Occurs after AGV is When an AGV goes to
unladen to collect collect a container and
container the container is not at
the designated position
we get this abort
ABLA Abort on Laden Occurs after AGV is When AGV is to drop a
laden to drop container container but its
designated position
was obstructed
ABCN Abort on TOS Cancel Occurs after operator Operator cancels the
cancels the transport transport order from an
order from an XPS XPS client - for both
client hard and soft cancels
ABRJ Abort on ECS Occurs when the order N4 Automation sends a
Rejection is rejected by ECS move order to ECS and
is rejected by ECS

3.4.8 Quay crane metrics

For real-time operation purposes, terminal managers need to analyze operational performance and implement
corrective measures to improve QC productivity. Quay crane metrics are computed based on Move Events and EC
Events. For a QC with dual trolley, metrics are computed separately for main trolley and secondary trolley.

You need the BI license to be able to view quay crane metrics.

3.4.8.1 Data element definition for QC metrics

At the CHE move level, the data elements described in the following table specify the CHE moves in the last 60
minutes (sp:che_moves_1hr).

Data Element Description

is_tandem True if move is a tandem move
is_quad True if move is a quad move
cycle_time Time taken to complete a move (move
completion - move dispatch)

3.4.8.2 Definition of QC metrics

This table describes the Quay crane metrics.

Metric Description
PickDispatchTime The time a CHE is dispatched to pick a container
PickArriveTime The time a CHE arrives to pick a container at either a
yard, vessel, or rail location
PickIdleTime The total elapsed time between the CHE’s last move and
the time the next move is dispatched (in milliseconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 569
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Quay crane metrics

PickWaitTime The total elapsed time between the time the CHE arrived
to pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropDispatchTime The time a CHE is dispatched to drop a container
DropArriveTime The time a CHE arrives at a yard, vessel, or rail location
to drop a container
DropIdleTime The time difference between the time the CHE arrives to
pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropWaitTime The time difference between the time the CHE arrived to
drop the container and the time the container is actually
taken off the CHE (in milliseconds)
ContainerOnTime The time a container is loaded onto the CHE
ContainerOffTime The time the container is taken off the CHE
WaitTimeQC For vessel and rail loads - the time difference between the
time the CHE arrives at the QC to drop the container on
the AGV and the time when it actually drops the container
on the AGV
For vessel and rail discharges - the time difference
between the time the CHE arrives at the QC to pick the
container from the AGV and the time when it actually
picks the container from the AGV
Is_Tandem If the move is a tandem move
Is_Quad If the move is a quad move
Spreader_ID The spreader used for QC operations - Portal, Main, or
Unknown
Cycle_Time The time difference between move dispatch and move
completion

3.4.8.3 QC EC Events
N4 generates the following EC Events to calculate Quay crane metrics.

QC EC Events

Event ID Event Description Timing

DSPT Dispatch Occurs when the crane is

dispatched
QCPL Set of a container Occurs when QC sets the
container
QCFL Lift of a container Occurs when QC lifts the
container
UCIM Unit capture image - when the Occurs when the container is on
OCR captures the image of the the platform
container on the platform

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 570
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
RTG/RMG metrics

Event ID Event Description Timing

UCMI Unit capture mis-identity - when Occurs when the container is on

the OCR mis-captured the image the platform
of the container on the platform
UCID Unit capture identification - when Occurs when the container is on
the OCR identifies the container the platform
on the platform
TROK Unit transfer allowed Occurs when the container is on
the platform
TRNO Unit transfer not allowed Occurs when the container is on
the platform

3.4.9 RTG/RMG metrics

For real-time operation purposes, terminal managers need to identify inefficiency and improve RTG and RMG
productivity.

You need the BI license to be able to view RTG/RMG metrics.

3.4.9.1 Definition of RTG/RMG metrics

This table describes the RTG/RMG metrics.

Metric Description
PickDispatchTime The time a CHE is dispatched to pick a container
PickArriveTime The time a CHE arrives to pick a container at either a
yard, vessel, or rail location
PickIdleTime The total elapsed time between the CHE’s last move and
the time the next move is dispatched (in milliseconds)
PickWaitTime The total elapsed time between the time the CHE arrived
to pick the container and the time the container is actually
loaded onto the CHE (in milliseconds)
DropDispatchTime The time a CHE is dispatched to drop a container
DropArriveTime The time a CHE arrives at a yard, vessel, or rail location
to drop a container
DropIdleTime The total time elapsed
DropWaitTime The time elapsed between the time the CHE arrived to
drop the container and the time the container is actually
taken off the CHE (in milliseconds)
ContainerOnTime The time a container is loaded onto the CHE
ContainerOffTime The time the container is taken off the CHE
DistanceLaden The distance that the laden CHE is required to travel to
complete the work instructions (WIs)
DistanceUnladen The distance the CHE traveled from its last known
position to the position of fetch

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 571
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Yard metrics

UnladenTravelTime The total unladen travel time for the CHE to complete the
move
LadenTravelTime The total laden travel time for the CHE to complete the
move

3.4.10 Yard metrics

For real-time operation purposes, terminal managers need to know at the block level how many slots are still open and
how many are already occupied by containers. In addition, they are interested in utilization information to determine if
they will soon run out of yard capacity, for example when the next large vessel arrives.

3.4.10.1 Data Element Definition for Yard metrics

This table describes the data elements that Yard metrics are based on.

Data Element Description

Slots The container capacity in a block,
where a 20' slot counts as 1 TEU and
a 40' slot counts as 2 TEU. For blocks
with 40'-only slots, N4 counts 2 TEU
per slot.
Block_id The ID of the block where the
container is located
Units The number of containers in a block.
This element applies to areas that are
not slot specific.
TEU The number of TEU in a block, where
20' counts as 1 TEU and 40' counts
as 2 TEU. This element applies to
areas that are not slot specific.

3.4.10.2 Definition of Yard metrics

This table describes the Yard metrics available at the block level.

Metric Description
total_slots For stack blocks, the number of total
possible slots for the block or tier.
usable_slots For stack blocks, the total number of
serviceable slots in the block, which
equals the number of slots minus the
stack restriction, such as roadways, men
working on other temporary obstructions,
or stack height, reefer types, and
locations.
used_slots The number of used slots (or current TEU)
is based on the number of TEU currently

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 572
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Yard metrics

Metric Description
in the block plus the number of TEU
planned into the block.

Planned moves out of the block

do not affect the number of used
slots for that block.

available_slots For stack blocks, the number of usable

slots minus the number of used slots.
utilization For stack blocks, the number of used slots
in the block divided by the number of
usable slots.
utilization_pc For stack blocks, utilization multiplied by
100, expressed in percent.

This table describes the Yard metrics available at the yard level.

Metric Description
total_slots The sum of total slots of all stack blocks in
the yard
usable_slots The sum of usable slots of all stack blocks
in the yard
used_slots The sum of used slots of all stack blocks
in the yard
available_slots The sum of available slots of all stack
blocks in the yard, which is the number of
usable slots minus the number of used
slots
utilization The number of used slots in the yard
divided by the number of usable slots in
the yard
utilization_pc Utilization multiplied by 100, expressed in
percent

3.4.10.3 Edge cases and restrictions

In some cases, the number of used slots may be greater than the number of available slots, the number of available
slots may be less than zero, and the utilization (utilization_pc) may be greater than 1 (100%). For example:

• When the number of usable slots in a block is zero and containers are moved to a block violating one or more stack
restrictions, such as when a 40' container is put in a 20' slot, overhanging into another occupied slot, or if containers
are stacked higher than the stack height restriction allows.
• A planner changes the stack restriction, which reduces the number of usable slots to less than the number of
available slots.

The total number of available slots in a block is the sum of the available slots in each tier, regardless of
whether the individual value is negative or not.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 573
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Gate metrics

The following restrictions apply:

• N4 does not handle the reporting of yard utilization if the same area in a yard file is defined as both wheeled and
grounded slots. XPS does not currently provide information that identifies wheeled and grounded slots as the same
area.
• N4 does not report container count for non-stack blocks, such as logical blocks or list blocks, only TEU.

3.4.11 Gate metrics

For real-time operation purposes, terminal managers need to monitor gate operations for gate throughput and service
time levels. Gate gadgets allow them to closely watch trends and key performance indicators, discover bottlenecks
before they turn into real problems, and improve efficiency in processing trucks.

3.4.11.1 Data Element Definition for Gate metrics

This table describes the data elements that Gate metrics are based on.

Data Element Description

TruckEnteredYard The date and time the truck entered the yard
TruckVisitStatus The status of the truck visit, which can be any
of the following: OK, TROUBLE,
COMPLETE, CANCEL, or CLOSED
TruckTurnTime The time elapsed to complete the truck visit
(in milliseconds)
TruckProcessingStartDate The time the truck visit started
TruckExitedYard The date and time the truck left the yard
TruckProcessingEndDate The time the truck visit ended
TruckHadTrouble Flag that (if set to TRUE) indicates a problem
occurred while processing the complete truck
visit (in any of the stages)
TruckTotalTransactionCount The amount of transactions involved in the
truck visit

3.4.11.2 Definition of Gate metrics

This table describes the Gate metrics available at the truck level.

Metric Description
Trucks in yard The count of trucks that entered but but
did not exit the yard, where the
TruckVisitStatus is OK or Trouble. An
integer value.
Trucks of long stay The count of trucks currently in the yard,
where (now - TruckEnteredYard) >
TruckTurnTime. An integer value.
Trucks entered The count of trucks with a
TruckEnteredYard time within the last 60

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 574
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Move count per facility visit metrics

Metric Description
minutes, regardless of the
TruckExitedYard time. An integer value.
Trucks exited The count of trucks with a
TruckExitedYard time within the last 60
minutes, regardless of the
TruckEnteredYard time. An integer value.
Average turn time The sum of TruckTurnTime for trucks with
a TruckExitedYard time within the last 60
minutes and a
TruckTotalTransactionCount=N, where
N=1, 2, 3, 4, or more transactions, divided
by the count of trucks with a
TruckExitedYard time within the last 60
minutes and a
TruckTotalTransactionCount=N. One
decimal number, in minutes.
Trouble visits The count of trucks with a
TruckEnteredYard time within the last 60
minutes and for which TruckHadTrouble is
trueAn integer value.
% of trouble visits The count of trucks with a
TruckEnteredYard time within the last 60
minutes and for which TruckHadTrouble is
true, multiplied by 100. One decimal
number, in percent (%).

3.4.12 Move count per facility visit metrics

For real-time operation purposes, terminal managers need to analyze container movement efficiency and operational
productivity for an active unit facility visit. You can use the Unit Facility Visit (UFV) move count to view moves for a
unit at the facility level, and Equipment Block Visit move count to view moves for a unit at the yard block level for a
facility.

You need the BI license to be able to view move count per facility visit metrics.

3.4.12.1 Unit facility visit move count metrics

For an active unit facility visit, you can view all completed unit moves by container attributes such as line operator,
status, and category in the Units view in N4. When you complete a move, N4 increments the move count and
decrements the move count when a move is deleted.

You must have the privilege VIEW_UFV_MOVE_COUNT assigned. If you do not have this privilege, N4 displays N/A in
the Move Count field in the Units view.

For information on privileges that control dashboard-related functionality, see Monitor Privileges (on page 461).

Initialize UFV move count

You can initialize the move count for the existing active units in the facility after loading the BI license.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 575
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Equipment block visit (EBV) count

You must have the privilege INITIALIZE_UFV_MOVE_COUNT assigned. If you do not have this privilege, the menu
item does not appear in the Actions menu.

Since this action initializes the move count of all active units in the facility, use it carefully to avoid performance
issues.

To initialize the UFV move count:

1. Log in to N4 as a user with administrator privileges.
2. In the Operations Units view, select the table rows for which you want to initialize UFV move count.
3. Select Actions Initialize Ufv Move Count for all active units.

3.4.13 Equipment block visit (EBV) count

While the unit facility move count metric provides you the count of all completed unit moves for an active unit at the
facility level, the equipment block visit count helps you view completed moves for a unit at the yard block level for a
facility. N4 keeps track of unit moves within and between different blocks in the yard, such as ASC blocks/stacks, RTG
blocks, ASC transfer zones, and straddle rows.

This metric helps you optimize yard moves and offers a different perspective to analyze and manage rehandles for
RTG blocks and straddle rows. For ASC blocks, analyzing the EBV count by move kind and distribution between
waterside and landside cranes helps you better understand intra-stack moves.

N4 computes EBV move count based on the equipment and the yard block ID per facility visit. You can view EBV move
count in the Equipment Block Visit view in N4. The Ebv MoveCount field displays the total moves for an equipment
at the yard block level. Because N4 uses the CHE Move Statistics (on page 273) reporting entity to display the EBV
count, EBV count is computed every time you execute the CHE Statistics background job.

The following general exceptions apply for the EBV metric:

• Works only for valid yard blocks.

• Does not consider moves completed without CHEs.
• Does not reflect moves completed using Ctrl+E.
You must have the privilege VIEW_EBV_TABLE assigned to view the Equipment Block Visit view.

For information on privileges that control dashboard-related functionality, see Monitor Privileges (on page 461).

3.4.14 Internal and External trucks wait time metrics

For real-time operation purposes, it is important for terminal managers to monitor the number of internal trucks waiting
at a yard block or the quay area and the number of external trucks waiting at an exchange area at any given point of
time. As equipment congestion impacts other operations at a terminal, N4 provides useful metrics to measure
congestion of internal prime movers (carry CHEs such as trucks, straddles, and Automatic Guided Vehicles (AGVs))
and external trucks.

You can use the metrics to:

• Determine the daily congestion pattern of prime movers and external trucks and balance congestion across different
yard areas to reduce unproductive wait time
• Observe the distribution of prime movers at the quay or yard and accordingly fine tune PrimeRoute
You need the BI license to be able to view the internal and external trucks wait time metrics.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 576
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Sample reports

3.4.14.1 Internal trucks wait time metrics

N4 computes wait time for a truck/straddle at the quay area and at a yard block based on the move kind, as follows:

Wait time at the quay area:

• For a vessel/rail load move, wait time is the difference between the time the truck arrived at the quay area and the
time the quay crane picked the container from the truck.
• For a vessel/rail discharge move, wait time is the difference between the time the truck arrived at the yard block and
the time when a CHE picked the container.
Wait time at the yard block:

• For vessel/rail load/discharge moves:

▪ For a vessel/rail load move, wait time is the difference between the time a truck arrived to pick a container and the
time when the CHE placed that container on the truck.
▪ For a vessel/rail discharge move, wait time is the difference between the time a truck arrived to drop the container
and the time when the CHE picked the container from the truck.
• For road receival, road delivery, yard shift, and house keeping moves:
▪ Wait time is the sum of wait time to pick the container and the wait time to drop the container.

3.4.14.2 External trucks wait time metrics

N4 computes external wait time metrics only for trucks at the exchange area and uses the Truck Transaction Stage (on
page 351) reporting entity to compute the queue time and wait time for external trucks. Queue time is the time a truck
waits to start the transaction stage, which is the difference between the end time of the previous stage and the start
time of the yard stage. Wait time is the difference between the stage start time and stage end time.

This metric requires that the exchange area is correctly configured and assigned to gate lanes.
See Exchange Areas form for more information.

3.4.15 Sample reports

N4 provides the following sample reports:

• Moving CHE Productivity Analysis (on page 578)

• Move Count by POW by CHE (on page 580)
• Straddle Productivity (on page 582)
• Yard Rehandle by Equipment Operator (on page 587)
• Truck Turn Time Analysis (on page 584)
• Clerk Activity (on page 586)
• Stack Block Utilization (on page 589)
• Reefer Plug Utilization (on page 590)
• Average Daily Yard Utilization (on page 591)
• UFV Move Count (on page 595)
• Internal Prime Movers (on page 596)
• External Trucks (on page 598)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 577
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

• ASC Move Count by Move Type (on page 600)

• ASC Move Count Summary (on page 601)
• ASC Productivity by Block (on page 604)
• ASC Productivity (on page 603)
• RTG/RMG Productivity (on page 606)
• AGV Productivity (on page 607)
• QC Productivity (on page 609)

To be able to view the designs and definitions for these reports, and to run these reports, you need the
RUN_ADVANCED_REPORT privilege. For more information, see Report Privileges (on page 462).
For additional information, see the following topics:

• Comparing straddle productivity (on page 557)

• Duration metrics for moving CHEs (on page 556)
• Moving container with straddle carriers (on page 626)

3.4.15.1 Moving CHE Productivity Analysis report

The Moving CHE Productivity Analysis report complements the Move Count by POW by CHE report (on page 580).
It can help you analyze quay-side operations by providing information on a truck's average wait times at a crane and
on its average travel time and distance, as shown in the following figure. This information is useful when shift
supervisors need to determine the possible causes for low crane productivity.

With this report, you can answer the following questions:

• Is a crane itself slow? To find out, look at a crane's average wait time.
• Is the move rate low because the CHEs have to travel far? To find out, look at the average travel time or distance.
For this report, you must specify the following information:

• A duration. By default, the report covers the last 8 hours: the From time is now minus 8, and the To time is now.

From a performance perspective, the report is designed to show productivity for up to the last 36 hours.

• A moving CHE type, which can be self-complete or truck.

• One or more move kinds (optional), such as: DSCH, LOAD, SHOB, RECV, DLVR, RDCS, RLOD, SHFT (rehandle),
YARD, or OTHR. By default, the report includes all move kinds.
This information is part of the report header. For information on the report body, see Moving CHE productivity table (on
page 579).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 578
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Moving CHE Productivity table

The table in the body of the Moving CHE Productivity Analysis report provides information on move-related metrics
on the left and trip-related metrics on the right. The information applies to CHEs of a specific moving type that have at
least completed a carry phase of a move during the specified time period for the given POW.

Column (metric) Description

Mvs The number of work instructions (WIs) completed
This includes all moves of the specified move kinds
for the specified time period that were in Carry
Complete stage.
Avg Mvs/hr The move count divided by the number of hours
that the report covers
Avg Wait At Crane The total wait time at a crane across all moves (in
seconds) divided by the move count
Avg Wait At Yard (mins) The total wait time in the yard across all moves (in
seconds) divided by the move count
Avg Idle Time (mins) The total idle time across all moves (in seconds)
divided by the move count
Trips The number of trips completed
This includes all WIs completed for the trip for the
specified move kinds for the specified time period.
Avg Unladen Travel Time (mins) The total unladen travel time across all trips (in
minutes) divided by the number of trips
Avg Laden Travel Time (mins) The total laden travel time across all trips (in
minutes) divided by the number of trips
Avg Unladen Travel Distance The total unladen travel distance across all trips (in
meters) divided by the number of trips
Avg Laden Travel Distance The total laden travel distance across all trips (in
meters) divided by the number of trips

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 579
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column (metric) Description

Total Wait Time At Crane (mins) The sum of the Wait At Crane Time across all
moves (in minutes)
Total Wait Time At Yard (mins) The sum of the Wait At Yard Time across all moves
(in minutes)
Total Idle Time (mins) The sum of the Pick Idle and Drop Idle Time across
all moves (in minutes)
Total Unladen Travel Time (mins) The sum of the Unladen Travel Time across all
moves (in minutes)
Total Laden Travel Time (mins) The sum of the Laden Travel Time across all
moves (in minutes)

3.4.15.2 Move Count by POW by CHE report

The Move Count by POW by CHE report complements the Moving CHE Productivity Analysis report (on page 578). It
can help you analyze yard CHEs (rehandles) by providing information on the number of CHEs per point of work (POW)
and their productivity. This is useful when shift supervisors need to determine the possible causes for low crane
productivity.

With this report, you can answer the following questions:

• Are enough CHEs assigned to the POW? To find out, look at the list of CHEs with moves for the crane POW.
• Are the ones assigned to the crane POW distracted in terms of servicing other POWs? To find out, look at the
moves for each POW for each CHE.
• Are the CHEs assigned to the crane POW slow? To find out, look at the number of moves per hour.
For this report, you must specify the following information:

• A duration. By default, the report covers the last 8 hours: the From time is now minus 8, and the To time is now.

From a performance perspective, the report is designed to show productivity for up to the last 36 hours.

• A CHE type, which can be moving or fixed.

• One or more POWs. By default, the report includes all POWs.
This information is part of the report header. For information on the report body, see Move Count by POW by CHE
table (on page 581).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 580
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Move Count by POW by CHE tables

The tables in the body of the Move Count by POW by CHE report provide information on CHE moves per POW. The
information applies to CHEs of a specific type that have at least completed one move phase during the specified time
period for the given POW. N4 considers a move complete as follows:

• At fetch time for a fetch CHE

• At carry complete time for a carry CHE
• At put time/move complete time for a put CHE

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 581
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

The top table provides a summary of moves and rehandles. It contains the columns described in the following table.

Column (metric) Description

CHE The identifier for the CHE
Total mvs The total number of moves that a CHE made
across all POWs
mv/hr The total number of moves divided by the number
of hours in the specified time period
Rehandles The total number of yard rehandles that a CHE
performed
This is only applicable to fetch CHEs. These
moves are considered unproductive.
Total productive moves The total number of moves minus rehandles

The bottom table shows the number of moves by CHE and POW. The Total Moves column sums up the number of a
specific row, providing the total for a specific CHE. The Total row at the bottom of the table sums up the numbers of a
specific POW, providing the total for all the CHEs listed in the table in the bottom right cell.

3.4.15.3 Straddle Productivity report

The Straddle Productivity report provides information on relative operator productivity. It helps terminal managers
identify training opportunities or determine operator compensation. See also Comparing straddle productivity (on page
557).

For this report, you must specify the following information:

• A duration, that is the From date and time and the To data and time, in the following format: mm-dd-yyyy hh:mm
The report only includes work instructions (WI) with a carry complete time that occurs in the specified time period.
The following formula applies: From time <= Time carry complete <= To time
• A straddle carrier.

The Straddle drop-down list in the Enter Filter Parameter Values form lists all CHEs and not just the
straddle because this field's value is retrieved from CHE trip statistics.

• One or more CHE operators (optional).

The report only includes operators that have carry-completed a move in the specified time period. By default, the
report includes all operators.
This information is part of the report header. For information on the report body, see Straddle Productivity table (on
page 583).

The Straddle Productivity Report in the following figure shows straddle productivity filtered by straddle and driver.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 582
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Straddle Productivity table

The table in the body of the Straddle Productivity report provides information on the carry moves that a CHE operator
performs during a specified time period, sorted by driver (operator) and start time, in ascending order.

The following table describes the available columns.

Column (metric) Description

Driver The login name for the CHE operator who
completed the move
Container The Unit ID of the container

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 583
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column (metric) Description

Transaction Type The gate transaction type, which can be any of
the following:
• Deliver Chassis (DC)
• Dray off (DE)
• Deliver Import (DI)
• Deliver Empty (DM)
• Receive Chassis (RC)
• Receive Export (RE)
• Dray In (RI)
• Receive Empty (RM)
Queue The work queue for the work instruction
POW The point of work for the work instruction
Move Kind The move kind, such as LOAD, DSCH, RLOD,
RDSC, or YARD
From Location The complete name of the location from which
the unit was moved
To Location The complete name of the location to which the
unit was moved
Start Time The time of dispatch to origin
Stop Time The complete time of the move
Elapsed Time The Carry Complete Time minus the Dispatch
Time
Idle Time The amount of time the CHE spent idle at both
origin and destination

3.4.15.4 Truck Turn Time Analysis report

The Truck Turn Time Analysis report provides information on transaction data by gate stage and user. It helps
terminal managers keep track of clerk statistics at a stage level to view productivity.

For this report, you must specify the following information:

• A duration, that is the From date and time and the To date and time, in the following format: yyyy-mm-dd hh:mm
The report only includes truck visits that ended between the From and To date. The following formula applies: From
time <= Truck visit end time <= To time
• A threshold, in minutes (optional). By default, the threshold is zero (0). The report only includes truck visits with a
through terminal time greater than the threshold, where the through terminal time is the time that the truck spends at
the terminal, that is from when it enters the terminal to when it leaves the terminal, minus any time it spends at the
trouble desk for a trouble ticket.
• One or more transaction types (optional), which can be any of the following:
▪ Deliver Chassis (DC) for trucks picking up a bare chassis at the terminal
▪ Dray Off (DE) for trucks picking up export containers at the terminal
▪ Deliver Import (DI) for trucks picking up import containers at the terminal
▪ Deliver Empty (DM) for trucks picking up empty containers at the terminal

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 584
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

▪ Receive Chassis (RC) for trucks dropping off a bare chassis at the terminal
▪ Receive Export (RE) for trucks dropping off export containers at the terminal
▪ Dray In (RI) for trucks dropping off dray-in import or export containers at the terminal
▪ Receive Empty (RM) for trucks dropping off empty containers at the terminal
▪ Through Container (TC) for trucks bringing in containers that pass through the terminal
▪ Receive Break-Bulk (RB) for truck delivering general cargo at the terminal
▪ Unknown (UK)
By default, the report includes all transaction types.
• One or more line operators (optional). By default, the report includes all line operators.
N4 obtains the list of operators from the Line Operators view.
This information is part of the report header. For information on the report body, see Truck Turn Time Analysis table (on
page 585).

Truck Turn Time Analysis table

The body of the Truck Turn Time Analysis report contains a table for each date in the specified time period. Each
table provides information on the truck transactions that occurred on that date, sorted by BAT number, in ascending
order, and Stage1 End Time, in ascending order.

The following table describes the available columns.

Column (metric) Description

BAT Number A short unique ID that is assigned to an external
truck arriving at the gate
Total Receival The number of receival transactions involved in the
truck visit
Total Delivery The number of delivery transactions involved in the
truck visit
Double Moves If Y, the visit has at least one receival and one
delivery move.
Visit Start Time The date and time when the truck visit starts
Stage1 End Time The end time of the visit stage, where Visit Stage
Sequence equals 1

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 585
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column (metric) Description

Stage 2 End Time The end time of the visit stage, where Visit Stage
Sequence equals 2
Visit End Time The date and time when the truck visit ends
Truck Turn Time The time elapsed to complete this truck visit (in
milliseconds)
Truck Trouble Time The time that was needed to solve a visit problem
(in milliseconds), and the sum of Visit Stage
Trouble Time for any stages of the visit that had a
problem
Truck Through Time The Truck Turn Time minus the Truck Trouble Time
(in milliseconds)
Transaction Type The type of transactions, such as DI or RE. See
also Truck Turn Time Analysis report (on page
584).
Line Operator Id The identifier of the line operator of the
transaction's unit
Freight Kind The filling status of the transaction's unit:
• E (Empty)
• F (Full Container Load)
• L (Less than Container Load)
• B (Breakbulk)
Category The category of the transaction's unit:
• I (Import)
• E (Export)
• T (Transship)
• D (Domestic)
• S (Storage)
• R (Through, including Restows)
Time Carry CHE Dispatch Dispatch time of the Carry CHE for the receival or
delivery move for the transaction
Time Carry CHE Complete Complete time of the Carry CHE for the receival or
delivery move for the transaction
Move Time The time difference between Time Carry CHE
Complete and Time Carry CHE Dispatch, rounded
to minutes
End Date The date that the truck visit ended

3.4.15.5 Clerk Activity report

The Clerk Activity report provides information on transaction data by gate stage and user. It helps terminal managers
keep track of clerk statistics at a stage level to view productivity.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 586
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

For this report, you must specify the following information:

• A duration, that is the From date and time and the To date and time, in the following format: mm-dd-yyyy hh:mm
The report only includes truck visits that ended between the From and To date. The following formula applies: From
time <= Truck visit end time <= To time
• A facility (optional)
This information is part of the report header. For information on the report body, see Clerk Activity table (on page 587).

Clerk Activity table

The table in the body of the Clerk Activity report provides information on the clerks' productivity, sorted by clerk ID, in
ascending order.

The following table describes the available columns.

Column (metric) Description

Clerk The user ID of the clerk processing the
ingate or outgate move (stage)
Visits In The number of visits that a clerk processed
at the ingate stage
Moves In The number of transactions that a clerk
processed at the ingate stage
Visits Out The number of visits that a clerk processed
at the outgate stage
Moves Out The number of transactions that a clerk
processed at the outgate stage
Total Visits The sum of visits at the ingate and outgate
stage
Total Moves The sum of transactions at the ingate and
outgate stage

3.4.15.6 Yard Rehandle by Equipment Operator report

The Yard Rehandle by Equipment Operator report helps terminal managers minimize rehandles by understanding
the circumstances that cause rehandles for vessel loads. A rehandle in this context is the act of moving a container out
of the way to get to the intended container. Rehandles translate to lost productivity.

For vessel load moves, rehandles often occur because equipment operators provide late, inaccurate, or changing

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 587
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

information regarding the actual outbound carrier of a container. For example, if container XYZ is planned to be loaded
to vessel A, but then it is replanned to vessel B, which is bound to arrive a week later, this container becomes a
rehandle for any containers that are stored underneath and are planned to vessel A.

Rehandle patterns can vary by vessel or service. For example, if a vessel often arrives much earlier or later than its
contractual window of arrival, it could increase the number of rehandles for itself or for another vessel. Therefore,
terminal managers need to be able to report the percentage of rehandles by equipment operator as well as by vessel
visit, vessel, and vessel service to understand the relative effort involved in servicing their customers.

For this report, you must specify a duration. The report includes the completed vessel load moves for all vessels that
arrived between 00:01 on the From date and 24:00 on the To date.

The covered time period appears in the report header. For information on the report body, see Yard Rehandle by
Equipment Operator table (on page 588).

Yard Rehandle by Equipment Operator table

The table in the body of the Rehandle by Equipment Operator report provides information on vessel load moves and
yard rehandles by equipment operator. The information applies to all equipment operators with at least one load move
during the specified time period. The number of rows depends on the number of equipment operators with load moves.
The Summary row at the bottom of the table sums up the numbers of a specific column, providing the total for all
equipment operators.

The following table describes the available columns.

Column (metric) Description

Line Operator The operator of the equipment
Rehandle Count The total number of yard rehandles performed for
all completed vessel load moves for the equipment
operator across all vessel visits
Load The number of completed vessel load moves for
the equipment operator across all vessel visits
Yard rehandle/Load (%) The yard load shifts divided by the number of loads
multiplied by 100, in percent.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 588
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

3.4.15.7 Stack Block Utilization report

The Stack Block Utilization sample report provides information on stack block utilization at the current facility, as shown
in the following figure. It contains the number of total slots, usable slots, used slots, and available slots as well as the
utilization percentage, which is derived from the total number of used slots divided by the total number of usable slots
for an area.

For this report, you must specify a date and an hour in the following format: mm/dd/yy hh:00. By default, both are the
most recent. For example, if the current time is 02/15/09 15:03, the information in the report reflects the utilization on
02/15/09 at 15:00. This information is part of the report header.

For information on the report body, see Stack Block Utilization table (on page 589).

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

Stack Block Utilization table

The table in the Stack Block Utilization report (on page 589) displays utilization information by area. The Summary
row at the bottom of the table sums up the numbers of a specific column, providing the total for all the areas listed in
the table.

The following table describes each column.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 589
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column Description
Area Code The code of the area that the blocks are assigned
to, ordered alphabetically, in ascending order of the
area codes

A yard area is a group of blocks, typically stack

containers, with similar characteristics, regardless
of their physical locations in the yard. Terminals
can assign area codes based on their yard
operation. For more information, see Managing
yard areas.

Total Slots The sum of all slots for all blocks assigned to the
area
Usable Slots The number of usable slots for all the blocks
assigned to the area
Used Slots The number of used slots for all the blocks
assigned to the area
Available Slots The number of available slots for all the blocks
assigned to the area
Utilization % The percentage of slots utilized, based on the
number of used slots divided by the number of
usable slots for the area

3.4.15.8 Reefer Plug Utilization report

The Reefer Plug Utilization sample report provides information on reefer plug utilization for the current facility, as
shown in the following figure. It contains the number of total plugs, usable plugs, used plugs, and available plugs as
well as the utilization percentage, which is derived from the total number of used plugs divided by the total number of
usable plugs for the block.

For this report, you must specify a date and an hour in the following format: mm/dd/yy hh:00. By default, both are the
most recent. For example, if the current time is 02/15/09 15:03, the information in the report reflects the utilization on
02/15/09 at 15:00. This information is part of the report header.

For information on the report body, see Reefer Plug Utilization table (on page 591).

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 590
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Reefer Plug Utilization table

The table in the Reefer Plug Utilization report (on page 590) displays reefer utilization information by block. The
Summary row at the bottom of the table sums up the number of a specific column, providing the total for all the blocks
listed in the table.

The following table describes each column.

Column Description
Blocks The name of a block with at least one reefer plug,
ordered alphabetically, in ascending order of the
yard blocks
Total Plugs The total number of plugs for the block
Usable Plugs The number of usable plugs for the block
Used Plugs The number of used plugs for the block
Available Plugs The number of available plugs for the block
Utilization % The percentage of plugs utilized, based on the
number of used plugs divided by the number of
usable plugs for the block

3.4.15.9 Average Daily Yard Utilization report

The Average Daily Yard Utilization sample report calculates information for the facility and yard that you are currently
logged in to, specifically the daily average utilization for reefer plugs and the total yard for the last seven days (from the
current date). In addition, it lists slot utilization by area for the same timeframe. Because the report focuses on day-to-
day variation, it displays a daily average and disregards utilization variation due to intra-day activities. To view yard
utilization at a given snapshot time, you can modify the report definition (on page 594).

Analytics calculates the utilization as follows:

• For each day, Analytics gets all available yard block statistics data, determined by ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) (on page 464), the setting that defines how often N4 runs the Yard Block
Statistics background job. Based on this data, N4 calculates the daily average utilization.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 591
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

• For reefer slots, the utilization is based on the number of used reefer slots divided by the number of usable reefer
slots.
• For total yard slots, the utilization is based on the number of used slots divided by the number of usable slots.
With the Average Daily Yard Utilization report, terminal managers can do the following:

• Examine the average utilization for the current date.

• Analyze the pattern of yard utilization by area and of reefer plug utilization across the week.

For an area code that is not in use at the time N4 calculates the data, the report displays a null value.

• Determine (along with other information) berth utilization, and when or whether the terminal can accommodate
additional business.
• Identify recurring yard utilization issues and use the emerging pattern to address yard issues proactively.
For example, if the reefer plug utilization typically jumps from 75% to 90% between Tuesday and Wednesday, and
on a particular Tuesday the reefer plug utilization is already 80%, this may require replanning.
For information on the report body, see Average Daily Yard Utilization tables (on page 593).

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 592
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Average Daily Yard Utilization tables

The Average Daily Yard Utilization report (on page 591) includes the following tables:

• Total Yard Utilization (%)

• Total Reefer Utilization (%)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 593
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

• Utilization (%) by Area

These tables display the daily average utilization percentage for the entity on the specified date, for the last 7 days.

The following table describes the columns.

Column Description
Date The date, in ascending order
Total Utilization (%) The percentage of the total number of utilized yard
slots
Reefer Utilization (%) The percentage of reefer plugs utilized
<Area Code> The percentage of slots utilized, by area code. The
table includes a separate column for each area
code that has slots assigned, such as Import,
Export, Reefers, Empty, or Rail.
A yard area is a group of blocks, typically stack
containers, with similar characteristics, regardless
of their physical locations in the yard. Terminals
can assign area codes based on their yard
operation. For more information, see Managing
yard areas.

For an area code that is not in use at the

time N4 calculates the data, the report
displays a null value.

Modifying the report definition to view yard utilization at snapshot

time
If you are interested in viewing the yard utilization at a given snapshot time, you can modify the out-of-box definition of
the Average Daily Yard Utilization report (on page 591) by adding a filter criteria that specifies a snapshot time. In
this case, N4 does not calculate the daily average.

When you run the snapshot report, it will look exactly like the Average Daily Yard Utilization report, but it will show
yard utilization data for the time of the snapshot instead of the daily average. If you prefer a different title for the report,
you can create a new report design that is based on the original Average Daily Yard Utilization Report design but
uses a modified XML file, and then base the snapshot report on the new design. For details, see Creating or updating a
report design.

Make sure the snapshot time corresponds to the round-off time determined by the ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) setting. Otherwise, the report may not contain any data. For details, see
ARGOMONITOR005 (YARD_BLOCK_STATISTICS_FREQ) (on page 464).

To modify the report definition to view yard utilization at a given snapshot time:
1. In the Report Definitions view (on page 28), right-click the Average Daily Yard Utilization report and select
Duplicate Report Def.

2. Click .
The view refreshes, displaying the duplicated report definition as Average Daily Utilization Report COPY 1.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 594
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

3. Double-click the duplicated report definition.

4. In the Edit Report Definition form (on page 30), in the Report Definition Name box, modify the name, if required,
for example as Daily Yard Utilization Snapshot. This could be useful to distinguish two reports based on the same
design.
5. From the Report Design list, select a different report design, if required.
For example, you want your report to include a different title than the Average Daily Yard Utilization report, to
clarify that it is based on a snapshot rather than on average calculations. For details, see Creating or updating a
report design.
6. Under Filter Criteria, add a new criterion:
a. From the first drop-down list on the left, select the Time attribute.
b. From the second drop-down list, select the is (=) operator.
c. In the text box to the right of the second drop-down list, type the required snapshot time, such as 10:00.
d. Click + Add Criterion.
The filter criterion appears in the filter pane.
7. Click Save.

3.4.15.10 UFV Move Count report

The UFV Move Count sample report provides information on a unit's completed moves for a departed facility visit for
the last seven days (from the current date).

For this report, you must specify a duration that is the From date and time and the To date and time, in the following
format: mm-dd-yyyy hh:mm. The covered time period appears in the report header. For information on the report body,
see UFV Move Count table (on page 595).

UFV Move Count table

The table in the body of the UFV Move Count Report provides information about a unit's completed moves for an
active facility visit. The Summary row at the bottom of the table sums up the numbers of a specific column. The
Average UFV Move count is the average of the Sum of UFV Move Count divided by the # of UFVs (the sum of a
unit's facility visits).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 595
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

The following table describes each column.

Column Description
UFV Move Count The number of move counts performed for a unit.
# of UFVs The number of units that were moved.
% of Total UFV The count of UFVs moves – in percentage.
Sum of UFV Move Count The sum of UFV move count.

3.4.15.11 Internal Prime Movers report

The Internal Prime Movers report provides information on truck/straddle wait time at the quay area and yard block for
the last seven days (from the current date).

For this report, you must specify a duration that is the Start date and time and the End date and time, in the following
format: mm-dd-yyyy hh:mm. The covered time period appears in the report header. Optionally, you can specify the
From Block and To Block. For information on the report body, see Internal Prime Movers table (on page 597).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 596
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Internal Prime Movers table

The table in the body of the Internal Prime Movers Report provides information about a truck’s wait time at the quay
area and the yard block. The Summary row at the bottom of the table sums up the number of moves for all the trucks in
the report.

The following table describes the available columns.

Column Description
QC ID The ID of the crane at the quay area
Wait time at QC in ms The truck’s wait time at the quay crane area (in
milliseconds)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 597
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column Description
Wait time at QC in min The truck’s wait time at the quay crane area (in minutes)
From Block ID The source yard block from where the truck
To Block ID The target yard block
Wait time at block in ms The truck’s wait time at a yard block (in milliseconds)
Wait time at block in min The truck’s wait time at a yard block (in minutes)

3.4.15.12 External Trucks report

The External Trucks report provides information on a truck’s queue time and wait time at an exchange area for the
last seven days (from the current date).

For this report, you must specify the following information:

• A duration that is the From date and time and the To date and time, in the following format: mm-dd-yyyy hh:mm
• The exchange area ID

N4 also considers transactions in CANCEL and CLOSED state.

The covered time period and the area ID appear in the report header. For information on the report body, see External
trucks table (on page 599).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 598
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

External Trucks table

The table in the body of the Report for External Trucks at an Area provides information about a truck’s queue time and
wait time at an exchange area. The Summary row at the bottom of the table sums up the trucks in the exchange area
that was considered for the report, the total queue time (in minutes), and the total wait time of trucks (in minutes).

The following table describes the available columns.

Column Description
Truck/Driver The truck’s license number or the truck driver’s ID
Start time The start time of the yard stage
End time The end time of the yard stage
Status The yard stage status
Queue time (mins) The truck’s queue time (in minutes)
Wait time (mins) The truck’s wait time (in minutes)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 599
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

3.4.15.13 ASC Move Count by Move Type report

The ASC Move Count by Move Type report provides information on ASC moves based on move kind such as LOAD,
DSCH, RLOD, RDSC, or YARD for the last seven days (from the current date). The Total Moves column displays the
total moves for a crane for all move types.

N4 displays Move kind columns only if a move kind has data.

You can also view moves performed by an ASC using the Fixed CHE Details gadget. But the gadget displays
only moves completed within the last hour.
For this report, you must specify the From date and time and the To date and time, in the following format: mm-dd-yyyy
hh:mm.

For information on the report body, see ASC Move Count by move type table (on page 600)

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

ASC Move Count by move type table

The table in the body of the ASC Move Count by move type provides information about the moves completed by an
ASC based on the move type, such as LOAD, DSCH, RLOD, RDSC, or YARD.

The following table describes the available columns.

Column Description
CHE Name The name of the ASC
Move Type The type of move performed by the ASC,
such as LOAD, DSCH, RLOD, RDSC, or
YARD

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 600
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column Description
Total Moves Total moves for an ASC for all move
types

N4 displays move kind columns only if a move kind has data.

3.4.15.14 ASC Move Count Summary report

The ASC Move Count Summary report displays the ASC move count by move direction and move purpose for the
last seven days (from the current date).

The ASC Move Count Summary report is split into:

• ASC Move Count by Move Direction table (on page 602), which displays the move count for:
▪ From TZ - for move kinds vessel discharge, rail discharge, and receival
▪ To TZ - for move kinds vessel load, rail load, and deliver
▪ Intrastack moves - for other yard to yard moves
• ASC Move Count by Move Purpose table (on page 602), which displays the move count for:
▪ Housekeeping
▪ Rehandle
▪ Transfer_In moves

You can also view moves performed by an ASC using the Fixed CHE Details gadget (on page 495). But the
gadget displays only moves completed within the last hour.

For this report, you must specify the From date and time and the To date and time, in the following format: mm-dd-yyyy
hh:mm.

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 601
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

ASC Move Count by Move Direction table

The ASC Move Count by Move Direction table in the body of the ASC Move Count Summary report (on page 601)
provides information about the moves completed by an ASC based on the move direction.

The following table describes the available columns.

Column Description
CHE Name The name of the ASC
Move Direction Move count by move direction, such as
from TZ, to TZ, and Intrastack
Total Total moves for an ASC based on move
direction

ASC Move Count by Move Purpose table

The ASC Move Count by Move Purpose table in the body of the ASC Move Count Summary report (on page 601)
provides information about the moves completed by an ASC based on the move purpose.

The following table describes the available columns.

Column Description
CHE Name The name of the ASC

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 602
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column Description
Move Direction Move count by move purpose, such as
housekeeping, rehandle, and transfer_in
Total Total moves for an ASC based on move
purpose

3.4.15.15 ASC Productivity report

The ASC Productivity report summarizes move information statistics for an ASC for the last seven days (from the
current date). It can help you analyze ASC operations by providing information on an ASC’s wait times, travel time, and
distance.

You can also view moves performed by an ASC using the Fixed CHE Details gadget. But the gadget displays
only moves completed within the last hour.
For this report, you must specify a date and an hour in the following format: mm-dd-yyyy hh:mm.

For information on the report body, see ASC Productivity table (on page 604).

If you encounter any problems when generating a report, see Troubleshooting reports for more information.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 603
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

ASC Productivity table

The table in the body of the ASC Productivity report (on page 603) provides consolidated information for an ASC for a
given period.

The following table describes the available columns.

Column Description
Moves The move count for each move kind
MoveKind The move kind, such as LOAD, DSCH,
RLOD, RDSC, or YARD
Container Id The container ID
IdleTime The total idle time for an ASC in the selected
period
WaitTime The total wait time for an ASC in the selected
period
Laden Distance The total laden distance for an ASC in the
selected period
Unladen Distance The total unladen distance for an ASC in the
selected period
Laden Travel Time The total laden travel time for an ASC in the
selected period
Unladen Travel Time The total unladen time for an ASC in the
selected period

3.4.15.16 ASC Productivity Report By Block

The ASC Productivity Report By Block summarizes move information statistics for an ASC for the last seven days
(from the current date) for all blocks. It can help you analyze ASC operations by providing information on an ASC's
laden and unladen travel time and distance. You can view this report for a specific block by entering the block name in
the Enter Filter Parameter Values form.

For this report, you must specify a duration, that is the From date and time and the To data and time, in the following
format: mm-dd-yyyy hh:mm

For information on the report body, see ASC Productivity by Block table (on page 605).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 604
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

ASC Productivity by block table

The table in the body of the QC Productivity Report (on page 609)provides information about a truck’s wait time at
the quay area and the yard block. The Summary row at the bottom of the table sums up the number of moves for all
the trucks in the report.

The following table describes the available columns.

Column (metric) Description

Moves The move count for each move kind
MoveKind The move kind, such as LOAD, DSCH, RLOD, RDSC, or
YARD
Container ID The container ID
Laden Distance The total laden distance for an ASC in the selected period
by block, in meters
Unladen Distance The total unladen distance for an ASC in the selected
period by block, in meters
Laden TravelTime The total laden travel time for an ASC in the selected
period by block, in milliseconds
Unladen TravelTime The total unladen travel time for an ASC in the selected
period by block, in milliseconds

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 605
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

3.4.15.17 RTG/RMG Productivity report

The RTG/RMG Productivity report summarizes move information statistics for an RTG/RMG for the last seven days
(from the current date). It can help you analyze RTG/RMG operations by providing information about an RTG/RMG’s
travel time and distance.

You can also view moves performed by an ASC using the Fixed CHE Details gadget (on page 495). But the
gadget displays only moves completed within the last hour.

For this report, you must specify the following information:

• A duration, that is the From Date and time and the To Date and time, in the following format: yy/mm/dd hh:00. By
default, both are the most recent.
• The RTG ID (optional)
• The Work Queue (optional)
For information on the report body, see RTG/RMG Productivity table (on page 606).

RTG/RMG Productivity table

The table in the body of the RTG/RMG Productivity report (on page 606)provides consolidated information for RTGs
and RMGs. The Summary row at the bottom of the table sums up the moves completed by the RTG/RMG, the total
laden and unladen distance (in metres), total laden time, and average time elapsed.

The following table describes the available columns.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 606
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column Description
Driver The identifier for the driver
Container The identifier for the container
Transaction Type The transaction type
POW The point of work for the work instruction
Move Kind The move kind, such as LOAD, DSCH,
RLOD, RDSC, or YARD
From Location The complete name of the location from
which the unit is moved
To Location The complete name of the location to
which the unit is moved
Laden Distance The distance that the laden CHE is
required to travel to complete the work
instructions (WIs)
UnLaden Distance The distance the CHE traveled from its last
known position to the position of fetch
Start Time The time of dispatch to origin
Stop Time The complete time of the move
Elapsed Time The Carry Complete Time minus the
Dispatch Time
Idle Time The amount of time the CHE spent idle at
both origin and destination

3.4.15.18 AGV Productivity Report

The AGV Productivity report summarizes move information statistics for an AGV for the last seven days (from the
current date). It can help you analyze AGV operations by providing information on an AGV's wait time, laden and
unladen travel time and distance.

For this report, you must specify a date and an hour in the following format: mm-dd-yyyy hh:mm.

For information on the report body, see AGV Productivity table (on page 608).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 607
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

AGV Productivity table

The table in the body of the AGV Productivity report provides consolidated information for an AGV for a given period.

The following table describes the available columns.

Column (metric) Description

Moves The move count for each move kind
MoveKind The move kind, such as LOAD, DSCH, RLOD, RDSC,
or YARD
Container ID The container ID
IdleTime The total idle time for the AGV in the selected period, in
millimeters
WaitTime The total wait time for the AGV in the selected period,
in millimeters

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 608
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Sample reports

Column (metric) Description

Laden Distance The total laden distance for an AGV in the selected
period by block, in meters
Unladen Distance The total unladen distance for an AGV in the selected
period by block, in meters
Laden TravelTime The total laden travel time for an AGV in the selected
period by block, in meters
Unladen TravelTime The total unladen travel time for an AGV in the
selected period by block, in meters

3.4.15.19 QC Productivity
The QC Productivity report summarizes move information statistics for a QC for the last seven days (from the current
date). It can help you analyze QC operations by providing information on a QC's wait and idle time.

For this report, you must specify a date and an hour in the following format: mm-dd-yyyy hh:mm.

For information on the report body, see QC Productivity table (on page 610).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 609
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Operation scenarios

QC Productivity table
The table in the body of the QC Productivity Report provides information about a truck’s wait time at the quay area
and the yard block.

The following table describes the available columns.

Column (metric) Description

Moves The move count for each move kind
MoveKind The move kind, such as LOAD, DSCH, RLOD, RDSC,
or YARD
Container ID The container ID
IdleTime The total idle time for the QC in the selected period, in
milliseconds
WaitTime The total wait time for the QC in the selected period, in
milliseconds

3.4.16 Operation scenarios

This section provides operation scenarios for vessel loads, vessel discharges, moving CHEs, and yard moves. These
scenarios describe the behavior of N4 in relation to XPS.

Due to site-specific requirements, XPS may not support all use cases described in this section for your site.
The following general exceptions apply:

• When the operator/clerk physically completes a move step but does not confirm it in the terminal operating system
(TOS), N4 does not know of this unrecorded move step.
• When the operator/clerk does not complete the move step physically but confirms it in the TOS, N4 assumes that a
move step is done based on a user entry in the TOS rather than on what physically happens.
• When the operator/clerk confirms a move step ahead or behind the actual CHE move (such as completing moves in
a batch), N4 takes the recorded move step time entered into the TOS.
• When no work instruction is given for a job, N4 does not count the completed job.
• During a vessel or rail load, if put_CHE is null when the move_stage is completed, N4 credits +1 move (the put step)
to the POW.
• During a vessel or rail discharge, if fetch_CHE is null when the move_stage is "Carry Underway/Carry Complete",
N4 credits +1 move (the fetch step) to the POW.
• The Moving CHE Details gadget does not reflect moves completed using Ctrl+E.

The Moving CHE Details gadget (on page 497) only displays trip count or distance-related metrics if the
XPS setting MENTRP is set to Y.

3.4.16.1 Loading a container to a vessel (RTG/RMG)

The primary actors in this scenario are as follows:

• CHEop: CHE operator, for CHEs such as RTG, RMG, Forklift, or GPS-enabled CHE
If a forklift does not record the move, this is similar to Extension 2a below.
• HC: Hatch clerk

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 610
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

• Driver: Terminal tractor or truck driver

• Dispatcher
The scenario is based on the following conditions:

• The fetch CHE is the yard CHE

• The carry CHE is an ITV (internal transfer vehicle, such as a terminal tractor or truck)
• The put CHE is a crane
• MoveKind is LOAD
• FromPosLocType is Yard
• ToPosLocType is Vessel
• +1 means increment by 1

Main success scenario

1. The CHEop lands the container on a truck.

Step 1 can take place before or after steps 2 and 3.

2. The CHEop selects a job, enters the truck ID, and confirms done.
3. XPS and BI update the move record as follows:
▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to Yard CHE ID
▪ Set CheCarry to truck ID
4. The truck arrives at the quay.
5. The crane loads the container to a vessel.

Step 5 can take place before or after steps 6 and 7.

6. The HC enters the container ID and completes the move after performing any required inspection or recording.
7. XPS and BI update the move record as follows:
▪ Change MoveStage from Carry to Complete
▪ Set CarryCompleteTime and PutTime to current time
▪ Set ChePut and CheQC to crane ID (same as POW ID).
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC

Extension 2a1
The CHEop never selects and records the job.

1. The truck goes to its usual QC. The HC provides additional confirmation to complete the move.
2. XPS and BI update the move record as follows:
▪ Change MoveStage from Fetch to Complete

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 611
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

▪ Set FetchTime, CarryCompleteTime, and PutTime to current time

▪ If there is no Yard CHE ID, set CheFetch to null
▪ If there is no truck ID, set CheCarry to null
▪ Set ChePut and CheQC to crane ID (same as POW ID)
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC

Extension 2a2
The FromCHEop never selects and records the job.

1. The truck driver enters the container ID to get directions where to go.

This requires setting parameter TRKTYP to Y.

2. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ If there is no FromCHE ID, set CheFetch to null
▪ Set CheCarry to truck ID
3. Continue with step 4 in the main success scenario.

Extension 2b
The CHEop indicates done on the wrong job, for example by landing ctr1 for job 1 but selecting job 2.

This is equivalent to a CHEop never recording job1 after landing ctr 1. ctr 2 is physically still in the yard, but in
the TOS, it appears to be on a truck.
For ctr2 for job2:

XPS and BI update the move record as follows:

• Change MoveStage (for job2) from Fetch to Carry

Set FetchTime to current time

• Set CheFetch to Yard CHE ID

• Set CheCarry to truck ID
For ctr1 for job1:

1. The truck goes to its usual QC. The HC provides additional confirmation to complete the move (same as extension
2a).
2. XPS and BI update the move record as follows:
▪ Change MoveStage (for job1) from Fetch to Complete
▪ Set FetchTime, CarryCompleteTime, and PutTime to current time
▪ If there is no Yard CHE ID, set CheFetch to null
▪ If there is no truck ID, set CheCarry to null

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 612
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

▪ Set ChePut and CheQC to crane ID (same as POW ID)

XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC

Extension 2c
The CHEop enters a wrong truck ID. For example: The truck landed on trk1, but the CHEop enters trk 2.

1. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to Yard CHE ID
▪ Set CheCarry to value entered by the CHEop (that is, trk2)
2. Continue with step 3 in the main success scenario.

Extension 2d
The CHEop enters a wrong truck ID, but the Equipment Controller uses the "Swap Dispatch" function in XPS to move
the assigned job to the correct CHE.

This scenario is technically feasible but operationally unlikely.

• Continue with the main success scenario.

Extension 2e
The CHEop enters truck 0.

Possible reason: A terminal may use leased trucks and drivers. Because the truck is not listed in XPS, the CHEop
enters 0 for the truck.

1. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to Yard CHE ID
▪ Set CheCarry to null (0 is an invalid truck ID)
2. Continue with step 3 in main success scenario.

Extension 4a
The Dispatcher resets the move and returns ctr to the job start location after the CHEop confirms done and before the
HC confirms a move.

For example, a fetch (such as a QC) or carry CHE (such as a TT) completes a move on the RDT before it physically
does. It then runs into a problem (for example a breakdown) that prevents it from completing the move in reality. The
dispatcher needs to reset the move and return the container to the job start position so as to be able to assign it to
another CHE.

1. XPS and BI update the move record as follows:

▪ Change MoveStage to "planned"
2. End use case.
When the move is redispatched, it will go through this use case again. At that point, the move record will be updated
with the CheFetch and CheCarry for that WI.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 613
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

Extension 5a
The crane sets down the container on a quay and completes the move.

• Assume the HC changes the move kind. In this case, the vessel LOAD use case is not applicable.

Extension 6a
The POW for the job is CR1, but the Put CHE is CR2, for one of the following reasons:

• A crane (CR1) broke down. The job is assigned to CR2, which completes it.
• CR2 completes the job (on the RDT and physically) even though the job for CR1 is not reassigned.
• The HC from CR2 completes the move on RDT even though the POW crane (CR1) physically completes a move.
XPS and BI update the move record as follows:

• Change MoveStage from Carry to Complete

• Set CarryCompleteTime and PutTime to current time
• Set POW to CR1
• Set ChePut and CheQC to CR2 (different from POW)
XPS and BI update the vessel crane statistics as follows:

• Count MovesCompleted +1 for CR2 (which is the CheQC)

• Update last move time for CR2 to current time
• Update last move time for CR2 to current time
• Count MovesLastHr +1 for CR2.
N4 updates the Last Hour Crane Move gadget as follows:

• Adds a load move for CR2

Extension 6b
One of the following is true:

• A dispatcher resets the move and completes a container to its planned position.
For example: A CHE, such as a rail clerk, completes a move physically without entering the information using a RDT
into XPS. Therefore, the dispatcher resets the move and completes it to reflect the correct position and status of the
container.
• A dispatcher resets the move and completes at a different position.
For example: There is a planned discharge from a vessel. As the QC discharges the vessel, the HC notices that the
container is damaged. He decides to put the container down in the backreach area first. Therefore, he resets the
move and completes it to a non-stack area.
• A dispatcher completes the move in XPS.
XPS and BI update the move record as follows:

• Set ChePut, CheQC to POW ID

• Set CheCarry and CheFetch to match the value in XPS

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 614
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

XPS and BI update the crane statistics as follows:

• Count MovesCompleted +1 for the CheQC

However, BI does substitute, for example, QC with POW when assuming that container moves are done by a crane
and that the crane is in the POW field for discharge when a QC is missing.

3.4.16.2 Discharging a container from a vessel (RTG/RMG)

The primary actors in this scenario are as follows:

• CHEop: Yard CHE operator, for CHEs such as RTG, RMG, Forklift, or GPS-enabled Yard CHEs
• HC: Hatch clerk
• Driver: Terminal tractor or truck driver
• Dispatcher
The scenario is based on the following conditions:

• The fetch CHE is a crane

• The carry CHE is an ITV (a terminal tractor or truck)
• The put CHE is the yard CHE
• MoveKind is DSCH
• FromPosLocType is Vessel
• ToPosLocType is Yard
• +1 means increment by 1

Main success scenario

1. A crane discharges a container from a vessel to a truck.

Step 1 can take place before or after steps 2 and 3.

2. The HC enters the container ID and truck ID.

3. XPS and BI update the move record as follows:
▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch, CheQC to Crane ID (same as POW ID)
▪ Set CheCarry to truck ID
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC
4. The truck arrives at the yard block
5. CHEop lifts the container from the truck and lands it in the yard.

Step 5 can take place before or after steps 6 and 7.

6. The CHEop completes the move.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 615
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

7. XPS and BI update the move record as follows:

▪ Change MoveStage from Carry to Complete
▪ Set CarryCompleteTime and PutTime to current time
▪ Set ChePut to Yard CHE ID

Extension 2a1
The HC never records the job.

1. Truck goes to his usual yard block, CHEop completes the move (DRVRSD is set to Y)
2. XPS and BI update the move record as follows:
▪ Changes MoveStage from Fetch to Complete.
▪ Sets FetchTime, CarryCompleteTime, and PutTime to current time.
▪ Sets CheFetch and CheQC to POW ID.
▪ If there is no truck ID, set CheCarry to null
▪ Set ChePut to Yard CHE ID
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC

Extension 2a2
The FromCHEop never selects and records the job.

1. The truck driver enters the container ID to get directions where to go.

This requires setting parameter TRKTYP to Y.

2. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ If there is no FromCHE ID, set CheFetch to null
▪ Set CheCarry to truck ID
3. Continue with step 4 in the main success scenario.

Extension 2b
The HC indicates done on the wrong job, for example by landing ctr1 for job 1 but selecting job 2.

For ctr2 for job2:

XPS and BI update the move record as follows:

• Change MoveStage (for job2) from Fetch to Carry

• Set FetchTime to current time
• Set CheFetch and CheQC to Crane ID (same as POW ID)
• Set CheCarry to truck ID

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 616
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

XPS and BI update the crane statistics as follows:

• Count MovesCompleted +1 for the CheQC

For ctr1 for job1

1. A truck goes to its usual yard block and the CHEop completes the move (as in extension 2a).
2. XPS and BI update the move record as follows:
▪ Change MoveStage (for job1) from Fetch to Complete
▪ Set FetchTime, CarryCompleteTime, and PutTime to current time
▪ Set CheFetch and CheQC to POW ID
▪ If there is no truck ID, set CheCarry to null
▪ Set ChePut to Yard CHE ID
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC

Extension 2c
The HC enters a wrong truck ID. For example: The truck landed on trk1, but the HC enters trk 2.

1. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch and CheQC to Crane ID (same as POW ID)
▪ Set CheCarry to the value entered by the HC ( that is trk2)
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC
2. Continue with step 3 in the main success scenario.

Extension 2d
The POW for the job is CR1, but the Fetch CHE is CR2, for one of the following reasons:

• A crane (CR1) broke down. The job is assigned to CR2, which performs it.
• CR2 lifts the container (on the RDT and physically) even though the job for CR1 is not reassigned.
• The HC from CR2 indicates done on RDT even though the POW crane (CR1) physically lifts the container.
• The job is planned for CR1, but the container is in a different location than BAPBLIE indicated, and hence CR2 lifts
it.
XPS and BI update the move record as follows:

• Change MoveStage from Fetch to Carry

• Set FetchTime to current time
• Set POW to CR1
• Set CheFetch and CheQC to CR2 (different from POW)
XPS and BI update the vessel crane statistics as follows:

• Count MovesCompleted +1 for CR1 (which is the POW)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 617
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

• Update last move time for CR2 to current time

• Count MovesLastHr +1 for CR2
N4 updates the Last Hour Crane Move gadget as follows:

• Adds a discharge move for CR2.

Extension 2e
The HC enters truck 0.

1. XPS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch and CheQC to Crane ID (same as POW ID)
▪ Set CheCarry to null (0 is an invalid truck ID)
XPS and BI update the crane statistics as follows:
▪ Count MovesCompleted +1 for the CheQC
2. Continue with step 3 in the main success scenario.

Extension 4a
The Dispatcher resets the move and returns ctr to the job start location after the HC indicates done and before the
CHEop confirms a move.

1. XPS and BI update the move record as follows:

▪ Change MoveStage to "planned"
XPS and BI update the crane statistics as follows:
▪ Undo MovesCompleted +1 for the CheQC (that is decrement MovesCompleted)
2. End use case.

Extension 4b
One of the following is true:

• The Dispatcher resets the move and completes the container to its planned position.
• The Dispatcher resets the move and completes the container to a different position.
• The Dispatcher completes the move in XPS.
If move reset/complete is before HC indicates done:

• XPS and BI update the move record as follows:

Set CheFetch and CheQC to POW ID
Set CheCarry and ChePut to the value in XPS
• XPS and BI update the crane statistics as follows:
Count MovesCompleted +1 for the CheQC
If move reset/complete occurs after the HC indicates done, XPS and BI update the move record as follows:

• Set CheFetch and CheQC to Crane ID (same as POW ID)

• Set CheCarry and ChePut to the value in XPS

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 618
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

3.4.16.3 Moving a container from one yard block to another

(RTG/RMG)
The primary actors in this scenario are:

• FromCHEop: The Yard CHE operator for the FromCHE, such as RTG, RMG, Forklift, or GPS-enabled Yard CHE
• ToCHEop: The Yard CHE operator for the ToCHE, such as RTG, RMG, Forlift, or GPS-enabled Yard CHE
• Driver: The terminal tractor or truck driver
• Dispatcher
The scenario is based on the following conditions:

• The fetch CHE is a FromCHE.

• The carry CHE is an ITV (a terminal tractor or truck).
• The put CHE is a ToCHE.
• MoveKind is YARD.
• FromPosLocType is Yard.
• ToPosLocType is Yard.
• +1 means incremented by 1.

Main success scenario

1. The FromCHEop lifts a container from the yard and lands it on a truck.

Step 1 can take place before or after steps 2 and 3.

2. The FromCHEop selects a job, enters the truck ID, and confirms done.
3. SPARCS and BI update the move record as follows:
▪ Change MoveStage from Fecth to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to FromCHE ID
▪ Set CheCarry to truck ID
SPARCS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the CheFetch
4. The Truck arrives at the destination block.
5. The ToCHEop lifts the container from the truck and lands it in the yard.

Step 5 can take place before or after steps 6 and 7.

6. The ToCHEop selects a job and confirms done.

7. SPARCS and BI update the move record as follows:
▪ Change MoveStage from Carry to Complete

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 619
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

▪ Set CarryCompleteTime and PutTime to current time

SPARCS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the CheCarry
▪ Count MovesCompleted +1 for the ChePut

Extension 2a1
The FromCHEop never selects and records the job.

1. The truck goes to its usual To block.

2. The ToCHEop dispatches the container, enters the container ID, and confirms the move to the yard.
3. SPARCS and BI update the move record as follows:
▪ Change MoveStage from Fetch to Complete
▪ Set FetchTime, CarryCompleteTime, and PutTime to current time
▪ Set CheFetch to ToCHEop
▪ Set CheCarry to Truck ID
▪ Set ChePut to ToCHE ID
SPARCS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the CheFetch
▪ Count MovesCompleted +1 for the CheCarry
▪ Count MovesCompleted +1 for the ChePut

Extension 2a2
The FromCHEop never selects and records the job.

1. The truck driver enters the container ID to get directions where to go.
This requires setting parameter TRKTYP to Y.
2. SPARCS and BI update the move record as follows:
▪ Change MoveStage from Fetch to Carry Underway
▪ Set FetchTime to current time
▪ If there is no FromCHE ID, set CheFetch to null
▪ Set CheCarry to truck ID
3. Continue with step 4 in the main success scenario.

Extension 2b
The FromCHEop completes the wrong job, for example by landing ctr1 for job 1 but selecting job 2.

For ctr2 for job2:

SPARCS and BI update the move record as follows:

• Change MoveStage (for job2) from Fetch to Carry

• Set FetchTime to current time
• Set CheFetch to FromCHE ID
• Set CheCarry to truck ID

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 620
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

SPARCS and BI update the CHE statistics as follows:

• Count MovesCompleted +1 for the CheFetch

For ctr1 for job1:

See extension 2a.

Extension 2c
The FromCHEop enters the wrong truck ID. For example: The container dispatched to TRK1, but the FromCHEop
entered TRK2.

1. SPARCS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to FromCHE ID
▪ Set CheCarry to value entered by the CHEop (that is, TRK2)
SPARCS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the CheFetch
2. Continue with step 4 in the main success scenario.

Extension 2d
The FromCHEop enters truck 0.

1. SPARCS and BI update the move record as follows:

▪ Change MoveStage from Fetch to Carry
▪ Set FetchTime to current time
▪ Set CheFetch to FromCHE ID
▪ Set CheCarry to null (0 is an invalid truck ID)
SPARCS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the CheFetch
2. Continue with step 4 in the main success scenario.

Extension 2e
The FromCHEop enters a wrong truck ID, but the Equipment Controller uses the "Swap Dispatch" function in SPARCS
to move the assigned job to the correct CHE.

Extension 4a
The Dispatcher resets the move and returns ctr to the job start location after the FromCHEop confirms done and before
the ToCHEop confirms done.

1. SPARCS and BI update the move record as follows:

▪ Change MoveStage to "planned"
SPARCS and BI update the CHE statistics as follows:
▪ Undo MovesCompleted +1 for the CheFetch (that is decrement the number of moves completed)
2. End use case.

Extension 4b

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 621
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

The Dispatcher does any of the following:

• Resets the move and completes the container to its planned position
• Resets the move and completes the container to a different positions
• Completes the move in SPARCS
SPARCS and BI update the move record as follows:

• Set CheFetch , CheCarry, and ChePut to the value in SPARCS

SPARCS and BI update the CHE statistics as follows:

• If a valid CheFetch exists, count MovesCompleted +1 for the CheFetch

• If a valid CheCarry exists, count MovesCompleted +1 for the CheCarry
• If a valid ChePut exists, count MovesCompleted +1 for the ChePut

3.4.16.4 Moving a container without a truck

This scenario is rare. If it occurs, it typically concerns moves within the same block.
The primary actors in this scenario are as follows:

• CHEop: Yard CHE operator for the FromCHE, such as RTG, RMG, Forklift, or GPS-enabled Yard CHE
• Dispatcher
The scenario is based on the following conditions:

• The fetch CHE, carry CHE, and put CHE is a Yard CHE
• MoveKind is YARD or SHIFT
• FromPosLocType is Yard
• ToPosLocType is Yard
• +1 means incremented by 1

Main success scenario

1. The CHEop lifts a container.
2. The CHEop selects a job and confirms done.
3. XPS and BI update the move record as follows:
▪ Change MoveStage to Complete
▪ Set Move completion time to current time
▪ Set CheFetch, CheCarry, and ChePut to Yard CHE
XPS and BI update the CHE statistics as follows:
▪ Count MovesCompleted +1 for the Yard CHE.

Extensions
Because the main scenario is rare, correct extension handling of other scenarios applies.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 622
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

3.4.16.5 Moving containers with moving CHEs

The operation scenarios in this section explain the behavior of the Moving CHE metrics. The moves that the scenarios
describe are the only moves in the system, as follows:

Scenario 1: F1 > P2 (on page 623)

Scenario 2: F1 & F2 > P1 & P2 (on page 624)

Scenario 3: F1 & F2 -> P1 -> P2 (on page 624)

Scenario 4: F1 -> F2 -> P1 & P2 (on page 625)

Scenario 5: F1 -> F2 -> P1 -> P2 (on page 625)

Scenario 6: F1 -> F2 -> P2 -> P1 (on page 625)

The following legend applies to all scenarios and illustrations.

LKP The last known position of a terminal

tractor (ITV) or straddle (STR).
F1/F2/F12 The position of the CHE when the first
or second (or both) container is
fetched by a straddle or put onto an
ITV.
P1/P2/P12 The position of the CHE when the first
or second container (or both) is put by
a straddle or lifted from an ITV to the
destination.
D The distance between two positions
provided by SPARCS, based on yard
path modeling. The subscripts to D
identify the two points.
T1/T2 The time the CHE completes the move
for the first or second container.
Green arrow The distance a CHE traveled laden for
each work instruction (WI). When
necessary to indicate how the trip
distance laden is calculated, a blue
arrow is used in combination.
Yellow arrow The distance a CHE traveled unladen
for a WI or for the trip.

F1 to P2
A CHE performs a single container fetch, carry, and put. This scenario is very common.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 623
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

After T1 and after the data was harvested from SPARCS, the data element values for the record of WI for ctr 1 are as
follows:

Trip distance unladen = DLKPtoF12 = trip_distance_unladen

Trip distance laden = DF1toP1 = trip_distance_laden

trip_ctr_count = 1

F1 and F2 to P1 and P2
A CHE performs twin fetches and twin puts. This scenario is very common.

After T1 (= T2) and after the data was harvested from SPARCS, the data element values for the record of the WIs for
ctr 1 and ctr 2 are as follows:

Trip distance unladen = DLKPtoF12 = trip_distance_unladen

Trip distance laden = DF12toP12 = trip_distance_laden

trip_ctr_count = 2

F1 and F2 to P1 to P2
A CHE performs twin fetches with separate puts, for example twin vessel discharges.

This scenario is not applicable to straddle operations.

After time T2 and after data was harvested from SPARCS, the data element values are as follows:

• For both records of the WI for ctr 1 and ctr 2:

▪ Trip distance unladen = DLKPtoF12
▪ Trip distance laden = DF12toP1+ DP1toP2
▪ trp_ctr+count = 2

SPARCS reports the WI as distance for ctr1as DF12toP1 and for ctr2 as DF12toP2.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 624
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

F1 to F2 to P1 and P2
A CHE performs separate fetches followed by twin puts, for example twin vessel loads.

This scenario is not applicable to straddle operations.

After time T1 (= T2) and after data was harvested from XPS, the data element values are as follows:

• For both records of WIs for ctr 1 and ctr 2

▪ Trip distance unladen = DLKPtoF1
▪ Trip distance laden = DF1toP12
▪ trip_ctr_count = 2

XPS reports the WI as distance for ctr1as DF1toP12 and for ctr2 as DF2toP12.

F1 to F2 to P1 to P2
This is a less common but possible scenario for yard moves. This scenario is not applicable to straddle operations.

After time T1 and after data was harvested from XPS, the data element values are as follows for both records of WIs
for ctr 1 and ctr 2:

• Trip distance unladen = DLKPtoF1 = trip_distance_unladen

• Trip distance laden = DF1toF2 + DF2toP1 + DP1toP2
• trip_ctr_count = 2

XPS reports the WI as distance for ctr1as DF1toP1 and for ctr2 as DF2toP2.

F1 to F2 to P2 to P1
This is a less common but possible scenario for yard moves.

This scenario is not applicable to straddle operations.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 625
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

For time T2 and T1 and after data was harvested from XPS, the data element show the following values for both
records of WIs for ctr 1 and ctr 2:

• Trip distance unladen = DLKPtoF1 = trip_distance_unladen

• Trip distance laden = DF1toF2 + DF2toP2 + DP2toP1
• trip_ctr_count = 2

3.4.16.6 Moving containers with straddle carriers

The scenarios in this section describe when XPS and BI count moves and set timestamps during operations that
involve straddle carriers.

Navis supports the following options for straddle scenarios:

• Equipment Control Options

• PrimeRoute for Straddle Carriers Option (PR_SC)
For both options, a hatch clerk is optional. Without a hatch clerk, XPS completes a load move when the straddle lands
the container on the quay. In this case, N4 measures the rate at which a straddle delivers containers to and carries
containers away from the quay, not the actual crane rate. In case of a discharge, a straddle operator enters the
container ID on the radio data terminal (RDT) to claim the move.

To determine straddle and crane productivity, BI uses the timestamps described in the following table.

CHE Move Timestamp Available Without Hatch Clerk?

Straddle (delivery/receival/yard) The move complete time n/a
Straddle (load) The carry end time when a straddle Y
sets down the container at the quay
Straddle (discharge) The move complete time when the Y
straddle sets down the container in
the yard
Crane (load) The move complete time when the XPS sets the move complete time
crane puts the container in the to the carry end time.
planned vessel position
Crane (discharge) The fetch complete time when the XPS sets the fetch complete time to
crane sets the container down in the carry start time.
the backreach

All scenarios described require that you set certain XPS parameters (on page 627).

N4 counts the completed moves as they occur.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 626
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

XPS settings for straddle operations

For straddle operations (on page 626), you need to set the XPS settings described in the following table.

Setting Description Default Value

VSLOAD If set to Y, XPS completes EC N
vessel load moves to the planned
slot. Set to Y for operations that do
not use or require a hatch clerk to
confirm load positions.
PRUSHC If set to Y, XPS assumes that a Y
hatch clerk enters load and
discharges transactions. PR-SC
only.
SHFLNN If set to Y, XPS assumes that a N
CHE carrying a yard shift also
carries the target for non-vessel
moves.
SHFLNV If set to Y, XPS assumes that a N
CHE carrying a yard shift also
carries the target for vessel moves
SHFTLN If set to Y, XPS dispatches target Y
move to the original straddle. If set
to N, PR-SC can dispatch the target
move to a different straddle.

Vessel load scenario

This scenario describes a vessel load operation that involves a straddle carrier. Optional:

• Hatch clerk
• PrimeRoute for Straddle Carriers Option
The primary actors in this scenario are:

• StrOp: A straddle or straddle operator, depending on the context, with or without PDS for jobstep position detection
• HC: A hatch clerk (if applicable)
The main success scenario involves a hatch clerk. In this case, the straddle carrier is the fetch and carry CHE, and
the quay crane (QC) is the put CHE.
The extensions cover scenarios without hatch clerk. In this case, the straddle is the fetch, carry, and put CHE.
▪ With HC, with PR-SC: VSLOAD = N and PRUSHC = Y
▪ Without HC, with PR-SC: VSLOAD = Y and PRUSHC = N
The following diagram depicts the events and timestamps related to duration metrics (on page 556) in this scenario.
Events and durations that depend on PrimeRoute appear in italics. Note the following:

• Duration metrics for straddles require PrimeRoute, except for unladen idle duration at the destination.
• Event dispatch to lift at origin applies to straddle operations (not to truck operations).
• Wait time does not occur because straddle carriers do not have to wait for any other CHE for exchange of a
container for load.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 627
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

Main success scenario

1. With EC only: Navis N4 XPS dispatches the StrOp.
With PR-SC:
▪ XPS dispatches StrOp to origin.
▪ The StrOp indicates arrival at origin.
▪ XPS dispatches the StrOp to lift the container.
▪ The StrOp indicates that it lifts the container.
2. XPS and BI update the move record as follows:
▪ Change MoveStage to Planned/Carry Underway.
▪ Set carry start time to current time.
3. With EC only: StrOp sets the container down at the destination and indicates so.
With PR-SC:
▪ XPS dispatches the StrOp to its destination.
▪ The StrOp sets the container down at the destination and indicates so.
4. XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the straddle (fetch/carry CHE_ID).
▪ Change MoveStage to Carry Complete.
▪ Set carry complete time to current time.
5. The HC completes the load.
6. XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the crane (put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension 1a and 3a
Before the StrOp indicates the setting down of the container, the dispatcher resets the move and returns the container
to the job's start location.

XPS and BI revert MoveStage to Planned. End of scenario.

Extension 1b and 3b
Before the StrOp indicates the setting down of the container, the dispatcher resets the move and completes the

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 628
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

container to its planned position or a different position, or the dispatcher completes the move in an XPS client (instead
of the RDT).

XPS and BI update the move record as follows:

• Count MoveCompleted +1 for the crane (POW).

• Change the MoveStage to Completed.
• Set move complete time to current time.
• With EC only, or with PR-SC but before the StrOp indicates lifting of the container:
▪ Count MovesCompleted +1 for the straddle (CHE_ID = unknown).
With PR-SC after the StrOp indicates lifting of the container:
▪ Count MovesCompleted +1 for the straddle (fetch/carry CHE_ID).
End of scenario.

Extension 4a
This extension is not applicable if you work with ECN4.
Without a hatch clerk, XPS and BI update the move record as follows:

• Count MovesCompleted +1 for the straddle (fetch/carry CHE_ID).

• Count MoveCompleted +1 for the crane (POW).
• Change MoveStage to Completed.
• Set carry complete time and move complete time to current time.
End of scenario.

Extension 5a
Before the HC completes the move, the dispatcher resets the move and returns the container to the job's start location.

XPS and BI update the move record as follows:

▪ Count MovesComplete -1 for the straddle (that is undo the count of +1 in step 4 of the main success scenario).
▪ Revert MoveStage to Planned.
End of scenario.

Extension 5b
Before the HC completes the move, the dispatcher resets the move and completes the container to its planned location
or a different position, or the dispatcher completes the move in XPS.

XPS and BI update the move record as follows:

• Count MovesCompleted +1 for the crane (POW).

• Change MoveStage to Completed.
• Set move complete time to current time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 629
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

Vessel discharge scenario

This scenario describes a vessel discharge operation that involves a straddle carrier. Optional:

• Hatch clerk
• PrimeRoute for Straddle Carriers Option
The primary actors in this scenario are:

• StrOp: A straddle or straddle operator, depending on the context, with or without PDS for jobstep position detection
• HC: A hatch clerk (if applicable)
The main success scenario involves a hatch clerk. In this case, the quay crane (QC) is the fetch CHE, and the
straddle carrier is the carry and put CHE.
The extensions cover scenarios without hatch clerk. In this case, the straddle is the fetch, carry, and put CHE.
▪ With HC, with PR-SC: VSLOAD = N and PRUSHC = Y
▪ Without HC, with PR-SC: VSLOAD = Y and PRUSHC = N
The following diagram depicts the events and timestamps related to duration metrics (on page 556) in this scenario.
Events and durations that depend on PrimeRoute appear in italics. Note the following:

• For straddles, duration metrics require PrimeRoute, except for unladen idle duration at the destination.
• Event dispatch to lift at origin applies to straddle operations but not to truck operations.
• In the case of a discharge, the straddle carrier may have to wait for the crane to land the container.

Main success scenario

With PR-SC, the following variations are possible between steps 1 and 2

• The container is discharged before or after the straddle is dispatched.

• The container is discharged before or after the straddle arrives at the quay crane.
• The container is swapped with another container.
1. With EC only: The StrOp arrives at the quay.
With PR-SC:
▪ XPS dispatches the StrOp to origin.
▪ The StrOp indicates arrival at origin.
2. The HC records the discharge to a straddle.
3. XPS and BI update the move record as follows:
▪ Count Moves Completed +1 for the crane (fetch CHE_ID).
▪ Change MoveStage to Carry Underway.
▪ Set fetch complete time and carry start time to current time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 630
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

4. With EC only:
▪ XPS dispatches the StrOp to its destination.
▪ The StrOp sets the container down at the destination and indicates so.
With PR-SC:
▪ XPS dispatches the StrOp to its destination.
▪ StrOp indicates arrival at destination.
▪ XPS dispatches the StrOp to a place.
▪ The StrOp sets the container down and indicates so.
5. XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the straddle (carry/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension 2a
This extension is not applicable if you work with the Hatch Clerk program.
The HC records a discharge to an unknown straddle (CHE_ID = 0), for example when no straddle is available.

1. XPS and BI update the move record as follows:

▪ Count Moves Completed +1 for the crane (fetch CHE_ID).
▪ Change MoveStage to Carry Underway.
▪ Set fetch complete time and carry start time to current time.
2. Any StrOp arrives at the quay, self dispatches, and enters the container ID.
3. Continue with step 4 in the Main Success Scenario.

Extension 2b
This extension is not applicable if you work with ECN4.
The StrOp enters the container ID to self-dispatch because no HC is available.

1. XPS and BI update the move record as follows:

▪ Count MovesCompleted +1 for the crane (POW).
▪ Change MoveStage to Carry Underway.
▪ Set fetch complete time and carry start time to current time.
2. Continue with step 4 in the Main Success Scenario.
For more extensions, see Rolling moves forward or backward (on page 636).

Yard move with yard shifts scenario

This scenario describes a shift move and a target yard move operation with the PrimeRoute for Straddle Carrier
Option.

The primary actors in this scenario can be one or two straddles (strad1, strad 2) and straddle operators (StrOp1,
StrOp2). A straddle is the fetch, carry, and put CHE.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 631
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

The following diagram depicts the events and timestamps related to duration metrics (on page 556) in this scenario.
Events and durations that depend on PrimeRoute appear in italics. Note the following:

• If SHFTLN = Y (default), XPS dispatches the target move to the original straddle carrier. If SHFTLN = N, XPS can
dispatch the target move to a different straddle carrier.
• After a straddle carrier sets the container of the SHIFT move down at its destination, the straddle carrier is
considered in idle state at origin for the YARD move.

Main success scenario

1. XPS dispatches the target move to StrOp1. StrOp1 indicates arrival at origin.
2. The target move first requires a yard shift and is thus deferred. XPS creates a yard shift move.
3. XPS dispatches StrOp1 to lift the shift move. StrOp1 lifts the container and indicates so. XPS dispatches StrOp1 to
the destination of the shift move. StrOp1 sets the shifted container down and indicates so.
4. For the shift move, XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for strad1.
▪ Change MoveStage to Completed.
▪ Set carry start time to current time.
5. XPS dispatches the target move to StrOp1. StrOp1 lifts the target container and indicates so. XPS dispatches
StrOp1 to the destination of the target move. StrOp1 sets the container down at the target destination and indicates
so.
6. XPS and BI update the move record as follows:
▪ Count MovesComleted +1 for strad1.
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension 5a
In XPS, the setting SHFTLN (on page 627) is set to N. XPS dispatches the target move to StrOp2.

1. Strad2 fetches the target container. carries it to its planned position, sets it down, and completes the job.
2. XPS and BI update the move record for the target move as follows:
▪ Count MovesCompleted +1 for strad2.
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.
End of scenario.

For reset extensions, see Rolling moves forward or backward (on page 636).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 632
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

Delivery, receival, or yard move scenario (straddle)

This scenario describes a delivery, receival, or yard move operation that involves a straddle carrier. Optional:

• PrimeRoute for Straddle Carriers Option

The primary actors in this scenario are:

• StrOp: A straddle or straddle operator, depending on the context, with or without PDS for jobstep position detection.
The straddle is the fetch, carry, and put CHE.
The following diagrams depict the events and timestamps related to duration metrics (on page 556) in this scenario.
Events and durations that depend on PrimeRoute appear in italics.

This diagram illustrates a delivery, which is similar to a load because the origin is the yard.

This diagram illustrates a receival, which is similar to a discharge because the destination is the yard.

Main success scenario

1. With EC only: XPS dispatches the StrOp.
With PR-SC:
▪ XPS dispatches the StrOp to origin.
▪ The StrOp indicates arrival at origin.
▪ XPS dispatches the StrOp to lift the container.
▪ The StrOp indicates that it lifts the container.
2. XPS and BI update the move record as follows:
▪ Change MoveStage to Carry Underway.
▪ Set carry start time to current time.
3. With EC only: StrOp sets the container down at the destination and indicates so.
With PR-SC for a delivery move:
▪ XPS dispatches the StrOp to its destination.
▪ The StrOp sets the container down at the destination and indicates so.
With PR-SC for a receival or yard move:
▪ XPS dispatches the StrOp to its destination.
▪ The StrOp indicates arrival at the destination.
▪ XPS dispatches the StrOp to place the container.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 633
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

▪ StrOp sets the container down and indicates so.

4. XPS and BI update the move record as follows
▪ Count MovesCompleted +1 for the straddle (fetch/carry CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension
See Rolling moves forward or backward. (on page 636)

Rail load scenario

This scenario describes a rail load operation. The main success scenario involves:

• A straddle carrier dispatched to the yard or truck exchange to take a container to the rail ramp (trackside staging
areas) (YARD or RECV).
• An RTG loads containers from the trackside positions onto the rail car (RLOD).
The extensions involve a straddle carrier loading a container directly onto the rail car without using the RTG.

This scenario does not distinguish between EC only and PR-SC.

The primary actors in this scenario are:

• StrOp: A straddle or straddle operator, depending on the context, with or without PDS for jobstep position detection
The straddle is the fetch, carry, and put CHE between the rail ramp and the yard for yard moves, or between the rail
ramp and the gate exchange for receival moves.
• RTG (RTGOp): The fetch and put CHE between the rail ramp and the rail car for rail load moves

Main success scenario

1. XPS dispatches the StrOp for a YARD or RECV move.
2. StrOp drives to the origin, which is the yard or the gate exchange, fetches the container, drives to the rail ramp, and
sets the container down.
3. For the YARD or RECV move, XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the straddle (fetch/carry/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.
4. The RTGOp self-dispatches, fetches the container from the rail ramp, and puts it on a rail car.
5. XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the RTG (fetch/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension 1a
XPS dispatches the StrOp directly for a RLOD move.

1. The StrOp drives to the origin, which is the yard or the gate exchange, fetches the container, drives to the specific
rail car, and sets the container down.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 634
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

2. For the RLOD move, XPS and BI update the move record as follows:
▪ Count MovesCompleted +1 for the straddle (fetch/carry/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.
For reset extensions, see Rolling moves forward or backward (on page 636).

Rail discharge scenario

This scenario describes a rail load operation that involves a straddle carrier. The main success scenario involves:

• A rubber-tired gantry crane (RTG) that discharges containers from a rail car to the trackside positions (RDSC)
• A straddle carrier dispatched to the rail ramp (trackside staging areas) to take a container to the yard or truck
exchange (YARD or DLVR)
The extensions involve a straddle carrier discharging a container directly from the rail car (RLOD) without using the
RTG.

This scenario does not distinguish between EC and PR-SC.

The primary actors in this scenario are:

• StrOp: A straddle or straddle operator, depending on the context, with or without PDS for jobstep position detection
The straddle is the fetch, carry, and put CHE between the rail ramp and the yard for yard moves, or between the rail
ramp and the gate exchange for receival moves.
• RTG (RTGOp): The fetch and put CHE between the rail ramp and the rail car for rail discharge moves

Main success scenario

1. The RTGOp self-dispatches, fetches the container from the rail car and puts it on the rail ram.
2. XPS and BI update the move record for the RDSC as follows:
▪ Count MovesCompleted +1 for the RTG (fetch/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.
3. XPS dispatches the StrOp for the YARD or DLVR move.
4. The StrOp drives to the origin, which is the rail ramp, fetches the container, drives to the yard or truck exchange,
and sets the container down.
5. XPS and BI update the move record for the YARD or DLVR move as follows:
▪ Count MovesCompleted +1 for the straddle (fetch/carry/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.

Extension 1a
XPS dispatches the StrOp directly for a RDSC move.

1. The StrOp drives to the origin, which is a specific rail car, fetches the container, drives to the yard or truck exchange,
and sets the container down.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 635
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

2. XPS and BI update the move record for the RDSC move as follows:
▪ Count MovesCompleted +1 for the straddle (fetch/carry/put CHE_ID).
▪ Change MoveStage to Completed.
▪ Set move complete time to current time.
For reset extensions, see Rolling moves forward or backward (on page 636).

Extension: Rolling moves forward or backward

A common extension to the main straddle operation scenarios results from rolling a move forward or backward, such
as by a dispatch. In this context, the following definitions apply:

• Roll backward: Undoing a move by rolling back any unconfirmed intermediate steps, such as when a dispatcher
resets a container to its planned position.
• Roll forward: Completing a move by skipping one or more outstanding intermediate steps, such as when a
dispatcher selects a complete move (by pressing Ctrl+E) or resets a container and completes the move.
• In progress: A move that is not completed but for which a straddle operator confirmed the receival of a container,
for example by confirming a container lift in PrimeRoute.

Extension 1a
1. The straddle operator rolls backward a move that may or may not be in progress.
2. XPS and BI do the following:
a. Revert the MoveStage to Planned.
b. Re-dispatch the container without crediting the move to any CHE.
The straddle scenario starts again.

Extension 2a
1. The straddle operator rolls forward a move that is in progress.
2. XPS and BI do the following:
a. Change the MoveStage to Completed.
b. Set the move complete time and other timestamps not yet populated to the current time.
c. Count MovesCompleted +1 for the CHE(s) that confirmed getting the container.
d. If quay crane information is missing, credit the move to the POW.
If XPS has no information about the remaining CHEs (fetch, carry, or put), credit the move to an unknown CHE.

Extension 3a
1. The straddle operator rolls forward one of the following:
▪ A move that is not in progress but that is dispatched and has nominated CHEs.
▪ A move that is in progress and for which "reset truck dispatch" is specified.
XPS has no CHE information for the move.
2. XPS and BI do the following:
a. Have no CHE information for the move.
b. Change the MoveStage to Completed.
c. Set the move complete time and other timestamps not yet populated to the current time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 636
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

d. For non-vessel moves, credit the move to an unknown fetch, carry, and put CHE.
For vessel moves, count MovesCompleted +1 for the POW of the work instruction (CHE-QC).

3.4.16.7 Moving a container to/from an ASC stack

The scenarios in this section describe an inbound move (single/twin) involving an ASC, that is, a container planned to
be moved to an ASC stack position from a transfer zone and from a transfer zone to an ASC stack.

Moving a single/twin container to an ASC stack

The primary actors in this scenario are:

• ASC operator
The scenario is based on the following conditions:

• The ASC is logged-in and active

• The container (single/twin) has been dropped in a transfer zone associated with the destination block

Main success scenario

1. The ASC dispatcher dispatches the ASC that covers the stack and transfer zone to the container position
2. The ASC goes unladen to carry CHE (to transfer zone)
3. The ASC is laden when moving to the intermediate position
4. The ASC goes idle after move completion

ASCs cannot move twin containers in a single move. Instead, an ASC moves each container in the twin
separately from the transfer zone position to the ASC stack.

Extension: Moving a single/twin container to an ASC stack - split-move

Depending on an ASC’s coverage of an ASC stack, the inbound move may need to be split. In such a scenario, two
ASCs are involved in moving the container from the transfer zone to the ASC stack.

1. The ASC dispatcher dispatches the first ASC that covers the stack and transfer zone to the container position
2. The first ASC goes unladen to carry CHE (to transfer zone)
3. The first ASC goes laden when moving to the intermediate position and places the container in the intermediate
position
4. The first ASC goes idle after move completion
5. The ASC dispatcher dispatches the second ASC that covers the stack and transfer zone to the intermediate
container position
6. The second ASC goes unladen to the intermediate position
7. The second ASC goes laden when moving to the container position
8. The second ASC goes idle after move completion

Moving a single/twin container out of an ASC stack

This scenario describes an outbound move involving an ASC, that is, a container planned to be moved from an ASC
stack position to a position outside of the ASC stacks.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 637
Confidential -- Proprietary
Part 3: Business Intelligence BI Reference
Operation scenarios

The primary actors in this scenario are:

• ASC operator
The scenario is based on the following conditions:

• The ASC is logged-in and active

Main success scenario

1. The ASC dispatcher dispatches the ASC that covers the stack
2. The ASC goes unladen to container position
3. The ASC goes laden to container position
4. The ASC goes idle after move completion

ASCs cannot move twin containers in a single move. Instead, an ASC moves each container in a twin
separately to the transfer zone position from the ASC stack.

Extension: Moving a single/twin container from an ASC stack - split-move

Depending on an ASC’s coverage of an ASC stack, the outbound move may need to be split. In such a scenario, two
ASCs are involved in moving the container from the ASC stack to the transfer zone.

1. The ASC dispatcher dispatches the first ASC that covers the stack and transfer zone to the container position
2. The first ASC goes unladen to container position
3. The first ASC is laden to container position (overlap hand-off area in stack) and places the container in the
intermediate position.
4. The first ASC goes idle after move completion
5. The ASC dispatcher dispatches the second ASC that covers the stack and transfer zone to the container position
6. The second ASC goes unladen to the intermediate position
7. The second ASC is laden when moving to carry CHE (to transfer zone)
8. The ASC goes idle after move completion

Intrastack move processing using as ASC

This scenario describes an intrastack move involving an ASC, that is, a container planned to be moved within an ASC
stack.

The primary actors in this scenario are:

• ASC operator
The scenario is based on the following conditions:

• The ASC is logged-in and active

Main success scenario

1. The ASC dispatcher dispatches the ASC to the container position
2. The ASC goes unladen to container position
3. The ASC is laden and moves to the container position (within the stack)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 638
Confidential -- Proprietary
 Part 3: Business Intelligence BI Reference
Reporting a Monitor metric issue

4. The ASC goes idle after move completion

3.4.17 Reporting a Monitor metric issue

To determine if a metric behaves the way it should, Navis support needs to see the metrics inside the application as
well as the detailed source data used to calculate the metrics. The data source could be N4 or XPS.

Because sometimes it is difficult to reproduce a metric issue on demand, it is essential that you provide as much
information as possible up front so that Navis support can properly diagnose and reproduce the problem.

When the Navis support team troubleshoots a metric issue:

• The N4 database backup and navis-apex.log file help determine if the problem is a BI issue.
• The XPS log files help determine what happened to containers.
• The XPS backup allows reproducing an XPS issue.

To report a Monitor metric issue:

1. Turn on detailed logging:
In the Logging view (Administration Settings Logging), for the com.navis.mensa package, change the log
level from WARN to INFO.
2. Reproduce the case and take screen captures of Monitor gadgets, dashboards, and the corresponding sources of
data described in Validating BI data (on page 640).

Make sure to display relevant timestamps (such as now).

3. Create a backup of the N4 database.

4. Create an XPS backup, including ship files.
5. Include the following information with your case:
▪ Screen captures
▪ navis-apex.log file
▪ XPS log and host .nml files covering the relevant time period
In addition, the development team may ask for a N4 database backup and XPS backup to try to reproduce the
issue.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 639
Confidential -- Proprietary
3.5 Validating BI data
This section provides instructions for validating the information displayed in N4 gadgets, tables, and reports.

In This Section

Validate the Vessels Alongside gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Validate the Vessel Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Validate the Vessel KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Validate the Crane KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Validate the Crane Rhythm gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Validate the Crane Metrics gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Validate the Fixed and Moving CHE Details gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Validate the Yard Utilization gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Validate dynamic gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Validate the Moves per Day gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Validate the Trucks in Yard gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Validate the Truck KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Validate the Vessel Crane Metrics view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Validate the Move Count By POW By CHE report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Validate the Moving CHE Productivity Analysis report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Validate the Yard Rehandle Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Validate the Reefer Plug Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Validate the Average Daily Yard Utilization report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 640
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Vessels Alongside gadget

3.5.1 Validate the Vessels Alongside gadget

The following table describes how to validate the metrics in the Vessels Alongside gadget.

Metric Validation Steps

Vessel Name 1. In XPS, select Vessel Vessel Schedule.
2. In the Vessel Schedule window, verify the vessel
name in the Vessel Name column.
Visit Ref In XPS, in the Vessel Schedule window, verify the visit
reference in the Ship Reference column.
Visit Phase In XPS, in the Vessel Schedule window, verify the visit
phase in the Visit Phase column.
Crane Count 1. In N4, select Vessel Vessel Crane Metrics view.
2. Filter the view for a particular vessel (Carrier).
3. Determine the number of cranes working for the
particular vessel.
In case of crane sharing, consider only one segment.
eGMPH 1. In N4, display the Vessel Metrics gadget.
2. In the Vessel Metrics gadget, verify the effective
gross moves per hour in the eGMPH column.
ETD In XPS, in the Vessel Schedule window, verify the
estimated time of departure in the ETD column.
ETC 1. In N4, in the Vessel Crane Metrics view, display the
Final ETC column.
2. Filter the view for a particular vessel (Carrier).
3. Find the maximum Final ETC of the cranes working
for the vessel.
In case of crane sharing, consider only one segment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 641
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Vessel Metrics gadget

Metric Validation Steps

Moves Completed 1. In N4, in the Vessel Crane Metrics view, display the
Final Mvs Completed column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Final Mvs Completed
column of the cranes working for the vessel.
In case of crane sharing, consider only one segment.
Alternatively, perform the following procedure to get all
moves. This procedure considers a move even if no
quay crane is involved in the move.
1. In the Yard Move History Move History view,
filter the vessel moves as follows:
▪ Carrier = [vessel ID]
▪ Move Kind = Load, Discharge, SHOB
2. Count the number of moves.
3. In the Yard Work Instructions Work
Instructions view, count the Discharge moves in
Carry Underway stage for the vessel and add them
to the move count you received in Step 2.
Moves To Go 1. In N4, in the Vessel Vessel Crane Metrics
Vessel Crane Metrics view, display the Final Mvs
To Go column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Final Mvs To Go column of
cranes working for the vessel.
In case of crane sharing, consider only one segment.

Status If Late Minutes is greater than Late Minutes Red, the

gadget displays a red error icon in the Status column. If
Late Minutes is greater than Late Minutes Yellow and is
less than or equal to Late Minutes Red, the gadget
displays a yellow warning icon. Otherwise, the gadget
displays a green icon.
BMPH This is the number of moves completed for the vessel
divided by the berth hours.
Calculation of berth hours:
If (ATD= "") or (ATD > now time), then Berth Hrs = Now
Time - ATA.
Otherwise, if (ATD < now time), Berth Hrs = ATD - ATA.

3.5.2 Validate the Vessel Metrics gadget

The following table describes how to validate the metrics in the Vessels Metrics gadget.

Metric Validation Steps

Vessel 1. In XPS, select Vessel Vessel Schedule.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 642
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Metrics gadget

Metric Validation Steps

2. In the Vessel Schedule window, verify the vessel
name in the Vessel Name column.
ETA In XPS, in the Vessel Schedule window, verify the
estimated time of arrival in the ETA column.
ETD In XPS, in the Vessel Schedule window, verify the
estimated time of departure in the ETD column.
Mvs Compl 1. In N4, in the Vessel Crane Metrics view, display the
Final Mvs Completed column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Final Mvs Completed
column of the cranes working for the vessel.
In case of crane sharing, consider only one segment.
Alternatively, perform the following procedure to get all
moves. This procedure considers a move even if no
quay crane is involved in the move.
1. In the Yard Move History Move History view,
filter the vessel moves as follows:
▪ Carrier = [vessel ID]
▪ Move Kind = Load, Discharge, SHOB
2. Count the number of moves.
3. In the Yard Work Instructions Work
Instructions view, count the Discharge moves in
Carry Underway stage for the vessel and add them
to the move count you received in Step 2.
eGGH 1. In N4, in the Vessel Vessel Crane Metrics view,
display the eGGH column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of effective gross gang hours of
cranes working for the vessel.
4. In case of crane sharing, consider only one segment.
eGMPH Divide Mvs Compl by eGGH.
Mvs to Go 1. In N4, in the Vessel Vessel Crane Metrics
Vessel Crane Metrics view, display the Final Mvs
To Go column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Final Mvs To Go column of
cranes working for the vessel.
In case of crane sharing, consider only one segment.

ETC 1. In N4, in the Vessel Crane Metrics view, display the

Final ETC column.
2. Filter the view for a particular vessel (Carrier).
3. Find the maximum Final ETC of the cranes working
for the vessel.
In case of crane sharing, consider only one segment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 643
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Metrics gadget

Metric Validation Steps

Plan Dev. Subtract PTC from ETC.
PTC 1. In N4, in the Vessel Vessel Crane Metrics view,
display the PTC column.
2. Filter the view for a particular vessel (Carrier).
3. Find the maximum PTC of the cranes working for the
vessel.
Time to PTC Subtract the current time (the time of the N4 server)
from PTC.
Req. BMPH Divide Moves to Go by Time to PTC.
eNGH 1. In N4, in the Vessel Vessel Crane Metrics view,
display the eNGH column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of eNGH of the cranes working
for the vessel.
In case of crane sharing, consider only one segment.

eNMPH Divide Mvs Cmpl by eNGH.

%Force Majeure Delays Divide Force Majeure Delay by eGGH; then multiply by
100.
To determine the Force Majeure Delay at the vessel
level:
1. In N4, in the Vessel Vessel Crane Metrics view,
display the Force Majeure Delay column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Force Majeure Delay of the
cranes working for the vessel.
In case of crane sharing, consider only one segment.

%Non Term Delays Divide Non Term Delay by eGGH; then multiply by 100.
To determine the Non Term Delay at the vessel level:
1. In N4, in the Vessel Vessel Crane Metrics view,
display the Non Terminal Delay column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Non Terminal Delay of the
cranes working for the vessel.
In case of crane sharing, consider only one segment.

%Term Delays Divide Term Delay by eGGH; then multiply by 100.

To determine the Term Delay at the vessel level:
1. In N4, in the Vessel Vessel Crane Metrics view,
display the Terminal Delay column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the Terminal Delay of the
cranes working for the vessel.
In case of crane sharing, consider only one segment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 644
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Vessel KPIs gadget

Metric Validation Steps

Service In XPS, in the Vessel Schedule window, verify the
vessel service in the Service column.
First Mv/Act time 1. In N4, in the Vessel Vessel Crane Metrics view,
display the First Move or Activity Time column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the minimum First Move or Activity Time of
the cranes working for the vessel.
Last Mv/Act time 1. In N4, in the Vessel Vessel Crane Metrics view,
display the Last Move or Activity Time column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the maximum Last Move or Activity Time
of the cranes working for the vessel.
Visit Ref In XPS, in the Vessel Schedule window, verify the
vessel visit reference in the Ship Reference column.
ATA In XPS, in the Vessel Schedule window, verify the
actual time of arrival in the ATA column.
ATD In XPS, in the Vessel Schedule window, verify the
actual time of departure in the ATD column.
GGH 1. In N4, in the Vessel Vessel Crane Metrics view,
display the GGH column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the GGH of the cranes working
for the vessel.
In case of crane sharing, consider only one segment.
GMPH Divide Mvs Cmpl by GGH.
NGH 1. In N4, in the Vessel Vessel Crane Metrics view,
display the NGH column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of the NGH of the cranes working
for the vessel.
In case of crane sharing, consider only one segment.

NMPH Divide the Mvs Cmpl by NGH.

3.5.3 Validate the Vessel KPIs gadget

The following table describes how to validate the metrics in the Vessel KPIs gadget (on page 503).

Metric Validation Steps

Moves last 60 mins (Actual column, 1st row) 1. In N4, in the Vessel Vessel Crane Metrics view,
display the Moves last 60 min column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of Moves last 60 min for the
cranes working for the vessel.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 645
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Crane KPIs gadget

Metric Validation Steps

In case of crane sharing, consider only one segment.

Moves last 60 mins (Actual vs. Threshold column, 1st Verify that the gauge reflects the actual moves
row) performed in the last 60 minutes.
Moves/hr last 36 hours (Last 36 Hours column, 1st row) 1. In N4, select Yard Move History.
2. Filter the Move History view by carrier visit for the
last 36 hours.
3. Count the number of moves completed every hour on
the hour.

After the first hour, the sparkline is a dot. It is

clearly visible after the completion of two hours
of work.

Plan Deviation (Actual column, 2nd row) In N4, open a Vessel Metrics gadget and verify the
value in the Plan Dev. column.
Plan Deviation (Actual vs. Threshold column, 2nd Verify that the gauge reflects the actual plan deviation.
row)
Plan dev last 36 hours (Last 36 Hours column, 2nd Verify the plan dev value on the hour.
row)
After the first hour, the sparkline is a dot. It is
clearly visible after the completion of two hours
of work.

3.5.4 Validate the Crane KPIs gadget

The following table describes how to validate the metrics in the Crane KPIs gadget (on page 491).

Metric Validation Steps

Cranes 1. In N4, select Vessel Vessel Crane Metrics view.
2. Filter the view for a particular vessel (Carrier).
3. Determine the number of cranes working for the
vessel.
In case of crane sharing, consider only one segment.

Moves last 60 mins (Actual column) 1. In N4, in the Vessel Vessel Crane Metrics view,
display the Moves last 60 min column.
2. Filter the view for a particular vessel (Carrier).
3. Determine the sum of Moves last 60 min for the
cranes working for the vessel.
In case of crane sharing, consider only one segment.

For discharge moves, N4 considers the fetch

time. For load moves, N4 considers the put
time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 646
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Crane Rhythm gadget

Metric Validation Steps

Moves last 60 mins (Actual vs. Threshold column) Verify that the gauge reflects the actual moves
performed in the last 60 minutes.
Moves/hr last 36 hours (Last 36 Hours column) 1. In N4, select Yard Move History.
2. Filter the Move History view by carrier visit for the
last 36 hours.
3. Count the number of moves completed every hour on
the hour.

After the first hour, the sparkline is a dot. It is

clearly visible after the completion of two hours
of work.

3.5.5 Validate the Crane Rhythm gadget

The following table describes how to validate the metrics in the Crane Moves Last Hour gadget (on page 493).

Metric Validation Steps

Cranes 1. In N4, select Vessel Vessel Crane Metrics view.
2. Filter the view for a particular vessel (Carrier).
3. Determine the number of cranes working for the
vessel.
In case of crane sharing, consider only one segment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 647
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Crane Metrics gadget

Metric Validation Steps

Crane Mvs and Activities To verify activities in XPS (top of chart):
1. Open the vessel (Vessel Open).
2. In the Crane Activities List window (Vessel Quay
Commander Actions Crane Activities List),
verify the spacing and duration of the delay category
in the chart based on the value selected from the
Look Back Hours field in the Crane Rythm form (on
page 517).

You can verify the delay categories in the Crane

Delay Types view (Configuration Other
Crane Delay Types).

To verify moves in N4 (bottom of chart):

1. In the Move History view (Yard Move History),
filter data by carrier visit and crane.
2. Sort the view by time completed.
3. Verify the spacing and move type in the chart based
on the value selected from the Look Back Hours
field in the Crane Rythm form.

N4 also considers discharge moves in Carry

Underway stage.

4. In the Work Instructions view (Yard Work

Instructions), filter vessel moves based on vessel.
5. Count the number of discharge moves in Carry
Underway stage for the last hour based on the work
queue for the respective cranes.
6. Verify the spacing and move type on the chart.
Mvs Last Hour 1. In N4, select Vessel Vessel Crane Metrics view.
1. Filter the view for a particular vessel (Carrier).
2. Verify the value in the Mvs Last 60 min column.

If this column is not visible, you need to

display it first.

Total Delays 1. In N4, select Vessel Vessel Crane Metrics view.

2. Filter the view for a particular vessel (Carrier).
3. Verify the value in the Total Delays column.

If this column is not visible, you need to

display it first.

3.5.6 Validate the Crane Metrics gadget

The following table describes how to validate the metrics in the Crane Metrics gadget.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 648
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Fixed and Moving CHE Details gadgets

To validate all metrics in this gadget:

1. In N4, select Vessel Vessel Crane Metrics view.
2. Filter the view for a particular vessel (Carrier).
3. Verify the value in the column specified in the table.

Metric Column Used for Verification

Cranes Crane CHE
First Mv/Act time First Move or Activity Time
Last Mv/Act time Last Move or Activity Time
Mvs Compl Final Mvs Completed
eGGH eGGH
eGMPH eGMPH
Final Mvs to Go Final Moves to Go
Final ETC Final ETC
Plan dev. Plan Dev.
PTC PTC
Time to PTC Time to PTC
Req. GMPH Req GMPH
eNMPH eNGH
%Force Majeure Delays % Force Majeure Delays
%Non Term Delays % Non Terminal Delays
%Term Delays % Terminal Delays
ETC ETC
Mvs To Go Mvs To Go
Last Move Time Last Move Time
Time Since Last Move Time since last move
GGH GGH
GMPH GMPH
NGH NGH
NMPH NMPH

3.5.7 Validate the Fixed and Moving CHE Details gadgets

You validate the data displayed in the Fixed CHE Details (on page 495) and Moving CHE Details (on page 497)
gadgets against information displayed in XPS.

To validate data:
1. In XPS, select Control Points of Work.
2. In the Points of Work window, select one or more POWs.
3. Select Control POW Move History.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 649
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Fixed and Moving CHE Details gadgets

4. In the History window, display the following columns:

▪ Move Kind
▪ Move Stage
▪ P.O.W.
▪ CHE-Carry
▪ CHE-Fetch
▪ CHE-Put
▪ Fetch Complete Time
▪ Carry Start Time
▪ Carry Complete Time
▪ Move Complete Time
▪ Unladen Carry CHE Distance
▪ Move Distance
▪ Twin Lift - Vessel
▪ Twin Lift - Yard
5. Export the information in the History window to a Microsoft Excel sheet:
a. Select File Save As.
b. In the Please enter text file name dialog box, enter a file name and click Save.
6. Open the resulting .txt file in Microsoft Excel.
7. In Microsoft Excel, sort data by Fetch Complete Time and Move Complete Time to find the last-hour details for all
CHEs.
8. Use the following table to validate the individual metrics.

Fixed CHE Details gadget

Metric Validation Steps

CHE ID Verify against the IDs of all fixed CHEs used in the last
hour for various move kinds.
Mvs Lst Hr Count the number of moves in the last 60 minutes using:
• The CHE-Fetch column for LOAD, RLOD, YARD,
DLVR, and OTHR moves.
• The CHE-Put column for DSCH, RDSC, YARD,
RECV, and OTHR moves.

For yard moves, do not double-count if the CHE

is both the CHE-Fetch and CHE-Put. BI only
counts a yard move performed by the same
CHE once.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 650
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Fixed and Moving CHE Details gadgets

Metric Validation Steps

Last Mv Time Verify the move time of the last move performed by a
CHE against the following columns:
• Move Complete Time column for DSCH moves
• Fetch Complete Time column for LOAD moves
• For OTHR moves, based on the fixed CHEs used in
the move phase:
▪ Fetch Complete Time column if a CHE is involved
in a Fetch phase
▪ Move Complete Time if a CHE is involved in a Put
phase

Time Since Last Move Subtract the Lat Mv Time for each CHE from the current
time.
Crane Mv Cnt Count the number of moves a crane performed in the
last 60 minutes using:
• The CHE-Fetch column for LOAD moves
• The CHE-Put column for DSCH moves
Non Crane Mv Cnt Subtract Crane Mv Cnt from Mvs Last Hr.
Rail Mv Cnt Count the number of rail moves performed in the last 60
minutes using:
• The CHE-Fetch column for RLOD moves
• The CHE-Put column for RDSC moves
Non-Rail Mv Count Subtract Rail Mv Cnt from Mvs Lst Hr

Moving CHE Details gadget

Metric Data Validation

CHE ID Verify against the IDs of all moving CHEs used in the
last hour for various move kinds.
Mvs Lst Hr Count the number of moves in the last 60 minutes:
• The CHE-Carry column for trucks
• For self-complete CHEs used in the Fetch-Carry (FC)
and Carry-Put (CP) phase (Move Stage column)
• For trucks used as carry CHEs (CHE-Carry column)

For self-complete CHEs, do not double-count a

move if the CHE is used in both the FC phase
or the CP phase. BI only counts a yard move
performed by the same CHE once.

If a self-complete CHE is not involved in a carry

phase, BI does not consider the CHE a moving
CHE.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 651
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Yard Utilization gadget

Metric Data Validation

Last Mv Time Verify the move time of the last move performed by a
CHE against the following columns:
• Move Complete Time column for trucks and self-
complete CHEs used in the CP phase
• Carry Complete Time column for self-complete CHEs
used in the FC phase.
Time Since Last Move Subtract the Last Mv Time for each CHE from the
current time.
Trip Count 1. Count the number of containers handled during each
trip by the CHE in the last hour. For a couple of
moves, if the same CHE is used for the Carry phase
with the same Carry Start Time, count this as a single
trip.
2. Count the number of trips for the last hour.
Avg Dis Laden Divide the total distance laden by the trip count.
Avg Dis Unladen Divide the total distance unladen by the trip count.
Tot Dis Unladen Sum the unladen distances that a CHE performed in the
last hour.
Tot Dis Sum Tot Dis Laden and Tot Dis Unladen.

3.5.8 Validate the Yard Utilization gadget

The table describes how to validate the metrics in the Yard Utilization gadget.

The following conditions apply:

• BI does not consider heap blocks.

• The Total Yard row in the Yard Utilization gadget summarizes utilization across the yard including reefer plugs and
slots.
• The Reefer Plugs row in the Yard Utilization gadget summarizes reefer plug utilization across the yard.

Metric Validation Steps

Area To view a list of all yard areas assigned to yard blocks:
1. Select Configuration Other Yard Block Table.
2. Compare the yard areas listed in the Yard Block
Table view with the areas that are listed in the Yard
Utilization gadget.
Utilization % See the following topics:
Total Slots • Validate reefer plug data in the Yard Utilization
Restricted Slots gadget (on page 653)
Usable Slots
Used Slots
Available Slots
Update Time N/A
Utilization Gauge

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 652
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Yard Utilization gadget

3.5.8.1 Validate reefer plug data in the Yard Utilization gadget

Like validating stack block data, validating reefer plug data in the Yard Utilization gadget involves working with both a
N4 and a Navis N4 XPS client. In addition, you need to consider the reefer status when looking up data in the Yard
Utilization Report (YUR) or calculating the total number of physical reefer fields in a block.

To validate reefer plug data in the Yard Utilization gadget:

1. Start the Yard Block Statistics job. For details, see Background Jobs view.
2. Place the Yard Utilization gadget in a dashboard. For details, see Adding or editing a dashboard (on page 483) and
Displaying gadgets (on page 484).
3. For each area listed in the gadget, identify the yard blocks assigned to it by looking up the Yard Block table. For
details, see Yard Block Table view.
4. For each block in an area, do the following:
▪ Look up relevant fields in the YUR
▪ Calculate the total number of physical slots in a block based on the information provided in the Yard.txt file.
▪ Count the number of:
Total reefer slots (on page 653)
Usable reefer slots (on page 653)
Used reefer slots (on page 654)
5. Compare the numbers you receive with the numbers displayed in the Yard Utilization gadget.

Count the number of total reefer slots

The number of total reefer slots equals the number of physical slots (based on the YUR) limited by the reefer status
flag. For details, see Calculating the total number of physical slots in an area.

For example: A block has 10 physical rows, 10 physical columns, a maximum of 5 tiers, and a reefer status of 4. In this
case, 500 total physical slots exist (100 x 5), but only 400 total slots for reefer containers (100 x 4).

Count the number of usable reefer slots

The number of usable reefer slots equals the sum of the totl fields of all tiers in the YUR up to the height set by the
reefer status. Because different factors control reefer slots (such as men working, stacking limit, stack status, which
affects the usable stack slots, and reefer status), for each tier in a block, take the minimum value of the totl field and
the slots constrained by reefer status flags. Consider the examples in the following table.

Example Physical Physical Stacking Reefer Usable Usable Total

Rows Columns Limit Status Slots Reefer Reefer
Slots Slots
1 10 10 5 4 500 = 5 x 400 = 4 x 400 = 4 x
100 100 100
2 10 10 3 4 300 = 3 x 300 = 3 x 400 = 4 x
100 100 100
3 10, but 2 10 5 4 400 = 5 x 80 320 = 4 x 80 400 = 4 x
blocked off 100
by stack
status

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 653
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Yard Utilization gadget

Example Physical Physical Stacking Reefer Usable Usable Total

Rows Columns Limit Status Slots Reefer Reefer
Slots Slots
4 10 10 3 on rows 1 4 440 = 3 x 380 = 3 x 400 = 4 x
and 10 100 + 80 + 100 + 80 100
4 on rows 2 60
and 9
5 on all other
rows

For Example 3 and 4, consider the following tables to understand the tier-wise allocation of slots.

Tier-wise allocation of slots in Example 3

Tier Totl (YUR) Slots Allowed Usable Reefers

by Reefer
Status
1 80 100 80
2 80 100 80
3 80 100 80
4 80 100 80
5 80 0 0
Total 400 400 320

Tier-wise allocation of slots in Example 4

Tier Totl (YUR) Slots Allowed Used Reefers

by Reefer
Status
1 100 100 100
2 100 100 100
3 100 100 100
4 80 100 80
5 60 0 0
Total 440 400 380

Count the number of used reefer slots

The number of used reefer slots equals the value of the used field in the YUR limited by the reefer status. For each tier
in a block, take the value of the used field in the YUR up to the height that is set by the reefer status.

A reefer slot occupied by a dry or reefer container is considered used. However, any container placed in a tier
above the reefer status flag is not considered as taking up a reefer slot.
For example: For a block with 10 physical rows and 10 physical columns that has a stacking limit of 5 and a reefer
status of 3, we can count the values shown in the following table.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 654
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate dynamic gadgets

Tier Used (YUR) Slots Allowed Used Reefers

by Reefer
Status
1 65 100 65
2 50 100 50
3 35 100 35
4 25 0 0
5 0 0 0
Total 175 300 150

3.5.9 Validate dynamic gadgets

The following table describes how to validate metrics in dynamic gadgets.

Gadget Metric Validation Steps

Units in Yard Number of units in yard 1. In N4, select Operations
Unit Units.
2. Create a filter with the
following criteria:
▪ Transit State = Yard
▪ Category = Import
3. Compare the number of
containers in the filter output
with the number of Import
containers displayed in the
gadget.
4. Repeat steps 2 and 3 for
other categories, such as
Transship, Through, Export,
Storage, Restow, or
Domestic.
Moves per Day Number of moves per day 1. In N4, select Operations
Yard Move History.
2. Create a filter with the
following criteria:
▪ Move Kind is (=) Load
▪ Time Completed is (=) Last
seven days
3. Compare the number of
containers in the filter output
with the number of Load
containers displayed in the
gadget.
4. Repeat steps 2 and 3 for
other move kinds, such as
Discharge and Yard Move.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 655
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate dynamic gadgets

Gadget Metric Validation Steps

Facility TEU Number of TEUs in yard 1. In N4, select Operations
Unit Units.
2. To determine the number of
20' containers in the Units
view, create a filter with the
criterion Equipment Type
Nominal Length is one of (in)
[20', 22', 24'].
3. To determine the number of
40' and 45' containers, create
a filter with the following
criteria:
▪ Equipment Type Nominal
Length is not (!=) 20'
▪ Equipment Type Nominal
Length is not (!=) 22'
▪ Equipment Type Nominal
Length is not (!=) 24'
▪ Transit State is (=) Yard
4. To determine the total
number of TEUs, calculate as
follows:
Number of 20' containers * 1
+ Number of 40' and 45'
containers * 2

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 656
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Moves per Day gadget

Gadget Metric Validation Steps

Unit Dwell Time Container dwell time 1. In N4, select Operations
Unit Units.
2. Create a filter with the
criterion Transit State is (=)
Yard.
3. Display the Time In and
Dwell columns (8-
Timestamp submenu).
4. Sort the Units view by the
Time In column, in
ascending order.
5. Count the number of
containers with a Dwell time
<= 4.
6. Compare this number with
the values for x-axis
coordinate 1-4 in the Unit
Dwell Time gadget.
7. Repeat steps 5 and 6 for
other x-axis coordinates (5-9,
10-14, 15-19, 20-24, 25-29,
30-34, 35-39, 40-44,45-49,
50+).

The Unit Dwell Time

gadget does not
consider units with a
dwell time longer than
365 days.

3.5.10 Validate the Moves per Day gadget

You validate the data in this gadget by comparing it with information in the Move History view.

To validate the data in the Moves per Day gadget:

1. In N4, select Yard Move History.
2. Filter the Move History view for the particular vessel visit (Carrier) and move kind.
3. Count the number of moves completed for each and every day (max: 7 days from current date).

3.5.11 Validate the Trucks in Yard gadget

You validate the metrics in the Trucks in Yard gadget using N4.

To validate the metrics in this gadget:

1. In the Truck Visits view (Operations Gate Truck Visits), display the following fields:
▪ Truck Visit Status

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 657
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Truck KPIs gadget

▪ Transaction Count
▪ Exited Yard
2. Count the number of single (transaction count = 1), dual (transaction count = 2), or other (transaction count > 2)
transactions with:
▪ A Transaction Visit Status of OK or TROUBLE
▪ A blank (null) Exited Yard column
3. To validate the total number of transactions, add up the numbers of single, dual, and other transactions.

3.5.12 Validate the Truck KPIs gadget

The following table describes how to validate the metrics in the Truck KPIs gadget.

Actual

Metric Validation Steps

Trucks in Yard 1. In the Truck Visits view (Operations Gate
Truck Visits), display the following fields:
▪ Truck Visit Status
▪ Transaction Count
▪ Trucks Entered
2. Count the number of records with Transaction
Visit Status = OK or TROUBLE and a blank
(null) Exited Yard.
Trucks of Long Stay 1. In the Settings view (Administration
Settings Settings), check the value for the
ROADMONITOR002 (YARD_SERVICE_TIME)
(on page 467) setting.
2. In the Truck Visits view, display the following
columns:
▪ Truck Visit Status
▪ Transaction Count
▪ Minutes in Yard
3. Count the number of records with Transaction
Visit Status = OK or TROUBLE and a Minutes
in Yard value > ROADMONITOR.
Trucks Entered 1. In the Truck Visits view, display the following
fields:
▪ Truck Visit Status
▪ Transaction Count
▪ Trucks Entered
2. Count the number of trucks entered in the last 60
minutes with a transaction status that is not
CANCEL or CLOSED.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 658
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Truck KPIs gadget

Metric Validation Steps

Average Turn Time 1. In the Truck Visits view, display the following
fields:
▪ Truck Visit Status
▪ Exited Yard
▪ Minutes In Yard
2. Filter for trucks with a status of COMPLETE and
an Exited Yard time in the last 60 minutes.
3. Average the Minutes In Yard field for the truck
visits.
% of Trouble Visits 1. To calculate the number of trouble visits in the
last hour, in the Truck Visits view, count the
number of trucks entered in the last 60 minutes
with a status of TROUBLE.
2. To calculate the percentage of trouble visits,
divide the result from step 1 by the number of
trucks entered; then multiply by 100.

Gauge

Metric Validation Steps

Trucks in Yard Verify that the gauge reflects the actual value of
Trucks in Yard
Trucks of Long Stay Verify that the gauge reflects the actual value of
Trucks of Long Stay
Trucks Entered Verify that the gauge reflects the actual value of
Trucks Entered
Average Turn Time Verify that the gauge reflects the actual value of
Average Turn Time
% of Trouble Visits Verify that the gauge reflects the actual value of %
of Trouble Visits

Sparkline

Metric Validation Steps

Trucks in Yard 1. In the Truck Visits view (Operations Gate

Truck Visits), display the following fields:
▪ Truck Visit Status
▪ Transaction Count
▪ Trucks Entered
2. Count the number of records with Transaction
Status = OK or TROUBLE for Trucks Entered
every hour for the last 4-8 hours, based on the
Look Back Hours value in the Truck KPIs form
(on page 519).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 659
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Truck KPIs gadget

Metric Validation Steps

Trucks of Long Stay 1. In the Settings view (Administration

Settings Settings), check the value for the
ROADMONITOR002 (YARD_SERVICE_TIME)
(on page 467) setting.
2. In the Truck Visits view, display the following
columns:
▪ Truck Visit Status
▪ Transaction Count
▪ Minutes in Yard
3. Count the number of records with Transaction
Status = OK or TROUBLE and a Minutes in
Yard value > ROADMONITOR every hour for the
last 4-8 hours, based on the Look Back Hours
value in the Truck KPIs form (on page 519).
Trucks Entered 1. In the Truck Visits view, display the following
fields:
▪ Truck Visit Status
▪ Transaction Count
▪ Trucks Entered
2. Count the number of trucks entered every hour
for the last 4-8 hours, based on the Look Back
Hours value in the Truck KPIs form (on page
519), with a transaction status that is not
CANCEL or CLOSED.
Average Turn Time 1. In the Truck Visits view, display the following
fields:
▪ Truck Visit Status
▪ Exited Yard
▪ Minutes In Yard
2. Filter for trucks with a status of COMPLETE and
an Exited Yard time for the last 8 hours.
3. Average the Minutes In Yard field for the truck
visits for every hour.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 660
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

% of Trouble Visits 1. In the Truck Visits view, do the following:

a. Display the fields Truck Visit Status and
Transaction Count.
b. Count the number of trucks entered every
hour for the last 4-8 hours, based on the Look
Back Hours value in the Truck KPIs form (on
page 519), with a transaction status that is not
CANCEL or CLOSED.
2. In the Truck Statistics view (Operations
Gate Truck Statistics), count the number of
trucks entered (Start field) for which the Trouble
flag is set (Trouble field) for every hour for the
last 4-8 hours, based on the Look Back Hours
value.
3. Divide the value from step 2 by the value from
step 1; then multiply by 100.

3.5.13 Validate the Vessel Crane Metrics view

The following table describes how to validate the metrics in the Vessels Metrics view.

Metric Validation Steps

Carrier Visit 1. In XPS, open a vessel (Vessel Open).
2. Select Planning Maintain Work Shifts.
3. In the Work Shifts window, verify the carrier visit in
the Shift Reference column.
Crane CHE 1. In XPS, open a vessel.
2. Select Vessel Crane Work List.
3. In the Crane Work List window, list all cranes
working for the vessel.
ETC 1. In XPS, open a vessel.
2. Select Vessel Crane Work List.
3. In the Crane Work List window, find the move time
of the last move of the last work queue or segment.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 661
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

First Move Time Do one of the following:
In XPS:
1. Select Control Points of Work.
2. In the Points of Work window, double-click the POW
to list all containers assigned for the crane.
3. Find the time of the first move.
In N4:
1. Select Yard Move History.
2. Filter the Move History view for the particular vessel
and crane (Carrier and Crane CHE).
3. Find the time of the first move.

For DSCH, this is the fetch time. For LOAD, this

is the put time. Either way, this is the first move
time for the entire vessel visit, regardless of
crane sharing.

Last Move Time Do one of the following:

In XPS:
1. Select Control Points of Work.
2. In the Points of Work window, double-click the POW
to list all containers assigned for the crane.
3. Find the time of the last move.
In N4:
1. Select Yard Move History.
2. Filter the Move History view for the particular vessel
and crane (Carrier and Crane CHE).
3. Find the time of the last move.

For DSCH, this is the fetch time. For LOAD, this

is the put time. Either way, this is the first move
time for the entire vessel visit, regardless of
crane sharing.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 662
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

Mvs To Go 1. In XPS, open a vessel.
2. Select Vessel Crane Work List to see the total
moves for each crane for the current segment.
3. Select Planning Maintain Queues.
4. In the Maintain Queues window:
▪ Sort the WQs based on the POW.
▪ Display the Projection total column (attribute).
5. To calculate Moves to go, subtract projections from
total moves.

Multiple segments for the same crane/vessel

visit combination only differ in ETC and Moves
To Go. In addition to Final ETC and Final Moves
To Go, other metrics are all the same (such as
Moves Completed, First Move, Last Move,
GGH, or Gross Productivity).

PTC N/A
Update Time Verify the time the XPS Data Harvester Job last updated
the record.
% Force Majeure Delays Divide Force Majeure Delays by the crane's eGGH; then
multiply by 100 (%).

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

% Non Terminal Delays Divide Non Terminal Delays by the crane's eGGH; then
multiply by 100 (%).

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

% Terminal Delays Divide Terminal Delays by the crane's eGGH; then

multiply by 100 (%).

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

Final ETC 1. In XPS, open a vessel.

2. Select Vessel Crane Work List.
3. In the Crane Work List window, find the move
complete time for the last move of the entire vessel
visit for the crane.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 663
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

Final Mvs To Go See Mvs To Go, but find the moves and projections for
the crane for the entire vessel visit (that is, subtract the
total number of projections from the total number of
moves).
First Move or Activity Time 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Verify the start time of the first completed activity and
compare it to the first move time.
5. Use the time that occurs first (minimum value).
Fore Majeure Delays 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Calculate the sum of duration of all Force Majeure
delays.

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

GGH Subtract First Move or Activity Time from Last Move or

Activity Time.
GMPH Divide Moves Completed by GGH.
Last Move or Activity Time 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Verify the end time of the last completed crane
activity and compare it to the last move time.
5. Use the time that occurs last (maximum value).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 664
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

Moves Completed 1. In N4, select Operations Yard Move History.
2. Filter the Move History view as follows:
▪ Carrier
▪ Crane CHE
▪ Move Kind is one of (in) [Discharge,Load,Shift
O.B.]
3. Count the number of moves.
4. To include discharge moves in Carry Underway
stage:
a. Select Yard Work Instructions.
b. Filter the Work Instructions view for the particular
vessel.
c. Based on the work queue for the respective
cranes, count the number of discharge moves in
Carry Underway stage.
d. Add the result to the number of moves counted in
Step 3.
NGH Subtract Total Delays from GGH.
NMPH Divide Moves Completed by NGH.
Non Terminal Delay 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Calculate the sum of duration of all Non Terminal
delays.

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

Plan Dev. Subtract Planned Completion from Estimated

Completion.
Terminal Delay 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Calculate the sum of duration of all Terminal delays.

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

Time since last move Subtract the last move time for the crane from the
current time of the N4 application server (now).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 665
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

Time to PTC Subtract PTC from the current time of the N4 application
server (now).
Total Delays 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Calculate the sum of duration of all user-defined
activities (Terminal, Non-Terminal, Force Majeure
delays).

You can identify a crane's delay category in the

Crane Delay Types view in N4 (Configuration
Other Crane Delay Types).

eGGH In case of crane sharing, use one of the following to

identify periods of extended inactivity to calculate eNGH
from NGH:
• In N4: Operations Yard Move History
• In XPS: Vessel Quay Commander Quay
Commander window Actions Crane Activities
List
eNGH In case of crane sharing, use N4 to identify periods of
extended inactivity to calculate eNGH from NGH:
Operations Yard Move History
eGMPH Divide Moves Completed by eGGH.
eNMPH Divide Moves Completed by eNGH.
Req GMPH Divide Moves To Go by Time To PTC to determine the
actual current value of required productivity for the crane
to complete on time.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 666
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Vessel Crane Metrics view

Metric Validation Steps

Final Mvs Completed Determine the number of moves completed by the crane
for the entire visit of the vessel.
1. In N4, select Operations Yard Move History.
2. Filter the Move History view as follows:
▪ Carrier
▪ Crane CHE
▪ Move Kind is one of (in) [Discharge,Load,Shift
O.B.]
3. Count the number of moves.
4. To include discharge moves in Carry Underway
stage:
a. Select Yard Work Instructions.
b. Filter the Work Instructions view for the particular
vessel.
c. Based on the work queue for the respective
cranes, count the number of discharge moves in
Carry Underway stage.
d. Add the result to the number of moves counted in
Step 3.
First Activity Time 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Find the start time of the first completed activity.
Last Activity Time 1. In XPS, open a vessel.
2. Select Vessel Quay Commander.
3. In the Quay Commander window, from the Actions
list, select Crane Activities List.
4. Find the end time of the last completed activity.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 667
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Move Count By POW By CHE report

Metric Validation Steps

Moves Last 60 min 1. In N4, select Operations Yard Move History.
2. Filter the Move History view for the particular vessel
and crane.
3. Count the number of moves completed in the last
hour.
4. To include discharge moves in Carry Underway
stage:
a. Select Yard Work Instructions.
b. Filter the Work Instructions view for the particular
vessel.
c. Based on the work queue for the respective
cranes, count the number of discharge moves in
Carry Underway stage.
d. Add the result to the number of moves counted in
Step 3.

3.5.14 Validate the Move Count By POW By CHE report

Before validating the data in the Move Count By POW By CHE report (on page 580), make sure that:

• The CHE Statistics job is running and processes all move records.
• EC events are available for all moves. For EC events to be available, setting EEVENH must be set to Y.
• Move record information is available in CHE-related tables.

To validate data in this report:

1. In N4, select Operations Yard Move History.
2. In the Move History view, display the following columns:
▪ WI POW
▪ Crane CHE
▪ Fetch CHE
▪ Carry CHE
▪ Put CHE
▪ Rehandle Count
3. Filter the view as follows:
▪ Time Completed is after (>) [From Date]
▪ Time Completed is before (<) [To Date]
4. If the report uses POW and CHE Kind filters, further filter the view for the respective CHE kind and POW.
5. Verify the values in the report against the calculations suggested in the following tables.

Report Header

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 668
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Move Count By POW By CHE report

Column Validation Steps

From Date N/A. This is a user-specified value (time field).
To Date N/A. This is a user-specified value (time field).
Duration Subtract To Date from From Date.
CHE Kind User-selected CHE types (such as STR, RTG, or TRK).
Blank if not selected.
POW User-selected POW value. Blank if not selected.

Details (number of moves performed by each CHE)

Column Validation Steps

CHE In the Move History view, verify the Fetch, Carry, and
Put CHEs (Require Handler or Self Complete).
Total In the Move History view, count the number of moves
performed by the CHE specified in the filter.

BI counts only one move for a CHE involved in

Fetch, Carry, or Put stage.

For trucks: Count the number of moves for the trucks

listed in the Carry CHE column for the given timestamp.
For self-complete CHEs: Count the number of moves
for the self-complete CHEs used in the fetch-carry (FC)
and carry-put (CP) phases for the given timestamp.
For Require Handler CHEs: Count the number of
moves for the Require Handler CHEs used in CHE-
Fetch and CHE-Put phases for the given timestamp.
Mvs/Hr Divide the report duration by the report total.
Rehandles In the Move History view, determine the rehandle count
for the respective CHE.
Total Productive Mvs Divide the report total by the report rehandles.

Summary (number of moves performed by each CHE per POW)

Column Validation Steps

CHE \ POW In the Move History view, verify:
• Fetch, Carry, and Put CHEs
• WI POW

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 669
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Moving CHE Productivity Analysis report

Column Validation Steps

Total Moves In the Move History view, count the total number of
moves performed by the CHE specified in the filter for
the respective POW.

BI counts only one move for a CHE involved in

Fetch, Carry, or Put stage.

For trucks: Count the number of moves for the trucks

listed in the Carry CHE column for the given timestamp.
For self-complete CHEs: Count the number of moves
for the self-complete CHEs used in the fetch-carry (FC)
and carry-put (CP) phases for the given timestamp.
For Require Handler CHEs: Count the number of
moves for the Require Handler CHEs used in CHE-
Fetch and CHE-Put phases for the given timestamp.
Total Moves (column) N/A. This column sums up the total number of moves for
a POW.
Total (row) N/A. This row sums up the total number of moves for a
CHE.

3.5.15 Validate the Moving CHE Productivity Analysis

report
Before validating the data in the Moving CHE Productivity Analysis report (on page 578), make sure that:

• The CHE Statistics job is running and processes all move records.
• EC events are available for all moves. For EC events to be available, setting EEVENH must be set to Y.
• Move record information is available in CHE-related tables.
For a validation example, see Validation of load moves (on page 673).

N4 only supports distance calculations with ECN4.

To validate data in this report:

1. In N4, select Operations Yard Move History.
2. In the Move History view, display the following columns:
▪ WI POW
▪ Crane CHE
▪ Fetch CHE
▪ Carry CHE
▪ Put CHE
▪ Rehandle Count
▪ Twin Fetch
▪ Twin Put

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 670
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Moving CHE Productivity Analysis report

3. Filter the view as follows:

▪ Time Completed is after (>) [From Date]
▪ Time Completed is before (<) [To Date]
4. Verify the values in the report against the calculations suggested in the following tables.

Report Header

Column Validation Steps

From Date N/A. This is a user-specified value (time field).
To Date N/A. This is a user-specified value (time field).
Duration Subtract To Date from From Date (in Hrs and Mnts)
Move Kind N/A. This is a user-specified value (move type, such as
Dsch, Load, Yard, or Recv). Blank if not selected.
CHE Kind N/A. This is a user-specified value (CHE type, such as
STR, RTG, or TRK). Blank if not selected.

Details (number of moves performed by each moving CHE and its wait time at various sites)

Column Validation Steps

CHE In the Move History view, verify the Carry CHEs.
Mvs In the Move History view, count the number of moves
for the CHEs used in the Carry CHE column for the
given timestamp and filter criteria.
Avg Mvs/Hr Divide the report moves by the report duration.
Trips Determine the number of containers that a CHE handled
on each trip.
Total Wait Time At Crane (mins) Sum up pick_wait_time (for DSCH moves) and
drop_wait_time (for LOAD moves). For details, see
Verification of time-related fields (on page 672).
Total Wait Time At Yard (mins) Sum up drop_wait_time (for DSCH moves),
pick_wait_time (for LOAD moves), and the sum of pick
and drop wait times for yard moves. For details, see
Verification of time-related fields (on page 672).
Total Idle Time (mins) Sum up pick_idle_time and drop_idle_time. For details,
see Verification of time-related fields (on page 672).
Total Unladen Travel Time (mins) Sum up unladen travel time (pick_travel_time) for all
moves returned by the specified filter. For details, see
Verification of time-related fields (on page 672).
Total Laden Travel Time (mins) Sum up laden travel time (drop_travel_time) for all
moves returned by the specified filter. For details, see
Verification of time-related fields (on page 672).
Avg Wait At Crane (mins) Divide Total Wait Time At Crane by Mvs (both values as
displayed in the report).
Avg Wait At Yard (mins) Divide Total Wait Time At Yard by Mvs (both values as
displayed in the report).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 671
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Moving CHE Productivity Analysis report

Column Validation Steps

Avg Idle Time (mins) Divide Total Idle Time by Mvs (both values as displayed
in the report).
Avg Unladen Travel Time (mins) Divide Total Unladen Travel Time by Trips (both values
as displayed in the report).
Avg Laden Travel Time (mins) Divide Total Laden Travel Time by Trips (both values as
displayed in the report).
Avg Unladen Travel Distance* Divide the Total unladen travel distance across all trips
by the numbers of trips displayed in the report.
Avg Laden Travel Distance* Divide the total laden travel distance across all trips by
the number of trips displayed in the report.

* Only available with ECN4.

3.5.15.1 Verification of time-related fields

The following table describes how to verify time-related fields in the Moving CHE Productivity Analysis report (on page
578).

mns_Che_Move_Statistics Truck Straddle

pick_dispatch_time For DSCH moves: xps_ecevent.ETSH(timestamp)

(t_pick_dispatch) xps_ecevent.TVCO(timestamp) xps_ecevent.ETRW(timestamp)
For LOAD/yard moves: xps_ecevent.ETRL(timestamp)
xps_ecevent.TYCO(timestamp)
xps_ecevent.ETGD(timestamp)
For Rail moves:
xps_ecevent.TRCO(timestamp)
pick_arrive_time For DSCH moves: xps_ecevent.EASH(timestamp)
(t_pick_arrive) xps_ecevent.AVCO(timestamp) xps_ecevent.EARW(timestamp)
For LOAD/yard moves: xps_ecevent.EARL(timestamp)
xps_ecevent.AYCO(timestamp)
xps_ecevent.EAGD(timestamp)
For Rail moves:
xps_ecevent.ARCO(timestamp)
drop_dispatch_time For DSCH moves: xps_ecevent.LTRW(timestamp)
(t_drop_dispatch) xps_ecevent.TYDR(timestamp) xps_ecevent.LTSH(timestamp)
For LOAD moves: xps_ecevent.LTRL(timestamp)
xps_ecevent.TVDR(timestamp)
xps_ecevent.LTGD(timestamp)
For Rail moves:
xps_ecevent.TRDR(timestamp)
drop_arrive_time For DSCH moves: xps_ecevent.LARW(timestamp)
(t_drop_arrive) xps_ecevent.AYDR(timestamp) xps_ecevent.LASH(timestamp)
For LOAD/yard moves: xps_ecevent.LARL(timestamp)
xps_ecevent.AVDR(timestamp)
xps_ecevent.LAGD(timestamp)
For Rail moves:
xps_ecevent.ARDR(timestamp)
container_on_time Land_cntr from RTG/Crane Lift_cntr from ground
(t_cntr_on) (substitute fetch_complete_time) (substitute fetch_complete_time)

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 672
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Moving CHE Productivity Analysis report

mns_Che_Move_Statistics Truck Straddle

container_off_time Lift _cntr from RTG/CRANE Land cntr on truck or ground

(t_cntr_off) (substitute carry_complete_time)
pick_wait_time Container_on_time - Container_on_time -
pick_arrive_time pick_arrive_time
drop_wait_time Container_off_time - Container_off_time -
drop_arrive_time drop_arrive_time
drop_idle_time drop_dispatch_time - drop_dispatch_time -
Container_on_time Container_on_time
pick_idle_time pick_dispatch_time - Equiment pick_dispatch_time - Equiment
Idle event Idle event
in the last hour from ec_event in the last hour from ec_event
table for the Che table for the Che
pick_travel_time (Unladen Travel pick_arrive_time - pick_arrive_time -
Time) pick_dispatch_time pick_dispatch_time
drop_travel_time drop_arrive_time - drop_arrive_time -
(Laden Travel Time) drop_dispatch_time drop_dispatch_time

3.5.15.2 Example: Validation of load moves

This example illustrates the validation steps for a LOAD move (STR STR QC).

To validate a LOAD move:

1. Perform a load move for sample container AMNU01006 using the Straddle STR04.
2. Execute the following query to make a note of events generated in the XPS_ECEVENT table:
select GKEY,yard,CHE_NAME, TYPE_DESCRIPTION,UNIT_ID_NAME,move_kind,
TIMESTAMP, OPERATOR_NAME,is_twin_move from xps_ecevent where unit_id_name =
'AMNU01006'

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 673
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Moving CHE Productivity Analysis report

3. Generate the Moving CHE Productivity Analysis report for the appropriate timestamp.

4. Validate the values in the sample report against the result set from Step 2, as shown in the following table, where:
▪ EC_EVENT is mapped to the TYPE_DESCRIPTION field
▪ Value is mapped to the TIMESTAMP field
For example, the first entry in the table (IDLE) refers to the first row (IDLE) of the result set.

Field EC_EVENT or Description Value

(mns_Che_Move_Statistics)
Idle Event in the Last hour IDLE 6/29/2010 18:26:55.490
pick_dispatch_time (t_pick_dispatch) ETRW 6/29/2010 18:28:49.397

pick_arrive_time (t_pick_arrive) EARW 6/29/2010 18:28:58.397

drop_dispatch_time LTSH 6/29/2010 18:29:23.333
(t_drop_dispatch)
drop_arrive_time (t_drop_arrive) LASH 6/29/2010 18:29:38.490
container_on_time (t_cntr_on) Move History view Time of Fetch 6/29/2010 18:29:23.000
column for the move
container_off_time (t_cntr_off) Move History view Time Carry 6/29/2010 18:30:30.677
Complete column for the move; if
null (blank), then Time Completed
column
pick_wait_time (mins) Container_on_time minus 0.410049995
pick_arrive_time
drop_wait_time (mins) Container_off_time minus 0.869783334
drop_arrive_time
drop_idle_time (mins) drop_dispatch_time minus 0.005550004
Container_on_time
pick_idle_time (mins) pick_dispatch_time minus Equiment 1.898450002
Idle event
in the last hour from ec_event table
for the CHE

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 674
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Yard Rehandle Report

Field EC_EVENT or Description Value

(mns_Che_Move_Statistics)
pick_travel_time (Unladen Travel pick_arrive_time minus 0.150000004
Time) (mins) pick_dispatch_time

drop_travel_time (Laden Travel drop_arrive_time minus 0.252616669

Time) (mins) drop_dispatch_time
Total Wait Time At Crane (mins) Sum of drop_wait_time because it is 0.869783334
a LOAD move
Total Wait Time At Yard (mins) Sum of pick_wait_time because is a 0.410049995
LOAD move
Total Idle Time (mins) Sum of Pick_Idle_Time and sum of 1.904000005
Drop_Ile_Time
Total Unladen Travel Time (mins) Sum of pick_travel_time, that is 0.150000004
unladen travel time
Total Laden Travel Time (mins) Sum of drop_travel_time, that is 0.252616669
laden travel time
Avg Wait At Crane (mins) Report.Total Wait Time At Crane 0.869783334
divided by Report.Mvs
Avg Wait At Yard (mins) Report.Total Wait Time At Yard 0.410049995
divided by Report.Mvs
Avg Idle Time (mins) Report.Total Idle Time divided by 1.904000005
Report.Mvs
Avg Unladen Travel Time (mins) Report.Total Unladen Travel Time 0.150000004
divided Report.Trips
Avg Laden Travel Time (mins) Report.Total Laden Travel Time 0.252616669
divided by Report.Trips

3.5.16 Validate the Yard Rehandle Report

You validate the data in the Yard Rehandle report (on page 587) against the Move History view in N4.

To validate data in this report:

1. In N4, select Operations Yard Move History.
2. In the Move History view, display the following columns:
▪ Line Operator
▪ Rehandle Count
▪ Move Kind
3. Filter the view as follows:
▪ Time Completed is after (>) [From Date]
▪ Time Completed is before (<) [To Date]
▪ Move Kind is (=) Load
4. Verify the values in the report against the calculations suggested in the following table.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 675
Confidential -- Proprietary
 Part 3: Business Intelligence Validating BI data
Validate the Reefer Plug Utilization report

Report Header

Column Validation Steps

From Date N/A. This is a user-specified value (time field).
To Date N/A. This is a user-specified value (time field).

Details

Column Validation Steps

Line Operator In the Move History view, verify the line
operators in the Unit Line Op column.
Rehandle Count In the Move History view, sum up the rehandle
count for each line operator.
Load In the Move History view, count the number of
load moves performed for each line operator.
Yard Rehandle / Load (%) Divide Rehandle Count by Load (both values as
displayed in the report); then multiply by 100.
Summary N/A. This row sums up the total for all line
operators.

3.5.17 Validate the Reefer Plug Utilization report

Before validating the data in this report:

1. Start the Yard Block Statistics job. For details, see Background Jobs view.
2. Generate the Reefer Plug Utilization report for the current timestamp. For details, see Running a report (on page
42).
The table describes how to validate the metrics in the Reefer Plug Utilization report.

Metric Validation Steps

As of Date/Hour N/A. This is a user-specified value (time field). N4
rounds the time off to the nearest hour, depending
on ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ) (on page
464).
Blocks 1. Select Configuration Other Yard Block
Table.
2. Compare the yard blocks listed in the Yard
Block Table view with the yard blocks listed in
the Reefer Plug Utilization report.
Summary N/A. This row sums up the numbers of a specific
report column, providing the total for all areas.

3.5.18 Validate the Average Daily Yard Utilization report

Validating the Average Daily Yard Utilization (on page 591) report involves running database queries.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 676
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Average Daily Yard Utilization report

The table describes how to validate the metrics in this report.

Metric Validation Steps

As of Date/Hour N/A. This field displays the date and time at which
you generated the report.
Date N/A. This column displays the last seven days, in
ascending order, in the following format: yyyy-mm-
dd.
Total Yard Utilization (%) See Percentage of total yard utilization (on page
677).
Total Reefer Utilization (%) See Percentage of total reefer utilization (on page
678).
[Area Code] See Percentage of utilization by area (on page
679).

3.5.18.1 Percentage of total yard utilization

Run the following query to validate the values in the Total Yard Utilization (%) section of the Average Daily Yard
Utilization report (on page 591).

SQL Server Oracle

select day(s.t_extracted) as Day, select TO_CHAR(t_extracted, 'DD')as Day,
sum(s.used_slots) as Total_Used, sum(s.used_slots) as Total_Used,
sum(s.usable_slots) as Total_Usable, sum(s.usable_slots) as Total_Usable,
(cast(sum(s.used_slots) as numeric (sum(s.used_slots)/
(12,3))/cast(sum(s.usable_slots) as sum(s.usable_slots))*100 as Utilization
numeric (12,3))*100) as Utilization from mns_yard_block_statistics s,
FROM mns_yard_block_statistics s, sparcsn4.mns_yard_block y where s.yb_gkey
mns_yard_block y = y.gkey and s.usable_slots > 0 and
where s.yb_gkey = y.gkey and y.block_type = 'STACK' and
s.usable_slots > 0 and y.block_type = s.t_extracted >= sysdate-7
'STACK' group by TO_CHAR(t_extracted, 'DD')
and datediff("d",s.t_extracted,getdate())
<= 7
group by day(s.t_extracted) order by
day(s.t_extracted) desc

The figure shows the query and its result against the respective section of the report.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 677
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Average Daily Yard Utilization report

3.5.18.2 Percentage of total reefer utilization

Run the following query to validate the values in the Total Reefer Utilization (%) section of the Average Daily Yard
Utilization report (on page 591).

SQL Server database Oracle database

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 678
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Average Daily Yard Utilization report

select day(s.t_extracted) as Day, select TO_CHAR(t_extracted, 'DD')as Day,

sum(s.used_reefer_slots) as Total_Used, sum(s.used_reefer_slots) as Total_Used,
sum(s.usable_reefer_slots) sum(s.usable_reefer_slots) as
as Total_Usable, Total_Usable,
(cast(sum(s.used_reefer_slots) as numeric (sum(s.used_reefer_slots)/
(12,3))/cast(sum(s.usable_reefer_slots) sum(s.usable_reefer_slots))*100 as
as numeric (12,3))*100) as Utilization Utilization from
mns_yard_block_statistics s,
FROM mns_yard_block_statistics s,
mns_yard_block y sparcsn4.mns_yard_block y where s.yb_gkey
= y.gkey and s.usable_reefer_slots > 0
where s.yb_gkey = y.gkey and
and y.block_type = 'STACK' and
s.usable_reefer_slots > 0 and
y.block_type = 'STACK' and s.t_extracted >= sysdate-7
datediff("d",s.t_extracted,getdate()) <= group by TO_CHAR(t_extracted, 'DD')
7
group by day(s.t_extracted)

The figure shows the query and its result against the respective section of the report.

3.5.18.3 Percentage of utilization by area

Run the following query to validate the values in the Utilization (%) by Area section of the Average Daily Yard
Utilization report (on page 591).

SQL Server Oracle

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 679
Confidential -- Proprietary
Part 3: Business Intelligence Validating BI data
Validate the Average Daily Yard Utilization report

select S.area_code,day(s.t_extracted) as select S.area_code, TO_CHAR(t_extracted,

Day, sum(s.used_slots) as Total_Used, 'DD')as Day, sum(s.used_slots) as
sum(s.usable_slots) as Total_Usable, Total_Used, sum(s.usable_slots) as
(cast(sum(s.used_slots) as numeric Total_Usable,
(12,3))/cast(sum(s.usable_slots) (sum(s.used_slots)/
as numeric (12,3))*100) as Utilization sum(s.usable_slots))*100 as Utilization
from mns_yard_block_statistics s,
FROM mns_yard_block_statistics s,
mns_yard_block y sparcsn4.mns_yard_block y where s.yb_gkey
= y.gkey and s.usable_slots > 0 and
where s.yb_gkey = y.gkey and
y.block_type = 'STACK' and
s.usable_slots > 0 and y.block_type =
'STACK' s.t_extracted >= sysdate-7
and datediff("d",s.t_extracted,getdate()) group by s.area_code,
<= 7 TO_CHAR(t_extracted, 'DD')
group by s.area_code, day(s.t_extracted)

The figure shows the query and its result against the respective section of the report.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 680
Confidential -- Proprietary
Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 681
Confidential -- Proprietary
Part 4
Troubleshooting
In this Section:

Troubleshooting Statistics and Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683

Reporting How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 682
Confidential -- Proprietary
4.1 Troubleshooting Statistics and Metrics
In This Section

Mensa statistics server role disconnects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684

XPS client as statistics server (Mensa client) does not populate the database tables mns_yard_block and
mns_yard_block_statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
AGV Wait at Parallel Buffer gadget does not display the AGV waiting time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
AGV Wait in ASC TZ gadget displays zero values in the X and Y axis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Vessel Metrics gadget displays null values in the eGMPH, eGGH, eNGH, eNMP columns. . . . . . . . . . . . . . . . . 685

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 683
Confidential -- Proprietary
 Part 4: Troubleshooting Troubleshooting Statistics and Metrics
Mensa statistics server role disconnects

4.1.1 Mensa statistics server role disconnects

This issue occurs when multiple users are assigned the MENSVR privilege.Navis recommends that you define only a
single user group for the Mensa statistics server and turn on MENSVR only for that group; then create one user ID for
this group and log in to the designated statistics server with this user ID.

4.1.2 XPS client as statistics server (Mensa client) does

not populate the database tables mns_yard_block and
mns_yard_block_statistics
Problem:

XPS Mensa client does not populate the database tables mns_yard_block and mns_yard_block_statistics
even though the Mensa server and N4 Yard Block Statistics background job are running. The Yard Block Statistics
background job responsible to collect the information on yard block utilization is unable to connect with XPS statistics
server. This happens because the default port ID 13301 configured in XPS Mensa client changes after upgrading to
new N4 version.

Solution:

You must manually configure the default port ID 13301 in the Set Port dialog box of the Mensa Statistics Server
Options window in Mensa client to enable the communication between N4 and XPS client statistics server. For more
information, refer to Setting up a Navis N4 XPS client as the statistics server.

In addition, ensure that the values for the N4 settings ARGOMONITOR002 (on page 464) and ARGOMONITOR003
(on page 464) for XPS statistics server are configured correctly. Restart the Yard Block Statistics background job and
the XPS client configured in the N4 setting ARGOMONITOR002 after verifying the connection between N4 node and
XPS statistics server. For more information, refer to Configuring settings for the XPS statistics server (on page 475).

4.1.3 AGV Wait at Parallel Buffer gadget does not display

the AGV waiting time
The CHE Move Statistics table should have the parallel buffer entry time and parallel buffer exit time for this gadget to
display the AGV waiting time. XPS records the EC events ENPB (enter parallel buffer time) and EXPB (exit parallel
buffer time). N4 calculates the metrics and records the information in the CHE Move Statistics table when you run the
CHE Statistics background job.

4.1.4 AGV Wait in ASC TZ gadget displays zero values in

the X and Y axis
The CHE Move Statistics table should have the ‘from block’ (FromBlock) and ‘to block’ (ToBlock) information for this
gadget to display data. You have to run the Yard Block Statistics background job, which collects information on yard
block utilization from XPS. Subsequently, when you run the CHE Statistics background job, N4 stores the 'from block'
and 'to block' information in the CHE Move Statistics table.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 684
Confidential -- Proprietary
 Part 4: Troubleshooting Troubleshooting Statistics and Metrics
Vessel Metrics gadget displays null values in the eGMPH, eGGH, eNGH, eNMP columns

4.1.5 Vessel Metrics gadget displays null values in the

eGMPH, eGGH, eNGH, eNMP columns
N4 populates values for these columns only if more than one move is completed for a vessel, that is, the first move or
activity and last move or activity should not be equal because, GGH is calculated as ‘Last move or activity – First move
or activity’ and NGH is 'GGH – sum of crane activity duration'. N4 displays the eGGH and eNGH columns with values
only if the same crane worked for multiple vessels on a day. Otherwise, eGGH and GGH will display the same value.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 685
Confidential -- Proprietary
4.2 Reporting How Do I...
How do I ...

In This Section

Add a new SQL Query report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687

Change the logo that appears on reports in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Sort a report by a computed field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Set up multiple notice requests for a single combination of Entity and Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Create a filter for General Notices that applies to Advised units only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 686
Confidential -- Proprietary
 Part 4: Troubleshooting Reporting How Do I...
Add a new SQL Query report

4.2.1 Add a new SQL Query report

In N4, you can use a SQL Query report to extract data from tables that do not have a parent-child relationship.

To create a new SQL Query Report:

1. Use any database editor, such as Toad or SQL Developer, to write the SQL statement you want to use to extract
the data for your report.
2. Compile and run the SQL Query to make sure it returns the expected data.

Ensure that the uppercase FROM and WHERE clauses are used in the outermost query. For more
information about the best practices and guidelines, see Guidelines for Designing SQL Query Reports (on
page 34).

3. Configure the iReport tool to use a SQL Datasource and add a new report layout:
a. Open iReport and set up a new Datasource and Database Connection.
b. Select the Database JDBC connection datasource.
c. Specify the details for the Database JDBC connection.
d. iReport displays the new SQL connection on the Datasources tab.
e. Select the new SQL connection.
f. Add a new Report by selecting a report template and providing the details, such as the name and location of the
new report.
g. In the iReport Designer, select the Report Query button.
h. In the Report query dialog box, paste the SQL Query that you compiled in the database editor.
i. Click Read Fields to populate the values of the fields in the bottom pane.
j. Click OK to populate the values in the Fields section in the Report Inspector pane.
k. Use the fields to create the layout of the report.
l. Save the report layout as a .jrxml file.
4. In N4, from the Operations Reports Report Designs Report Designs view (on page 18), add a new report
design.
5. In the Report Design form (on page 19) import the .jrxml file in the XML Design field.
6. From the Operations Reports Report Definitions Report Definitions view (on page 28), add a new report
definition based on the report design added in step 4 above.
7. Run the report (on page 42) to view the result in the desired format.

4.2.2 Change the logo that appears on reports in N4

You use an XML editor to modify existing report designs and to create new report designs. Navis recommends
installing/using an open source XML editor called iReport, which is the free, open source report designer for
JasperReports. The overview steps are:

• Download iReport from http://ireport.sourceforge.net/.

• Install and configure iReport.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 687
Confidential -- Proprietary
Part 4: Troubleshooting Reporting How Do I...
Change the logo that appears on reports in N4

• Add the image/logo to N4.

• Add the image/logo to the report using iReport.
The version of iReport that you install depends on the version of N4 that you are running. Refer to the chart below for
the correct version:

To use iReport for N4, you must configure it to be compatible with the JasperReports version by navigating (in iReport)
to Tools Options iReport Compatibility. On the Compatibility screen, you can select the JasperReports
version you need as the compatibility model that the iReport version you are using should use when operating.

The following table displays the N4 versions and the corresponding compatible version of the third-party components.

N4 Release JasperReports Release iReports Release

2.4 4.1.3 4.1.3

2.5 4.1.3 4.1.3
2.6 5.1.0 5.1.0
A key change in the latest
version is that each element
in the report design has its
own unique UUID.
Since there is no change to
the structure of the .jrxml,
except for the addition of
new elements, all reports in
N4 release 2.4 and above
will work as expected when
you upgrade JasperReports
to 5.1.0.
Navis recommends that you
use iReport 5.1.0 instead of
iReport 4.1.3 with N4 release
2.6.
3.1 and later 5.5.x 5.5.x
iReport/Jaspersoft Studio
has announced that as of
version 5.5.0, Jaspersoft
Studio will be the official
design client for
JasperReports. iReport will
remain as a supported
product in maintenance-only
mode until December 31,
2015.

To change the logo on customer-facing reports from N4:

1. Download, install, and configure iReport. (See version information, above.)
2. Add/import the image/logo to N4 (add media asset):
a. In N4, navigate to Operations Reports Media Assets + Add.
b. Use the Media Asset form (on page 27) to add a media asset. You must use the same media asset ID that you
define for the image/logo in this step to add a parameter in iReport.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 688
Confidential -- Proprietary
 Part 4: Troubleshooting Reporting How Do I...
Sort a report by a computed field

3. Add the image/logo to the report using iReport. This is a two-step process. First you add/define the image as a new
parameter. Then you place the image (as a parameter) where you want the image to display in the report.
a. In iReport, go to File Open and navigate to select/open the report to be modified.
b. Still in iReport, search for Media Asset parameter.
c. Follow the detailed instructions in the iReport Help for defining a media asset parameter in iReport.
◦ Instructions 1 and 2 describe how to add/define the image as a new parameter (Go to View Parameter, click
New, and use the same media asset ID defined previously in N4).
◦ Instructions 3 to 6 describe how to place the image in the report (in the Document Structure panel).
For further iReport documentation, please go to http://jasperforge.org/index.php?q=project/
ireport.

4.2.3 Sort a report by a computed field

Computed reporting fields are not database fields and are therefore not available for sorting in N4. However, you can
sort a report by a computed field when setting up the report using iReport.

To find out whether a reporting field is calculated:

N4 2.1 and earlier N4 2.2 and later

1. Locate the reporting entity in the N4 online help. 1. Open the Reporting Entity form (on page 45) for the
2. Look up the In Sort column for the field by which you respective entity.
want to sort the report. If this column displays the value 2. On the Configured Fields tab (on page 46), look up
No, this means the field is computed. the Can Use In Sort column for the field by which you
want to sort the report. If this column displays the value
No, this means the field is computed.

To sort by a computed field in iReport:

1. In iReport, open a report.
2. In the Report Inspector pane, right-click SortReport.
3. In the Report query dialog box, click Sort Options.
4. In the Sorting dialog box, click Add field to add the computed field by which you want to sort your report.
5. Click Close, and then click Save query.

4.2.4 Set up multiple notice requests for a single

combination of Entity and Event
To prevent duplicate notifications, N4 allows you to add only one notice request for each combination of Business
Entity and Event if the action is Print, Execute Code, or Send JMS. For other notice request actions, N4 avoids
duplicates by verifying other information instead. N4 allows multiple requests to Send Email as long as the Email
Party or Email Address is different for each request. Similarly, you can add multiple requests to Execute Code
Extension if the code extensions to be executed are not the same.

You must have the EXTENSIONS license to use code extensions.

You can always have multiple notice requests for a single combination of Business Entity and Event if the notice
requests execute different actions (such as a Send Email request and a Print request on Unit DISCH).

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 689
Confidential -- Proprietary
 Part 4: Troubleshooting Reporting How Do I...
Create a filter for General Notices that applies to Advised units only

To set up multiple notice requests with different actions or multiple notice requests to Send Email or Execute Code
Extension, add one of the notice requests first, then add another. For more information about how to add a notice
request, see Notice Request form.

4.2.5 Create a filter for General Notices that applies to

Advised units only
In N4, a unit can have multiple unit facility visits (UFVs) that are in various T-States (Transit States), such as Active,
Advised, or Retired. When you create a general notice for an Active UFV, N4 maps this active UFV with the parent unit
and creates the general notice, correctly. However, when you create a general notice for Advised UFVs, since there is
no unit to map to, N4 does not create the general notice.

To achieve the expected behavior for Advised units, when defining the filter for the general notice:
• To define a filter that excludes the Advised T-state, you should use the positive filter is one of (in) for the Transit
State field and include all the options except for Advised to trigger the general notice for all T-states except
Advised.
• To define a filter that includes only the Advised T-state, you should use the negative filter is not (!=) for the
Transit State field and include all the options except for Advised to trigger the general notice for the Advised units.

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 690
Confidential -- Proprietary
 Index

Index
ARGOMONITOR002
Business Intelligence. . . . . . . . . . . . . . . . . . . . . . 473 (MONITOR_SPARCS_CLIENT_IP). . . . . . . . . . . 464
ARGOMONITOR003
<
(MONITOR_SPARCS_CLIENT_PORT). . . . . . . . 464
<Dashboard> tab. . . . . . . . . . . . . . . . . . . . . . . . . 484
ARGOMONITOR005
(YARD_BLOCK_STATISTICS_FREQ). . . . . . . . . 464
A
ARGOMONITOR006
About data availability in Crane gadgets. . . . . . . 485 (BREAK_BULK_CRANE_ACTIVITY_ID). . . . . . . 464
About gadget titles. . . . . . . . . . . . . . . . . . . . . . . . 485 ARGOMONITOR007
Activity categories and codes. . . . . . . . . . . . . . . . 545 (HATCH_LID_CRANE_ACTIVITY_ID). . . . . . . . . 464
Add a new SQL Query report. . . . . . . . . . . . . . . . 687 ARGOMONITOR008
Adding gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . 486 (TWIST_LOCK_CRANE_ACTIVITY_ID). . . . . . . 464

Adding General Notice Requests. . . . . . . . . . . . . . 13 ARGOMONITOR009

(EGEAR_CRANE_ACTIVITY_ID). . . . . . . . . . . . 465
Adding or editing a dashboard. . . . . . . . . . . . . . . 483
ARGOMONITOR010
Adding Report Definitions. . . . . . . . . . . . . . . . . . . . 15 (MENSA_SERVER_SOCKET_TIMEOUT)'. . . . . 465
Adding Report Designs. . . . . . . . . . . . . . . . . . . . . 14 ARGOREPORTING001
Advanced SQL Definition. . . . . . . . . . . . . . . . . . . . 41 (REPORTING_TEMP_FILE_FOLDER). . . . . . . . 468
AGV Average moves per hour form. . . . . . . . . . . 510 ARGOREPORTING002
AGV Average moves per hour gadget. . . . . . . . . 486 (REPORTING_FROM_EMAIL). . . . . . . . . . . . . . 468

AGV Idle Time By AGV Pool form. . . . . . . . . . . . 510 ARGOREPORTING003

(REPORTING_REPLY_TO_EMAIL). . . . . . . . . . 468
AGV Idle Time By AGV Pool gadget. . . . . . . . . . 486
ARGOREPORTING004
AGV metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566 (REPORTING_NULL_PARAM_VALUE). . . . . . . 468
AGV Moves Per Hour gadget. . . . . . . . . . . . . . . . 487 ARGOREPORTING005
AGV Moves Per Hours form. . . . . . . . . . . . . . . . . 511 (REPORTING_SQL_TIMEOUT). . . . . . . . . . . . . 468
AGV Productivity Report. . . . . . . . . . . . . . . . . . . 607 ARGOREPORTING006 (REPORTING_SQL_ROWS)
AGV Productivity table. . . . . . . . . . . . . . . . . . . . . 608 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

AGV Travel Distance form. . . . . . . . . . . . . . . . . . 511 ARGOREPORTING007

(REPORTING_SQL_FETCH_SIZE). . . . . . . . . . 469
AGV Travel Distance gadget. . . . . . . . . . . . . . . . 486
ARGOREPORTING008
AGV Wait At Parallel Buffer form. . . . . . . . . . . . . 511 (REPORTING_CLEANUP_TIME_MILLIS). . . . . . 469
AGV Wait At Parallel Buffer gadget. . . . . . . . . . . 487 ARGOREPORTING009 (REPORTING VIEW
AGV Wait at Parallel Buffer gadget does not display VESSEL VISIT CLOSED). . . . . . . . . . . . . . . . . . 470
the AGV waiting time. . . . . . . . . . . . . . . . . . . . . . 684 ASC Driving Time form. . . . . . . . . . . . . . . . . . . . . 512
AGV Wait at QC form. . . . . . . . . . . . . . . . . . . . . . 511 ASC Driving Time gadget. . . . . . . . . . . . . . . . . . . 488
AGV Wait at QC gadget. . . . . . . . . . . . . . . . . . . . 487 ASC EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . 565
AGV Wait In ASC TZ form. . . . . . . . . . . . . . . . . . 512 ASC Idle Time by Yard Block form. . . . . . . . . . . . 512
AGV Wait In ASC TZ gadget. . . . . . . . . . . . . . . . 487 ASC Idle Time by Yard Block gadget. . . . . . . . . . 488
AGV Wait in ASC TZ gadget displays zero values in ASC metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
the X and Y axis. . . . . . . . . . . . . . . . . . . . . . . . . . 684
ASC Move Count by Move Direction table. . . . . . 602
AGV/AHT EC Events. . . . . . . . . . . . . . . . . . . . . . 567
ASC Move Count by Move Purpose table. . . . . . 602
Appointments. . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
ASC Move Count by Move Type report. . . . . . . . 600

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 691
Confidential -- Proprietary
 Index

ASC Move Count by move type table. . . . . . . . . 600 CHE terminology. . . . . . . . . . . . . . . . . . . . . . . . . 554
ASC Move Count Summary report. . . . . . . . . . . . 601 CHE Trip Statistics. . . . . . . . . . . . . . . . . . . . . . . . 281
ASC Moves by Move Kind form. . . . . . . . . . . . . . 513 Clerk Activity report. . . . . . . . . . . . . . . . . . . . . . . 586
ASC Moves by Move Kind gadget. . . . . . . . . . . . 488 Clerk Activity table. . . . . . . . . . . . . . . . . . . . . . . . 587
ASC Moves last hour form. . . . . . . . . . . . . . . . . . 513 Comparing straddle productivity. . . . . . . . . . . . . . 557
ASC Moves last hour gadget. . . . . . . . . . . . . . . . 489 Configured Fields tab. . . . . . . . . . . . . . . . . . . . . . . 46
ASC Productivity by block table. . . . . . . . . . . . . . 605 Configuring settings for the XPS statistics server 475
ASC Productivity form. . . . . . . . . . . . . . . . . . . . . 513 Configuring settings for vessel and crane gadgets. . .
ASC Productivity gadget. . . . . . . . . . . . . . . . . . . 489 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

ASC Productivity report. . . . . . . . . . . . . . . . . . . . 603 Configuring the Business Intelligence Option. . . . 474

ASC Productivity Report By Block. . . . . . . . . . . . 604 Count the number of total reefer slots. . . . . . . . . 653

ASC Productivity table. . . . . . . . . . . . . . . . . . . . . 604 Count the number of usable reefer slots. . . . . . . 653

ASC Red Time Current Day Range form. . . . . . . 514 Count the number of used reefer slots. . . . . . . . . 654

ASC Red Time Current Day Range gadget. . . . . 489 Crane KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . . 516

ASC Red Time For Date Range form. . . . . . . . . . 514 Crane KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . 491

ASC Red Time For Date Range gadget. . . . . . . . 489 Crane Metrics form. . . . . . . . . . . . . . . . . . . . . . . . 516
ASC Summary form. . . . . . . . . . . . . . . . . . . . . . . 514 Crane Metrics gadget. . . . . . . . . . . . . . . . . . . . . . 492

ASC Summary gadget. . . . . . . . . . . . . . . . . . . . . 490 Crane Rhythm form. . . . . . . . . . . . . . . . . . . . . . . 517

ASC Travel Distance form. . . . . . . . . . . . . . . . . . 515 Crane Rhythm gadget. . . . . . . . . . . . . . . . . . . . . 493

ASC Travel Distance gadget. . . . . . . . . . . . . . . . 490 Crane Worked Last Hour gadget. . . . . . . . . . . . . 494

Associate a role with a report definition. . . . . . . . . 31 Crane/Vessel Crane Activity metrics. . . . . . . . . . 542

Average ASC Cycle Time By ASC form. . . . . . . . 515 Crane/vessel crane activity terminology. . . . . . . . 543

Average ASC Cycle Time by ASC gadget. . . . . . 490 Crane/Vessel Forward-Looking metrics. . . . . . . . 532

Average Daily Yard Utilization report. . . . . . . . . . 591 Create a filter for General Notices that applies to
Advised units only. . . . . . . . . . . . . . . . . . . . . . . . 690
Average Daily Yard Utilization tables. . . . . . . . . . 593
Creating a PCPH gadget. . . . . . . . . . . . . . . . . . . 524
B Custom Fields tab. . . . . . . . . . . . . . . . . . . . . . . . . 46
BI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
D
Bill of Lading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Data Element Definition for AGV metrics. . . . . . . 566
Bill of Lading - Item. . . . . . . . . . . . . . . . . . . . . . . . . 59
Data Element Definition for ASC metrics. . . . . . . 563
Block Fullness for ASC yard blocks gadget. . . . . 491
Data Element Definition for Crane/Vessel Forward-
Booking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 Looking metrics. . . . . . . . . . . . . . . . . . . . . . . . . . 533
Booking Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 Data Element Definition for Gate metrics. . . . . . . 574
Data Element Definition for Moving CHE metrics. 555
C
Data element definition for QC metrics. . . . . . . . 569
Cargo Lot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Data Element Definition for Yard metrics. . . . . . . 572
Carrier Visit Service Order. . . . . . . . . . . . . . . . . . 313
Definition of AGV metrics. . . . . . . . . . . . . . . . . . . 566
Carrier Visit Service Type. . . . . . . . . . . . . . . . . . . 314
Definition of ASC metrics. . . . . . . . . . . . . . . . . . . 564
Change the logo that appears on reports in N4. . 687
Definition of Crane/Vessel Crane Activity metrics 544
Changing a gadget type's default parameter settings.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 Definition of Crane/Vessel Forward-Looking Metrics.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Definition of Fixed CHE metrics. . . . . . . . . . . . . . 557
Che Move Statistics. . . . . . . . . . . . . . . . . . . . . . . 273
Definition of Gate metrics. . . . . . . . . . . . . . . . . . . 574

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 692
Confidential -- Proprietary
 Index

Definition of Moving CHE metrics. . . . . . . . . . . . . 556 External trucks wait time metrics. . . . . . . . . . . . . 577
Definition of QC metrics. . . . . . . . . . . . . . . . . . . . 569
F
Definition of RTG/RMG metrics. . . . . . . . . . . . . . 571
F1 and F2 to P1 and P2. . . . . . . . . . . . . . . . . . . . 624
Definition of Yard metrics. . . . . . . . . . . . . . . . . . . 572
F1 and F2 to P1 to P2. . . . . . . . . . . . . . . . . . . . . 624
Delivery, receival, or yard move scenario (straddle). .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633 F1 to F2 to P1 and P2. . . . . . . . . . . . . . . . . . . . . 625
Determining which quay crane made a vessel move. F1 to F2 to P1 to P2. . . . . . . . . . . . . . . . . . . . . . . 625
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 F1 to F2 to P2 to P1. . . . . . . . . . . . . . . . . . . . . . . 625
Discharging a container from a vessel (RTG/RMG). . F1 to P2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Facility TEU gadget. . . . . . . . . . . . . . . . . . . . . . . 495
Displaying gadgets. . . . . . . . . . . . . . . . . . . . . . . . 484
Fixed CHE Details form. . . . . . . . . . . . . . . . . . . . 517
Duplicate a report definition. . . . . . . . . . . . . . . . . . 43
Fixed CHE Details gadget. . . . . . . . . . . . . . . . . . 495
Duration metrics for moving CHEs. . . . . . . . . . . . 556
Fixed CHE metrics. . . . . . . . . . . . . . . . . . . . . . . . 557

E Footnote 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Edge cases and restrictions. . . . . . . . . . . . . . . . . 573 Footnote 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

EDI Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Footnote 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Editing gadget-related settings. . . . . . . . . . . . . . . 477 Footnote 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562

Editing the display properties of table gadgets. . 523 FRMCARINA033 (GADGET_REFRESH_PERIOD). .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Editing the parameter settings of gadgets. . . . . . 509
Enabling the Dashboards menu. . . . . . . . . . . . . . 480 G
Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Gate metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Equipment Block Visit. . . . . . . . . . . . . . . . . . . . . . 283 Good plan deviation. . . . . . . . . . . . . . . . . . . . . . . 527
Equipment block visit (EBV) count. . . . . . . . . . . . 576 Guidelines for Designing SQL Query Reports. . . . 34
Equipment Delivery Order. . . . . . . . . . . . . . . . . . 302
Equipment Loadout Order. . . . . . . . . . . . . . . . . . 300 H

Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413 Hiding gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . 523

Example of a SQL Query with the UNION clause. 40

I
Example scenarios for Crane/Vessel Crane Activity
Initialize UFV move count. . . . . . . . . . . . . . . . . . . 575
Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Initializing standard report designs. . . . . . . . . . . . 476
Example scenarios for Crane/Vessel Forward-
Looking Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . 536 Internal and External trucks wait time metrics. . . 576
Example: Validation of load moves. . . . . . . . . . . 673 Internal Prime Movers report. . . . . . . . . . . . . . . . 596
Examples of Invalid SQL Queries. . . . . . . . . . . . . 39 Internal Prime Movers table. . . . . . . . . . . . . . . . . 597
Examples of Valid SQL Queries. . . . . . . . . . . . . . . 38 Internal trucks wait time metrics. . . . . . . . . . . . . . 577
Extension: Moving a single/twin container from an Intrastack move processing using as ASC. . . . . . 638
ASC stack - split-move. . . . . . . . . . . . . . . . . . . . . 638 Item Service Type Unit. . . . . . . . . . . . . . . . . . . . . 311
Extension: Moving a single/twin container to an ASC
stack - split-move. . . . . . . . . . . . . . . . . . . . . . . . . 637 L
Extension: Rolling moves forward or backward. . 636 Line DischargeList. . . . . . . . . . . . . . . . . . . . . . . . 416
External Trucks report. . . . . . . . . . . . . . . . . . . . . 598 Line LoadList. . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
External Trucks table. . . . . . . . . . . . . . . . . . . . . . 599 Loading a container to a vessel (RTG/RMG). . . . 610

M
Manage Dashboards Columns. . . . . . . . . . . . . . . 482

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 693
Confidential -- Proprietary
 Index

Manage Dashboards view. . . . . . . . . . . . . . . . . . 481 Move counts for rehandles/shift moves. . . . . . . . 563
Media Asset form. . . . . . . . . . . . . . . . . . . . . . . . . . 27 Moves per Day form. . . . . . . . . . . . . . . . . . . . . . . 517
Media Asset parameter in iReport. . . . . . . . . . . . . 28 Moves per Day gadget. . . . . . . . . . . . . . . . . . . . . 496
Media Assets Columns. . . . . . . . . . . . . . . . . . . . . . 27 Moving a container from one yard block to another
Media Assets Privileges. . . . . . . . . . . . . . . . . . . . 461 (RTG/RMG). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619

Media Assets view. . . . . . . . . . . . . . . . . . . . . . . . . 26 Moving a container to/from an ASC stack. . . . . . 637

MENCHEMETRICS001 Moving a container without a truck. . . . . . . . . . . . 622

(CHE_METRICS_FOR_MINUTES_AGO). . 465, 471 Moving a single/twin container out of an ASC stack. .
MENDASHBOARD001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
(AUTO_CREATE_DASHBOARD_FREQUENCY) 465 Moving a single/twin container to an ASC stack. 637
MENDASHBOARD002 Moving CHE Details form. . . . . . . . . . . . . . . . . . . 518
(VSL_DATA_DISPLAY_PERIOD). . . . . . . . . . . . 465 Moving CHE Details gadget. . . . . . . . . . . . . . . . . 497
MENDASHBOARD003 Moving CHE metrics. . . . . . . . . . . . . . . . . . . . . . . 555
(AUTO_CREATE_DASHBOARD_ROLE). . . . . . 466
Moving CHE Productivity Analysis report. . . . . . . 578
MENDASHBOARD005 (VSL_SHOW_ALL_CRANES)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Moving CHE Productivity table. . . . . . . . . . . . . . . 579

MENDATAMART001 Moving containers with moving CHEs. . . . . . . . . 623

(MONITOR_MOVES_EXTRACT_LATENCY). . . 466 Moving containers with straddle carriers. . . . . . . 626
MENJOBS001 Moving gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . 509
(VESSEL_STATISTICS_JOB_FREQUENCY). . 466,
471 N
MENJOBS002 N4 and JasperReports Compatibility Matrix. . . . . . 25
(CHE_STATISTICS_JOB_FREQUENCY). . 466, 471
MENJOBS003 O
(EC_EVENT_IMPORTER_JOB_FREQUENCY). 466 Operation guidelines for gathering decision support
MENJOBS004 data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
(EC_EVENT_IMPORTER_FILE_PATH). . . . . . . 467 Operation scenarios. . . . . . . . . . . . . . . . . . . . . . . 610
MENJOBS005 Other SQL Conditions. . . . . . . . . . . . . . . . . . . . . . 41
(EC_EVENT_IMPORTER_PROCESSED_FILE_PATH)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
P
Mensa statistics server role disconnects. . . . . . . 684
Percentage of total reefer utilization. . . . . . . . . . . 678
MENSPARCS003
Percentage of total yard utilization. . . . . . . . . . . . 677
(SPARCS_STATISTICS_SERVER_HARVEST_FREQ)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 Percentage of utilization by area. . . . . . . . . . . . . 679
MENSPARCS004 Poor plan deviation. . . . . . . . . . . . . . . . . . . . . . . . 528
(SPARCS_STATISTICS_SERVER_REQUEST_DELAY) Projection scenarios. . . . . . . . . . . . . . . . . . . . . . . 534
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Modifying the report definition to view yard utilization Q
at snapshot time. . . . . . . . . . . . . . . . . . . . . . . . . . 594 QC EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Monitor and Analytics configuration settings. . . . 463 QC Productivity . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Monitor Privileges. . . . . . . . . . . . . . . . . . . . . . . . . 461 QC Productivity table. . . . . . . . . . . . . . . . . . . . . . 610
Monitoring and Reporting Configuration. . . . . . . . 460 Quay crane metrics. . . . . . . . . . . . . . . . . . . . . . . 569
Monitoring and Reporting Privileges. . . . . . . . . . 461 Quay Cranes Moves By Hour gadget. . . . . . . . . . 498
Move Count by POW by CHE report. . . . . . . . . . 580 Quay Cranes Moves by Lift Mode for selected Quay
Move Count by POW by CHE tables. . . . . . . . . . 581 form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Move count per facility visit metrics. . . . . . . . . . . 575 Quay Cranes Moves by Lift Mode for selected Quay
Move counts for multiple moves. . . . . . . . . . . . . . 562 gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 694
Confidential -- Proprietary
 Index

Quay Cranes Moves by Lift Mode gadget. . . . . . 498 Run a report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Quay Cranes Net Moves By Hour form. . . . . . . . 519
S
Quay Cranes Net Moves By Hour gadget. . . . . . 498
Sample reports. . . . . . . . . . . . . . . . . . . . . . . . . . . 577
R Service Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Rail discharge scenario. . . . . . . . . . . . . . . . . . . . 635 Service Order Item. . . . . . . . . . . . . . . . . . . . . . . . 309
Rail load scenario. . . . . . . . . . . . . . . . . . . . . . . . . 634 Service Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Rail Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 Set up multiple notice requests for a single
Railcar Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 combination of Entity and Event. . . . . . . . . . . . . . 689

Reasonable negative plan deviation. . . . . . . . . . 529 Setting up a Navis N4 XPS client as the statistics
server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Reasonable positive plan deviation (Vessel KPIs
gadget). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 Setting up Reports. . . . . . . . . . . . . . . . . . . . . . . . . 12

Reefer Plug Utilization report. . . . . . . . . . . . . . . . 590 Setting up the automatic creation of vessel/crane
dashboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Reefer Plug Utilization table. . . . . . . . . . . . . . . . . 591
Sort a report by a computed field. . . . . . . . . . . . . 689
Reefer Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
SQL Design Guidelines. . . . . . . . . . . . . . . . . . . . . 37
Relevant XPS configuration settings. . . . . . . . . . 545
SQL Query Reports. . . . . . . . . . . . . . . . . . . . . . . . 32
Report Definition form. . . . . . . . . . . . . . . . . . . . . . 30
SRVNOTICE001
Report Definitions Columns. . . . . . . . . . . . . . . . . . 29 (NOTICE_RETURN_EMAIL_ADDRESS). . . . . . 471
Report Definitions view. . . . . . . . . . . . . . . . . . . . . . 28 Stack Block Utilization report. . . . . . . . . . . . . . . . 589
Report Design form. . . . . . . . . . . . . . . . . . . . . . . . 19 Stack Block Utilization table. . . . . . . . . . . . . . . . . 589
Report design parameters . . . . . . . . . . . . . . . . . . . 24 Standard report definitions. . . . . . . . . . . . . . . . . . . 32
Report Designs Columns. . . . . . . . . . . . . . . . . . . . 19 Standard report designs. . . . . . . . . . . . . . . . . . . . . 21
Report Designs view. . . . . . . . . . . . . . . . . . . . . . . 18 Starting BI-related background jobs. . . . . . . . . . . 477
Report Privileges. . . . . . . . . . . . . . . . . . . . . . . . . 462 Straddle Productivity report. . . . . . . . . . . . . . . . . 582
Reporting a Monitor metric issue. . . . . . . . . . . . . 639 Straddle Productivity table. . . . . . . . . . . . . . . . . . 583
Reporting Config Fields form. . . . . . . . . . . . . . . . . 46 Supported Entities. . . . . . . . . . . . . . . . . . . . . . . . . 35
Reporting Custom Fields form. . . . . . . . . . . . . . . . 47
Reporting Entities. . . . . . . . . . . . . . . . . . . . . . . . . . 48 T
Reporting Entities columns. . . . . . . . . . . . . . . . . . . 44 Terminal Monitor Privileges. . . . . . . . . . . . . . . . . 463
Reporting Entities view. . . . . . . . . . . . . . . . . . . . . . 43 Train Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Reporting Entity form. . . . . . . . . . . . . . . . . . . . . . . 45 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . 682
Reporting How Do I.... . . . . . . . . . . . . . . . . . . . . . 686 Troubleshooting Statistics and Metrics. . . . . . . . . 683
Reporting job settings. . . . . . . . . . . . . . . . . . . . . . 467 Truck KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . . 519
Reporting Views. . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Truck KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . . 499
Reports Configuration. . . . . . . . . . . . . . . . . . . . . . 16 Truck Transaction Stage. . . . . . . . . . . . . . . . . . . 351
Reports Process Flows. . . . . . . . . . . . . . . . . . . . . . 11 Truck Turn Time Analysis report. . . . . . . . . . . . . . 584
ROADMONITOR001 (MONITOR_REFRESH). . 467 Truck Turn Time Analysis table. . . . . . . . . . . . . . 585
ROADMONITOR002 (YARD_SERVICE_TIME). . 467 Truck Turn Time gadget. . . . . . . . . . . . . . . . . . . . 500
RTG/RMG metrics. . . . . . . . . . . . . . . . . . . . . . . . 571 Truck Visit Details. . . . . . . . . . . . . . . . . . . . . . . . . 376
RTG/RMG Productivity report. . . . . . . . . . . . . . . 606 Truck Visit Stage and Transaction. . . . . . . . . . . . 380
RTG/RMG Productivity table. . . . . . . . . . . . . . . . 606 Truck Visit Stages. . . . . . . . . . . . . . . . . . . . . . . . . 405
Truck Visit Statistics. . . . . . . . . . . . . . . . . . . . . . . 410
Trucks in Yard form. . . . . . . . . . . . . . . . . . . . . . . 521

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 695
Confidential -- Proprietary
 Index

Trucks in Yard gadget. . . . . . . . . . . . . . . . . . . . . . 501 Vessel Crane Statistics. . . . . . . . . . . . . . . . . . . . . 434

Vessel Crane Statistics - Delays. . . . . . . . . . . . . 442
U
Vessel discharge scenario. . . . . . . . . . . . . . . . . . 630
UFV Arrived on Railcar Visit. . . . . . . . . . . . . . . . . 327
Vessel Exchange Instructions. . . . . . . . . . . . . . . 258
UFV Move Count report. . . . . . . . . . . . . . . . . . . . 595
Vessel KPIs form. . . . . . . . . . . . . . . . . . . . . . . . . 522
UFV Move Count table. . . . . . . . . . . . . . . . . . . . . 595
Vessel KPIs gadget. . . . . . . . . . . . . . . . . . . . . . . 503
UFV on Railcar Visit. . . . . . . . . . . . . . . . . . . . . . . 335
Vessel load scenario. . . . . . . . . . . . . . . . . . . . . . 627
Understanding the Plan Deviation gauge. . . . . . . 527
Vessel Metrics form. . . . . . . . . . . . . . . . . . . . . . . 523
Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Vessel Metrics gadget. . . . . . . . . . . . . . . . . . . . . 504
Unit - Complex Visit. . . . . . . . . . . . . . . . . . . . . . . 123
Vessel Metrics gadget displays null values in the
Unit - Damages. . . . . . . . . . . . . . . . . . . . . . . . . . 153 eGMPH, eGGH, eNGH, eNMP columns. . . . . . . 685
Unit - Hazards. . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Vessel Visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Unit - Hazards and Train Visit. . . . . . . . . . . . . . . . 215 Vessel/crane scenario: A. . . . . . . . . . . . . . . . . . . 536
Unit - Holds/Permissions. . . . . . . . . . . . . . . . . . . 219 Vessel/crane scenario: A to B. . . . . . . . . . . . . . . 537
Unit Dwell Time gadget. . . . . . . . . . . . . . . . . . . . 501 Vessel/crane scenario: A to B to A. . . . . . . . . . . . 539
Unit facility visit move count metrics. . . . . . . . . . . 575 Vessel/crane scenario: A to B to A to B. . . . . . . . 540
Unit Move Event. . . . . . . . . . . . . . . . . . . . . . . . . . 222 Vessel/crane scenario: A to B to C. . . . . . . . . . . . 541
Units in Yard gadget. . . . . . . . . . . . . . . . . . . . . . . 502 Vessel/crane scenario: A to B to C to A. . . . . . . . 542
Vessel/crane scenario: A to completion. . . . . . . . 536
V
Vessel/crane scenario: Default behavior for crane
Validate dynamic gadgets. . . . . . . . . . . . . . . . . . 655 activity recording. . . . . . . . . . . . . . . . . . . . . . . . . 546
Validate reefer plug data in the Yard Utilization gadget Vessel/crane scenario: Deleting a stopped crane
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Validate the Average Daily Yard Utilization report 676 Vessel/crane scenario: Editing a stopped crane
Validate the Crane KPIs gadget. . . . . . . . . . . . . . 646 activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Validate the Crane Metrics gadget. . . . . . . . . . . . 648 Vessel/crane scenario: Recording the number of
Validate the Crane Rhythm gadget. . . . . . . . . . . 647 containers moved using Egear. . . . . . . . . . . . . . . 548

Validate the Fixed and Moving CHE Details gadgets. Vessel/crane scenario: Recording the number of
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649 hatch lids, breakbulk, or twistlock bins. . . . . . . . . 547

Validate the Move Count By POW By CHE report 668 Vessels Alongside form. . . . . . . . . . . . . . . . . . . . 521

Validate the Moves per Day gadget. . . . . . . . . . . 657 Vessels Alongside gadget. . . . . . . . . . . . . . . . . . 506

Validate the Moving CHE Productivity Analysis report

W
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Which CHE are credited with a move. . . . . . . . . . 558
Validate the Reefer Plug Utilization report. . . . . . 676
Validate the Truck KPIs gadget. . . . . . . . . . . . . . 658 X
Validate the Trucks in Yard gadget. . . . . . . . . . . . 657 XPS client as statistics server (Mensa client) does not
Validate the Vessel Crane Metrics view. . . . . . . . 661 populate the database tables mns_yard_block and
Validate the Vessel KPIs gadget. . . . . . . . . . . . . 645 mns_yard_block_statistics. . . . . . . . . . . . . . . . . . 684

Validate the Vessel Metrics gadget. . . . . . . . . . . 642 XPS settings for straddle operations. . . . . . . . . . 627

Validate the Vessels Alongside gadget. . . . . . . . 641

Y
Validate the Yard Rehandle Report. . . . . . . . . . . 675
Yard Block Statistics. . . . . . . . . . . . . . . . . . . . . . . 284
Validate the Yard Utilization gadget. . . . . . . . . . . 652
Yard metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Validating BI data. . . . . . . . . . . . . . . . . . . . . . . . . 640
Yard move with yard shifts scenario. . . . . . . . . . . 631
Verification of time-related fields. . . . . . . . . . . . . 672

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 696
Confidential -- Proprietary
 Index

Yard Rehandle by Equipment Operator report. . . 587

Yard Rehandle by Equipment Operator table. . . . 588
Yard Utilization form. . . . . . . . . . . . . . . . . . . . . . . 523
Yard Utilization gadget. . . . . . . . . . . . . . . . . . . . . 508

Published: Wednesday, December 01, 2021 Navis N4 3.8.20: Monitoring and Reporting Guide 697
Confidential -- Proprietary